Це багатосторінкова версія цього розділу для друку. Натисніть тут, щоб надрукувати.
Scheduling
- 1: CompositePodGroup
- 2: PodGroup
- 3: PriorityClass
- 4: Workload
1 - CompositePodGroup
CompositePodGroup представляє екземпляр груп подів у в процесі виконання, згрупованих разом. CompositePodGroups створюються контролерами робочих навантажень (LWS, JobSet тощо) з Workload.compositePodGroupTemplates. Увімкнення API CompositePodGroup відбувається за допомогою функціональної можливості CompositePodGroup.
apiVersion: scheduling.k8s.io/v1alpha3
import "k8s.io/api/scheduling/v1alpha3"
CompositePodGroup
CompositePodGroup представляє екземпляр груп подів у процесі виконання, згрупованих разом. CompositePodGroups створюються контролерами робочих навантажень (LWS, JobSet тощо) з Workload.compositePodGroupTemplates. Увімкнення API CompositePodGroup відбувається за допомогою функціональної можливості CompositePodGroup.
| Поле | Опис |
|---|---|
apiVersionstring | APIVersion визначає версію схеми цього представлення обʼєкта. Сервери повинні конвертувати розпізнані схеми до останнього внутрішнього значення і можуть відхиляти нерозпізнані значення. Детальніше: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources |
kindstring | Kind визначає тип REST-ресурсу, який представляє цей обʼєкт. Сервери можуть визначати це з точки доступу, до якої клієнт надсилає запити. Не може бути оновлено. У CamelCase. Детальніше: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
metadataObjectMeta | Стандартні метадані обʼєкта. Детальніше: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata |
spec *CompositePodGroupSpec | spec визначає бажаний стан CompositePodGroup. |
statusCompositePodGroupStatus | status представляє поточний спостережений стан CompositePodGroup. |
CompositePodGroupSpec
CompositePodGroupSpec визначає бажаний стан CompositePodGroup.
| Поле | Опис |
|---|---|
disruptionModeCompositeDisruptionMode | disruptionMode визначає режим, у якому вказаний CompositePodGroup може бути порушений. Контролери повинні заповнювати це поле, копіюючи його з CompositePodGroupTemplate. Одне з: Single, All. Стандартно — Single, якщо не встановлено. Це поле є незмінним. |
parentCompositePodGroupNamestring | parentCompositePodGroupName містить назву батьківської складеної групи подів у тому ж просторі назв, що й ця складена група подів. Вона повинна бути назвою DNS. Якщо вона є nil, тоді ця складена група подів є коренем ієрархії робочого навантаження. Це поле є незмінним. |
preemptionPolicystring | preemptionPolicy — це політика для переривання подів/подгруп з нижчим пріоритетом. Одне з: Never, PreemptLowerPriority. Стандартно — PreemptLowerPriority, якщо не встановлено. Коли контроль допуску пріоритету увімкнений, він заповнює це поле з PriorityClassName і встановлює PreemptLowerPriority стандартно, якщо значення не встановлено в PriorityClass. Це поле є незмінним. Це поле доступне лише тоді, коли ворота функції PodGroupPreemptionPolicy увімкнені. Можливі значення перерахування: - "Never" означає, що под ніколи не перериває інші поди з нижчим пріоритетом.- "PreemptLowerPriority" означає, що под може переривати інші поди з нижчим пріоритетом. |
priorityinteger | priority — це значення пріоритету цієї складеної групи подів. Різні системні компоненти використовують це поле, щоб знайти пріоритет складеної групи подів. Коли контроль допуску пріоритету ввімкнений, він запобігає встановленню цього поля користувачами. Контроль допуску заповнює це поле з PriorityClassName. Чим вище значення, тим вищий пріоритет. Це поле є незмінним. |
priorityClassNamestring | priorityClassName визначає пріоритет, який слід враховувати під час планування цього CompositePodGroup. Контролери повинні заповнювати це поле, копіюючи його з CompositePodGroupTemplate. Якщо не вказано, воно валідується та вирішується аналогічно полю PriorityClassName в подах (тобто якщо клас пріоритету не вказано, контроль допуску може встановити його на стандартний глобальний клас пріоритету, якщо він існує. В іншому випадку пріоритет складеної групи подів буде нульовим). Це поле є незмінним. |
schedulingConstraintsCompositePodGroupSchedulingConstraints | schedulingConstraints визначає необовʼязкові обмеження планування (наприклад, топологію) для цього CompositePodGroup. Контролери повинні заповнювати це поле, копіюючи його з CompositePodGroupTemplate. Це поле є незмінним. |
schedulingPolicy *CompositePodGroupSchedulingPolicy | schedulingPolicy визначає політику планування для цього екземпляра CompositePodGroup. Контролери повинні заповнювати це поле, копіюючи його з CompositePodGroupTemplate. Це поле є незмінним. |
workloadRef *WorkloadReference | workloadRef посилається на необовʼязковий шаблон CompositePodGroup у межах обʼєкта Workload, який використовувався для створення CompositePodGroup. Це поле є обовʼязковим. Це поле є незмінним. |
CompositePodGroupStatus
CompositePodGroupStatus представляє інформацію про стан групи подів.
| Поле | Опис |
|---|---|
conditionsCondition array patch strategy: злиття за ключем type | conditions представляють останні спостереження стану CompositePodGroup. Відомі типи станів: - "CompositePodGroupInitiallyScheduled": Вказує, чи було задоволено загальну вимогу планування для піддерева під цим CompositePodGroup. Після переходу цього стану до True він слугує кінцевим станом і ніколи не повертається до False, навіть якщо поди будуть пізніше видалені та обмеження групи більше не виконуються. - "DisruptionTarget": Вказує, чи буде CompositePodGroup незабаром завершено через порушення, таке як переривання. Відомі причини стану CompositePodGroupInitiallyScheduled: - "Unschedulable": Піддерево CompositePodGroup не вдалося розмістити через обмеження ресурсів, афінність/антиафінність або топологічні обмеження. - "SchedulerError": CompositePodGroup не може бути заплановано через деяку внутрішню помилку, що сталася під час планування. - "Invalid": Встановлюється в True, коли kube-scheduler виявляє недійсний макет групи під час валідації виконання. Поле message детально описує конкретне порушення макету (таке як виявлений цикл, перевищення максимальної глибини 4 або посилання на кілька різних Workload). Відомі причини стану DisruptionTarget: - "PreemptionByScheduler": CompositePodGroup був ціллю циклу переривання планувальника для звільнення місця для переривачів з вищим пріоритетом. |
CompositePodGroupList
CompositePodGroupList містить список ресурсів CompositePodGroup.
| Поле | Опис |
|---|---|
apiVersionstring | APIVersion визначає версію схеми цього представлення обʼєкта. Сервери повинні конвертувати розпізнані схеми до останнього внутрішнього значення і можуть відхиляти нерозпізнані значення. Детальніше: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources |
items *CompositePodGroup array | Items є списком CompositePodGroups. |
kindstring | Kind визначає тип REST-ресурсу, який представляє цей обʼєкт. Сервери можуть визначати це з точки доступу, до якої клієнт надсилає запити. Не може бути оновлено. У CamelCase. Детальніше: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
metadataListMeta | Стандартні метадані списку. |
Операції
post Create
HTTP Запит
POST /apis/scheduling.k8s.io/v1alpha3/namespaces/{namespace}/compositepodgroups
Параметри шляху
| Назва | Тип | Опис |
|---|---|---|
namespace | string | назва обʼєкта та область автентифікації, наприклад для команд та проєктів |
Параметри запиту
| Назва | Тип | Опис |
|---|---|---|
pretty | string | Якщо 'true', то вихідні дані форматуються у зручному для читання вигляді. Зазвичай 'false', якщо user-agent не вказує оглядач або командний інструмент для роботи з HTTP (curl та wget). |
dryRun | string | Коли параметр присутній, це вказує, що зміни не повинні зберігатися. Неправильна або нерозпізнана директива dryRun призведе до помилки та припинення обробки запиту. Дійсні значення:
|
fieldManager | string | fieldManager є імʼям, повʼязаним з а́ктором або сутністю, яка вносить ці зміни. Значення повинно бути менше або дорівнювати 128 символам і містити лише друковані символи, як визначено в https://golang.org/pkg/unicode/#IsPrint. |
fieldValidation | string | fieldValidation інструктує сервер, як обробляти обʼєкти в запиті (POST/PUT/PATCH), що містять невідомі або дубльовані поля. Дійсні значення:
|
Параметри тіла запиту
| Назва | Тип | Опис |
|---|---|---|
body | CompositePodGroup |
Відповідь
| Статус | Опис | Відповідь |
|---|---|---|
| 200 | OK | CompositePodGroup |
| 201 | Created | CompositePodGroup |
| 202 | Accepted | CompositePodGroup |
patch Patch
HTTP Запит
PATCH /apis/scheduling.k8s.io/v1alpha3/namespaces/{namespace}/compositepodgroups/{name}
Параметри шляху
| Назва | Тип | Опис |
|---|---|---|
name | string | назва обʼєкта CompositePodGroup |
namespace | string | назва обʼєкта та область автентифікації, наприклад для команд та проєктів |
Параметри запиту
| Назва | Тип | Опис |
|---|---|---|
pretty | string | Якщо 'true', то вихідні дані форматуються у зручному для читання вигляді. Зазвичай 'false', якщо user-agent не вказує оглядач або командний інструмент для роботи з HTTP (curl та wget). |
dryRun | string | Коли параметр присутній, це вказує, що зміни не повинні зберігатися. Неправильна або нерозпізнана директива dryRun призведе до помилки та припинення обробки запиту. Дійсні значення:
|
fieldManager | string | fieldManager є імʼям, повʼязаним з а́ктором або сутністю, яка вносить ці зміни. Значення повинно бути менше або дорівнювати 128 символам і містити лише друковані символи, як визначено в https://golang.org/pkg/unicode/#IsPrint. Це поле є обовʼязковим для запитів apply (application/apply-patch), але необовʼязковим для типів patch, що не є apply (JsonPatch, MergePatch, StrategicMergePatch). |
fieldValidation | string | fieldValidation інструктує сервер, як обробляти обʼєкти в запиті (POST/PUT/PATCH), що містять невідомі або дубльовані поля. Дійсні значення:
|
force | boolean | Force здійснює "примусове" виконання запитів Apply. Це означає, що користувач повторно отримає конфліктні поля, що належать іншим людям. Прапорець Force повинен бути не встановлений для запитів patch, що не є apply. |
Параметри тіла запиту
| Назва | Тип | Опис |
|---|---|---|
body | Patch |
Відповідь
| Статус | Опис | Відповідь |
|---|---|---|
| 200 | OK | CompositePodGroup |
| 201 | Created | CompositePodGroup |
put Replace
HTTP Запит
PUT /apis/scheduling.k8s.io/v1alpha3/namespaces/{namespace}/compositepodgroups/{name}
Параметри шляху
| Назва | Тип | Опис |
|---|---|---|
name | string | назва обʼєкта CompositePodGroup |
namespace | string | назва обʼєкта та область автентифікації, наприклад для команд та проєктів |
Параметри запиту
| Назва | Тип | Опис |
|---|---|---|
pretty | string | Якщо 'true', то вихідні дані форматуються у зручному для читання вигляді. Зазвичай 'false', якщо user-agent не вказує оглядач або командний інструмент для роботи з HTTP (curl та wget). |
dryRun | string | Коли параметр присутній, це вказує, що зміни не повинні зберігатися. Неправильна або нерозпізнана директива dryRun призведе до помилки та припинення обробки запиту. Дійсні значення:
|
fieldManager | string | fieldManager є імʼям, повʼязаним з а́ктором або сутністю, яка вносить ці зміни. Значення повинно бути менше або дорівнювати 128 символам і містити лише друковані символи, як визначено в https://golang.org/pkg/unicode/#IsPrint. |
fieldValidation | string | fieldValidation інструктує сервер, як обробляти обʼєкти в запиті (POST/PUT/PATCH), що містять невідомі або дубльовані поля. Дійсні значення:
|
Параметри тіла запиту
| Назва | Тип | Опис |
|---|---|---|
body | CompositePodGroup |
Відповідь
| Статус | Опис | Відповідь |
|---|---|---|
| 200 | OK | CompositePodGroup |
| 201 | Created | CompositePodGroup |
delete Delete
HTTP Запит
DELETE /apis/scheduling.k8s.io/v1alpha3/namespaces/{namespace}/compositepodgroups/{name}
Параметри шляху
| Назва | Тип | Опис |
|---|---|---|
name | string | назва обʼєкта CompositePodGroup |
namespace | string | назва обʼєкта та область автентифікації, наприклад для команд та проєктів |
Параметри запиту
| Назва | Тип | Опис |
|---|---|---|
pretty | string | Якщо 'true', то вихідні дані форматуються у зручному для читання вигляді. Зазвичай 'false', якщо user-agent не вказує оглядач або командний інструмент для роботи з HTTP (curl та wget). |
dryRun | string | Коли параметр присутній, це вказує, що зміни не повинні зберігатися. Неправильна або нерозпізнана директива dryRun призведе до помилки та припинення обробки запиту. Дійсні значення:
|
gracePeriodSeconds | integer | Тривалість у секундах перед видаленням обʼєкта. Значення повинно бути невідʼємним цілим числом. Значення нуль вказує на негайне видалення. Якщо це значення дорівнює nil, буде використано стандартний період очікування для вказаного типу. Стандартно — значення для кожного обʼєкта, якщо не вказано. Нуль означає негайне видалення. |
ignoreStoreReadErrorWithClusterBreakingPotential | boolean | якщо встановлено true, це запустить небезпечне видалення ресурсу у випадку, якщо звичайний процес вилення завершується помилкою пошкодженого обʼєкта. Ресурс вважається пошкодженим, якщо його не вдається успішно отримати з базового сховища через a) неможливість трансформації даних (наприклад, помилка розшифрування), або b) неможливість декодування в обʼєкт. ПРИМІТКА: небезпечне видалення ігнорує обмеження фіналізаторів, пропускає перевірки попередніх умов і видаляє обʼєкт зі сховища. ПОПЕРЕДЖЕННЯ: це може потенційно порушити кластер, якщо робоче навантаження, повʼязане з ресурсом, що видаляється небезпечним чином, покладається на звичайний процес вилення. Використовуйте лише якщо ВИ ПОВНІСТЮ розумієте, що робите. Стандартне значення — false, і користувач повинен погодитися на активацію. |
orphanDependents | boolean | Застаріле: будь ласка, використовуйте PropagationPolicy, це поле буде застарілим у версії 1.7. Чи повинні залежні обʼєкти бути осиротілими. Якщо true/false, фіналізатор "orphan" буде додано/видалено зі списку фіналізаторів обʼєкта. Може бути встановлено або це поле, або PropagationPolicy, але не обидва. |
propagationPolicy | string | Чи та як буде виконано збирання сміття. Може бути встановлено або це поле, або OrphanDependents, але не обидва. Стандартна політика визначається існуючим фіналізатором у metadata.finalizers та стандартною політикою для конкретного ресурсу. Допустимі значення: 'Orphan' — осиротити залежні обʼєкти; 'Background' — дозволити збирачу сміття видалити залежні обʼєкти у фоновому режимі; 'Foreground' — каскадна політика, яка видаляє всі залежні обʼєкти у передньому плані. |
Параметри тіла запиту
| Назва | Тип | Опис |
|---|---|---|
body | DeleteOptions |
Відповідь
| Статус | Опис | Відповідь |
|---|---|---|
| 200 | OK | Status |
| 202 | Accepted | Status |
delete Delete Collection
HTTP Запит
DELETE /apis/scheduling.k8s.io/v1alpha3/namespaces/{namespace}/compositepodgroups
Параметри шляху
| Назва | Тип | Опис |
|---|---|---|
namespace | string | назва обʼєкта та область автентифікації, наприклад для команд та проєктів |
Параметри запиту
| Назва | Тип | Опис |
|---|---|---|
pretty | string | Якщо 'true', то вихідні дані форматуються у зручному для читання вигляді. Зазвичай 'false', якщо user-agent не вказує оглядач або командний інструмент для роботи з HTTP (curl та wget). |
continue | string | Параметр continue слід встановлювати при отриманні додаткових результатів від сервера. Оскільки це значення визначається сервером, клієнти можуть використовувати значення continue лише з попереднього результату запиту з ідентичними параметрами запиту (крім значення continue), і сервер може відхилити значення continue, яке він не визнає. Якщо вказане значення continue більше не дійсне через термін дії (зазвичай від пʼяти до пʼятнадцяти хвилин) або зміну конфігурації на сервері, сервер поверне помилку 410 ResourceExpired разом з токеном continue. Якщо клієнту потрібен послідовний список, його необхідно перезапустити без поля continue. В іншому випадку клієнт може надіслати інший запит на отримання списку з токеном, отриманим з помилкою 410, і сервер поверне список, починаючи з наступного ключа, але з останнього знімка, що є непослідовним з попередніми результатами списку — обʼєкти, створені, змінені або видалені після першого запиту списку, будуть включені у відповідь, поки їхні ключі знаходяться після "наступного ключа". Це поле не підтримується, коли watch дорівнює true. Клієнти можуть почати спостереження з останнього значення resourceVersion, повернутого сервером, і не пропустити жодних змін. |
dryRun | string | Коли параметр присутній, це вказує, що зміни не повинні зберігатися. Неправильна або нерозпізнана директива dryRun призведе до помилки та припинення обробки запиту. Дійсні значення:
|
fieldSelector | string | Селектор для обмеження списку повернутих обʼєктів за їхніми полями. Стандартно — все. |
gracePeriodSeconds | integer | Тривалість у секундах перед видаленням обʼєкта. Значення повинно бути невідʼємним цілим числом. Значення нуль вказує на негайне видалення. Якщо це значення дорівнює nil, буде використано стандартний період очікування для вказаного типу. Стандартно — значення для кожного обʼєкта, якщо не вказано. Нуль означає негайне видалення. |
ignoreStoreReadErrorWithClusterBreakingPotential | boolean | якщо встановлено true, це запустить небезпечне видалення ресурсу у випадку, якщо звичайний процес вилення завершується помилкою пошкодженого обʼєкта. Ресурс вважається пошкодженим, якщо його не вдається успішно отримати з базового сховища через a) неможливість трансформації даних (наприклад, помилка розшифрування), або b) неможливість декодування в обʼєкт. ПРИМІТКА: небезпечне видалення ігнорує обмеження фіналізаторів, пропускає перевірки попередніх умов і видаляє обʼєкт зі сховища. ПОПЕРЕДЖЕННЯ: це може потенційно порушити кластер, якщо робоче навантаження, повʼязане з ресурсом, що видаляється небезпечним чином, покладається на звичайний процес вилення. Використовуйте лише якщо ВИ ПОВНІСТЮ розумієте, що робите. Стандартне значення — false, і користувач повинен погодитися на активацію. |
labelSelector | string | Селектор для обмеження списку повернутих обʼєктів за їхніми мітками. Стандартно — все. |
limit | integer | limit — це максимальна кількість відповідей для повернення у виклику списку. Якщо існує більше елементів, сервер встановить поле continue у метаданих списку на значення, яке можна використовувати з тим самим початковим запитом для отримання наступного набору результатів. Встановлення ліміту може повернути менше запитаної кількості елементів (до нуля елементів), якщо всі запитані обʼєкти відфільтровані, і клієнти повинні використовувати наявність поля continue для визначення наявності додаткових результатів. Сервери можуть не підтримувати аргумент limit і повертатимуть усі доступні результати. Якщо limit вказано, а поле continue порожнє, клієнти можуть припустити, що додаткові результати відсутні. Це поле не підтримується, якщо watch дорівнює true. Гарантується, що обʼєкти, повернуті при використанні continue, будуть ідентичними одноразовому виклику списку без ліміту — тобто жодні обʼєкти, створені, змінені або видалені після першого запиту, не будуть включені у наступні запити з continue. Це іноді називається послідовним знімком і забезпечує клієнту, який використовує limit для отримання менших частин дуже великого результату, можливість побачити всі можливі обʼєкти. Якщо обʼєкти оновлюються під час розбитого на частини списку, повертається версія обʼєкта, яка була на момент розрахунку першого результату списку. |
orphanDependents | boolean | Застаріле: будь ласка, використовуйте PropagationPolicy, це поле буде застарілим у версії 1.7. Чи повинні залежні обʼєкти бути осиротілими. Якщо true/false, фіналізатор "orphan" буде додано/видалено зі списку фіналізаторів обʼєкта. Може бути встановлено або це поле, або PropagationPolicy, але не обидва. |
propagationPolicy | string | Чи та як буде виконано збирання сміття. Може бути встановлено або це поле, або OrphanDependents, але не обидва. Стандартна політика визначається існуючим фіналізатором у metadata.finalizers та стандартною політикою для конкретного ресурсу. Допустимі значення: 'Orphan' — осиротити залежні обʼєкти; 'Background' — дозволити збирачу сміття видалити залежні обʼєкти у фоновому режимі; 'Foreground' — каскадна політика, яка видаляє всі залежні обʼєкти у передньому плані. |
resourceVersion | string | resourceVersion встановлює обмеження щодо того, з яких версій ресурсу може обслуговуватися запит. Детальніше: https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions. Стандартно — не встановлено |
resourceVersionMatch | string | resourceVersionMatch визначає, як resourceVersion застосовується до викликів списку. Наполегливо рекомендується встановлювати resourceVersionMatch для викликів списку, де встановлено resourceVersion. Детальніше: https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions. Стандартно — не встановлено |
sendInitialEvents | boolean | Параметр sendInitialEvents=true може бути встановлений разом із watch=true. У цьому випадку потік спостереження почнеться із синтетичних подій, щоб відобразити поточний стан обʼєктів у колекції. Після того, як усі такі події буде надіслано, буде надіслано синтетичну подію "Bookmark". Ця подія повідомить ResourceVersion (RV), що відповідає набору обʼєктів, і буде позначена анотацією "k8s.io/initial-events-end": "true". Далі потік спостереження продовжиться як зазвичай, надсилаючи події, що відповідають змінам (після цієї RV) обʼєктів, за якими ведеться спостереження.Коли встановлено параметр sendInitialEvents, ми вимагаємо, щоб також був встановлений параметр resourceVersionMatch. Семантика запиту на спостереження така:- resourceVersionMatch = NotOlderThan інтерпретується як "дані принаймні такі ж нові, як наданий resourceVersion", і подія-bookmark надсилається, коли стан синхронізовано до resourceVersion, принаймні так само свіжого, як наданий у ListOptions. Якщо resourceVersion не встановлено, це інтерпретується як "consistent read", і подія-bookmark надсилається, коли стан синхронізовано принаймні до моменту початку обробки запиту.- resourceVersionMatch, встановлений у будь-яке інше значення або не встановлений, повертає помилку Invalid. Стандартно true, якщо resourceVersion="" або resourceVersion="0" (з міркувань зворотної сумісності), і false в інших випадках. |
shardSelector | string | shardSelector обмежує список повернутих обʼєктів за допомогою виразу селектора шардів на основі CEL. Формат використовує функцію shardRange() у поєднанні з || (логічне АБО) для визначення одного або кількох діапазонів хешів: shardRange(object.metadata.uid, '0x0', '0x8000000000000000') shardRange(object.metadata.uid, '0x0', '0x8000000000000000') || shardRange(object.metadata.uid, '0x8000000000000000', '0x10000000000000000') Шляхи до полів використовують синтаксис CEL з коренем обʼєкта (наприклад, "object.metadata.uid"), а НЕ формат fieldSelector ("metadata.uid"). Наразі підтримуються шляхи: - object.metadata.uid - object.metadata.namespace hexStart та hexEnd — одинарні рядкові літерали CEL з префіксом '0x', що визначають включну нижню та виключну верхню межі простору хешів FNV-1a розміром 64 біти. Повний діапазон — [0x0, 0x10000000000000000), де виключна верхня межа дорівнює 2^64. Приклади: Розщеплення на 2 шарди: шард 0: shardRange(object.metadata.uid, '0x0000000000000000', '0x8000000000000000') шард 1: shardRange(object.metadata.uid, '0x8000000000000000', '0x10000000000000000') Розщеплення на 4 шарди: шард 0: shardRange(object.metadata.uid, '0x0000000000000000', '0x4000000000000000') шард 1: shardRange(object.metadata.uid, '0x4000000000000000', '0x8000000000000000') шард 2: shardRange(object.metadata.uid, '0x8000000000000000', '0xc000000000000000') шард 3: shardRange(object.metadata.uid, '0xc000000000000000', '0x10000000000000000') Це альфа-поле і потребує увімкнення функціональної можливості ShardedListAndWatch. |
timeoutSeconds | integer | Час очікування для виклику списку/спостереження. Це обмежує тривалість виклику, незалежно від активності чи бездіяльності. |
Параметри тіла запиту
| Назва | Тип | Опис |
|---|---|---|
body | DeleteOptions |
Відповідь
| Статус | Опис | Відповідь |
|---|---|---|
| 200 | OK | Status |
get Read
HTTP Запит
GET /apis/scheduling.k8s.io/v1alpha3/namespaces/{namespace}/compositepodgroups/{name}
Параметри шляху
| Назва | Тип | Опис |
|---|---|---|
name | string | назва обʼєкта CompositePodGroup |
namespace | string | назва обʼєкта та область автентифікації, наприклад для команд та проєктів |
Параметри запиту
| Назва | Тип | Опис |
|---|---|---|
pretty | string | Якщо 'true', то вихідні дані форматуються у зручному для читання вигляді. Зазвичай 'false', якщо user-agent не вказує оглядач або командний інструмент для роботи з HTTP (curl та wget). |
Відповідь
| Статус | Опис | Відповідь |
|---|---|---|
| 200 | OK | CompositePodGroup |
get List
HTTP Запит
GET /apis/scheduling.k8s.io/v1alpha3/namespaces/{namespace}/compositepodgroups
Параметри шляху
| Назва | Тип | Опис |
|---|---|---|
namespace | string | назва обʼєкта та область автентифікації, наприклад для команд та проєктів |
Параметри запиту
| Назва | Тип | Опис |
|---|---|---|
pretty | string | Якщо 'true', то вихідні дані форматуються у зручному для читання вигляді. Зазвичай 'false', якщо user-agent не вказує оглядач або командний інструмент для роботи з HTTP (curl та wget). |
allowWatchBookmarks | boolean | Дозволяє запити подій спостереження з типом "BOOKMARK". Сервери, які не реалізовують закладки, можуть ігнорувати цей прапорець, а закладки надсилаються на розсуд сервера. Клієнти не повинні припускати, що закладки повертаються через будь-який конкретний інтервал, а також не повинні припускати, що сервер надсилатиме будь-яку подію BOOKMARK під час сеансу. Якщо це не спостереження, це поле ігнорується. |
continue | string | Параметр continue слід встановлювати при отриманні додаткових результатів від сервера. Оскільки це значення визначається сервером, клієнти можуть використовувати значення continue лише з попереднього результату запиту з ідентичними параметрами запиту (крім значення continue), і сервер може відхилити значення continue, яке він не визнає. Якщо вказане значення continue більше не дійсне через термін дії (зазвичай від пʼяти до пʼятнадцяти хвилин) або зміну конфігурації на сервері, сервер поверне помилку 410 ResourceExpired разом з токеном continue. Якщо клієнту потрібен послідовний список, його необхідно перезапустити без поля continue. В іншому випадку клієнт може надіслати інший запит на отримання списку з токеном, отриманим з помилкою 410, і сервер поверне список, починаючи з наступного ключа, але з останнього знімка, що є непослідовним з попередніми результатами списку — обʼєкти, створені, змінені або видалені після першого запиту списку, будуть включені у відповідь, поки їхні ключі знаходяться після "наступного ключа". Це поле не підтримується, коли watch дорівнює true. Клієнти можуть почати спостереження з останнього значення resourceVersion, повернутого сервером, і не пропустити жодних змін. |
fieldSelector | string | Селектор для обмеження списку повернутих обʼєктів за їхніми полями. Стандартно — все. |
labelSelector | string | Селектор для обмеження списку повернутих обʼєктів за їхніми мітками. Стандартно — все. |
limit | integer | limit — це максимальна кількість відповідей для повернення у виклику списку. Якщо існує більше елементів, сервер встановить поле continue у метаданих списку на значення, яке можна використовувати з тим самим початковим запитом для отримання наступного набору результатів. Встановлення ліміту може повернути менше запитаної кількості елементів (до нуля елементів), якщо всі запитані обʼєкти відфільтровані, і клієнти повинні використовувати наявність поля continue для визначення наявності додаткових результатів. Сервери можуть не підтримувати аргумент limit і повертатимуть усі доступні результати. Якщо limit вказано, а поле continue порожнє, клієнти можуть припустити, що додаткові результати відсутні. Це поле не підтримується, якщо watch дорівнює true. Гарантується, що обʼєкти, повернуті при використанні continue, будуть ідентичними одноразовому виклику списку без ліміту — тобто жодні обʼєкти, створені, змінені або видалені після першого запиту, не будуть включені у наступні запити з continue. Це іноді називається послідовним знімком і забезпечує клієнту, який використовує limit для отримання менших частин дуже великого результату, можливість побачити всі можливі обʼєкти. Якщо обʼєкти оновлюються під час розбитого на частини списку, повертається версія обʼєкта, яка була на момент розрахунку першого результату списку. |
resourceVersion | string | resourceVersion встановлює обмеження щодо того, з яких версій ресурсу може обслуговуватися запит. Детальніше: https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions. Стандартно — не встановлено |
resourceVersionMatch | string | resourceVersionMatch визначає, як resourceVersion застосовується до викликів списку. Наполегливо рекомендується встановлювати resourceVersionMatch для викликів списку, де встановлено resourceVersion. Детальніше: https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions. Стандартно — не встановлено |
sendInitialEvents | boolean | Параметр sendInitialEvents=true може бути встановлений разом із watch=true. У цьому випадку потік спостереження почнеться із синтетичних подій, щоб відобразити поточний стан обʼєктів у колекції. Після того, як усі такі події буде надіслано, буде надіслано синтетичну подію "Bookmark". Ця подія повідомить ResourceVersion (RV), що відповідає набору обʼєктів, і буде позначена анотацією "k8s.io/initial-events-end": "true". Далі потік спостереження продовжиться як зазвичай, надсилаючи події, що відповідають змінам (після цієї RV) обʼєктів, за якими ведеться спостереження.Коли встановлено параметр sendInitialEvents, ми вимагаємо, щоб також був встановлений параметр resourceVersionMatch. Семантика запиту на спостереження така:- resourceVersionMatch = NotOlderThan інтерпретується як "дані принаймні такі ж нові, як наданий resourceVersion", і подія-bookmark надсилається, коли стан синхронізовано до resourceVersion, принаймні так само свіжого, як наданий у ListOptions. Якщо resourceVersion не встановлено, це інтерпретується як "consistent read", і подія-bookmark надсилається, коли стан синхронізовано принаймні до моменту початку обробки запиту.- resourceVersionMatch, встановлений у будь-яке інше значення або не встановлений, повертає помилку Invalid. Стандартно true, якщо resourceVersion="" або resourceVersion="0" (з міркувань зворотної сумісності), і false в інших випадках. |
shardSelector | string | shardSelector обмежує список повернутих обʼєктів за допомогою виразу селектора шардів на основі CEL. Формат використовує функцію shardRange() у поєднанні з || (логічне АБО) для визначення одного або кількох діапазонів хешів: shardRange(object.metadata.uid, '0x0', '0x8000000000000000') shardRange(object.metadata.uid, '0x0', '0x8000000000000000') || shardRange(object.metadata.uid, '0x8000000000000000', '0x10000000000000000') Шляхи до полів використовують синтаксис CEL з коренем обʼєкта (наприклад, "object.metadata.uid"), а НЕ формат fieldSelector ("metadata.uid"). Наразі підтримуються шляхи: - object.metadata.uid - object.metadata.namespace hexStart та hexEnd — одинарні рядкові літерали CEL з префіксом '0x', що визначають включну нижню та виключну верхню межі простору хешів FNV-1a розміром 64 біти. Повний діапазон — [0x0, 0x10000000000000000), де виключна верхня межа дорівнює 2^64. Приклади: Розщеплення на 2 шарди: шард 0: shardRange(object.metadata.uid, '0x0000000000000000', '0x8000000000000000') шард 1: shardRange(object.metadata.uid, '0x8000000000000000', '0x10000000000000000') Розщеплення на 4 шарди: шард 0: shardRange(object.metadata.uid, '0x0000000000000000', '0x4000000000000000') шард 1: shardRange(object.metadata.uid, '0x4000000000000000', '0x8000000000000000') шард 2: shardRange(object.metadata.uid, '0x8000000000000000', '0xc000000000000000') шард 3: shardRange(object.metadata.uid, '0xc000000000000000', '0x10000000000000000') Це альфа-поле і потребує увімкнення функціональної можливості ShardedListAndWatch. |
timeoutSeconds | integer | Час очікування для виклику списку/спостереження. Це обмежує тривалість виклику, незалежно від активності чи бездіяльності. |
watch | boolean | Спостерігати за змінами описаних ресурсів і повертати їх як потік сповіщень про додавання, оновлення та видалення. Вкажіть resourceVersion. |
Відповідь
| Статус | Опис | Відповідь |
|---|---|---|
| 200 | OK | CompositePodGroupList |
get List All Namespaces
HTTP Запит
GET /apis/scheduling.k8s.io/v1alpha3/compositepodgroups
Параметри запиту
| Назва | Тип | Опис |
|---|---|---|
allowWatchBookmarks | boolean | Дозволяє запити подій спостереження з типом "BOOKMARK". Сервери, які не реалізовують закладки, можуть ігнорувати цей прапорець, а закладки надсилаються на розсуд сервера. Клієнти не повинні припускати, що закладки повертаються через будь-який конкретний інтервал, а також не повинні припускати, що сервер надсилатиме будь-яку подію BOOKMARK під час сеансу. Якщо це не спостереження, це поле ігнорується. |
continue | string | Параметр continue слід встановлювати при отриманні додаткових результатів від сервера. Оскільки це значення визначається сервером, клієнти можуть використовувати значення continue лише з попереднього результату запиту з ідентичними параметрами запиту (крім значення continue), і сервер може відхилити значення continue, яке він не визнає. Якщо вказане значення continue більше не дійсне через термін дії (зазвичай від пʼяти до пʼятнадцяти хвилин) або зміну конфігурації на сервері, сервер поверне помилку 410 ResourceExpired разом з токеном continue. Якщо клієнту потрібен послідовний список, його необхідно перезапустити без поля continue. В іншому випадку клієнт може надіслати інший запит на отримання списку з токеном, отриманим з помилкою 410, і сервер поверне список, починаючи з наступного ключа, але з останнього знімка, що є непослідовним з попередніми результатами списку — обʼєкти, створені, змінені або видалені після першого запиту списку, будуть включені у відповідь, поки їхні ключі знаходяться після "наступного ключа". Це поле не підтримується, коли watch дорівнює true. Клієнти можуть почати спостереження з останнього значення resourceVersion, повернутого сервером, і не пропустити жодних змін. |
fieldSelector | string | Селектор для обмеження списку повернутих обʼєктів за їхніми полями. Стандартно — все. |
labelSelector | string | Селектор для обмеження списку повернутих обʼєктів за їхніми мітками. Стандартно — все. |
limit | integer | limit — це максимальна кількість відповідей для повернення у виклику списку. Якщо існує більше елементів, сервер встановить поле continue у метаданих списку на значення, яке можна використовувати з тим самим початковим запитом для отримання наступного набору результатів. Встановлення ліміту може повернути менше запитаної кількості елементів (до нуля елементів), якщо всі запитані обʼєкти відфільтровані, і клієнти повинні використовувати наявність поля continue для визначення наявності додаткових результатів. Сервери можуть не підтримувати аргумент limit і повертатимуть усі доступні результати. Якщо limit вказано, а поле continue порожнє, клієнти можуть припустити, що додаткові результати відсутні. Це поле не підтримується, якщо watch дорівнює true. Гарантується, що обʼєкти, повернуті при використанні continue, будуть ідентичними одноразовому виклику списку без ліміту — тобто жодні обʼєкти, створені, змінені або видалені після першого запиту, не будуть включені у наступні запити з continue. Це іноді називається послідовним знімком і забезпечує клієнту, який використовує limit для отримання менших частин дуже великого результату, можливість побачити всі можливі обʼєкти. Якщо обʼєкти оновлюються під час розбитого на частини списку, повертається версія обʼєкта, яка була на момент розрахунку першого результату списку. |
pretty | string | Якщо 'true', то вихідні дані форматуються у зручному для читання вигляді. Зазвичай 'false', якщо user-agent не вказує оглядач або командний інструмент для роботи з HTTP (curl та wget). |
resourceVersion | string | resourceVersion встановлює обмеження щодо того, з яких версій ресурсу може обслуговуватися запит. Детальніше: https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions. Стандартно — не встановлено |
resourceVersionMatch | string | resourceVersionMatch визначає, як resourceVersion застосовується до викликів списку. Наполегливо рекомендується встановлювати resourceVersionMatch для викликів списку, де встановлено resourceVersion. Детальніше: https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions. Стандартно — не встановлено |
sendInitialEvents | boolean | Параметр sendInitialEvents=true може бути встановлений разом із watch=true. У цьому випадку потік спостереження почнеться із синтетичних подій, щоб відобразити поточний стан обʼєктів у колекції. Після того, як усі такі події буде надіслано, буде надіслано синтетичну подію "Bookmark". Ця подія повідомить ResourceVersion (RV), що відповідає набору обʼєктів, і буде позначена анотацією "k8s.io/initial-events-end": "true". Далі потік спостереження продовжиться як зазвичай, надсилаючи події, що відповідають змінам (після цієї RV) обʼєктів, за якими ведеться спостереження.Коли встановлено параметр sendInitialEvents, ми вимагаємо, щоб також був встановлений параметр resourceVersionMatch. Семантика запиту на спостереження така:- resourceVersionMatch = NotOlderThan інтерпретується як "дані принаймні такі ж нові, як наданий resourceVersion", і подія-bookmark надсилається, коли стан синхронізовано до resourceVersion, принаймні так само свіжого, як наданий у ListOptions. Якщо resourceVersion не встановлено, це інтерпретується як "consistent read", і подія-bookmark надсилається, коли стан синхронізовано принаймні до моменту початку обробки запиту.- resourceVersionMatch, встановлений у будь-яке інше значення або не встановлений, повертає помилку Invalid. Стандартно true, якщо resourceVersion="" або resourceVersion="0" (з міркувань зворотної сумісності), і false в інших випадках. |
shardSelector | string | shardSelector обмежує список повернутих обʼєктів за допомогою виразу селектора шардів на основі CEL. Формат використовує функцію shardRange() у поєднанні з || (логічне АБО) для визначення одного або кількох діапазонів хешів: shardRange(object.metadata.uid, '0x0', '0x8000000000000000') shardRange(object.metadata.uid, '0x0', '0x8000000000000000') || shardRange(object.metadata.uid, '0x8000000000000000', '0x10000000000000000') Шляхи до полів використовують синтаксис CEL з коренем обʼєкта (наприклад, "object.metadata.uid"), а НЕ формат fieldSelector ("metadata.uid"). Наразі підтримуються шляхи: - object.metadata.uid - object.metadata.namespace hexStart та hexEnd — одинарні рядкові літерали CEL з префіксом '0x', що визначають включну нижню та виключну верхню межі простору хешів FNV-1a розміром 64 біти. Повний діапазон — [0x0, 0x10000000000000000), де виключна верхня межа дорівнює 2^64. Приклади: Розщеплення на 2 шарди: шард 0: shardRange(object.metadata.uid, '0x0000000000000000', '0x8000000000000000') шард 1: shardRange(object.metadata.uid, '0x8000000000000000', '0x10000000000000000') Розщеплення на 4 шарди: шард 0: shardRange(object.metadata.uid, '0x0000000000000000', '0x4000000000000000') шард 1: shardRange(object.metadata.uid, '0x4000000000000000', '0x8000000000000000') шард 2: shardRange(object.metadata.uid, '0x8000000000000000', '0xc000000000000000') шард 3: shardRange(object.metadata.uid, '0xc000000000000000', '0x10000000000000000') Це альфа-поле і потребує увімкнення функціональної можливості ShardedListAndWatch. |
timeoutSeconds | integer | Час очікування для виклику списку/спостереження. Це обмежує тривалість виклику, незалежно від активності чи бездіяльності. |
watch | boolean | Спостерігати за змінами описаних ресурсів і повертати їх як потік сповіщень про додавання, оновлення та видалення. Вкажіть resourceVersion. |
Відповідь
| Статус | Опис | Відповідь |
|---|---|---|
| 200 | OK | CompositePodGroupList |
get Watch
HTTP Запит
GET /apis/scheduling.k8s.io/v1alpha3/watch/namespaces/{namespace}/compositepodgroups/{name}
Параметри шляху
| Назва | Тип | Опис |
|---|---|---|
name | string | назва обʼєкта CompositePodGroup |
namespace | string | назва обʼєкта та область автентифікації, наприклад для команд та проєктів |
Параметри запиту
| Назва | Тип | Опис |
|---|---|---|
allowWatchBookmarks | boolean | Дозволяє запити подій спостереження з типом "BOOKMARK". Сервери, які не реалізовують закладки, можуть ігнорувати цей прапорець, а закладки надсилаються на розсуд сервера. Клієнти не повинні припускати, що закладки повертаються через будь-який конкретний інтервал, а також не повинні припускати, що сервер надсилатиме будь-яку подію BOOKMARK під час сеансу. Якщо це не спостереження, це поле ігнорується. |
continue | string | Параметр continue слід встановлювати при отриманні додаткових результатів від сервера. Оскільки це значення визначається сервером, клієнти можуть використовувати значення continue лише з попереднього результату запиту з ідентичними параметрами запиту (крім значення continue), і сервер може відхилити значення continue, яке він не визнає. Якщо вказане значення continue більше не дійсне через термін дії (зазвичай від пʼяти до пʼятнадцяти хвилин) або зміну конфігурації на сервері, сервер поверне помилку 410 ResourceExpired разом з токеном continue. Якщо клієнту потрібен послідовний список, його необхідно перезапустити без поля continue. В іншому випадку клієнт може надіслати інший запит на отримання списку з токеном, отриманим з помилкою 410, і сервер поверне список, починаючи з наступного ключа, але з останнього знімка, що є непослідовним з попередніми результатами списку — обʼєкти, створені, змінені або видалені після першого запиту списку, будуть включені у відповідь, поки їхні ключі знаходяться після "наступного ключа". Це поле не підтримується, коли watch дорівнює true. Клієнти можуть почати спостереження з останнього значення resourceVersion, повернутого сервером, і не пропустити жодних змін. |
fieldSelector | string | Селектор для обмеження списку повернутих обʼєктів за їхніми полями. Стандартно — все. |
labelSelector | string | Селектор для обмеження списку повернутих обʼєктів за їхніми мітками. Стандартно — все. |
limit | integer | limit — це максимальна кількість відповідей для повернення у виклику списку. Якщо існує більше елементів, сервер встановить поле continue у метаданих списку на значення, яке можна використовувати з тим самим початковим запитом для отримання наступного набору результатів. Встановлення ліміту може повернути менше запитаної кількості елементів (до нуля елементів), якщо всі запитані обʼєкти відфільтровані, і клієнти повинні використовувати наявність поля continue для визначення наявності додаткових результатів. Сервери можуть не підтримувати аргумент limit і повертатимуть усі доступні результати. Якщо limit вказано, а поле continue порожнє, клієнти можуть припустити, що додаткові результати відсутні. Це поле не підтримується, якщо watch дорівнює true. Гарантується, що обʼєкти, повернуті при використанні continue, будуть ідентичними одноразовому виклику списку без ліміту — тобто жодні обʼєкти, створені, змінені або видалені після першого запиту, не будуть включені у наступні запити з continue. Це іноді називається послідовним знімком і забезпечує клієнту, який використовує limit для отримання менших частин дуже великого результату, можливість побачити всі можливі обʼєкти. Якщо обʼєкти оновлюються під час розбитого на частини списку, повертається версія обʼєкта, яка була на момент розрахунку першого результату списку. |
pretty | string | Якщо 'true', то вихідні дані форматуються у зручному для читання вигляді. Зазвичай 'false', якщо user-agent не вказує оглядач або командний інструмент для роботи з HTTP (curl та wget). |
resourceVersion | string | resourceVersion встановлює обмеження щодо того, з яких версій ресурсу може обслуговуватися запит. Детальніше: https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions. Стандартно — не встановлено |
resourceVersionMatch | string | resourceVersionMatch визначає, як resourceVersion застосовується до викликів списку. Наполегливо рекомендується встановлювати resourceVersionMatch для викликів списку, де встановлено resourceVersion. Детальніше: https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions. Стандартно — не встановлено |
sendInitialEvents | boolean | Параметр sendInitialEvents=true може бути встановлений разом із watch=true. У цьому випадку потік спостереження почнеться із синтетичних подій, щоб відобразити поточний стан обʼєктів у колекції. Після того, як усі такі події буде надіслано, буде надіслано синтетичну подію "Bookmark". Ця подія повідомить ResourceVersion (RV), що відповідає набору обʼєктів, і буде позначена анотацією "k8s.io/initial-events-end": "true". Далі потік спостереження продовжиться як зазвичай, надсилаючи події, що відповідають змінам (після цієї RV) обʼєктів, за якими ведеться спостереження.Коли встановлено параметр sendInitialEvents, ми вимагаємо, щоб також був встановлений параметр resourceVersionMatch. Семантика запиту на спостереження така:- resourceVersionMatch = NotOlderThan інтерпретується як "дані принаймні такі ж нові, як наданий resourceVersion", і подія-bookmark надсилається, коли стан синхронізовано до resourceVersion, принаймні так само свіжого, як наданий у ListOptions. Якщо resourceVersion не встановлено, це інтерпретується як "consistent read", і подія-bookmark надсилається, коли стан синхронізовано принаймні до моменту початку обробки запиту.- resourceVersionMatch, встановлений у будь-яке інше значення або не встановлений, повертає помилку Invalid. Стандартно true, якщо resourceVersion="" або resourceVersion="0" (з міркувань зворотної сумісності), і false в інших випадках. |
shardSelector | string | shardSelector обмежує список повернутих обʼєктів за допомогою виразу селектора шардів на основі CEL. Формат використовує функцію shardRange() у поєднанні з || (логічне АБО) для визначення одного або кількох діапазонів хешів: shardRange(object.metadata.uid, '0x0', '0x8000000000000000') shardRange(object.metadata.uid, '0x0', '0x8000000000000000') || shardRange(object.metadata.uid, '0x8000000000000000', '0x10000000000000000') Шляхи до полів використовують синтаксис CEL з коренем обʼєкта (наприклад, "object.metadata.uid"), а НЕ формат fieldSelector ("metadata.uid"). Наразі підтримуються шляхи: - object.metadata.uid - object.metadata.namespace hexStart та hexEnd — одинарні рядкові літерали CEL з префіксом '0x', що визначають включну нижню та виключну верхню межі простору хешів FNV-1a розміром 64 біти. Повний діапазон — [0x0, 0x10000000000000000), де виключна верхня межа дорівнює 2^64. Приклади: Розщеплення на 2 шарди: шард 0: shardRange(object.metadata.uid, '0x0000000000000000', '0x8000000000000000') шард 1: shardRange(object.metadata.uid, '0x8000000000000000', '0x10000000000000000') Розщеплення на 4 шарди: шард 0: shardRange(object.metadata.uid, '0x0000000000000000', '0x4000000000000000') шард 1: shardRange(object.metadata.uid, '0x4000000000000000', '0x8000000000000000') шард 2: shardRange(object.metadata.uid, '0x8000000000000000', '0xc000000000000000') шард 3: shardRange(object.metadata.uid, '0xc000000000000000', '0x10000000000000000') Це альфа-поле і потребує увімкнення функціональної можливості ShardedListAndWatch. |
timeoutSeconds | integer | Час очікування для виклику списку/спостереження. Це обмежує тривалість виклику, незалежно від активності чи бездіяльності. |
watch | boolean | Спостерігати за змінами описаних ресурсів і повертати їх як потік сповіщень про додавання, оновлення та видалення. Вкажіть resourceVersion. |
Відповідь
| Статус | Опис | Відповідь |
|---|---|---|
| 200 | OK | WatchEvent |
get Watch List
HTTP Запит
GET /apis/scheduling.k8s.io/v1alpha3/watch/namespaces/{namespace}/compositepodgroups
Параметри шляху
| Назва | Тип | Опис |
|---|---|---|
namespace | string | назва обʼєкта та область автентифікації, наприклад для команд та проєктів |
Параметри запиту
| Назва | Тип | Опис |
|---|---|---|
allowWatchBookmarks | boolean | Дозволяє запити подій спостереження з типом "BOOKMARK". Сервери, які не реалізовують закладки, можуть ігнорувати цей прапорець, а закладки надсилаються на розсуд сервера. Клієнти не повинні припускати, що закладки повертаються через будь-який конкретний інтервал, а також не повинні припускати, що сервер надсилатиме будь-яку подію BOOKMARK під час сеансу. Якщо це не спостереження, це поле ігнорується. |
continue | string | Параметр continue слід встановлювати при отриманні додаткових результатів від сервера. Оскільки це значення визначається сервером, клієнти можуть використовувати значення continue лише з попереднього результату запиту з ідентичними параметрами запиту (крім значення continue), і сервер може відхилити значення continue, яке він не визнає. Якщо вказане значення continue більше не дійсне через термін дії (зазвичай від пʼяти до пʼятнадцяти хвилин) або зміну конфігурації на сервері, сервер поверне помилку 410 ResourceExpired разом з токеном continue. Якщо клієнту потрібен послідовний список, його необхідно перезапустити без поля continue. В іншому випадку клієнт може надіслати інший запит на отримання списку з токеном, отриманим з помилкою 410, і сервер поверне список, починаючи з наступного ключа, але з останнього знімка, що є непослідовним з попередніми результатами списку — обʼєкти, створені, змінені або видалені після першого запиту списку, будуть включені у відповідь, поки їхні ключі знаходяться після "наступного ключа". Це поле не підтримується, коли watch дорівнює true. Клієнти можуть почати спостереження з останнього значення resourceVersion, повернутого сервером, і не пропустити жодних змін. |
fieldSelector | string | Селектор для обмеження списку повернутих обʼєктів за їхніми полями. Стандартно — все. |
labelSelector | string | Селектор для обмеження списку повернутих обʼєктів за їхніми мітками. Стандартно — все. |
limit | integer | limit — це максимальна кількість відповідей для повернення у виклику списку. Якщо існує більше елементів, сервер встановить поле continue у метаданих списку на значення, яке можна використовувати з тим самим початковим запитом для отримання наступного набору результатів. Встановлення ліміту може повернути менше запитаної кількості елементів (до нуля елементів), якщо всі запитані обʼєкти відфільтровані, і клієнти повинні використовувати наявність поля continue для визначення наявності додаткових результатів. Сервери можуть не підтримувати аргумент limit і повертатимуть усі доступні результати. Якщо limit вказано, а поле continue порожнє, клієнти можуть припустити, що додаткові результати відсутні. Це поле не підтримується, якщо watch дорівнює true. Гарантується, що обʼєкти, повернуті при використанні continue, будуть ідентичними одноразовому виклику списку без ліміту — тобто жодні обʼєкти, створені, змінені або видалені після першого запиту, не будуть включені у наступні запити з continue. Це іноді називається послідовним знімком і забезпечує клієнту, який використовує limit для отримання менших частин дуже великого результату, можливість побачити всі можливі обʼєкти. Якщо обʼєкти оновлюються під час розбитого на частини списку, повертається версія обʼєкта, яка була на момент розрахунку першого результату списку. |
pretty | string | Якщо 'true', то вихідні дані форматуються у зручному для читання вигляді. Зазвичай 'false', якщо user-agent не вказує оглядач або командний інструмент для роботи з HTTP (curl та wget). |
resourceVersion | string | resourceVersion встановлює обмеження щодо того, з яких версій ресурсу може обслуговуватися запит. Детальніше: https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions. Стандартно — не встановлено |
resourceVersionMatch | string | resourceVersionMatch визначає, як resourceVersion застосовується до викликів списку. Наполегливо рекомендується встановлювати resourceVersionMatch для викликів списку, де встановлено resourceVersion. Детальніше: https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions. Стандартно — не встановлено |
sendInitialEvents | boolean | Параметр sendInitialEvents=true може бути встановлений разом із watch=true. У цьому випадку потік спостереження почнеться із синтетичних подій, щоб відобразити поточний стан обʼєктів у колекції. Після того, як усі такі події буде надіслано, буде надіслано синтетичну подію "Bookmark". Ця подія повідомить ResourceVersion (RV), що відповідає набору обʼєктів, і буде позначена анотацією "k8s.io/initial-events-end": "true". Далі потік спостереження продовжиться як зазвичай, надсилаючи події, що відповідають змінам (після цієї RV) обʼєктів, за якими ведеться спостереження.Коли встановлено параметр sendInitialEvents, ми вимагаємо, щоб також був встановлений параметр resourceVersionMatch. Семантика запиту на спостереження така:- resourceVersionMatch = NotOlderThan інтерпретується як "дані принаймні такі ж нові, як наданий resourceVersion", і подія-bookmark надсилається, коли стан синхронізовано до resourceVersion, принаймні так само свіжого, як наданий у ListOptions. Якщо resourceVersion не встановлено, це інтерпретується як "consistent read", і подія-bookmark надсилається, коли стан синхронізовано принаймні до моменту початку обробки запиту.- resourceVersionMatch, встановлений у будь-яке інше значення або не встановлений, повертає помилку Invalid. Стандартно true, якщо resourceVersion="" або resourceVersion="0" (з міркувань зворотної сумісності), і false в інших випадках. |
shardSelector | string | shardSelector обмежує список повернутих обʼєктів за допомогою виразу селектора шардів на основі CEL. Формат використовує функцію shardRange() у поєднанні з || (логічне АБО) для визначення одного або кількох діапазонів хешів: shardRange(object.metadata.uid, '0x0', '0x8000000000000000') shardRange(object.metadata.uid, '0x0', '0x8000000000000000') || shardRange(object.metadata.uid, '0x8000000000000000', '0x10000000000000000') Шляхи до полів використовують синтаксис CEL з коренем обʼєкта (наприклад, "object.metadata.uid"), а НЕ формат fieldSelector ("metadata.uid"). Наразі підтримуються шляхи: - object.metadata.uid - object.metadata.namespace hexStart та hexEnd — одинарні рядкові літерали CEL з префіксом '0x', що визначають включну нижню та виключну верхню межі простору хешів FNV-1a розміром 64 біти. Повний діапазон — [0x0, 0x10000000000000000), де виключна верхня межа дорівнює 2^64. Приклади: Розщеплення на 2 шарди: шард 0: shardRange(object.metadata.uid, '0x0000000000000000', '0x8000000000000000') шард 1: shardRange(object.metadata.uid, '0x8000000000000000', '0x10000000000000000') Розщеплення на 4 шарди: шард 0: shardRange(object.metadata.uid, '0x0000000000000000', '0x4000000000000000') шард 1: shardRange(object.metadata.uid, '0x4000000000000000', '0x8000000000000000') шард 2: shardRange(object.metadata.uid, '0x8000000000000000', '0xc000000000000000') шард 3: shardRange(object.metadata.uid, '0xc000000000000000', '0x10000000000000000') Це альфа-поле і потребує увімкнення функціональної можливості ShardedListAndWatch. |
timeoutSeconds | integer | Час очікування для виклику списку/спостереження. Це обмежує тривалість виклику, незалежно від активності чи бездіяльності. |
watch | boolean | Спостерігати за змінами описаних ресурсів і повертати їх як потік сповіщень про додавання, оновлення та видалення. Вкажіть resourceVersion. |
Відповідь
| Статус | Опис | Відповідь |
|---|---|---|
| 200 | OK | WatchEvent |
get Watch List All Namespaces
HTTP Запит
GET /apis/scheduling.k8s.io/v1alpha3/watch/compositepodgroups
Параметри запиту
| Назва | Тип | Опис |
|---|---|---|
allowWatchBookmarks | boolean | Дозволяє запити подій спостереження з типом "BOOKMARK". Сервери, які не реалізовують закладки, можуть ігнорувати цей прапорець, а закладки надсилаються на розсуд сервера. Клієнти не повинні припускати, що закладки повертаються через будь-який конкретний інтервал, а також не повинні припускати, що сервер надсилатиме будь-яку подію BOOKMARK під час сеансу. Якщо це не спостереження, це поле ігнорується. |
continue | string | Параметр continue слід встановлювати при отриманні додаткових результатів від сервера. Оскільки це значення визначається сервером, клієнти можуть використовувати значення continue лише з попереднього результату запиту з ідентичними параметрами запиту (крім значення continue), і сервер може відхилити значення continue, яке він не визнає. Якщо вказане значення continue більше не дійсне через термін дії (зазвичай від пʼяти до пʼятнадцяти хвилин) або зміну конфігурації на сервері, сервер поверне помилку 410 ResourceExpired разом з токеном continue. Якщо клієнту потрібен послідовний список, його необхідно перезапустити без поля continue. В іншому випадку клієнт може надіслати інший запит на отримання списку з токеном, отриманим з помилкою 410, і сервер поверне список, починаючи з наступного ключа, але з останнього знімка, що є непослідовним з попередніми результатами списку — обʼєкти, створені, змінені або видалені після першого запиту списку, будуть включені у відповідь, поки їхні ключі знаходяться після "наступного ключа". Це поле не підтримується, коли watch дорівнює true. Клієнти можуть почати спостереження з останнього значення resourceVersion, повернутого сервером, і не пропустити жодних змін. |
fieldSelector | string | Селектор для обмеження списку повернутих обʼєктів за їхніми полями. Стандартно — все. |
labelSelector | string | Селектор для обмеження списку повернутих обʼєктів за їхніми мітками. Стандартно — все. |
limit | integer | limit — це максимальна кількість відповідей для повернення у виклику списку. Якщо існує більше елементів, сервер встановить поле continue у метаданих списку на значення, яке можна використовувати з тим самим початковим запитом для отримання наступного набору результатів. Встановлення ліміту може повернути менше запитаної кількості елементів (до нуля елементів), якщо всі запитані обʼєкти відфільтровані, і клієнти повинні використовувати наявність поля continue для визначення наявності додаткових результатів. Сервери можуть не підтримувати аргумент limit і повертатимуть усі доступні результати. Якщо limit вказано, а поле continue порожнє, клієнти можуть припустити, що додаткові результати відсутні. Це поле не підтримується, якщо watch дорівнює true. Гарантується, що обʼєкти, повернуті при використанні continue, будуть ідентичними одноразовому виклику списку без ліміту — тобто жодні обʼєкти, створені, змінені або видалені після першого запиту, не будуть включені у наступні запити з continue. Це іноді називається послідовним знімком і забезпечує клієнту, який використовує limit для отримання менших частин дуже великого результату, можливість побачити всі можливі обʼєкти. Якщо обʼєкти оновлюються під час розбитого на частини списку, повертається версія обʼєкта, яка була на момент розрахунку першого результату списку. |
pretty | string | Якщо 'true', то вихідні дані форматуються у зручному для читання вигляді. Зазвичай 'false', якщо user-agent не вказує оглядач або командний інструмент для роботи з HTTP (curl та wget). |
resourceVersion | string | resourceVersion встановлює обмеження щодо того, з яких версій ресурсу може обслуговуватися запит. Детальніше: https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions. Стандартно — не встановлено |
resourceVersionMatch | string | resourceVersionMatch визначає, як resourceVersion застосовується до викликів списку. Наполегливо рекомендується встановлювати resourceVersionMatch для викликів списку, де встановлено resourceVersion. Детальніше: https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions. Стандартно — не встановлено |
sendInitialEvents | boolean | Параметр sendInitialEvents=true може бути встановлений разом із watch=true. У цьому випадку потік спостереження почнеться із синтетичних подій, щоб відобразити поточний стан обʼєктів у колекції. Після того, як усі такі події буде надіслано, буде надіслано синтетичну подію "Bookmark". Ця подія повідомить ResourceVersion (RV), що відповідає набору обʼєктів, і буде позначена анотацією "k8s.io/initial-events-end": "true". Далі потік спостереження продовжиться як зазвичай, надсилаючи події, що відповідають змінам (після цієї RV) обʼєктів, за якими ведеться спостереження.Коли встановлено параметр sendInitialEvents, ми вимагаємо, щоб також був встановлений параметр resourceVersionMatch. Семантика запиту на спостереження така:- resourceVersionMatch = NotOlderThan інтерпретується як "дані принаймні такі ж нові, як наданий resourceVersion", і подія-bookmark надсилається, коли стан синхронізовано до resourceVersion, принаймні так само свіжого, як наданий у ListOptions. Якщо resourceVersion не встановлено, це інтерпретується як "consistent read", і подія-bookmark надсилається, коли стан синхронізовано принаймні до моменту початку обробки запиту.- resourceVersionMatch, встановлений у будь-яке інше значення або не встановлений, повертає помилку Invalid. Стандартно true, якщо resourceVersion="" або resourceVersion="0" (з міркувань зворотної сумісності), і false в інших випадках. |
shardSelector | string | shardSelector обмежує список повернутих обʼєктів за допомогою виразу селектора шардів на основі CEL. Формат використовує функцію shardRange() у поєднанні з || (логічне АБО) для визначення одного або кількох діапазонів хешів: shardRange(object.metadata.uid, '0x0', '0x8000000000000000') shardRange(object.metadata.uid, '0x0', '0x8000000000000000') || shardRange(object.metadata.uid, '0x8000000000000000', '0x10000000000000000') Шляхи до полів використовують синтаксис CEL з коренем обʼєкта (наприклад, "object.metadata.uid"), а НЕ формат fieldSelector ("metadata.uid"). Наразі підтримуються шляхи: - object.metadata.uid - object.metadata.namespace hexStart та hexEnd — одинарні рядкові літерали CEL з префіксом '0x', що визначають включну нижню та виключну верхню межі простору хешів FNV-1a розміром 64 біти. Повний діапазон — [0x0, 0x10000000000000000), де виключна верхня межа дорівнює 2^64. Приклади: Розщеплення на 2 шарди: шард 0: shardRange(object.metadata.uid, '0x0000000000000000', '0x8000000000000000') шард 1: shardRange(object.metadata.uid, '0x8000000000000000', '0x10000000000000000') Розщеплення на 4 шарди: шард 0: shardRange(object.metadata.uid, '0x0000000000000000', '0x4000000000000000') шард 1: shardRange(object.metadata.uid, '0x4000000000000000', '0x8000000000000000') шард 2: shardRange(object.metadata.uid, '0x8000000000000000', '0xc000000000000000') шард 3: shardRange(object.metadata.uid, '0xc000000000000000', '0x10000000000000000') Це альфа-поле і потребує увімкнення функціональної можливості ShardedListAndWatch. |
timeoutSeconds | integer | Час очікування для виклику списку/спостереження. Це обмежує тривалість виклику, незалежно від активності чи бездіяльності. |
watch | boolean | Спостерігати за змінами описаних ресурсів і повертати їх як потік сповіщень про додавання, оновлення та видалення. Вкажіть resourceVersion. |
Відповідь
| Статус | Опис | Відповідь |
|---|---|---|
| 200 | OK | WatchEvent |
patch Patch Status
HTTP Запит
PATCH /apis/scheduling.k8s.io/v1alpha3/namespaces/{namespace}/compositepodgroups/{name}/status
Параметри шляху
| Назва | Тип | Опис |
|---|---|---|
name | string | назва обʼєкта CompositePodGroup |
namespace | string | назва обʼєкта та область автентифікації, наприклад для команд та проєктів |
Параметри запиту
| Назва | Тип | Опис |
|---|---|---|
pretty | string | Якщо 'true', то вихідні дані форматуються у зручному для читання вигляді. Зазвичай 'false', якщо user-agent не вказує оглядач або командний інструмент для роботи з HTTP (curl та wget). |
dryRun | string | Коли параметр присутній, це вказує, що зміни не повинні зберігатися. Неправильна або нерозпізнана директива dryRun призведе до помилки та припинення обробки запиту. Дійсні значення:
|
fieldManager | string | fieldManager є імʼям, повʼязаним з а́ктором або сутністю, яка вносить ці зміни. Значення повинно бути менше або дорівнювати 128 символам і містити лише друковані символи, як визначено в https://golang.org/pkg/unicode/#IsPrint. Це поле є обовʼязковим для запитів apply (application/apply-patch), але необовʼязковим для типів patch, що не є apply (JsonPatch, MergePatch, StrategicMergePatch). |
fieldValidation | string | fieldValidation інструктує сервер, як обробляти обʼєкти в запиті (POST/PUT/PATCH), що містять невідомі або дубльовані поля. Дійсні значення:
|
force | boolean | Force здійснює "примусове" виконання запитів Apply. Це означає, що користувач повторно отримає конфліктні поля, що належать іншим людям. Прапорець Force повинен бути не встановлений для запитів patch, що не є apply. |
Параметри тіла запиту
| Назва | Тип | Опис |
|---|---|---|
body | Patch |
Відповідь
| Статус | Опис | Відповідь |
|---|---|---|
| 200 | OK | CompositePodGroup |
| 201 | Created | CompositePodGroup |
get Read Status
HTTP Запит
GET /apis/scheduling.k8s.io/v1alpha3/namespaces/{namespace}/compositepodgroups/{name}/status
Параметри шляху
| Назва | Тип | Опис |
|---|---|---|
name | string | назва обʼєкта CompositePodGroup |
namespace | string | назва обʼєкта та область автентифікації, наприклад для команд та проєктів |
Параметри запиту
| Назва | Тип | Опис |
|---|---|---|
pretty | string | Якщо 'true', то вихідні дані форматуються у зручному для читання вигляді. Зазвичай 'false', якщо user-agent не вказує оглядач або командний інструмент для роботи з HTTP (curl та wget). |
Відповідь
| Статус | Опис | Відповідь |
|---|---|---|
| 200 | OK | CompositePodGroup |
put Replace Status
HTTP Запит
PUT /apis/scheduling.k8s.io/v1alpha3/namespaces/{namespace}/compositepodgroups/{name}/status
Параметри шляху
| Назва | Тип | Опис |
|---|---|---|
name | string | назва обʼєкта CompositePodGroup |
namespace | string | назва обʼєкта та область автентифікації, наприклад для команд та проєктів |
Параметри запиту
| Назва | Тип | Опис |
|---|---|---|
pretty | string | Якщо 'true', то вихідні дані форматуються у зручному для читання вигляді. Зазвичай 'false', якщо user-agent не вказує оглядач або командний інструмент для роботи з HTTP (curl та wget). |
dryRun | string | Коли параметр присутній, це вказує, що зміни не повинні зберігатися. Неправильна або нерозпізнана директива dryRun призведе до помилки та припинення обробки запиту. Дійсні значення:
|
fieldManager | string | fieldManager є імʼям, повʼязаним з а́ктором або сутністю, яка вносить ці зміни. Значення повинно бути менше або дорівнювати 128 символам і містити лише друковані символи, як визначено в https://golang.org/pkg/unicode/#IsPrint. |
fieldValidation | string | fieldValidation інструктує сервер, як обробляти обʼєкти в запиті (POST/PUT/PATCH), що містять невідомі або дубльовані поля. Дійсні значення:
|
Параметри тіла запиту
| Назва | Тип | Опис |
|---|---|---|
body | CompositePodGroup |
Відповідь
| Статус | Опис | Відповідь |
|---|---|---|
| 200 | OK | CompositePodGroup |
| 201 | Created | CompositePodGroup |
2 - PodGroup
PodGroup представляє екземпляр виконання подів, згрупованих разом. PodGroups створюються контролерами робочих навантажень (Job, LWS, JobSet тощо) з Workload.podGroupTemplates. Увімкнення API PodGroup керується прапорцем функції GenericWorkload.
apiVersion: scheduling.k8s.io/v1beta1
import "k8s.io/api/scheduling/v1beta1"
PodGroup
PodGroup представляє екземпляр подів у процесі виконання, згрупованих разом. PodGroup створюються контролерами робочих навантажень (Job, LWS, JobSet тощо) з Workload.podGroupTemplates. Увімкнення API PodGroup керується функціональною можливістю GenericWorkload.
| Поле | Опис |
|---|---|
apiVersionstring | APIVersion визначає версію схеми цього представлення обʼєкта. Сервери повинні конвертувати розпізнані схеми до останнього внутрішнього значення і можуть відхиляти нерозпізнані значення. Детальніше: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources |
kindstring | Kind визначає тип REST-ресурсу, який представляє цей обʼєкт. Сервери можуть визначати це з точки доступу, до якої клієнт надсилає запити. Не може бути оновлено. У CamelCase. Детальніше: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
metadataObjectMeta | Стандартні метадані обʼєкта. Детальніше: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata |
spec *PodGroupSpec | spec визначає бажаний стан PodGroup. |
statusPodGroupStatus | status представляє поточний спостережуваний стан PodGroup. |
PodGroupSpec
PodGroupSpec визначає бажаний стан PodGroup.
| Поле | Опис |
|---|---|
disruptionModeDisruptionMode | disruptionMode визначає режим, у якому дану PodGroup можна порушити. Контролери очікують, що це поле буде заповнене шляхом копіювання його з PodGroupTemplate. Одне з Single, All. Стандартно — Single, якщо не встановлено. Це поле є незмінним. |
parentCompositePodGroupNamestring | parentCompositePodGroupName містить назву батьківської складеної групи подів у тому ж просторі імен, що й ця група подів. Якщо воно має значення nil, то ця група подів є коренем ієрархії робочого навантаження. Це поле використовується лише тоді, коли увімкнено функціональну можливість CompositePodGroup. Це поле є незмінним. |
preemptionPolicystring | preemptionPolicy — це політика витіснення подів/груп подів з нижчим пріоритетом. Одне з Never, PreemptLowerPriority. Стандартно — PreemptLowerPriority, якщо не встановлено. Коли ввімкнено контролер допуску пріоритету, він заповнює це поле з PriorityClassName та зазвичай встановлює PreemptLowerPriority, якщо значення не встановлено у PriorityClass. Це поле є незмінним. Це поле доступне лише тоді, коли увімкнено функціональну можливість PodGroupPreemptionPolicy. Можливі значення enum: - "Never" означає, що под ніколи не випереджає інші поди з нижчим пріоритетом.- "PreemptLowerPriority" означає, що под може випереджати інші поди з нижчим пріоритетом. |
priorityinteger | priority — це значення пріоритету цієї групи подів. Різні компоненти системи використовують це поле для визначення пріоритету групи подів. Коли ввімкнено контролер допуску пріоритету, він запобігає встановленню цього поля користувачами. Контролер допуску заповнює це поле з PriorityClassName. Чим вище значення, тим вищий пріоритет. Це поле є незмінним. |
priorityClassNamestring | priorityClassName визначає пріоритет, який слід враховувати під час планування цієї групи подів. Контролери очікують, що це поле буде заповнене шляхом копіювання його з PodGroupTemplate. В іншому разі воно перевіряється та вирішується аналогічно до PriorityClassName на PodGroupTemplate (тобто якщо клас пріоритету не вказано, контроль доступу може встановити глобальний стандартний клас пріоритету, якщо він існує. В іншому випадку пріоритет групи подів буде нульовим). Це поле є незмінним. |
resourceClaimsPodGroupResourceClaim array patch strategy: merge,retainKeys on key name | resourceClaims визначає, які ResourceClaims можуть бути спільно використані серед подів у групі. Поди споживають пристрої, виділені для заявки PodGroup, визначаючи заявку у власному Spec.ResourceClaims, яка точно відповідає заявці PodGroup. Заявка повинна мати однакове імʼя та посилатися на той самий ResourceClaim або ResourceClaimTemplate. Це поле є бета-рівнем і вимагає, щоб функціональна можливість DRAWorkloadResourceClaims була увімкнена. Це поле є незмінним. |
schedulingConstraintsPodGroupSchedulingConstraints | schedulingConstraints визначає опціональні обмеження планування (наприклад, топологію) для цієї PodGroup. Контролери очікують, що це поле буде заповнене шляхом копіювання його з PodGroupTemplate. Це поле є незмінним. Це поле доступне лише тоді, коли увімкнено функціональну можливість TopologyAwareWorkloadScheduling. |
schedulingPolicy *PodGroupSchedulingPolicy | schedulingPolicy визначає політику планування для цього екземпляра PodGroup. Контролери очікують, що це поле буде заповнене шляхом копіювання його з PodGroupTemplate. |
workloadRefWorkloadReference | workloadRef посилається на опціональний шаблон PodGroup у межах обʼєкта Workload, який був використаний для створення PodGroup. Це поле є незмінним. |
PodGroupStatus
PodGroupStatus представляє інформацію про стан групи подів.
| Поле | Опис |
|---|---|
conditionsCondition array patch strategy: злиття за ключем type | conditions представляють останні спостереження за станом PodGroup. Відомі типи станів:
Відомі причини стану PodGroupInitiallyScheduled:
Відомі причини стану DisruptionTarget:
|
resourceClaimStatusesPodGroupResourceClaimStatus array patch strategy: merge,retainKeys on key name | resourceClaimStatuses — це статус заявок на ресурси. |
PodGroupList
PodGroupList містить список ресурсів PodGroup.
| Поле | Опис |
|---|---|
apiVersionstring | APIVersion визначає версію схеми цього представлення обʼєкта. Сервери повинні конвертувати розпізнані схеми до останнього внутрішнього значення і можуть відхиляти нерозпізнані значення. Детальніше: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources |
items *PodGroup array | items містить список PodGroup. |
kindstring | Kind визначає тип REST-ресурсу, який представляє цей обʼєкт. Сервери можуть визначати це з точки доступу, до якої клієнт надсилає запити. Не може бути оновлено. У CamelCase. Детальніше: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
metadataListMeta | Стандартні метадані списку. |
AllDisruptionMode
AllDisruptionMode визначає, що дочірні елементи можуть бути порушені лише разом.
BasicSchedulingPolicy
BasicSchedulingPolicy вказує, що слід використовувати стандартну поведінку планування Kubernetes.
DisruptionMode
DisruptionMode визначає, як окремі сутності в межах групи можуть бути порушені. Можна встановити рівно один режим.
| Поле | Опис |
|---|---|
allAllDisruptionMode | all визначає, що всі дочірні елементи можуть бути порушені лише разом. |
singleSingleDisruptionMode | single визначає, що дочірні елементи можуть бути порушені незалежно один від одного. |
GangSchedulingPolicy
GangSchedulingPolicy визначає параметри для групового планування.
| Поле | Опис |
|---|---|
minCount *integer | minCount — це мінімальна кількість подів, які повинні бути доступними для планування або запланованими одночасно, щоб планувальник дозволив усю групу. Це має бути додатне ціле число. Це поле є змінним для підтримки масштабування робочого навантаження. Зверніть увагу, що планувальник працює за зразком зрештою узгодженої моделі. Оновлення minCount можуть не одразу відображатися у рішеннях планування через затримки поширення. Якщо minCount оновлюється під час циклу планування для цієї групи, нове значення може не набути чинності до наступного циклу. Більш того, minCount застосовується лише під час планування, тобто зміни цього поля не впливають на вже заплановані поди, застосовуючись лише до тих, що оцінюються у майбутніх циклах. |
PodGroupResourceClaim
PodGroupResourceClaim посилається точно на один ResourceClaim, або безпосередньо, або шляхом вказівки ResourceClaimTemplate, який потім перетворюється на ResourceClaim для PodGroup.
Вона додає імʼя, яке унікально ідентифікує ResourceClaim всередині PodGroup. Поди, які потребують доступу до ResourceClaim, визначають відповідне посилання у власному Spec.ResourceClaims. Заявка поду повинна точно відповідати всім полям заявки PodGroup.
| Поле | Опис |
|---|---|
name *string | name унікально ідентифікує цю заявку на ресурс усередині PodGroup. Це має бути DNS_LABEL. |
resourceClaimNamestring | resourceClaimName — це імʼя обʼєкта ResourceClaim у тому самому просторі імен, що й ця PodGroup. ResourceClaim буде зарезервовано для PodGroup замість її окремих подів. Повинен бути встановлений рівно один з полів ResourceClaimName та ResourceClaimTemplateName. |
resourceClaimTemplateNamestring | resourceClaimTemplateName — це імʼя обʼєкта ResourceClaimTemplate у тому самому просторі імен, що й ця PodGroup. Шаблон буде використано для створення нового ResourceClaim, який буде привʼязаний до цієї PodGroup. Коли цю PodGroup буде видалено, ResourceClaim також буде видалено. Імʼя PodGroup та імʼя ресурсу, разом із згенерованим компонентом, будуть використані для формування унікального імені для ResourceClaim, яке буде записано у podgroup.status.resourceClaimStatuses. Це поле є незмінним, і після створення ResourceClaim панель управління не вноситиме жодних змін до відповідного ResourceClaim. Повинно бути встановлено рівно одне з полів ResourceClaimName та ResourceClaimTemplateName. |
PodGroupSchedulingConstraints
PodGroupSchedulingConstraints визначає обмеження планування (наприклад, топологію) для PodGroup.
| Поле | Опис |
|---|---|
topologyTopologyConstraint array | topology визначає обмеження топології для групи подів. Наразі можна вказати лише одне обмеження топології. Це може змінитися в майбутньому. |
PodGroupSchedulingPolicy
PodGroupSchedulingPolicy визначає конфігурацію планування для PodGroup. Повинна бути встановлена рівно одна політика. Політика обирається під час створення шляхом встановлення поля Basic або Gang. PodGroup не може змінити політику після створення. Поля в межах обраної політики можуть оновлюватися після створення, якщо це дозволяють їхні окремі поля.
| Поле | Опис |
|---|---|
basicBasicSchedulingPolicy | basic визначає, що поди в цій групі повинні плануватися з використанням стандартної поведінки планування Kubernetes. Встановлення цього поля під час створення групи обирає для цієї групи базове планування; це поле не можна змінити згодом. |
gangGangSchedulingPolicy | gang визначає, що поди в цій групі повинні плануватися з використанням семантики "все або нічого". Встановлення цього поля під час створення групи обирає для цієї групи групове планування; це поле не можна встановити або скинути згодом. Поле minCount у межах політики групового планування залишається змінним після створення групи. |
SingleDisruptionMode
SingleDisruptionMode визначає, що дочірні елементи можуть бути порушені незалежно.
TopologyConstraint
TopologyConstraint визначає обмеження топології для PodGroup.
| Поле | Опис |
|---|---|
key *string | key визначає ключ мітки вузла, що представляє топологічну доменну область. Усі поди в межах PodGroup повинні бути розташовані в одному екземплярі доменної області. Різні PodGroup можуть розташовуватися в різних екземплярах доменної області, навіть якщо вони походять з одного PodGroupTemplate. Приклади: "topology.kubernetes.io/rack" |
WorkloadReference
WorkloadReference посилається на обʼєкт Workload разом із шаблоном, який був використаний для створення певної PodGroup.
| Поле | Опис |
|---|---|
templateName *string | templateName — це назва шаблону в межах обʼєкта Workload, який був використаний для створення групи подів. Це має бути мітка DNS. Це поле є обовʼязковим. |
workloadName *string | workloadName — це назва обʼєкта Workload, який містить шаблон, що використовувався під час створення групи подів. Це має бути імʼя DNS. Це поле є обовʼязковим. |
Операції
post Create
HTTP Запит
POST /apis/scheduling.k8s.io/v1beta1/namespaces/{namespace}/podgroups
Параметри шляху
| Назва | Тип | Опис |
|---|---|---|
namespace | string | Назва обʼєкта та область авторизації, наприклад для команд і проєктів |
Параметри запиту
| Назва | Тип | Опис |
|---|---|---|
pretty | string | Якщо 'true', то вихідні дані форматуються у зручному для читання вигляді. Зазвичай 'false', якщо user-agent не вказує оглядач або командний інструмент для роботи з HTTP (curl та wget). |
dryRun | string | Коли параметр присутній, це вказує, що зміни не повинні зберігатися. Неправильна або нерозпізнана директива dryRun призведе до помилки та припинення обробки запиту. Дійсні значення:
|
fieldManager | string | fieldManager є імʼям, повʼязаним з а́ктором або сутністю, яка вносить ці зміни. Значення повинно бути менше або дорівнювати 128 символам і містити лише друковані символи, як визначено в https://golang.org/pkg/unicode/#IsPrint. |
fieldValidation | string | fieldValidation інструктує сервер, як обробляти обʼєкти в запиті (POST/PUT/PATCH), що містять невідомі або дубльовані поля. Дійсні значення:
|
Параметри тіла запиту
| Назва | Тип | Опис |
|---|---|---|
body | PodGroup |
Відповідь
| Статус | Опис | Відповідь |
|---|---|---|
| 200 | OK | PodGroup |
| 201 | Created | PodGroup |
| 202 | Accepted | PodGroup |
patch Patch
HTTP Запит
PATCH /apis/scheduling.k8s.io/v1beta1/namespaces/{namespace}/podgroups/{name}
Параметри шляху
| Назва | Тип | Опис |
|---|---|---|
name | string | Назва PodGroup |
namespace | string | Назва обʼєкта та область авторизації, наприклад для команд і проєктів |
Параметри запиту
| Назва | Тип | Опис |
|---|---|---|
pretty | string | Якщо 'true', то вихідні дані форматуються у зручному для читання вигляді. Зазвичай 'false', якщо user-agent не вказує оглядач або командний інструмент для роботи з HTTP (curl та wget). |
dryRun | string | Коли параметр присутній, це вказує, що зміни не повинні зберігатися. Неправильна або нерозпізнана директива dryRun призведе до помилки та припинення обробки запиту. Дійсні значення:
|
fieldManager | string | fieldManager є імʼям, повʼязаним з а́ктором або сутністю, яка вносить ці зміни. Значення повинно бути менше або дорівнювати 128 символам і містити лише друковані символи, як визначено в https://golang.org/pkg/unicode/#IsPrint. Це поле обовʼязкове для запитів apply (application/apply-patch), але необовʼязкове для типів патчів, що не застосовуються (JsonPatch, MergePatch, StrategicMergePatch). |
fieldValidation | string | fieldValidation інструктує сервер, як обробляти обʼєкти в запиті (POST/PUT/PATCH), що містять невідомі або дубльовані поля. Дійсні значення:
|
force | boolean | Force має на меті "примусово" застосовувати запити Apply. Це означає, що користувач повторно отримає конфліктні поля, що належать іншим користувачам. Прапорець Force повинен бути скасований для запитів, що не є патчами apply. |
Параметри тіла запиту
| Назва | Тип | Опис |
|---|---|---|
body | Patch |
Відповідь
| Статус | Опис | Відповідь |
|---|---|---|
| 200 | OK | PodGroup |
| 201 | Created | PodGroup |
put Replace
HTTP Запит
PUT /apis/scheduling.k8s.io/v1beta1/namespaces/{namespace}/podgroups/{name}
Параметри шляху
| Назва | Тип | Опис |
|---|---|---|
name | string | Назва PodGroup |
namespace | string | Назва обʼєкта та область авторизації, наприклад для команд і проєктів |
Параметри запиту
| Назва | Тип | Опис |
|---|---|---|
pretty | string | Якщо 'true', то вихідні дані форматуються у зручному для читання вигляді. Зазвичай 'false', якщо user-agent не вказує оглядач або командний інструмент для роботи з HTTP (curl та wget). |
dryRun | string | Коли параметр присутній, це вказує, що зміни не повинні зберігатися. Неправильна або нерозпізнана директива dryRun призведе до помилки та припинення обробки запиту. Дійсні значення:
|
fieldManager | string | fieldManager є імʼям, повʼязаним з а́ктором або сутністю, яка вносить ці зміни. Значення повинно бути менше або дорівнювати 128 символам і містити лише друковані символи, як визначено в https://golang.org/pkg/unicode/#IsPrint. |
fieldValidation | string | fieldValidation інструктує сервер, як обробляти обʼєкти в запиті (POST/PUT/PATCH), що містять невідомі або дубльовані поля. Дійсні значення:
|
Параметри тіла запиту
| Назва | Тип | Опис |
|---|---|---|
body | PodGroup |
Відповідь
| Статус | Опис | Відповідь |
|---|---|---|
| 200 | OK | PodGroup |
| 201 | Created | PodGroup |
delete Delete
HTTP Запит
DELETE /apis/scheduling.k8s.io/v1beta1/namespaces/{namespace}/podgroups/{name}
Параметри шляху
| Назва | Тип | Опис |
|---|---|---|
name | string | Назва PodGroup |
namespace | string | Назва обʼєкта та область авторизації, наприклад для команд і проєктів |
Параметри запиту
| Назва | Тип | Опис |
|---|---|---|
pretty | string | Якщо 'true', то вихідні дані форматуються у зручному для читання вигляді. Зазвичай 'false', якщо user-agent не вказує оглядач або командний інструмент для роботи з HTTP (curl та wget). |
dryRun | string | Коли параметр присутній, це вказує, що зміни не повинні зберігатися. Неправильна або нерозпізнана директива dryRun призведе до помилки та припинення обробки запиту. Дійсні значення:
|
gracePeriodSeconds | integer | Час у секундах перед видаленням обʼєкта. Значення повинно бути невідʼємним цілим числом. Значення нуль вказує на негайне видалення. Якщо це значення відсутнє, буде використано стандартний період очікування для зазначеного типу. Зазвичай використовується значення для конкретного обʼєкта, якщо не вказано. Нуль означає негайне видалення. |
ignoreStoreReadErrorWithClusterBreakingPotential | boolean | Якщо встановлено в true, це призведе до небезпечного видалення ресурсу у випадку, якщо нормальний процес видалення не вдасться через помилку пошкодженого обʼєкта. Ресурс вважається пошкодженим, якщо його не можна успішно отримати з відповідного сховища томущо: a) його дані не можна трансформувати, наприклад, помилка дешифрування, або b) не вдається декодувати в обʼєкт. ПРИМІТКА: небезпечне видалення ігнорує обмеження завершувача, пропускає перевірки передумов і видаляє обʼєкт зі сховища. ПОПЕРЕДЖЕННЯ: це може потенційно порушити роботу кластера, якщо робоче навантаження, повʼязане з ресурсом, що видаляється небезпечно, покладається на нормальний процес видалення. Використовуйте лише якщо ви ДІЙСНО знаєте, що робите. Стандартне значення — false, і користувач повинен явно погодитися на його використання. |
orphanDependents | boolean | Застаріло: будь ласка, використовуйте PropagationPolicy, це поле буде застарілим у версії 1.7. Чи повинні залежні обʼєкти залишатися покинутими. Якщо true/false, завершувач "orphan" буде доданий до/видалений з списку завершувачів обʼєкта. Можна встановити або це поле, або PropagationPolicy, але не обидва. |
propagationPolicy | string | Чи і як буде виконано збір сміття. Можна встановити або це поле, або OrphanDependents, але не обидва. Стандартна політика визначається наявним завершувачем у metadata.finalizers та стандартною політикою для конкретного ресурсу. Допустимі значення: 'Orphan' — залишити залежні обʼєкти покинутими; 'Background' — дозволити збирачу сміття видаляти залежні обʼєкти у фоновому режимі; 'Foreground' — каскадна політика, яка видаляє всі залежні обʼєкти з показом всіх дій. |
Параметри тіла запиту
| Назва | Тип | Опис |
|---|---|---|
body | DeleteOptions |
Відповідь
| Статус | Опис | Відповідь |
|---|---|---|
| 200 | OK | Status |
| 202 | Accepted | Status |
delete Delete Collection
HTTP Запит
DELETE /apis/scheduling.k8s.io/v1beta1/namespaces/{namespace}/podgroups
Параметри шляху
| Назва | Тип | Опис |
|---|---|---|
namespace | string | Назва обʼєкта та область авторизації, наприклад для команд і проєктів |
Параметри запиту
| Назва | Тип | Опис |
|---|---|---|
pretty | string | Якщо 'true', то вихідні дані форматуються у зручному для читання вигляді. Зазвичай 'false', якщо user-agent не вказує оглядач або командний інструмент для роботи з HTTP (curl та wget). |
continue | string | Опція continue повинна бути встановлена при отриманні додаткових результатів від сервера. Оскільки це значення визначається сервером, клієнти можуть використовувати значення continue лише з попереднього результату запиту з ідентичними параметрами запиту (крім значення continue), і сервер може відхилити значення continue, яке він не розпізнає. Якщо вказане значення continue більше не дійсне через закінчення терміну дії (зазвичай пʼять-пʼятнадцять хвилин) або зміну конфігурації на сервері, сервер відповість помилкою 410 ResourceExpired разом з токеном continue. Якщо клієнту потрібен послідовний список, він повинен перезапустити свій список без поля continue. В іншому випадку клієнт може надіслати ще один запит списку з токеном, отриманим з помилкою 410, сервер відповість списком, починаючи з наступного ключа, але з останнього знімка, що не відповідає попереднім результатам списку — обʼєкти, які були створені, змінені або видалені після першого запиту списку, будуть включені у відповідь, якщо їх ключі йдуть після "наступного ключа". Це поле не підтримується, коли watch встановлено в true. Клієнти можуть почати спостереження з останнього значення resourceVersion, повернутого сервером, і не пропустити жодних змін. |
dryRun | string | Коли параметр присутній, це вказує, що зміни не повинні зберігатися. Неправильна або нерозпізнана директива dryRun призведе до помилки та припинення обробки запиту. Дійсні значення:
|
fieldSelector | string | Селектор для обмеження списку обʼєктів, що повертаються, за їхніми полями. Зазвичай повертаються всі обʼєкти. |
gracePeriodSeconds | integer | Час у секундах перед видаленням обʼєкта. Значення повинно бути невідʼємним цілим числом. Значення нуль вказує на негайне видалення. Якщо це значення відсутнє, буде використано стандартний період очікування для зазначеного типу. Зазвичай використовується значення для конкретного обʼєкта, якщо не вказано. Нуль означає негайне видалення. |
ignoreStoreReadErrorWithClusterBreakingPotential | boolean | Якщо встановлено в true, це призведе до небезпечного видалення ресурсу у випадку, якщо нормальний процес видалення не вдасться через помилку пошкодженого обʼєкта. Ресурс вважається пошкодженим, якщо його не можна успішно отримати з відповідного сховища томущо: a) його дані не можна трансформувати, наприклад, помилка дешифрування, або b) не вдається декодувати в обʼєкт. ПРИМІТКА: небезпечне видалення ігнорує обмеження завершувача, пропускає перевірки передумов і видаляє обʼєкт зі сховища. ПОПЕРЕДЖЕННЯ: це може потенційно порушити роботу кластера, якщо робоче навантаження, повʼязане з ресурсом, що видаляється небезпечно, покладається на нормальний процес видалення. Використовуйте лише якщо ви ДІЙСНО знаєте, що робите. Стандартне значення — false, і користувач повинен явно погодитися на його використання. |
labelSelector | string | Селектор для обмеження списку обʼєктів, що повертаються, за їхніми мітками. Зазвичай повертаються всі обʼєкти. |
limit | integer | limit є максимальним числом відповідей, які потрібно повернути для виклику списку. Якщо існує більше елементів, сервер встановить поле continue у метаданих списку на значення, яке можна використовувати з тим самим початковим запитом для отримання наступного набору результатів. Встановлення обмеження може повернути менше, ніж запитана кількість елементів (до нуля елементів) у випадку, якщо всі запитані обʼєкти відфільтровані, і клієнти повинні використовувати лише наявність поля continue, щоб визначити, чи доступні додаткові результати. Сервери можуть вирішити не підтримувати аргумент limit і повернуть усі доступні результати. Якщо limit вказано, а поле continue порожнє, клієнти можуть припустити, що результатів більше немає. Це поле не підтримується, якщо watch дорівнює true. Сервер гарантує, що обʼєкти, повернені при використанні continue, будуть ідентичні до виконання одного виклику списку без обмеження — тобто жодні обʼєкти, створені, змінені або видалені після першого запиту, не будуть включені в будь-які наступні продовжені запити. Це іноді називають послідовним знімком, і забезпечує, що клієнт, який використовує limit для отримання менших частин дуже великого результату, може бути впевнений, що він бачить усі можливі обʼєкти. Якщо обʼєкти оновлюються під час отримання часткового списку, повертається версія обʼєкта, яка була присутня на момент обчислення першого результату списку. |
orphanDependents | boolean | Застаріло: будь ласка, використовуйте PropagationPolicy, це поле буде застарілим у версії 1.7. Чи повинні залежні обʼєкти залишатися покинутими. Якщо true/false, завершувач "orphan" буде доданий до/видалений з списку завершувачів обʼєкта. Можна встановити або це поле, або PropagationPolicy, але не обидва. |
propagationPolicy | string | Чи і як буде виконано збір сміття. Можна встановити або це поле, або OrphanDependents, але не обидва. Стандартна політика визначається наявним завершувачем у metadata.finalizers та стандартною політикою для конкретного ресурсу. Допустимі значення: 'Orphan' — залишити залежні обʼєкти покинутими; 'Background' — дозволити збирачу сміття видаляти залежні обʼєкти у фоновому режимі; 'Foreground' — каскадна політика, яка видаляє всі залежні обʼєкти з показом всіх дій. |
resourceVersion | string | resourceVersion встановлює обмеження на те, з яких версій ресурсів може обслуговуватися запит. Див. https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions для деталей. Стандартне значення не встановлено |
resourceVersionMatch | string | resourceVersionMatch визначає, як resourceVersion застосовується до викликів списку. Рекомендується встановлювати resourceVersionMatch для викликів списку, де встановлено resourceVersion. Див. https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions для деталей. Стандартне значення не встановлено |
sendInitialEvents | boolean | sendInitialEvents=true може бути встановлено разом з watch=true. У цьому випадку потік спостереження почнеться з синтетичних подій для відтворення поточного стану обʼєктів у колекції. Після надсилання всіх таких подій буде надіслано синтетичну подію "Bookmark". Закладка повідомить ResourceVersion (RV), що відповідає набору обʼєктів, і буде позначена анотацією "k8s.io/initial-events-end": "true". Після цього потік спостереження продовжиться як зазвичай, надсилаючи події спостереження, що відповідають змінам (після RV) для спостережуваних обʼєктів. Коли встановлено опцію sendInitialEvents, ми вимагаємо також встановлення опції resourceVersionMatch. Семантика запиту спостереження наступна:
|
shardSelector | string | shardSelector обмежує список обʼєктів, що повертаються, за допомогою виразу вибору шардів на основі CEL. Формат використовує функцію shardRange() у поєднанні з || (логічне АБО) для вказівки одного або кількох діапазонів хешів: shardRange(object.metadata.uid, '0x0', '0x8000000000000000') shardRange(object.metadata.uid, '0x0', '0x8000000000000000') || shardRange(object.metadata.uid, '0x8000000000000000', '0x10000000000000000') Шляхи полів використовують синтаксис CEL, що починається з обʼєкта (наприклад, "object.metadata.uid"), а не формат fieldSelector ("metadata.uid"). Наразі підтримуються такі шляхи:
|
timeoutSeconds | integer | Час очікування для виклику list/watch. Це обмежує тривалість виклику, незалежно від будь-якої активності чи неактивності. |
Параметри тіла запиту
| Назва | Тип | Опис |
|---|---|---|
body | DeleteOptions |
Відповідь
| Статус | Опис | Відповідь |
|---|---|---|
| 200 | OK | Status |
get Read
HTTP Запит
GET /apis/scheduling.k8s.io/v1beta1/namespaces/{namespace}/podgroups/{name}
Параметри шляху
| Назва | Тип | Опис |
|---|---|---|
name | string | Назва PodGroup |
namespace | string | Назва обʼєкта та область авторизації, наприклад для команд і проєктів |
Параметри запиту
| Назва | Тип | Опис |
|---|---|---|
pretty | string | Якщо 'true', то вихідні дані форматуються у зручному для читання вигляді. Зазвичай 'false', якщо user-agent не вказує оглядач або командний інструмент для роботи з HTTP (curl та wget). |
Відповідь
| Статус | Опис | Відповідь |
|---|---|---|
| 200 | OK | PodGroup |
get List
HTTP Запит
GET /apis/scheduling.k8s.io/v1beta1/namespaces/{namespace}/podgroups
Параметри шляху
| Назва | Тип | Опис |
|---|---|---|
namespace | string | Назва обʼєкта та область авторизації, наприклад для команд і проєктів |
Параметри запиту
| Назва | Тип | Опис |
|---|---|---|
pretty | string | Якщо 'true', то вихідні дані форматуються у зручному для читання вигляді. Зазвичай 'false', якщо user-agent не вказує оглядач або командний інструмент для роботи з HTTP (curl та wget). |
allowWatchBookmarks | boolean | allowWatchBookmarks запитує події спостереження з типом "BOOKMARK". Сервери, які не реалізують закладки, можуть ігнорувати цей прапорець, а закладки надсилаються на розсуд сервера. Клієнти не повинні припускати, що закладки повертаються через певний інтервал, і не можуть припускати, що сервер надішле будь-яку подію BOOKMARK під час сеансу. Якщо це не спостереження, це поле ігнорується. |
continue | string | Опція continue повинна бути встановлена при отриманні додаткових результатів від сервера. Оскільки це значення визначається сервером, клієнти можуть використовувати значення continue лише з попереднього результату запиту з ідентичними параметрами запиту (крім значення continue), і сервер може відхилити значення continue, яке він не розпізнає. Якщо вказане значення continue більше не дійсне через закінчення терміну дії (зазвичай пʼять-пʼятнадцять хвилин) або зміну конфігурації на сервері, сервер відповість помилкою 410 ResourceExpired разом з токеном continue. Якщо клієнту потрібен послідовний список, він повинен перезапустити свій список без поля continue. В іншому випадку клієнт може надіслати ще один запит списку з токеном, отриманим з помилкою 410, сервер відповість списком, починаючи з наступного ключа, але з останнього знімка, що не відповідає попереднім результатам списку — обʼєкти, які були створені, змінені або видалені після першого запиту списку, будуть включені у відповідь, якщо їх ключі йдуть після "наступного ключа". Це поле не підтримується, коли watch встановлено в true. Клієнти можуть почати спостереження з останнього значення resourceVersion, повернутого сервером, і не пропустити жодних змін. |
fieldSelector | string | Селектор для обмеження списку обʼєктів, що повертаються, за їхніми полями. Зазвичай повертаються всі обʼєкти. |
labelSelector | string | Селектор для обмеження списку обʼєктів, що повертаються, за їхніми мітками. Зазвичай повертаються всі обʼєкти. |
limit | integer | limit є максимальним числом відповідей, які потрібно повернути для виклику списку. Якщо існує більше елементів, сервер встановить поле continue у метаданих списку на значення, яке можна використовувати з тим самим початковим запитом для отримання наступного набору результатів. Встановлення обмеження може повернути менше, ніж запитана кількість елементів (до нуля елементів) у випадку, якщо всі запитані обʼєкти відфільтровані, і клієнти повинні використовувати лише наявність поля continue, щоб визначити, чи доступні додаткові результати. Сервери можуть вирішити не підтримувати аргумент limit і повернуть усі доступні результати. Якщо limit вказано, а поле continue порожнє, клієнти можуть припустити, що результатів більше немає. Це поле не підтримується, якщо watch дорівнює true. Сервер гарантує, що обʼєкти, повернені при використанні continue, будуть ідентичні до виконання одного виклику списку без обмеження — тобто жодні обʼєкти, створені, змінені або видалені після першого запиту, не будуть включені в будь-які наступні продовжені запити. Це іноді називають послідовним знімком, і забезпечує, що клієнт, який використовує limit для отримання менших частин дуже великого результату, може бути впевнений, що він бачить усі можливі обʼєкти. Якщо обʼєкти оновлюються під час отримання часткового списку, повертається версія обʼєкта, яка була присутня на момент обчислення першого результату списку. |
resourceVersion | string | resourceVersion встановлює обмеження на те, з яких версій ресурсів може обслуговуватися запит. Див. https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions для деталей. Стандартне значення не встановлено |
resourceVersionMatch | string | resourceVersionMatch визначає, як resourceVersion застосовується до викликів списку. Рекомендується встановлювати resourceVersionMatch для викликів списку, де встановлено resourceVersion. Див. https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions для деталей. Стандартне значення не встановлено |
sendInitialEvents | boolean | sendInitialEvents=true може бути встановлено разом з watch=true. У цьому випадку потік спостереження почнеться з синтетичних подій для відтворення поточного стану обʼєктів у колекції. Після надсилання всіх таких подій буде надіслано синтетичну подію "Bookmark". Закладка повідомить ResourceVersion (RV), що відповідає набору обʼєктів, і буде позначена анотацією "k8s.io/initial-events-end": "true". Після цього потік спостереження продовжиться як зазвичай, надсилаючи події спостереження, що відповідають змінам (після RV) для спостережуваних обʼєктів. Коли встановлено опцію sendInitialEvents, ми вимагаємо також встановлення опції resourceVersionMatch. Семантика запиту спостереження наступна:
|
shardSelector | string | shardSelector обмежує список обʼєктів, що повертаються, за допомогою виразу вибору шардів на основі CEL. Формат використовує функцію shardRange() у поєднанні з || (логічне АБО) для вказівки одного або кількох діапазонів хешів: shardRange(object.metadata.uid, '0x0', '0x8000000000000000') shardRange(object.metadata.uid, '0x0', '0x8000000000000000') || shardRange(object.metadata.uid, '0x8000000000000000', '0x10000000000000000') Шляхи полів використовують синтаксис CEL, що починається з обʼєкта (наприклад, "object.metadata.uid"), а не формат fieldSelector ("metadata.uid"). Наразі підтримуються такі шляхи:
|
timeoutSeconds | integer | Час очікування для виклику list/watch. Це обмежує тривалість виклику, незалежно від будь-якої активності чи неактивності. |
watch | boolean | Спостерігати за змінами описаних ресурсів і повертати їх як потік сповіщень про додавання, оновлення та видалення. Вкажіть resourceVersion. |
Відповідь
| Статус | Опис | Відповідь |
|---|---|---|
| 200 | OK | PodGroupList |
get List All Namespaces
HTTP Запит
GET /apis/scheduling.k8s.io/v1beta1/podgroups
Параметри запиту
| Назва | Тип | Опис |
|---|---|---|
allowWatchBookmarks | boolean | allowWatchBookmarks запитує події спостереження з типом "BOOKMARK". Сервери, які не реалізують закладки, можуть ігнорувати цей прапорець, а закладки надсилаються на розсуд сервера. Клієнти не повинні припускати, що закладки повертаються через певний інтервал, і не можуть припускати, що сервер надішле будь-яку подію BOOKMARK під час сеансу. Якщо це не спостереження, це поле ігнорується. |
continue | string | Опція continue повинна бути встановлена при отриманні додаткових результатів від сервера. Оскільки це значення визначається сервером, клієнти можуть використовувати значення continue лише з попереднього результату запиту з ідентичними параметрами запиту (крім значення continue), і сервер може відхилити значення continue, яке він не розпізнає. Якщо вказане значення continue більше не дійсне через закінчення терміну дії (зазвичай пʼять-пʼятнадцять хвилин) або зміну конфігурації на сервері, сервер відповість помилкою 410 ResourceExpired разом з токеном continue. Якщо клієнту потрібен послідовний список, він повинен перезапустити свій список без поля continue. В іншому випадку клієнт може надіслати ще один запит списку з токеном, отриманим з помилкою 410, сервер відповість списком, починаючи з наступного ключа, але з останнього знімка, що не відповідає попереднім результатам списку — обʼєкти, які були створені, змінені або видалені після першого запиту списку, будуть включені у відповідь, якщо їх ключі йдуть після "наступного ключа". Це поле не підтримується, коли watch встановлено в true. Клієнти можуть почати спостереження з останнього значення resourceVersion, повернутого сервером, і не пропустити жодних змін. |
fieldSelector | string | Селектор для обмеження списку обʼєктів, що повертаються, за їхніми полями. Зазвичай повертаються всі обʼєкти. |
labelSelector | string | Селектор для обмеження списку обʼєктів, що повертаються, за їхніми мітками. Зазвичай повертаються всі обʼєкти. |
limit | integer | limit є максимальним числом відповідей, які потрібно повернути для виклику списку. Якщо існує більше елементів, сервер встановить поле continue у метаданих списку на значення, яке можна використовувати з тим самим початковим запитом для отримання наступного набору результатів. Встановлення обмеження може повернути менше, ніж запитана кількість елементів (до нуля елементів) у випадку, якщо всі запитані обʼєкти відфільтровані, і клієнти повинні використовувати лише наявність поля continue, щоб визначити, чи доступні додаткові результати. Сервери можуть вирішити не підтримувати аргумент limit і повернуть усі доступні результати. Якщо limit вказано, а поле continue порожнє, клієнти можуть припустити, що результатів більше немає. Це поле не підтримується, якщо watch дорівнює true. Сервер гарантує, що обʼєкти, повернені при використанні continue, будуть ідентичні до виконання одного виклику списку без обмеження — тобто жодні обʼєкти, створені, змінені або видалені після першого запиту, не будуть включені в будь-які наступні продовжені запити. Це іноді називають послідовним знімком, і забезпечує, що клієнт, який використовує limit для отримання менших частин дуже великого результату, може бути впевнений, що він бачить усі можливі обʼєкти. Якщо обʼєкти оновлюються під час отримання часткового списку, повертається версія обʼєкта, яка була присутня на момент обчислення першого результату списку. |
pretty | string | Якщо 'true', то вихідні дані форматуються у зручному для читання вигляді. Зазвичай 'false', якщо user-agent не вказує оглядач або командний інструмент для роботи з HTTP (curl та wget). |
resourceVersion | string | resourceVersion встановлює обмеження на те, з яких версій ресурсів може обслуговуватися запит. Див. https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions для деталей. Стандартне значення не встановлено |
resourceVersionMatch | string | resourceVersionMatch визначає, як resourceVersion застосовується до викликів списку. Рекомендується встановлювати resourceVersionMatch для викликів списку, де встановлено resourceVersion. Див. https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions для деталей. Стандартне значення не встановлено |
sendInitialEvents | boolean | sendInitialEvents=true може бути встановлено разом з watch=true. У цьому випадку потік спостереження почнеться з синтетичних подій для відтворення поточного стану обʼєктів у колекції. Після надсилання всіх таких подій буде надіслано синтетичну подію "Bookmark". Закладка повідомить ResourceVersion (RV), що відповідає набору обʼєктів, і буде позначена анотацією "k8s.io/initial-events-end": "true". Після цього потік спостереження продовжиться як зазвичай, надсилаючи події спостереження, що відповідають змінам (після RV) для спостережуваних обʼєктів. Коли встановлено опцію sendInitialEvents, ми вимагаємо також встановлення опції resourceVersionMatch. Семантика запиту спостереження наступна:
|
shardSelector | string | shardSelector обмежує список обʼєктів, що повертаються, за допомогою виразу вибору шардів на основі CEL. Формат використовує функцію shardRange() у поєднанні з || (логічне АБО) для вказівки одного або кількох діапазонів хешів: shardRange(object.metadata.uid, '0x0', '0x8000000000000000') shardRange(object.metadata.uid, '0x0', '0x8000000000000000') || shardRange(object.metadata.uid, '0x8000000000000000', '0x10000000000000000') Шляхи полів використовують синтаксис CEL, що починається з обʼєкта (наприклад, "object.metadata.uid"), а не формат fieldSelector ("metadata.uid"). Наразі підтримуються такі шляхи:
|
timeoutSeconds | integer | Час очікування для виклику list/watch. Це обмежує тривалість виклику, незалежно від будь-якої активності чи неактивності. |
watch | boolean | Спостерігати за змінами описаних ресурсів і повертати їх як потік сповіщень про додавання, оновлення та видалення. Вкажіть resourceVersion. |
Відповідь
| Статус | Опис | Відповідь |
|---|---|---|
| 200 | OK | PodGroupList |
get Watch
HTTP Запит
GET /apis/scheduling.k8s.io/v1beta1/watch/namespaces/{namespace}/podgroups/{name}
Параметри шляху
| Назва | Тип | Опис |
|---|---|---|
name | string | Назва PodGroup |
namespace | string | Назва обʼєкта та область авторизації, наприклад для команд і проєктів |
Параметри запиту
| Назва | Тип | Опис |
|---|---|---|
allowWatchBookmarks | boolean | allowWatchBookmarks запитує події спостереження з типом "BOOKMARK". Сервери, які не реалізують закладки, можуть ігнорувати цей прапорець, а закладки надсилаються на розсуд сервера. Клієнти не повинні припускати, що закладки повертаються через певний інтервал, і не можуть припускати, що сервер надішле будь-яку подію BOOKMARK під час сеансу. Якщо це не спостереження, це поле ігнорується. |
continue | string | Опція continue повинна бути встановлена при отриманні додаткових результатів від сервера. Оскільки це значення визначається сервером, клієнти можуть використовувати значення continue лише з попереднього результату запиту з ідентичними параметрами запиту (крім значення continue), і сервер може відхилити значення continue, яке він не розпізнає. Якщо вказане значення continue більше не дійсне через закінчення терміну дії (зазвичай пʼять-пʼятнадцять хвилин) або зміну конфігурації на сервері, сервер відповість помилкою 410 ResourceExpired разом з токеном continue. Якщо клієнту потрібен послідовний список, він повинен перезапустити свій список без поля continue. В іншому випадку клієнт може надіслати ще один запит списку з токеном, отриманим з помилкою 410, сервер відповість списком, починаючи з наступного ключа, але з останнього знімка, що не відповідає попереднім результатам списку — обʼєкти, які були створені, змінені або видалені після першого запиту списку, будуть включені у відповідь, якщо їх ключі йдуть після "наступного ключа". Це поле не підтримується, коли watch встановлено в true. Клієнти можуть почати спостереження з останнього значення resourceVersion, повернутого сервером, і не пропустити жодних змін. |
fieldSelector | string | Селектор для обмеження списку обʼєктів, що повертаються, за їхніми полями. Зазвичай повертаються всі обʼєкти. |
labelSelector | string | Селектор для обмеження списку обʼєктів, що повертаються, за їхніми мітками. Зазвичай повертаються всі обʼєкти. |
limit | integer | limit є максимальним числом відповідей, які потрібно повернути для виклику списку. Якщо існує більше елементів, сервер встановить поле continue у метаданих списку на значення, яке можна використовувати з тим самим початковим запитом для отримання наступного набору результатів. Встановлення обмеження може повернути менше, ніж запитана кількість елементів (до нуля елементів) у випадку, якщо всі запитані обʼєкти відфільтровані, і клієнти повинні використовувати лише наявність поля continue, щоб визначити, чи доступні додаткові результати. Сервери можуть вирішити не підтримувати аргумент limit і повернуть усі доступні результати. Якщо limit вказано, а поле continue порожнє, клієнти можуть припустити, що результатів більше немає. Це поле не підтримується, якщо watch дорівнює true. Сервер гарантує, що обʼєкти, повернені при використанні continue, будуть ідентичні до виконання одного виклику списку без обмеження — тобто жодні обʼєкти, створені, змінені або видалені після першого запиту, не будуть включені в будь-які наступні продовжені запити. Це іноді називають послідовним знімком, і забезпечує, що клієнт, який використовує limit для отримання менших частин дуже великого результату, може бути впевнений, що він бачить усі можливі обʼєкти. Якщо обʼєкти оновлюються під час отримання часткового списку, повертається версія обʼєкта, яка була присутня на момент обчислення першого результату списку. |
pretty | string | Якщо 'true', то вихідні дані форматуються у зручному для читання вигляді. Зазвичай 'false', якщо user-agent не вказує оглядач або командний інструмент для роботи з HTTP (curl та wget). |
resourceVersion | string | resourceVersion встановлює обмеження на те, з яких версій ресурсів може обслуговуватися запит. Див. https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions для деталей. Стандартне значення не встановлено |
resourceVersionMatch | string | resourceVersionMatch визначає, як resourceVersion застосовується до викликів списку. Рекомендується встановлювати resourceVersionMatch для викликів списку, де встановлено resourceVersion. Див. https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions для деталей. Стандартне значення не встановлено |
sendInitialEvents | boolean | sendInitialEvents=true може бути встановлено разом з watch=true. У цьому випадку потік спостереження почнеться з синтетичних подій для відтворення поточного стану обʼєктів у колекції. Після надсилання всіх таких подій буде надіслано синтетичну подію "Bookmark". Закладка повідомить ResourceVersion (RV), що відповідає набору обʼєктів, і буде позначена анотацією "k8s.io/initial-events-end": "true". Після цього потік спостереження продовжиться як зазвичай, надсилаючи події спостереження, що відповідають змінам (після RV) для спостережуваних обʼєктів. Коли встановлено опцію sendInitialEvents, ми вимагаємо також встановлення опції resourceVersionMatch. Семантика запиту спостереження наступна:
|
shardSelector | string | shardSelector обмежує список обʼєктів, що повертаються, за допомогою виразу вибору шардів на основі CEL. Формат використовує функцію shardRange() у поєднанні з || (логічне АБО) для вказівки одного або кількох діапазонів хешів: shardRange(object.metadata.uid, '0x0', '0x8000000000000000') shardRange(object.metadata.uid, '0x0', '0x8000000000000000') || shardRange(object.metadata.uid, '0x8000000000000000', '0x10000000000000000') Шляхи полів використовують синтаксис CEL, що починається з обʼєкта (наприклад, "object.metadata.uid"), а не формат fieldSelector ("metadata.uid"). Наразі підтримуються такі шляхи:
|
timeoutSeconds | integer | Час очікування для виклику list/watch. Це обмежує тривалість виклику, незалежно від будь-якої активності чи неактивності. |
watch | boolean | Спостерігати за змінами описаних ресурсів і повертати їх як потік сповіщень про додавання, оновлення та видалення. Вкажіть resourceVersion. |
Відповідь
| Статус | Опис | Відповідь |
|---|---|---|
| 200 | OK | WatchEvent |
get Watch List
HTTP Запит
GET /apis/scheduling.k8s.io/v1beta1/watch/namespaces/{namespace}/podgroups
Параметри шляху
| Назва | Тип | Опис |
|---|---|---|
namespace | string | Назва обʼєкта та область авторизації, наприклад для команд і проєктів |
Параметри запиту
| Назва | Тип | Опис |
|---|---|---|
allowWatchBookmarks | boolean | allowWatchBookmarks запитує події спостереження з типом "BOOKMARK". Сервери, які не реалізують закладки, можуть ігнорувати цей прапорець, а закладки надсилаються на розсуд сервера. Клієнти не повинні припускати, що закладки повертаються через певний інтервал, і не можуть припускати, що сервер надішле будь-яку подію BOOKMARK під час сеансу. Якщо це не спостереження, це поле ігнорується. |
continue | string | Опція continue повинна бути встановлена при отриманні додаткових результатів від сервера. Оскільки це значення визначається сервером, клієнти можуть використовувати значення continue лише з попереднього результату запиту з ідентичними параметрами запиту (крім значення continue), і сервер може відхилити значення continue, яке він не розпізнає. Якщо вказане значення continue більше не дійсне через закінчення терміну дії (зазвичай пʼять-пʼятнадцять хвилин) або зміну конфігурації на сервері, сервер відповість помилкою 410 ResourceExpired разом з токеном continue. Якщо клієнту потрібен послідовний список, він повинен перезапустити свій список без поля continue. В іншому випадку клієнт може надіслати ще один запит списку з токеном, отриманим з помилкою 410, сервер відповість списком, починаючи з наступного ключа, але з останнього знімка, що не відповідає попереднім результатам списку — обʼєкти, які були створені, змінені або видалені після першого запиту списку, будуть включені у відповідь, якщо їх ключі йдуть після "наступного ключа". Це поле не підтримується, коли watch встановлено в true. Клієнти можуть почати спостереження з останнього значення resourceVersion, повернутого сервером, і не пропустити жодних змін. |
fieldSelector | string | Селектор для обмеження списку обʼєктів, що повертаються, за їхніми полями. Зазвичай повертаються всі обʼєкти. |
labelSelector | string | Селектор для обмеження списку обʼєктів, що повертаються, за їхніми мітками. Зазвичай повертаються всі обʼєкти. |
limit | integer | limit є максимальним числом відповідей, які потрібно повернути для виклику списку. Якщо існує більше елементів, сервер встановить поле continue у метаданих списку на значення, яке можна використовувати з тим самим початковим запитом для отримання наступного набору результатів. Встановлення обмеження може повернути менше, ніж запитана кількість елементів (до нуля елементів) у випадку, якщо всі запитані обʼєкти відфільтровані, і клієнти повинні використовувати лише наявність поля continue, щоб визначити, чи доступні додаткові результати. Сервери можуть вирішити не підтримувати аргумент limit і повернуть усі доступні результати. Якщо limit вказано, а поле continue порожнє, клієнти можуть припустити, що результатів більше немає. Це поле не підтримується, якщо watch дорівнює true. Сервер гарантує, що обʼєкти, повернені при використанні continue, будуть ідентичні до виконання одного виклику списку без обмеження — тобто жодні обʼєкти, створені, змінені або видалені після першого запиту, не будуть включені в будь-які наступні продовжені запити. Це іноді називають послідовним знімком, і забезпечує, що клієнт, який використовує limit для отримання менших частин дуже великого результату, може бути впевнений, що він бачить усі можливі обʼєкти. Якщо обʼєкти оновлюються під час отримання часткового списку, повертається версія обʼєкта, яка була присутня на момент обчислення першого результату списку. |
pretty | string | Якщо 'true', то вихідні дані форматуються у зручному для читання вигляді. Зазвичай 'false', якщо user-agent не вказує оглядач або командний інструмент для роботи з HTTP (curl та wget). |
resourceVersion | string | resourceVersion встановлює обмеження на те, з яких версій ресурсів може обслуговуватися запит. Див. https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions для деталей. Стандартне значення не встановлено |
resourceVersionMatch | string | resourceVersionMatch визначає, як resourceVersion застосовується до викликів списку. Рекомендується встановлювати resourceVersionMatch для викликів списку, де встановлено resourceVersion. Див. https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions для деталей. Стандартне значення не встановлено |
sendInitialEvents | boolean | sendInitialEvents=true може бути встановлено разом з watch=true. У цьому випадку потік спостереження почнеться з синтетичних подій для відтворення поточного стану обʼєктів у колекції. Після надсилання всіх таких подій буде надіслано синтетичну подію "Bookmark". Закладка повідомить ResourceVersion (RV), що відповідає набору обʼєктів, і буде позначена анотацією "k8s.io/initial-events-end": "true". Після цього потік спостереження продовжиться як зазвичай, надсилаючи події спостереження, що відповідають змінам (після RV) для спостережуваних обʼєктів. Коли встановлено опцію sendInitialEvents, ми вимагаємо також встановлення опції resourceVersionMatch. Семантика запиту спостереження наступна:
|
shardSelector | string | shardSelector обмежує список обʼєктів, що повертаються, за допомогою виразу вибору шардів на основі CEL. Формат використовує функцію shardRange() у поєднанні з || (логічне АБО) для вказівки одного або кількох діапазонів хешів: shardRange(object.metadata.uid, '0x0', '0x8000000000000000') shardRange(object.metadata.uid, '0x0', '0x8000000000000000') || shardRange(object.metadata.uid, '0x8000000000000000', '0x10000000000000000') Шляхи полів використовують синтаксис CEL, що починається з обʼєкта (наприклад, "object.metadata.uid"), а не формат fieldSelector ("metadata.uid"). Наразі підтримуються такі шляхи:
|
timeoutSeconds | integer | Час очікування для виклику list/watch. Це обмежує тривалість виклику, незалежно від будь-якої активності чи неактивності. |
watch | boolean | Спостерігати за змінами описаних ресурсів і повертати їх як потік сповіщень про додавання, оновлення та видалення. Вкажіть resourceVersion. |
Відповідь
| Статус | Опис | Відповідь |
|---|---|---|
| 200 | OK | WatchEvent |
get Watch List All Namespaces
HTTP Запит
GET /apis/scheduling.k8s.io/v1beta1/watch/podgroups
Параметри запиту
| Назва | Тип | Опис |
|---|---|---|
allowWatchBookmarks | boolean | allowWatchBookmarks запитує події спостереження з типом "BOOKMARK". Сервери, які не реалізують закладки, можуть ігнорувати цей прапорець, а закладки надсилаються на розсуд сервера. Клієнти не повинні припускати, що закладки повертаються через певний інтервал, і не можуть припускати, що сервер надішле будь-яку подію BOOKMARK під час сеансу. Якщо це не спостереження, це поле ігнорується. |
continue | string | Опція continue повинна бути встановлена при отриманні додаткових результатів від сервера. Оскільки це значення визначається сервером, клієнти можуть використовувати значення continue лише з попереднього результату запиту з ідентичними параметрами запиту (крім значення continue), і сервер може відхилити значення continue, яке він не розпізнає. Якщо вказане значення continue більше не дійсне через закінчення терміну дії (зазвичай пʼять-пʼятнадцять хвилин) або зміну конфігурації на сервері, сервер відповість помилкою 410 ResourceExpired разом з токеном continue. Якщо клієнту потрібен послідовний список, він повинен перезапустити свій список без поля continue. В іншому випадку клієнт може надіслати ще один запит списку з токеном, отриманим з помилкою 410, сервер відповість списком, починаючи з наступного ключа, але з останнього знімка, що не відповідає попереднім результатам списку — обʼєкти, які були створені, змінені або видалені після першого запиту списку, будуть включені у відповідь, якщо їх ключі йдуть після "наступного ключа". Це поле не підтримується, коли watch встановлено в true. Клієнти можуть почати спостереження з останнього значення resourceVersion, повернутого сервером, і не пропустити жодних змін. |
fieldSelector | string | Селектор для обмеження списку обʼєктів, що повертаються, за їхніми полями. Зазвичай повертаються всі обʼєкти. |
labelSelector | string | Селектор для обмеження списку обʼєктів, що повертаються, за їхніми мітками. Зазвичай повертаються всі обʼєкти. |
limit | integer | limit є максимальним числом відповідей, які потрібно повернути для виклику списку. Якщо існує більше елементів, сервер встановить поле continue у метаданих списку на значення, яке можна використовувати з тим самим початковим запитом для отримання наступного набору результатів. Встановлення обмеження може повернути менше, ніж запитана кількість елементів (до нуля елементів) у випадку, якщо всі запитані обʼєкти відфільтровані, і клієнти повинні використовувати лише наявність поля continue, щоб визначити, чи доступні додаткові результати. Сервери можуть вирішити не підтримувати аргумент limit і повернуть усі доступні результати. Якщо limit вказано, а поле continue порожнє, клієнти можуть припустити, що результатів більше немає. Це поле не підтримується, якщо watch дорівнює true. Сервер гарантує, що обʼєкти, повернені при використанні continue, будуть ідентичні до виконання одного виклику списку без обмеження — тобто жодні обʼєкти, створені, змінені або видалені після першого запиту, не будуть включені в будь-які наступні продовжені запити. Це іноді називають послідовним знімком, і забезпечує, що клієнт, який використовує limit для отримання менших частин дуже великого результату, може бути впевнений, що він бачить усі можливі обʼєкти. Якщо обʼєкти оновлюються під час отримання часткового списку, повертається версія обʼєкта, яка була присутня на момент обчислення першого результату списку. |
pretty | string | Якщо 'true', то вихідні дані форматуються у зручному для читання вигляді. Зазвичай 'false', якщо user-agent не вказує оглядач або командний інструмент для роботи з HTTP (curl та wget). |
resourceVersion | string | resourceVersion встановлює обмеження на те, з яких версій ресурсів може обслуговуватися запит. Див. https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions для деталей. Стандартне значення не встановлено |
resourceVersionMatch | string | resourceVersionMatch визначає, як resourceVersion застосовується до викликів списку. Рекомендується встановлювати resourceVersionMatch для викликів списку, де встановлено resourceVersion. Див. https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions для деталей. Стандартне значення не встановлено |
sendInitialEvents | boolean | sendInitialEvents=true може бути встановлено разом з watch=true. У цьому випадку потік спостереження почнеться з синтетичних подій для відтворення поточного стану обʼєктів у колекції. Після надсилання всіх таких подій буде надіслано синтетичну подію "Bookmark". Закладка повідомить ResourceVersion (RV), що відповідає набору обʼєктів, і буде позначена анотацією "k8s.io/initial-events-end": "true". Після цього потік спостереження продовжиться як зазвичай, надсилаючи події спостереження, що відповідають змінам (після RV) для спостережуваних обʼєктів. Коли встановлено опцію sendInitialEvents, ми вимагаємо також встановлення опції resourceVersionMatch. Семантика запиту спостереження наступна:
|
shardSelector | string | shardSelector обмежує список обʼєктів, що повертаються, за допомогою виразу вибору шардів на основі CEL. Формат використовує функцію shardRange() у поєднанні з || (логічне АБО) для вказівки одного або кількох діапазонів хешів: shardRange(object.metadata.uid, '0x0', '0x8000000000000000') shardRange(object.metadata.uid, '0x0', '0x8000000000000000') || shardRange(object.metadata.uid, '0x8000000000000000', '0x10000000000000000') Шляхи полів використовують синтаксис CEL, що починається з обʼєкта (наприклад, "object.metadata.uid"), а не формат fieldSelector ("metadata.uid"). Наразі підтримуються такі шляхи:
|
timeoutSeconds | integer | Час очікування для виклику list/watch. Це обмежує тривалість виклику, незалежно від будь-якої активності чи неактивності. |
watch | boolean | Спостерігати за змінами описаних ресурсів і повертати їх як потік сповіщень про додавання, оновлення та видалення. Вкажіть resourceVersion. |
Відповідь
| Статус | Опис | Відповідь |
|---|---|---|
| 200 | OK | WatchEvent |
patch Patch Status
HTTP Запит
PATCH /apis/scheduling.k8s.io/v1beta1/namespaces/{namespace}/podgroups/{name}/status
Параметри шляху
| Назва | Тип | Опис |
|---|---|---|
name | string | Назва PodGroup |
namespace | string | Назва обʼєкта та область авторизації, наприклад для команд і проєктів |
Параметри запиту
| Назва | Тип | Опис |
|---|---|---|
pretty | string | Якщо 'true', то вихідні дані форматуються у зручному для читання вигляді. Зазвичай 'false', якщо user-agent не вказує оглядач або командний інструмент для роботи з HTTP (curl та wget). |
dryRun | string | Коли параметр присутній, це вказує, що зміни не повинні зберігатися. Неправильна або нерозпізнана директива dryRun призведе до помилки та припинення обробки запиту. Дійсні значення:
|
fieldManager | string | fieldManager є імʼям, повʼязаним з а́ктором або сутністю, яка вносить ці зміни. Значення повинно бути менше або дорівнювати 128 символам і містити лише друковані символи, як визначено в https://golang.org/pkg/unicode/#IsPrint. Це поле обовʼязкове для запитів apply (application/apply-patch), але необовʼязкове для типів патчів, що не застосовуються (JsonPatch, MergePatch, StrategicMergePatch). |
fieldValidation | string | fieldValidation інструктує сервер, як обробляти обʼєкти в запиті (POST/PUT/PATCH), що містять невідомі або дубльовані поля. Дійсні значення:
|
force | boolean | Force має на меті "примусово" застосовувати запити Apply. Це означає, що користувач повторно отримає конфліктні поля, що належать іншим користувачам. Прапорець Force повинен бути скасований для запитів, що не є патчами apply. |
Параметри тіла запиту
| Назва | Тип | Опис |
|---|---|---|
body | Patch |
Відповідь
| Статус | Опис | Відповідь |
|---|---|---|
| 200 | OK | PodGroup |
| 201 | Created | PodGroup |
get Read Status
HTTP Запит
GET /apis/scheduling.k8s.io/v1beta1/namespaces/{namespace}/podgroups/{name}/status
Параметри шляху
| Назва | Тип | Опис |
|---|---|---|
name | string | Назва PodGroup |
namespace | string | Назва обʼєкта та область авторизації, наприклад для команд і проєктів |
Параметри запиту
| Назва | Тип | Опис |
|---|---|---|
pretty | string | Якщо 'true', то вихідні дані форматуються у зручному для читання вигляді. Зазвичай 'false', якщо user-agent не вказує оглядач або командний інструмент для роботи з HTTP (curl та wget). |
Відповідь
| Статус | Опис | Відповідь |
|---|---|---|
| 200 | OK | PodGroup |
put Replace Status
HTTP Запит
PUT /apis/scheduling.k8s.io/v1beta1/namespaces/{namespace}/podgroups/{name}/status
Параметри шляху
| Назва | Тип | Опис |
|---|---|---|
name | string | Назва PodGroup |
namespace | string | Назва обʼєкта та область авторизації, наприклад для команд і проєктів |
Параметри запиту
| Назва | Тип | Опис |
|---|---|---|
pretty | string | Якщо 'true', то вихідні дані форматуються у зручному для читання вигляді. Зазвичай 'false', якщо user-agent не вказує оглядач або командний інструмент для роботи з HTTP (curl та wget). |
dryRun | string | Коли параметр присутній, це вказує, що зміни не повинні зберігатися. Неправильна або нерозпізнана директива dryRun призведе до помилки та припинення обробки запиту. Дійсні значення:
|
fieldManager | string | fieldManager є імʼям, повʼязаним з а́ктором або сутністю, яка вносить ці зміни. Значення повинно бути менше або дорівнювати 128 символам і містити лише друковані символи, як визначено в https://golang.org/pkg/unicode/#IsPrint. |
fieldValidation | string | fieldValidation інструктує сервер, як обробляти обʼєкти в запиті (POST/PUT/PATCH), що містять невідомі або дубльовані поля. Дійсні значення:
|
Параметри тіла запиту
| Назва | Тип | Опис |
|---|---|---|
body | PodGroup |
Відповідь
| Статус | Опис | Відповідь |
|---|---|---|
| 200 | OK | PodGroup |
| 201 | Created | PodGroup |
3 - PriorityClass
PriorityClass визначає зіставлення імені класу пріоритету з цілим числом пріоритету. Значення може бути будь-яким дійсним цілим числом.
apiVersion: scheduling.k8s.io/v1
import "k8s.io/api/scheduling/v1"
PriorityClass
PriorityClass визначає зіставлення імені класу пріоритету з цілим числом пріоритету. Значення може бути будь-яким дійсним цілим числом.
| Поле | Опис |
|---|---|
apiVersionstring | APIVersion визначає версію схеми цього представлення обʼєкта. Сервери повинні конвертувати розпізнані схеми до останнього внутрішнього значення і можуть відхиляти нерозпізнані значення. Детальніше: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources |
descriptionstring | description є довільним рядком, який зазвичай надає рекомендації щодо того, коли слід використовувати цей клас пріоритету. |
globalDefaultboolean | globalDefault вказує, чи слід вважати цей PriorityClass стандартним пріоритетом для подів, які не мають жодного класу пріоритету. Лише один PriorityClass може бути позначений як globalDefault. Однак, якщо існує більше одного PriorityClass з полем globalDefault, встановленим у true, буде використано найменше значення таких стандартних глобальних пріоритетів. |
kindstring | Kind визначає тип REST-ресурсу, який представляє цей обʼєкт. Сервери можуть визначати це з точки доступу, до якої клієнт надсилає запити. Не може бути оновлено. У CamelCase. Детальніше: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
metadataObjectMeta | metadata — стандартні метадані обʼєкта. Детальніше: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata |
preemptionPolicystring | preemptionPolicy є Політикою витіснення подів з нижчим пріоритетом. Одне з значень: Never, PreemptLowerPriority. Стандартно використовується PreemptLowerPriority, якщо не вказано. Можливі значення enum:
|
valueinteger | value представляє ціле число цього класу пріоритету. Це фактичний пріоритет, який отримують поди, коли вони мають імʼя цього класу у своїй специфікації поду. |
PriorityClassList
PriorityClassList є колекцією класів пріоритету.
| Поле | Опис |
|---|---|
apiVersionstring | APIVersion визначає версію схеми цього представлення обʼєкта. Сервери повинні конвертувати розпізнані схеми до останнього внутрішнього значення і можуть відхиляти нерозпізнані значення. Детальніше: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources |
items *PriorityClass array | items є списком PriorityClasses |
kindstring | Kind визначає тип REST-ресурсу, який представляє цей обʼєкт. Сервери можуть визначати це з точки доступу, до якої клієнт надсилає запити. Не може бути оновлено. У CamelCase. Детальніше: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
metadataListMeta | Стандартні метадані списку. Детальніше: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata |
Операції
post Create
HTTP Запит
POST /apis/scheduling.k8s.io/v1/priorityclasses
Параметри запиту
| Назва | Тип | Опис |
|---|---|---|
pretty | string | Якщо 'true', то вихідні дані форматуються у зручному для читання вигляді. Зазвичай 'false', якщо user-agent не вказує оглядач або командний інструмент для роботи з HTTP (curl та wget). |
dryRun | string | Коли параметр присутній, це вказує, що зміни не повинні зберігатися. Неправильна або нерозпізнана директива dryRun призведе до помилки та припинення обробки запиту. Дійсні значення:
|
fieldManager | string | fieldManager є імʼям, повʼязаним з а́ктором або сутністю, яка вносить ці зміни. Значення повинно бути менше або дорівнювати 128 символам і містити лише друковані символи, як визначено в https://golang.org/pkg/unicode/#IsPrint. |
fieldValidation | string | fieldValidation інструктує сервер, як обробляти обʼєкти в запиті (POST/PUT/PATCH), що містять невідомі або дубльовані поля. Дійсні значення:
|
Параметри тіла запиту
| Назва | Тип | Опис |
|---|---|---|
body | PriorityClass |
Відповідь
| Статус | Опис | Відповідь |
|---|---|---|
| 200 | OK | PriorityClass |
| 201 | Created | PriorityClass |
| 202 | Accepted | PriorityClass |
patch Patch
HTTP Запит
PATCH /apis/scheduling.k8s.io/v1/priorityclasses/{name}
Параметри шляху
| Назва | Тип | Опис |
|---|---|---|
name | string | Назва PriorityClass |
Параметри запиту
| Назва | Тип | Опис |
|---|---|---|
pretty | string | Якщо 'true', то вихідні дані форматуються у зручному для читання вигляді. Зазвичай 'false', якщо user-agent не вказує оглядач або командний інструмент для роботи з HTTP (curl та wget). |
dryRun | string | Коли параметр присутній, це вказує, що зміни не повинні зберігатися. Неправильна або нерозпізнана директива dryRun призведе до помилки та припинення обробки запиту. Дійсні значення:
|
fieldManager | string | fieldManager є імʼям, повʼязаним з а́ктором або сутністю, яка вносить ці зміни. Значення повинно бути менше або дорівнювати 128 символам і містити лише друковані символи, як визначено в https://golang.org/pkg/unicode/#IsPrint. Це поле обовʼязкове для запитів apply (application/apply-patch), але необовʼязкове для типів патчів, що не застосовуються (JsonPatch, MergePatch, StrategicMergePatch). |
fieldValidation | string | fieldValidation інструктує сервер, як обробляти обʼєкти в запиті (POST/PUT/PATCH), що містять невідомі або дубльовані поля. Дійсні значення:
|
force | boolean | Force має на меті "примусово" застосовувати запити Apply. Це означає, що користувач повторно отримає конфліктні поля, що належать іншим користувачам. Прапорець Force повинен бути скасований для запитів, що не є патчами apply. |
Параметри тіла запиту
| Назва | Тип | Опис |
|---|---|---|
body | Patch |
Відповідь
| Статус | Опис | Відповідь |
|---|---|---|
| 200 | OK | PriorityClass |
| 201 | Created | PriorityClass |
put Replace
HTTP Запит
PUT /apis/scheduling.k8s.io/v1/priorityclasses/{name}
Параметри шляху
| Назва | Тип | Опис |
|---|---|---|
name | string | Назва PriorityClass |
Параметри запиту
| Назва | Тип | Опис |
|---|---|---|
pretty | string | Якщо 'true', то вихідні дані форматуються у зручному для читання вигляді. Зазвичай 'false', якщо user-agent не вказує оглядач або командний інструмент для роботи з HTTP (curl та wget). |
dryRun | string | Коли параметр присутній, це вказує, що зміни не повинні зберігатися. Неправильна або нерозпізнана директива dryRun призведе до помилки та припинення обробки запиту. Дійсні значення:
|
fieldManager | string | fieldManager є імʼям, повʼязаним з а́ктором або сутністю, яка вносить ці зміни. Значення повинно бути менше або дорівнювати 128 символам і містити лише друковані символи, як визначено в https://golang.org/pkg/unicode/#IsPrint. |
fieldValidation | string | fieldValidation інструктує сервер, як обробляти обʼєкти в запиті (POST/PUT/PATCH), що містять невідомі або дубльовані поля. Дійсні значення:
|
Параметри тіла запиту
| Назва | Тип | Опис |
|---|---|---|
body | PriorityClass |
Відповідь
| Статус | Опис | Відповідь |
|---|---|---|
| 200 | OK | PriorityClass |
| 201 | Created | PriorityClass |
delete Delete
HTTP Запит
DELETE /apis/scheduling.k8s.io/v1/priorityclasses/{name}
Параметри шляху
| Назва | Тип | Опис |
|---|---|---|
name | string | Назва PriorityClass |
Параметри запиту
| Назва | Тип | Опис |
|---|---|---|
pretty | string | Якщо 'true', то вихідні дані форматуються у зручному для читання вигляді. Зазвичай 'false', якщо user-agent не вказує оглядач або командний інструмент для роботи з HTTP (curl та wget). |
dryRun | string | Коли параметр присутній, це вказує, що зміни не повинні зберігатися. Неправильна або нерозпізнана директива dryRun призведе до помилки та припинення обробки запиту. Дійсні значення:
|
gracePeriodSeconds | integer | Часу у секундах перед видаленням обʼєкта. Значення повинно бути невідʼємним цілим числом. Значення нуль вказує на негайне видалення. Якщо це значення відсутнє, буде використано стандартний період очікування для зазначеного типу. Зазвичай використовується значення для конкретного обʼєкта, якщо не вказано. Нуль означає негайне видалення. |
ignoreStoreReadErrorWithClusterBreakingPotential | boolean | Якщо встановлено в true, це призведе до небезпечного видалення ресурсу у випадку, якщо нормальний процес видалення не вдасться через помилку пошкодженого обʼєкта. Ресурс вважається пошкодженим, якщо його не можна успішно отримати з відповідного сховища томущо: a) його дані не можна трансформувати, наприклад, помилка дешифрування, або b) не вдається декодувати в обʼєкт. ПРИМІТКА: небезпечне видалення ігнорує обмеження завершувача, пропускає перевірки передумов і видаляє обʼєкт зі сховища. ПОПЕРЕДЖЕННЯ: це може потенційно порушити роботу кластера, якщо робоче навантаження, повʼязане з ресурсом, що видаляється небезпечно, покладається на нормальний процес видалення. Використовуйте лише якщо ви ДІЙСНО знаєте, що робите. Стандартне значення — false, і користувач повинен явно погодитися на його використання. |
orphanDependents | boolean | Застаріло: будь ласка, використовуйте PropagationPolicy, це поле буде застарілим у версії 1.7. Чи повинні залежні обʼєкти залишатися покинутими. Якщо true/false, завершувач "orphan" буде доданий до/видалений з списку завершувачів обʼєкта. Можна встановити або це поле, або PropagationPolicy, але не обидва. |
propagationPolicy | string | Чи і як буде виконано збір сміття. Можна встановити або це поле, або OrphanDependents, але не обидва. Стандартна політика визначається наявним завершувачем у metadata.finalizers та стандартною політикою для конкретного ресурсу. Допустимі значення: 'Orphan' — залишити залежні обʼєкти покинутими; 'Background' — дозволити збирачу сміття видаляти залежні обʼєкти у фоновому режимі; 'Foreground' — каскадна політика, яка видаляє всі залежні обʼєкти з показом всіх дій. |
Параметри тіла запиту
| Назва | Тип | Опис |
|---|---|---|
body | DeleteOptions |
Відповідь
| Статус | Опис | Відповідь |
|---|---|---|
| 200 | OK | Status |
| 202 | Accepted | Status |
delete Delete Collection
HTTP Запит
DELETE /apis/scheduling.k8s.io/v1/priorityclasses
Параметри запиту
| Назва | Тип | Опис |
|---|---|---|
pretty | string | Якщо 'true', то вихідні дані форматуються у зручному для читання вигляді. Зазвичай 'false', якщо user-agent не вказує оглядач або командний інструмент для роботи з HTTP (curl та wget). |
continue | string | Опція continue повинна бути встановлена при отриманні додаткових результатів від сервера. Оскільки це значення визначається сервером, клієнти можуть використовувати значення continue лише з попереднього результату запиту з ідентичними параметрами запиту (крім значення continue), і сервер може відхилити значення continue, яке він не розпізнає. Якщо вказане значення continue більше не дійсне через закінчення терміну дії (зазвичай пʼять-пʼятнадцять хвилин) або зміну конфігурації на сервері, сервер відповість помилкою 410 ResourceExpired разом з токеном continue. Якщо клієнту потрібен послідовний список, він повинен перезапустити свій список без поля continue. В іншому випадку клієнт може надіслати ще один запит списку з токеном, отриманим з помилкою 410, сервер відповість списком, починаючи з наступного ключа, але з останнього знімка, що не відповідає попереднім результатам списку — обʼєкти, які були створені, змінені або видалені після першого запиту списку, будуть включені у відповідь, якщо їх ключі йдуть після "наступного ключа". Це поле не підтримується, коли watch встановлено в true. Клієнти можуть почати спостереження з останнього значення resourceVersion, повернутого сервером, і не пропустити жодних змін. |
dryRun | string | Коли параметр присутній, це вказує, що зміни не повинні зберігатися. Неправильна або нерозпізнана директива dryRun призведе до помилки та припинення обробки запиту. Дійсні значення:
|
fieldSelector | string | Селектор для обмеження списку обʼєктів, що повертаються, за їхніми полями. Зазвичай повертаються всі обʼєкти. |
gracePeriodSeconds | integer | Часу у секундах перед видаленням обʼєкта. Значення повинно бути невідʼємним цілим числом. Значення нуль вказує на негайне видалення. Якщо це значення відсутнє, буде використано стандартний період очікування для зазначеного типу. Зазвичай використовується значення для конкретного обʼєкта, якщо не вказано. Нуль означає негайне видалення. |
ignoreStoreReadErrorWithClusterBreakingPotential | boolean | Якщо встановлено в true, це призведе до небезпечного видалення ресурсу у випадку, якщо нормальний процес видалення не вдасться через помилку пошкодженого обʼєкта. Ресурс вважається пошкодженим, якщо його не можна успішно отримати з відповідного сховища томущо: a) його дані не можна трансформувати, наприклад, помилка дешифрування, або b) не вдається декодувати в обʼєкт. ПРИМІТКА: небезпечне видалення ігнорує обмеження завершувача, пропускає перевірки передумов і видаляє обʼєкт зі сховища. ПОПЕРЕДЖЕННЯ: це може потенційно порушити роботу кластера, якщо робоче навантаження, повʼязане з ресурсом, що видаляється небезпечно, покладається на нормальний процес видалення. Використовуйте лише якщо ви ДІЙСНО знаєте, що робите. Стандартне значення — false, і користувач повинен явно погодитися на його використання. |
labelSelector | string | Селектор для обмеження списку обʼєктів, що повертаються, за їхніми мітками. Зазвичай повертаються всі обʼєкти. |
limit | integer | limit є максимальним числом відповідей, які потрібно повернути для виклику списку. Якщо існує більше елементів, сервер встановить поле continue у метаданих списку на значення, яке можна використовувати з тим самим початковим запитом для отримання наступного набору результатів. Встановлення обмеження може повернути менше, ніж запитана кількість елементів (до нуля елементів) у випадку, якщо всі запитані обʼєкти відфільтровані, і клієнти повинні використовувати лише наявність поля continue, щоб визначити, чи доступні додаткові результати. Сервери можуть вирішити не підтримувати аргумент limit і повернуть усі доступні результати. Якщо limit вказано, а поле continue порожнє, клієнти можуть припустити, що результатів більше немає. Це поле не підтримується, якщо watch дорівнює true. Сервер гарантує, що обʼєкти, повернені при використанні continue, будуть ідентичні до виконання одного виклику списку без обмеження — тобто жодні обʼєкти, створені, змінені або видалені після першого запиту, не будуть включені в будь-які наступні продовжені запити. Це іноді називають послідовним знімком, і забезпечує, що клієнт, який використовує limit для отримання менших частин дуже великого результату, може бути впевнений, що він бачить усі можливі обʼєкти. Якщо обʼєкти оновлюються під час отримання часткового списку, повертається версія обʼєкта, яка була присутня на момент обчислення першого результату списку. |
orphanDependents | boolean | Застаріло: будь ласка, використовуйте PropagationPolicy, це поле буде застарілим у версії 1.7. Чи повинні залежні обʼєкти залишатися покинутими. Якщо true/false, завершувач "orphan" буде доданий до/видалений з списку завершувачів обʼєкта. Можна встановити або це поле, або PropagationPolicy, але не обидва. |
propagationPolicy | string | Чи і як буде виконано збір сміття. Можна встановити або це поле, або OrphanDependents, але не обидва. Стандартна політика визначається наявним завершувачем у metadata.finalizers та стандартною політикою для конкретного ресурсу. Допустимі значення: 'Orphan' — залишити залежні обʼєкти покинутими; 'Background' — дозволити збирачу сміття видаляти залежні обʼєкти у фоновому режимі; 'Foreground' — каскадна політика, яка видаляє всі залежні обʼєкти з показом всіх дій. |
resourceVersion | string | resourceVersion встановлює обмеження на те, з яких версій ресурсів може обслуговуватися запит. Див. https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions для деталей. Стандартне значення не встановлено |
resourceVersionMatch | string | resourceVersionMatch визначає, як resourceVersion застосовується до викликів списку. Рекомендується встановлювати resourceVersionMatch для викликів списку, де встановлено resourceVersion. Див. https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions для деталей. Стандартне значення не встановлено |
sendInitialEvents | boolean | sendInitialEvents=true може бути встановлено разом з watch=true. У цьому випадку потік спостереження почнеться з синтетичних подій для відтворення поточного стану обʼєктів у колекції. Після надсилання всіх таких подій буде надіслано синтетичну подію "Bookmark". Закладка повідомить ResourceVersion (RV), що відповідає набору обʼєктів, і буде позначена анотацією "k8s.io/initial-events-end": "true". Після цього потік спостереження продовжиться як зазвичай, надсилаючи події спостереження, що відповідають змінам (після RV) для спостережуваних обʼєктів. Коли встановлено опцію sendInitialEvents, ми вимагаємо також встановлення опції resourceVersionMatch. Семантика запиту спостереження наступна:
|
shardSelector | string | shardSelector обмежує список обʼєктів, що повертаються, за допомогою виразу вибору шардів на основі CEL. Формат використовує функцію shardRange() у поєднанні з || (логічне АБО) для вказівки одного або кількох діапазонів хешів: shardRange(object.metadata.uid, '0x0', '0x8000000000000000') shardRange(object.metadata.uid, '0x0', '0x8000000000000000') || shardRange(object.metadata.uid, '0x8000000000000000', '0x10000000000000000') Шляхи полів використовують синтаксис CEL, що починається з обʼєкта (наприклад, "object.metadata.uid"), а не формат fieldSelector ("metadata.uid"). Наразі підтримуються такі шляхи:
|
timeoutSeconds | integer | Час очікування для виклику list/watch. Це обмежує тривалість виклику, незалежно від будь-якої активності чи неактивності. |
Параметри тіла запиту
| Назва | Тип | Опис |
|---|---|---|
body | DeleteOptions |
Відповідь
| Статус | Опис | Відповідь |
|---|---|---|
| 200 | OK | Status |
get Read
HTTP Запит
GET /apis/scheduling.k8s.io/v1/priorityclasses/{name}
Параметри шляху
| Назва | Тип | Опис |
|---|---|---|
name | string | Назва PriorityClass |
Параметри запиту
| Назва | Тип | Опис |
|---|---|---|
pretty | string | Якщо 'true', то вихідні дані форматуються у зручному для читання вигляді. Зазвичай 'false', якщо user-agent не вказує оглядач або командний інструмент для роботи з HTTP (curl та wget). |
Відповідь
| Статус | Опис | Відповідь |
|---|---|---|
| 200 | OK | PriorityClass |
get List
HTTP Запит
GET /apis/scheduling.k8s.io/v1/priorityclasses
Параметри запиту
| Назва | Тип | Опис |
|---|---|---|
pretty | string | Якщо 'true', то вихідні дані форматуються у зручному для читання вигляді. Зазвичай 'false', якщо user-agent не вказує оглядач або командний інструмент для роботи з HTTP (curl та wget). |
allowWatchBookmarks | boolean | allowWatchBookmarks запитує події спостереження з типом "BOOKMARK". Сервери, які не реалізують закладки, можуть ігнорувати цей прапорець, а закладки надсилаються на розсуд сервера. Клієнти не повинні припускати, що закладки повертаються через певний інтервал, і не можуть припускати, що сервер надішле будь-яку подію BOOKMARK під час сеансу. Якщо це не спостереження, це поле ігнорується. |
continue | string | Опція continue повинна бути встановлена при отриманні додаткових результатів від сервера. Оскільки це значення визначається сервером, клієнти можуть використовувати значення continue лише з попереднього результату запиту з ідентичними параметрами запиту (крім значення continue), і сервер може відхилити значення continue, яке він не розпізнає. Якщо вказане значення continue більше не дійсне через закінчення терміну дії (зазвичай пʼять-пʼятнадцять хвилин) або зміну конфігурації на сервері, сервер відповість помилкою 410 ResourceExpired разом з токеном continue. Якщо клієнту потрібен послідовний список, він повинен перезапустити свій список без поля continue. В іншому випадку клієнт може надіслати ще один запит списку з токеном, отриманим з помилкою 410, сервер відповість списком, починаючи з наступного ключа, але з останнього знімка, що не відповідає попереднім результатам списку — обʼєкти, які були створені, змінені або видалені після першого запиту списку, будуть включені у відповідь, якщо їх ключі йдуть після "наступного ключа". Це поле не підтримується, коли watch встановлено в true. Клієнти можуть почати спостереження з останнього значення resourceVersion, повернутого сервером, і не пропустити жодних змін. |
fieldSelector | string | Селектор для обмеження списку обʼєктів, що повертаються, за їхніми полями. Зазвичай повертаються всі обʼєкти. |
labelSelector | string | Селектор для обмеження списку обʼєктів, що повертаються, за їхніми мітками. Зазвичай повертаються всі обʼєкти. |
limit | integer | limit є максимальним числом відповідей, які потрібно повернути для виклику списку. Якщо існує більше елементів, сервер встановить поле continue у метаданих списку на значення, яке можна використовувати з тим самим початковим запитом для отримання наступного набору результатів. Встановлення обмеження може повернути менше, ніж запитана кількість елементів (до нуля елементів) у випадку, якщо всі запитані обʼєкти відфільтровані, і клієнти повинні використовувати лише наявність поля continue, щоб визначити, чи доступні додаткові результати. Сервери можуть вирішити не підтримувати аргумент limit і повернуть усі доступні результати. Якщо limit вказано, а поле continue порожнє, клієнти можуть припустити, що результатів більше немає. Це поле не підтримується, якщо watch дорівнює true. Сервер гарантує, що обʼєкти, повернені при використанні continue, будуть ідентичні до виконання одного виклику списку без обмеження — тобто жодні обʼєкти, створені, змінені або видалені після першого запиту, не будуть включені в будь-які наступні продовжені запити. Це іноді називають послідовним знімком, і забезпечує, що клієнт, який використовує limit для отримання менших частин дуже великого результату, може бути впевнений, що він бачить усі можливі обʼєкти. Якщо обʼєкти оновлюються під час отримання часткового списку, повертається версія обʼєкта, яка була присутня на момент обчислення першого результату списку. |
resourceVersion | string | resourceVersion встановлює обмеження на те, з яких версій ресурсів може обслуговуватися запит. Див. https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions для деталей. Стандартне значення не встановлено |
resourceVersionMatch | string | resourceVersionMatch визначає, як resourceVersion застосовується до викликів списку. Рекомендується встановлювати resourceVersionMatch для викликів списку, де встановлено resourceVersion. Див. https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions для деталей. Стандартне значення не встановлено |
sendInitialEvents | boolean | sendInitialEvents=true може бути встановлено разом з watch=true. У цьому випадку потік спостереження почнеться з синтетичних подій для відтворення поточного стану обʼєктів у колекції. Після надсилання всіх таких подій буде надіслано синтетичну подію "Bookmark". Закладка повідомить ResourceVersion (RV), що відповідає набору обʼєктів, і буде позначена анотацією "k8s.io/initial-events-end": "true". Після цього потік спостереження продовжиться як зазвичай, надсилаючи події спостереження, що відповідають змінам (після RV) для спостережуваних обʼєктів. Коли встановлено опцію sendInitialEvents, ми вимагаємо також встановлення опції resourceVersionMatch. Семантика запиту спостереження наступна:
|
shardSelector | string | shardSelector обмежує список обʼєктів, що повертаються, за допомогою виразу вибору шардів на основі CEL. Формат використовує функцію shardRange() у поєднанні з || (логічне АБО) для вказівки одного або кількох діапазонів хешів: shardRange(object.metadata.uid, '0x0', '0x8000000000000000') shardRange(object.metadata.uid, '0x0', '0x8000000000000000') || shardRange(object.metadata.uid, '0x8000000000000000', '0x10000000000000000') Шляхи полів використовують синтаксис CEL, що починається з обʼєкта (наприклад, "object.metadata.uid"), а не формат fieldSelector ("metadata.uid"). Наразі підтримуються такі шляхи:
|
timeoutSeconds | integer | Час очікування для виклику list/watch. Це обмежує тривалість виклику, незалежно від будь-якої активності чи неактивності. |
watch | boolean | Спостерігати за змінами описаних ресурсів і повертати їх як потік сповіщень про додавання, оновлення та видалення. Вкажіть resourceVersion. |
Відповідь
| Статус | Опис | Відповідь |
|---|---|---|
| 200 | OK | PriorityClassList |
get Watch
HTTP Запит
GET /apis/scheduling.k8s.io/v1/watch/priorityclasses/{name}
Параметри шляху
| Назва | Тип | Опис |
|---|---|---|
name | string | Назва PriorityClass |
Параметри запиту
| Назва | Тип | Опис |
|---|---|---|
allowWatchBookmarks | boolean | allowWatchBookmarks запитує події спостереження з типом "BOOKMARK". Сервери, які не реалізують закладки, можуть ігнорувати цей прапорець, а закладки надсилаються на розсуд сервера. Клієнти не повинні припускати, що закладки повертаються через певний інтервал, і не можуть припускати, що сервер надішле будь-яку подію BOOKMARK під час сеансу. Якщо це не спостереження, це поле ігнорується. |
continue | string | Опція continue повинна бути встановлена при отриманні додаткових результатів від сервера. Оскільки це значення визначається сервером, клієнти можуть використовувати значення continue лише з попереднього результату запиту з ідентичними параметрами запиту (крім значення continue), і сервер може відхилити значення continue, яке він не розпізнає. Якщо вказане значення continue більше не дійсне через закінчення терміну дії (зазвичай пʼять-пʼятнадцять хвилин) або зміну конфігурації на сервері, сервер відповість помилкою 410 ResourceExpired разом з токеном continue. Якщо клієнту потрібен послідовний список, він повинен перезапустити свій список без поля continue. В іншому випадку клієнт може надіслати ще один запит списку з токеном, отриманим з помилкою 410, сервер відповість списком, починаючи з наступного ключа, але з останнього знімка, що не відповідає попереднім результатам списку — обʼєкти, які були створені, змінені або видалені після першого запиту списку, будуть включені у відповідь, якщо їх ключі йдуть після "наступного ключа". Це поле не підтримується, коли watch встановлено в true. Клієнти можуть почати спостереження з останнього значення resourceVersion, повернутого сервером, і не пропустити жодних змін. |
fieldSelector | string | Селектор для обмеження списку обʼєктів, що повертаються, за їхніми полями. Зазвичай повертаються всі обʼєкти. |
labelSelector | string | Селектор для обмеження списку обʼєктів, що повертаються, за їхніми мітками. Зазвичай повертаються всі обʼєкти. |
limit | integer | limit є максимальним числом відповідей, які потрібно повернути для виклику списку. Якщо існує більше елементів, сервер встановить поле continue у метаданих списку на значення, яке можна використовувати з тим самим початковим запитом для отримання наступного набору результатів. Встановлення обмеження може повернути менше, ніж запитана кількість елементів (до нуля елементів) у випадку, якщо всі запитані обʼєкти відфільтровані, і клієнти повинні використовувати лише наявність поля continue, щоб визначити, чи доступні додаткові результати. Сервери можуть вирішити не підтримувати аргумент limit і повернуть усі доступні результати. Якщо limit вказано, а поле continue порожнє, клієнти можуть припустити, що результатів більше немає. Це поле не підтримується, якщо watch дорівнює true. Сервер гарантує, що обʼєкти, повернені при використанні continue, будуть ідентичні до виконання одного виклику списку без обмеження — тобто жодні обʼєкти, створені, змінені або видалені після першого запиту, не будуть включені в будь-які наступні продовжені запити. Це іноді називають послідовним знімком, і забезпечує, що клієнт, який використовує limit для отримання менших частин дуже великого результату, може бути впевнений, що він бачить усі можливі обʼєкти. Якщо обʼєкти оновлюються під час отримання часткового списку, повертається версія обʼєкта, яка була присутня на момент обчислення першого результату списку. |
pretty | string | Якщо 'true', то вихідні дані форматуються у зручному для читання вигляді. Зазвичай 'false', якщо user-agent не вказує оглядач або командний інструмент для роботи з HTTP (curl та wget). |
resourceVersion | string | resourceVersion встановлює обмеження на те, з яких версій ресурсів може обслуговуватися запит. Див. https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions для деталей. Стандартне значення не встановлено |
resourceVersionMatch | string | resourceVersionMatch визначає, як resourceVersion застосовується до викликів списку. Рекомендується встановлювати resourceVersionMatch для викликів списку, де встановлено resourceVersion. Див. https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions для деталей. Стандартне значення не встановлено |
sendInitialEvents | boolean | sendInitialEvents=true може бути встановлено разом з watch=true. У цьому випадку потік спостереження почнеться з синтетичних подій для відтворення поточного стану обʼєктів у колекції. Після надсилання всіх таких подій буде надіслано синтетичну подію "Bookmark". Закладка повідомить ResourceVersion (RV), що відповідає набору обʼєктів, і буде позначена анотацією "k8s.io/initial-events-end": "true". Після цього потік спостереження продовжиться як зазвичай, надсилаючи події спостереження, що відповідають змінам (після RV) для спостережуваних обʼєктів. Коли встановлено опцію sendInitialEvents, ми вимагаємо також встановлення опції resourceVersionMatch. Семантика запиту спостереження наступна:
|
shardSelector | string | shardSelector обмежує список обʼєктів, що повертаються, за допомогою виразу вибору шардів на основі CEL. Формат використовує функцію shardRange() у поєднанні з || (логічне АБО) для вказівки одного або кількох діапазонів хешів: shardRange(object.metadata.uid, '0x0', '0x8000000000000000') shardRange(object.metadata.uid, '0x0', '0x8000000000000000') || shardRange(object.metadata.uid, '0x8000000000000000', '0x10000000000000000') Шляхи полів використовують синтаксис CEL, що починається з обʼєкта (наприклад, "object.metadata.uid"), а не формат fieldSelector ("metadata.uid"). Наразі підтримуються такі шляхи:
|
timeoutSeconds | integer | Час очікування для виклику list/watch. Це обмежує тривалість виклику, незалежно від будь-якої активності чи неактивності. |
watch | boolean | Спостерігати за змінами описаних ресурсів і повертати їх як потік сповіщень про додавання, оновлення та видалення. Вкажіть resourceVersion. |
Відповідь
| Статус | Опис | Відповідь |
|---|---|---|
| 200 | OK | WatchEvent |
get Watch List
HTTP Запит
GET /apis/scheduling.k8s.io/v1/watch/priorityclasses
Параметри запиту
| Назва | Тип | Опис |
|---|---|---|
allowWatchBookmarks | boolean | allowWatchBookmarks запитує події спостереження з типом "BOOKMARK". Сервери, які не реалізують закладки, можуть ігнорувати цей прапорець, а закладки надсилаються на розсуд сервера. Клієнти не повинні припускати, що закладки повертаються через певний інтервал, і не можуть припускати, що сервер надішле будь-яку подію BOOKMARK під час сеансу. Якщо це не спостереження, це поле ігнорується. |
continue | string | Опція continue повинна бути встановлена при отриманні додаткових результатів від сервера. Оскільки це значення визначається сервером, клієнти можуть використовувати значення continue лише з попереднього результату запиту з ідентичними параметрами запиту (крім значення continue), і сервер може відхилити значення continue, яке він не розпізнає. Якщо вказане значення continue більше не дійсне через закінчення терміну дії (зазвичай пʼять-пʼятнадцять хвилин) або зміну конфігурації на сервері, сервер відповість помилкою 410 ResourceExpired разом з токеном continue. Якщо клієнту потрібен послідовний список, він повинен перезапустити свій список без поля continue. В іншому випадку клієнт може надіслати ще один запит списку з токеном, отриманим з помилкою 410, сервер відповість списком, починаючи з наступного ключа, але з останнього знімка, що не відповідає попереднім результатам списку — обʼєкти, які були створені, змінені або видалені після першого запиту списку, будуть включені у відповідь, якщо їх ключі йдуть після "наступного ключа". Це поле не підтримується, коли watch встановлено в true. Клієнти можуть почати спостереження з останнього значення resourceVersion, повернутого сервером, і не пропустити жодних змін. |
fieldSelector | string | Селектор для обмеження списку обʼєктів, що повертаються, за їхніми полями. Зазвичай повертаються всі обʼєкти. |
labelSelector | string | Селектор для обмеження списку обʼєктів, що повертаються, за їхніми мітками. Зазвичай повертаються всі обʼєкти. |
limit | integer | limit є максимальним числом відповідей, які потрібно повернути для виклику списку. Якщо існує більше елементів, сервер встановить поле continue у метаданих списку на значення, яке можна використовувати з тим самим початковим запитом для отримання наступного набору результатів. Встановлення обмеження може повернути менше, ніж запитана кількість елементів (до нуля елементів) у випадку, якщо всі запитані обʼєкти відфільтровані, і клієнти повинні використовувати лише наявність поля continue, щоб визначити, чи доступні додаткові результати. Сервери можуть вирішити не підтримувати аргумент limit і повернуть усі доступні результати. Якщо limit вказано, а поле continue порожнє, клієнти можуть припустити, що результатів більше немає. Це поле не підтримується, якщо watch дорівнює true. Сервер гарантує, що обʼєкти, повернені при використанні continue, будуть ідентичні до виконання одного виклику списку без обмеження — тобто жодні обʼєкти, створені, змінені або видалені після першого запиту, не будуть включені в будь-які наступні продовжені запити. Це іноді називають послідовним знімком, і забезпечує, що клієнт, який використовує limit для отримання менших частин дуже великого результату, може бути впевнений, що він бачить усі можливі обʼєкти. Якщо обʼєкти оновлюються під час отримання часткового списку, повертається версія обʼєкта, яка була присутня на момент обчислення першого результату списку. |
pretty | string | Якщо 'true', то вихідні дані форматуються у зручному для читання вигляді. Зазвичай 'false', якщо user-agent не вказує оглядач або командний інструмент для роботи з HTTP (curl та wget). |
resourceVersion | string | resourceVersion встановлює обмеження на те, з яких версій ресурсів може обслуговуватися запит. Див. https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions для деталей. Стандартне значення не встановлено |
resourceVersionMatch | string | resourceVersionMatch визначає, як resourceVersion застосовується до викликів списку. Рекомендується встановлювати resourceVersionMatch для викликів списку, де встановлено resourceVersion. Див. https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions для деталей. Стандартне значення не встановлено |
sendInitialEvents | boolean | sendInitialEvents=true може бути встановлено разом з watch=true. У цьому випадку потік спостереження почнеться з синтетичних подій для відтворення поточного стану обʼєктів у колекції. Після надсилання всіх таких подій буде надіслано синтетичну подію "Bookmark". Закладка повідомить ResourceVersion (RV), що відповідає набору обʼєктів, і буде позначена анотацією "k8s.io/initial-events-end": "true". Після цього потік спостереження продовжиться як зазвичай, надсилаючи події спостереження, що відповідають змінам (після RV) для спостережуваних обʼєктів. Коли встановлено опцію sendInitialEvents, ми вимагаємо також встановлення опції resourceVersionMatch. Семантика запиту спостереження наступна:
|
shardSelector | string | shardSelector обмежує список обʼєктів, що повертаються, за допомогою виразу вибору шардів на основі CEL. Формат використовує функцію shardRange() у поєднанні з || (логічне АБО) для вказівки одного або кількох діапазонів хешів: shardRange(object.metadata.uid, '0x0', '0x8000000000000000') shardRange(object.metadata.uid, '0x0', '0x8000000000000000') || shardRange(object.metadata.uid, '0x8000000000000000', '0x10000000000000000') Шляхи полів використовують синтаксис CEL, що починається з обʼєкта (наприклад, "object.metadata.uid"), а не формат fieldSelector ("metadata.uid"). Наразі підтримуються такі шляхи:
|
timeoutSeconds | integer | Час очікування для виклику list/watch. Це обмежує тривалість виклику, незалежно від будь-якої активності чи неактивності. |
watch | boolean | Спостерігати за змінами описаних ресурсів і повертати їх як потік сповіщень про додавання, оновлення та видалення. Вкажіть resourceVersion. |
Відповідь
| Статус | Опис | Відповідь |
|---|---|---|
| 200 | OK | WatchEvent |
4 - Workload
Workload дозволяє виражати обмеження планування, які слід використовувати при управлінні життєвим циклом робочих навантажень з точки зору планування, включаючи планування, витіснення, виселення та інші фази. Увімкнення API Workload керується функціональною можливістю GenericWorkload.
apiVersion: scheduling.k8s.io/v1beta1
import "k8s.io/api/scheduling/v1beta1"
Workload
Workload дозволяє виражати обмеження планування, які слід використовувати при управлінні життєвим циклом робочих навантажень з точки зору планування, включаючи планування, витіснення, виселення та інші фази. Увімкнення API Workload керується функціональною можливістю GenericWorkload.
| Поле | Опис |
|---|---|
apiVersionstring | APIVersion визначає версію схеми цього представлення обʼєкта. Сервери повинні конвертувати розпізнані схеми до останнього внутрішнього значення і можуть відхиляти нерозпізнані значення. Детальніше: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources |
kindstring | Kind визначає тип REST-ресурсу, який представляє цей обʼєкт. Сервери можуть визначати це з точки доступу, до якої клієнт надсилає запити. Не може бути оновлено. У CamelCase. Детальніше: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
metadataObjectMeta | Стандартні метадані обʼєкта. Детальніше: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata |
spec *WorkloadSpec | spec визначає бажану поведінку Workload. |
WorkloadSpec
WorkloadSpec визначає бажаний стан Workload.
| Поле | Опис |
|---|---|
compositePodGroupTemplatesCompositePodGroupTemplate array | compositePodGroupTemplates — це список шаблонів CompositePodGroup, що складають Workload. Максимальна кількість шаблонів — 8. Це поле є незмінним. Необхідно встановити рівно одне з: CompositePodGroupTemplates або PodGroupTemplates. Це поле використовується лише тоді, коли ворота функції CompositePodGroup увімкнені. |
controllerRefTypedLocalObjectReference | controllerRef є опцональним посиланням на обʼєкт, який контролює, наприклад, Deployment або Job. Це поле призначене для використання інструментами, такими як CLI, для надання посилання на оригінальне визначення робочого навантаження. Це поле є незмінним. |
podGroupTemplates *PodGroupTemplate array | podGroupTemplates є списком шаблонів, які складають Workload. Максимальна кількість шаблонів — 8. Шаблони не можна додавати або видаляти після створення робочого навантаження. Існуючі шаблони все ще можуть оновлюватися, якщо їхні окремі поля це дозволяють. Необхідно встановити рівно одне з: CompositePodGroupTemplates або PodGroupTemplates. |
WorkloadList
WorkloadList містить список ресурсів Workload.
| Поле | Опис |
|---|---|
apiVersionstring | APIVersion визначає версію схеми цього представлення обʼєкта. Сервери повинні конвертувати розпізнані схеми до останнього внутрішнього значення і можуть відхиляти нерозпізнані значення. Детальніше: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources |
items *Workload array | Items є списком Workloads. |
kindstring | Kind визначає тип REST-ресурсу, який представляє цей обʼєкт. Сервери можуть визначати це з точки доступу, до якої клієнт надсилає запити. Не може бути оновлено. У CamelCase. Детальніше: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
metadataListMeta | metadata — стандартні метадані списку. |
AllCompositeDisruptionMode
AllCompositeDisruptionMode означає, що дочірні елементи CompositePodGroup можуть бути порушені або витіснені лише разом.
CompositeBasicSchedulingPolicy
CompositeBasicSchedulingPolicy вказує, що групи, що належать до складеної групи, повинні плануватися незалежно.
CompositeDisruptionMode
CompositeDisruptionMode визначає, як окремі сутності в складеній групі подів можуть бути порушені. Необхідно встановити тільки один режим.
| Поле | Опис |
|---|---|
allAllCompositeDisruptionMode | all вказує, що всі дочірні групи можуть бути порушені лише разом. |
singleSingleCompositeDisruptionMode | single вказує, що дочірні групи можуть бути порушені незалежно одна від одної. |
CompositeGangSchedulingPolicy
CompositeGangSchedulingPolicy вказує, що групи, що належать до складеної групи, повинні плануватися з використанням семантики «все-або-нічого».
| Поле | Опис |
|---|---|
minGroupCount *integer | minGroupCount — це мінімальна кількість дочірніх груп, які повинні бути доступними для планування або запланованими одночасно, щоб планувальник допустив всю групу. Вона повинна бути додатним цілим числом. |
CompositePodGroupSchedulingConstraints
CompositePodGroupSchedulingConstraints визначає обмеження планування (наприклад, топологію) для CompositePodGroup.
| Поле | Опис |
|---|---|
topologyTopologyConstraint array | topology визначає обмеження топології для складеної групи подів. Наразі можна вказати лише одне обмеження топології. Це може змінитися в майбутньому. |
CompositePodGroupSchedulingPolicy
CompositePodGroupSchedulingPolicy визначає конфігурацію планування для CompositePodGroup. Необхідно встановити рівно одну політику.
| Поле | Опис |
|---|---|
basicCompositeBasicSchedulingPolicy | basic вказує, що групи цієї складеної групи повинні плануватися незалежно. Це поле є незмінним. |
gangCompositeGangSchedulingPolicy | gang вказує, що групи цієї складеної групи повинні плануватися з використанням семантики «все-або-нічого». |
CompositePodGroupTemplate
CompositePodGroupTemplate представляє шаблон для CompositePodGroup з політикою планування.
| Поле | Опис |
|---|---|
compositePodGroupTemplatesCompositePodGroupTemplate array | compositePodGroupTemplates — це список шаблонів для дочірніх CompositePodGroup. Максимальна кількість шаблонів — 8. Щонайменше один запис у CompositePodGroupTemplates аbo PodGroupTemplates повинен бути встановлений. |
disruptionModeCompositeDisruptionMode | disruptionMode визначає режим, у якому вказаний CompositePodGroup може бути порушений. Одне з: Single, All. Це поле є незмінним. |
name *string | name — це унікальний ідентифікатор для CompositePodGroupTemplate у межах Workload. Він повинен бути міткою DNS. Це поле є обовʼязковим. |
podGroupTemplatesPodGroupTemplate array | podGroupTemplates — це список шаблонів для дочірніх PodGroup. Максимальна кількість шаблонів — 8. Щонайменше один запис у CompositePodGroupTemplates аbo PodGroupTemplates повинен бути встановлений. |
preemptionPolicystring | preemptionPolicy — це політика для переривання подів/подгруп з нижчим пріоритетом. Одне з: Never, PreemptLowerPriority. Це поле є незмінним. Це поле доступне лише тоді, коли ворота функції PodGroupPreemptionPolicy увімкнені. Можливі значення перерахування: - `"Never"` означає, що под ніколи не перериває інші поди з нижчим пріоритетом. - `"PreemptLowerPriority"` означає, що под може переривати інші поди з нижчим пріоритетом. |
priorityinteger | priority — це значення пріоритету складених груп подів, створених із цього шаблону. Різні системні компоненти використовують це поле, щоб знайти пріоритет складеної групи подів. Коли контроль допуску пріоритету ввімкнений, він запобігає встановленню цього поля користувачами. Контроль допуску заповнює це поле з PriorityClassName. Чим вище значення, тим вищий пріоритет. Це поле є незмінним. |
priorityClassNamestring | priorityClassName вказує пріоритет, який слід враховувати під час планування складеної групи подів, створеної з цього шаблону. Якщо клас пріоритету не вказано, контроль допуску може встановити його на типовий глобальний клас пріоритету, якщо він існує. В іншому випадку складені групи подів, створені з цього шаблону, матимуть пріоритет, встановлений на нуль. Це поле є незмінним. |
schedulingConstraintsCompositePodGroupSchedulingConstraints | schedulingConstraints визначає необовʼязкові обмеження планування (наприклад, топологію) для цього CompositePodGroupTemplate. Це поле є незмінним. |
schedulingPolicy *CompositePodGroupSchedulingPolicy | schedulingPolicy визначає політику планування для цього шаблону. |
PodGroupTemplate
PodGroupTemplate представляє шаблон для набору подів з політикою планування.
| Поле | Опис |
|---|---|
disruptionModeDisruptionMode | disruptionMode визначає режим, у якому вказаний PodGroup може бути порушений. Одне з: Single, All. Це поле є незмінним. |
name *string | name — це унікальний ідентифікатор для PodGroupTemplate у межах Workload. Він повинен бути міткою DNS. Це поле є незмінним. |
preemptionPolicystring | preemptionPolicy — це політика для переривання подів/подгруп з нижчим пріоритетом. Одне з: Never, PreemptLowerPriority. Це поле є незмінним. Це поле доступне лише тоді, коли ворота функції PodGroupPreemptionPolicy увімкнені. Можливі значення перерахування: - `"Never"` означає, що под ніколи не перериває інші поди з нижчим пріоритетом. - `"PreemptLowerPriority"` означає, що под може переривати інші поди з нижчим пріоритетом. |
priorityinteger | priority — це значення пріоритету груп подів, створених із цього шаблону. Різні системні компоненти використовують це поле, щоб знайти пріоритет групи подів. Чим вище значення, тим вищий пріоритет. Це поле є незмінним. |
priorityClassNamestring | priorityClassName вказує пріоритет, який слід враховувати під час планування групи подів, створеної з цього шаблону. Це поле є незмінним. |
resourceClaimsPodGroupResourceClaim array patch strategy: merge,retainKeys on key name | ResourceClaims визначає, які ResourceClaims можуть бути спільно використані серед Podʼів у групі. Podʼи використовують пристрої, виділені для заявок PodGroup, визначаючи заявку у власному Spec.ResourceClaims, яка точно відповідає заявці PodGroup. Заявка повинна мати однакове імʼя та посилатися на той самий ResourceClaim або ResourceClaimTemplate. Це поле є альфа-рівня і вимагає, щоб функціональна можливість DRAWorkloadResourceClaims була увімкнена. Це поле є незмінним. |
schedulingConstraintsPodGroupSchedulingConstraints | SchedulingConstraints визначає опціональні обмеження планування (наприклад, топологію) для цього PodGroupTemplate. Це поле доступне лише тоді, коли увімкнено функціональну можливість TopologyAwareWorkloadScheduling. |
schedulingPolicy *PodGroupSchedulingPolicy | schedulingPolicy визначає політику планування для цього PodGroupTemplate. |
SingleCompositeDisruptionMode
SingleCompositeDisruptionMode означає, що окремі дочірні елементи CompositePodGroup можуть бути порушені або витіснені незалежно.
Операції
post Create
HTTP Запит
POST /apis/scheduling.k8s.io/v1beta1/namespaces/{namespace}/workloads
Параметри шляху
| Назва | Тип | Опис |
|---|---|---|
namespace | string | Назва обʼєкта та область авторизації, наприклад для команд і проєктів |
Параметри запиту
| Назва | Тип | Опис |
|---|---|---|
pretty | string | Якщо 'true', то вихідні дані форматуються у зручному для читання вигляді. Зазвичай 'false', якщо user-agent не вказує оглядач або командний інструмент для роботи з HTTP (curl та wget). |
dryRun | string | Коли параметр присутній, це вказує, що зміни не повинні зберігатися. Неправильна або нерозпізнана директива dryRun призведе до помилки та припинення обробки запиту. Дійсні значення:
|
fieldManager | string | fieldManager є імʼям, повʼязаним з а́ктором або сутністю, яка вносить ці зміни. Значення повинно бути менше або дорівнювати 128 символам і містити лише друковані символи, як визначено в https://golang.org/pkg/unicode/#IsPrint. |
fieldValidation | string | fieldValidation інструктує сервер, як обробляти обʼєкти в запиті (POST/PUT/PATCH), що містять невідомі або дубльовані поля. Дійсні значення:
|
Параметри тіла запиту
| Назва | Тип | Опис |
|---|---|---|
body | Workload |
Відповідь
| Статус | Опис | Відповідь |
|---|---|---|
| 200 | OK | Workload |
| 201 | Created | Workload |
| 202 | Accepted | Workload |
patch Patch
HTTP Запит
PATCH /apis/scheduling.k8s.io/v1beta1/namespaces/{namespace}/workloads/{name}
Параметри шляху
| Назва | Тип | Опис |
|---|---|---|
name | string | Назва Workload |
namespace | string | Назва обʼєкта та область авторизації, наприклад для команд і проєктів |
Параметри запиту
| Назва | Тип | Опис |
|---|---|---|
pretty | string | Якщо 'true', то вихідні дані форматуються у зручному для читання вигляді. Зазвичай 'false', якщо user-agent не вказує оглядач або командний інструмент для роботи з HTTP (curl та wget). |
dryRun | string | Коли параметр присутній, це вказує, що зміни не повинні зберігатися. Неправильна або нерозпізнана директива dryRun призведе до помилки та припинення обробки запиту. Дійсні значення:
|
fieldManager | string | fieldManager є імʼям, повʼязаним з а́ктором або сутністю, яка вносить ці зміни. Значення повинно бути менше або дорівнювати 128 символам і містити лише друковані символи, як визначено в https://golang.org/pkg/unicode/#IsPrint. Це поле обовʼязкове для запитів apply (application/apply-patch), але необовʼязкове для типів патчів, що не застосовуються (JsonPatch, MergePatch, StrategicMergePatch). |
fieldValidation | string | fieldValidation інструктує сервер, як обробляти обʼєкти в запиті (POST/PUT/PATCH), що містять невідомі або дубльовані поля. Дійсні значення:
|
force | boolean | Force має на меті "примусово" застосовувати запити Apply. Це означає, що користувач повторно отримає конфліктні поля, що належать іншим користувачам. Прапорець Force повинен бути скасований для запитів, що не є патчами apply. |
Параметри тіла запиту
| Назва | Тип | Опис |
|---|---|---|
body | Patch |
Відповідь
| Статус | Опис | Відповідь |
|---|---|---|
| 200 | OK | Workload |
| 201 | Created | Workload |
put Replace
HTTP Запит
PUT /apis/scheduling.k8s.io/v1beta1/namespaces/{namespace}/workloads/{name}
Параметри шляху
| Назва | Тип | Опис |
|---|---|---|
name | string | Назва Workload |
namespace | string | Назва обʼєкта та область авторизації, наприклад для команд і проєктів |
Параметри запиту
| Назва | Тип | Опис |
|---|---|---|
pretty | string | Якщо 'true', то вихідні дані форматуються у зручному для читання вигляді. Зазвичай 'false', якщо user-agent не вказує оглядач або командний інструмент для роботи з HTTP (curl та wget). |
dryRun | string | Коли параметр присутній, це вказує, що зміни не повинні зберігатися. Неправильна або нерозпізнана директива dryRun призведе до помилки та припинення обробки запиту. Дійсні значення:
|
fieldManager | string | fieldManager є імʼям, повʼязаним з а́ктором або сутністю, яка вносить ці зміни. Значення повинно бути менше або дорівнювати 128 символам і містити лише друковані символи, як визначено в https://golang.org/pkg/unicode/#IsPrint. |
fieldValidation | string | fieldValidation інструктує сервер, як обробляти обʼєкти в запиті (POST/PUT/PATCH), що містять невідомі або дубльовані поля. Дійсні значення:
|
Параметри тіла запиту
| Назва | Тип | Опис |
|---|---|---|
body | Workload |
Відповідь
| Статус | Опис | Відповідь |
|---|---|---|
| 200 | OK | Workload |
| 201 | Created | Workload |
delete Delete
HTTP Запит
DELETE /apis/scheduling.k8s.io/v1beta1/namespaces/{namespace}/workloads/{name}
Параметри шляху
| Назва | Тип | Опис |
|---|---|---|
name | string | Назва Workload |
namespace | string | Назва обʼєкта та область авторизації, наприклад для команд і проєктів |
Параметри запиту
| Назва | Тип | Опис |
|---|---|---|
pretty | string | Якщо 'true', то вихідні дані форматуються у зручному для читання вигляді. Зазвичай 'false', якщо user-agent не вказує оглядач або командний інструмент для роботи з HTTP (curl та wget). |
dryRun | string | Коли параметр присутній, це вказує, що зміни не повинні зберігатися. Неправильна або нерозпізнана директива dryRun призведе до помилки та припинення обробки запиту. Дійсні значення:
|
gracePeriodSeconds | integer | Час у секундах перед видаленням обʼєкта. Значення повинно бути невідʼємним цілим числом. Значення нуль вказує на негайне видалення. Якщо це значення відсутнє, буде використано стандартний період очікування для зазначеного типу. Зазвичай використовується значення для конкретного обʼєкта, якщо не вказано. Нуль означає негайне видалення. |
ignoreStoreReadErrorWithClusterBreakingPotential | boolean | Якщо встановлено в true, це призведе до небезпечного видалення ресурсу у випадку, якщо нормальний процес видалення не вдасться через помилку пошкодженого обʼєкта. Ресурс вважається пошкодженим, якщо його не можна успішно отримати з відповідного сховища томущо: a) його дані не можна трансформувати, наприклад, помилка дешифрування, або b) не вдається декодувати в обʼєкт. ПРИМІТКА: небезпечне видалення ігнорує обмеження завершувача, пропускає перевірки передумов і видаляє обʼєкт зі сховища. ПОПЕРЕДЖЕННЯ: це може потенційно порушити роботу кластера, якщо робоче навантаження, повʼязане з ресурсом, що видаляється небезпечно, покладається на нормальний процес видалення. Використовуйте лише якщо ви ДІЙСНО знаєте, що робите. Стандартне значення — false, і користувач повинен явно погодитися на його використання. |
orphanDependents | boolean | Застаріло: будь ласка, використовуйте PropagationPolicy, це поле буде застарілим у версії 1.7. Чи повинні залежні обʼєкти залишатися покинутими. Якщо true/false, завершувач "orphan" буде доданий до/видалений з списку завершувачів обʼєкта. Можна встановити або це поле, або PropagationPolicy, але не обидва. |
propagationPolicy | string | Чи і як буде виконано збір сміття. Можна встановити або це поле, або OrphanDependents, але не обидва. Стандартна політика визначається наявним завершувачем у metadata.finalizers та стандартною політикою для конкретного ресурсу. Допустимі значення: 'Orphan' — залишити залежні обʼєкти покинутими; 'Background' — дозволити збирачу сміття видаляти залежні обʼєкти у фоновому режимі; 'Foreground' — каскадна політика, яка видаляє всі залежні обʼєкти з показом всіх дій. |
Параметри тіла запиту
| Назва | Тип | Опис |
|---|---|---|
body | DeleteOptions |
Відповідь
| Статус | Опис | Відповідь |
|---|---|---|
| 200 | OK | Status |
| 202 | Accepted | Status |
delete Delete Collection
HTTP Запит
DELETE /apis/scheduling.k8s.io/v1beta1/namespaces/{namespace}/workloads
Параметри шляху
| Назва | Тип | Опис |
|---|---|---|
namespace | string | Назва обʼєкта та область авторизації, наприклад для команд і проєктів |
Параметри запиту
| Назва | Тип | Опис |
|---|---|---|
pretty | string | Якщо 'true', то вихідні дані форматуються у зручному для читання вигляді. Зазвичай 'false', якщо user-agent не вказує оглядач або командний інструмент для роботи з HTTP (curl та wget). |
continue | string | Опція continue повинна бути встановлена при отриманні додаткових результатів від сервера. Оскільки це значення визначається сервером, клієнти можуть використовувати значення continue лише з попереднього результату запиту з ідентичними параметрами запиту (крім значення continue), і сервер може відхилити значення continue, яке він не розпізнає. Якщо вказане значення continue більше не дійсне через закінчення терміну дії (зазвичай пʼять-пʼятнадцять хвилин) або зміну конфігурації на сервері, сервер відповість помилкою 410 ResourceExpired разом з токеном continue. Якщо клієнту потрібен послідовний список, він повинен перезапустити свій список без поля continue. В іншому випадку клієнт може надіслати ще один запит списку з токеном, отриманим з помилкою 410, сервер відповість списком, починаючи з наступного ключа, але з останнього знімка, що не відповідає попереднім результатам списку — обʼєкти, які були створені, змінені або видалені після першого запиту списку, будуть включені у відповідь, якщо їх ключі йдуть після "наступного ключа". Це поле не підтримується, коли watch встановлено в true. Клієнти можуть почати спостереження з останнього значення resourceVersion, повернутого сервером, і не пропустити жодних змін. |
dryRun | string | Коли параметр присутній, це вказує, що зміни не повинні зберігатися. Неправильна або нерозпізнана директива dryRun призведе до помилки та припинення обробки запиту. Дійсні значення:
|
fieldSelector | string | Селектор для обмеження списку обʼєктів, що повертаються, за їхніми полями. Зазвичай повертаються всі обʼєкти. |
gracePeriodSeconds | integer | Час у секундах перед видаленням обʼєкта. Значення повинно бути невідʼємним цілим числом. Значення нуль вказує на негайне видалення. Якщо це значення відсутнє, буде використано стандартний період очікування для зазначеного типу. Зазвичай використовується значення для конкретного обʼєкта, якщо не вказано. Нуль означає негайне видалення. |
ignoreStoreReadErrorWithClusterBreakingPotential | boolean | Якщо встановлено в true, це призведе до небезпечного видалення ресурсу у випадку, якщо нормальний процес видалення не вдасться через помилку пошкодженого обʼєкта. Ресурс вважається пошкодженим, якщо його не можна успішно отримати з відповідного сховища томущо: a) його дані не можна трансформувати, наприклад, помилка дешифрування, або b) не вдається декодувати в обʼєкт. ПРИМІТКА: небезпечне видалення ігнорує обмеження завершувача, пропускає перевірки передумов і видаляє обʼєкт зі сховища. ПОПЕРЕДЖЕННЯ: це може потенційно порушити роботу кластера, якщо робоче навантаження, повʼязане з ресурсом, що видаляється небезпечно, покладається на нормальний процес видалення. Використовуйте лише якщо ви ДІЙСНО знаєте, що робите. Стандартне значення — false, і користувач повинен явно погодитися на його використання. |
labelSelector | string | Селектор для обмеження списку обʼєктів, що повертаються, за їхніми мітками. Зазвичай повертаються всі обʼєкти. |
limit | integer | limit є максимальним числом відповідей, які потрібно повернути для виклику списку. Якщо існує більше елементів, сервер встановить поле continue у метаданих списку на значення, яке можна використовувати з тим самим початковим запитом для отримання наступного набору результатів. Встановлення обмеження може повернути менше, ніж запитана кількість елементів (до нуля елементів) у випадку, якщо всі запитані обʼєкти відфільтровані, і клієнти повинні використовувати лише наявність поля continue, щоб визначити, чи доступні додаткові результати. Сервери можуть вирішити не підтримувати аргумент limit і повернуть усі доступні результати. Якщо limit вказано, а поле continue порожнє, клієнти можуть припустити, що результатів більше немає. Це поле не підтримується, якщо watch дорівнює true. Сервер гарантує, що обʼєкти, повернені при використанні continue, будуть ідентичні до виконання одного виклику списку без обмеження — тобто жодні обʼєкти, створені, змінені або видалені після першого запиту, не будуть включені в будь-які наступні продовжені запити. Це іноді називають послідовним знімком, і забезпечує, що клієнт, який використовує limit для отримання менших частин дуже великого результату, може бути впевнений, що він бачить усі можливі обʼєкти. Якщо обʼєкти оновлюються під час отримання часткового списку, повертається версія обʼєкта, яка була присутня на момент обчислення першого результату списку. |
orphanDependents | boolean | Застаріло: будь ласка, використовуйте PropagationPolicy, це поле буде застарілим у версії 1.7. Чи повинні залежні обʼєкти залишатися покинутими. Якщо true/false, завершувач "orphan" буде доданий до/видалений з списку завершувачів обʼєкта. Можна встановити або це поле, або PropagationPolicy, але не обидва. |
propagationPolicy | string | Чи і як буде виконано збір сміття. Можна встановити або це поле, або OrphanDependents, але не обидва. Стандартна політика визначається наявним завершувачем у metadata.finalizers та стандартною політикою для конкретного ресурсу. Допустимі значення: 'Orphan' — залишити залежні обʼєкти покинутими; 'Background' — дозволити збирачу сміття видаляти залежні обʼєкти у фоновому режимі; 'Foreground' — каскадна політика, яка видаляє всі залежні обʼєкти з показом всіх дій. |
resourceVersion | string | resourceVersion встановлює обмеження на те, з яких версій ресурсів може обслуговуватися запит. Див. https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions для деталей. Стандартне значення не встановлено |
resourceVersionMatch | string | resourceVersionMatch визначає, як resourceVersion застосовується до викликів списку. Рекомендується встановлювати resourceVersionMatch для викликів списку, де встановлено resourceVersion. Див. https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions для деталей. Стандартне значення не встановлено |
sendInitialEvents | boolean | sendInitialEvents=true може бути встановлено разом з watch=true. У цьому випадку потік спостереження почнеться з синтетичних подій для відтворення поточного стану обʼєктів у колекції. Після надсилання всіх таких подій буде надіслано синтетичну подію "Bookmark". Закладка повідомить ResourceVersion (RV), що відповідає набору обʼєктів, і буде позначена анотацією "k8s.io/initial-events-end": "true". Після цього потік спостереження продовжиться як зазвичай, надсилаючи події спостереження, що відповідають змінам (після RV) для спостережуваних обʼєктів. Коли встановлено опцію sendInitialEvents, ми вимагаємо також встановлення опції resourceVersionMatch. Семантика запиту спостереження наступна:
|
shardSelector | string | shardSelector обмежує список обʼєктів, що повертаються, за допомогою виразу вибору шардів на основі CEL. Формат використовує функцію shardRange() у поєднанні з || (логічне АБО) для вказівки одного або кількох діапазонів хешів: shardRange(object.metadata.uid, '0x0', '0x8000000000000000') shardRange(object.metadata.uid, '0x0', '0x8000000000000000') || shardRange(object.metadata.uid, '0x8000000000000000', '0x10000000000000000') Шляхи полів використовують синтаксис CEL, що починається з обʼєкта (наприклад, "object.metadata.uid"), а не формат fieldSelector ("metadata.uid"). Наразі підтримуються такі шляхи:
|
timeoutSeconds | integer | Час очікування для виклику list/watch. Це обмежує тривалість виклику, незалежно від будь-якої активності чи неактивності. |
Параметри тіла запиту
| Назва | Тип | Опис |
|---|---|---|
body | DeleteOptions |
Відповідь
| Статус | Опис | Відповідь |
|---|---|---|
| 200 | OK | Status |
get Read
HTTP Запит
GET /apis/scheduling.k8s.io/v1beta1/namespaces/{namespace}/workloads/{name}
Параметри шляху
| Назва | Тип | Опис |
|---|---|---|
name | string | Назва Workload |
namespace | string | Назва обʼєкта та область авторизації, наприклад для команд і проєктів |
Параметри запиту
| Назва | Тип | Опис |
|---|---|---|
pretty | string | Якщо 'true', то вихідні дані форматуються у зручному для читання вигляді. Зазвичай 'false', якщо user-agent не вказує оглядач або командний інструмент для роботи з HTTP (curl та wget). |
Відповідь
| Статус | Опис | Відповідь |
|---|---|---|
| 200 | OK | Workload |
get List
HTTP Запит
GET /apis/scheduling.k8s.io/v1beta1/namespaces/{namespace}/workloads
Параметри шляху
| Назва | Тип | Опис |
|---|---|---|
namespace | string | Назва обʼєкта та область авторизації, наприклад для команд і проєктів |
Параметри запиту
| Назва | Тип | Опис |
|---|---|---|
pretty | string | Якщо 'true', то вихідні дані форматуються у зручному для читання вигляді. Зазвичай 'false', якщо user-agent не вказує оглядач або командний інструмент для роботи з HTTP (curl та wget). |
allowWatchBookmarks | boolean | allowWatchBookmarks запитує події спостереження з типом "BOOKMARK". Сервери, які не реалізують закладки, можуть ігнорувати цей прапорець, а закладки надсилаються на розсуд сервера. Клієнти не повинні припускати, що закладки повертаються через певний інтервал, і не можуть припускати, що сервер надішле будь-яку подію BOOKMARK під час сеансу. Якщо це не спостереження, це поле ігнорується. |
continue | string | Опція continue повинна бути встановлена при отриманні додаткових результатів від сервера. Оскільки це значення визначається сервером, клієнти можуть використовувати значення continue лише з попереднього результату запиту з ідентичними параметрами запиту (крім значення continue), і сервер може відхилити значення continue, яке він не розпізнає. Якщо вказане значення continue більше не дійсне через закінчення терміну дії (зазвичай пʼять-пʼятнадцять хвилин) або зміну конфігурації на сервері, сервер відповість помилкою 410 ResourceExpired разом з токеном continue. Якщо клієнту потрібен послідовний список, він повинен перезапустити свій список без поля continue. В іншому випадку клієнт може надіслати ще один запит списку з токеном, отриманим з помилкою 410, сервер відповість списком, починаючи з наступного ключа, але з останнього знімка, що не відповідає попереднім результатам списку — обʼєкти, які були створені, змінені або видалені після першого запиту списку, будуть включені у відповідь, якщо їх ключі йдуть після "наступного ключа". Це поле не підтримується, коли watch встановлено в true. Клієнти можуть почати спостереження з останнього значення resourceVersion, повернутого сервером, і не пропустити жодних змін. |
fieldSelector | string | Селектор для обмеження списку обʼєктів, що повертаються, за їхніми полями. Зазвичай повертаються всі обʼєкти. |
labelSelector | string | Селектор для обмеження списку обʼєктів, що повертаються, за їхніми мітками. Зазвичай повертаються всі обʼєкти. |
limit | integer | limit є максимальним числом відповідей, які потрібно повернути для виклику списку. Якщо існує більше елементів, сервер встановить поле continue у метаданих списку на значення, яке можна використовувати з тим самим початковим запитом для отримання наступного набору результатів. Встановлення обмеження може повернути менше, ніж запитана кількість елементів (до нуля елементів) у випадку, якщо всі запитані обʼєкти відфільтровані, і клієнти повинні використовувати лише наявність поля continue, щоб визначити, чи доступні додаткові результати. Сервери можуть вирішити не підтримувати аргумент limit і повернуть усі доступні результати. Якщо limit вказано, а поле continue порожнє, клієнти можуть припустити, що результатів більше немає. Це поле не підтримується, якщо watch дорівнює true. Сервер гарантує, що обʼєкти, повернені при використанні continue, будуть ідентичні до виконання одного виклику списку без обмеження — тобто жодні обʼєкти, створені, змінені або видалені після першого запиту, не будуть включені в будь-які наступні продовжені запити. Це іноді називають послідовним знімком, і забезпечує, що клієнт, який використовує limit для отримання менших частин дуже великого результату, може бути впевнений, що він бачить усі можливі обʼєкти. Якщо обʼєкти оновлюються під час отримання часткового списку, повертається версія обʼєкта, яка була присутня на момент обчислення першого результату списку. |
resourceVersion | string | resourceVersion встановлює обмеження на те, з яких версій ресурсів може обслуговуватися запит. Див. https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions для деталей. Стандартне значення не встановлено |
resourceVersionMatch | string | resourceVersionMatch визначає, як resourceVersion застосовується до викликів списку. Рекомендується встановлювати resourceVersionMatch для викликів списку, де встановлено resourceVersion. Див. https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions для деталей. Стандартне значення не встановлено |
sendInitialEvents | boolean | sendInitialEvents=true може бути встановлено разом з watch=true. У цьому випадку потік спостереження почнеться з синтетичних подій для відтворення поточного стану обʼєктів у колекції. Після надсилання всіх таких подій буде надіслано синтетичну подію "Bookmark". Закладка повідомить ResourceVersion (RV), що відповідає набору обʼєктів, і буде позначена анотацією "k8s.io/initial-events-end": "true". Після цього потік спостереження продовжиться як зазвичай, надсилаючи події спостереження, що відповідають змінам (після RV) для спостережуваних обʼєктів. Коли встановлено опцію sendInitialEvents, ми вимагаємо також встановлення опції resourceVersionMatch. Семантика запиту спостереження наступна:
|
shardSelector | string | shardSelector обмежує список обʼєктів, що повертаються, за допомогою виразу вибору шардів на основі CEL. Формат використовує функцію shardRange() у поєднанні з || (логічне АБО) для вказівки одного або кількох діапазонів хешів: shardRange(object.metadata.uid, '0x0', '0x8000000000000000') shardRange(object.metadata.uid, '0x0', '0x8000000000000000') || shardRange(object.metadata.uid, '0x8000000000000000', '0x10000000000000000') Шляхи полів використовують синтаксис CEL, що починається з обʼєкта (наприклад, "object.metadata.uid"), а не формат fieldSelector ("metadata.uid"). Наразі підтримуються такі шляхи:
|
timeoutSeconds | integer | Час очікування для виклику list/watch. Це обмежує тривалість виклику, незалежно від будь-якої активності чи неактивності. |
watch | boolean | Спостерігати за змінами описаних ресурсів і повертати їх як потік сповіщень про додавання, оновлення та видалення. Вкажіть resourceVersion. |
Відповідь
| Статус | Опис | Відповідь |
|---|---|---|
| 200 | OK | WorkloadList |
get List All Namespaces
HTTP Запит
GET /apis/scheduling.k8s.io/v1beta1/workloads
Параметри запиту
| Назва | Тип | Опис |
|---|---|---|
allowWatchBookmarks | boolean | allowWatchBookmarks запитує події спостереження з типом "BOOKMARK". Сервери, які не реалізують закладки, можуть ігнорувати цей прапорець, а закладки надсилаються на розсуд сервера. Клієнти не повинні припускати, що закладки повертаються через певний інтервал, і не можуть припускати, що сервер надішле будь-яку подію BOOKMARK під час сеансу. Якщо це не спостереження, це поле ігнорується. |
continue | string | Опція continue повинна бути встановлена при отриманні додаткових результатів від сервера. Оскільки це значення визначається сервером, клієнти можуть використовувати значення continue лише з попереднього результату запиту з ідентичними параметрами запиту (крім значення continue), і сервер може відхилити значення continue, яке він не розпізнає. Якщо вказане значення continue більше не дійсне через закінчення терміну дії (зазвичай пʼять-пʼятнадцять хвилин) або зміну конфігурації на сервері, сервер відповість помилкою 410 ResourceExpired разом з токеном continue. Якщо клієнту потрібен послідовний список, він повинен перезапустити свій список без поля continue. В іншому випадку клієнт може надіслати ще один запит списку з токеном, отриманим з помилкою 410, сервер відповість списком, починаючи з наступного ключа, але з останнього знімка, що не відповідає попереднім результатам списку — обʼєкти, які були створені, змінені або видалені після першого запиту списку, будуть включені у відповідь, якщо їх ключі йдуть після "наступного ключа". Це поле не підтримується, коли watch встановлено в true. Клієнти можуть почати спостереження з останнього значення resourceVersion, повернутого сервером, і не пропустити жодних змін. |
fieldSelector | string | Селектор для обмеження списку обʼєктів, що повертаються, за їхніми полями. Зазвичай повертаються всі обʼєкти. |
labelSelector | string | Селектор для обмеження списку обʼєктів, що повертаються, за їхніми мітками. Зазвичай повертаються всі обʼєкти. |
limit | integer | limit є максимальним числом відповідей, які потрібно повернути для виклику списку. Якщо існує більше елементів, сервер встановить поле continue у метаданих списку на значення, яке можна використовувати з тим самим початковим запитом для отримання наступного набору результатів. Встановлення обмеження може повернути менше, ніж запитана кількість елементів (до нуля елементів) у випадку, якщо всі запитані обʼєкти відфільтровані, і клієнти повинні використовувати лише наявність поля continue, щоб визначити, чи доступні додаткові результати. Сервери можуть вирішити не підтримувати аргумент limit і повернуть усі доступні результати. Якщо limit вказано, а поле continue порожнє, клієнти можуть припустити, що результатів більше немає. Це поле не підтримується, якщо watch дорівнює true. Сервер гарантує, що обʼєкти, повернені при використанні continue, будуть ідентичні до виконання одного виклику списку без обмеження — тобто жодні обʼєкти, створені, змінені або видалені після першого запиту, не будуть включені в будь-які наступні продовжені запити. Це іноді називають послідовним знімком, і забезпечує, що клієнт, який використовує limit для отримання менших частин дуже великого результату, може бути впевнений, що він бачить усі можливі обʼєкти. Якщо обʼєкти оновлюються під час отримання часткового списку, повертається версія обʼєкта, яка була присутня на момент обчислення першого результату списку. |
pretty | string | Якщо 'true', то вихідні дані форматуються у зручному для читання вигляді. Зазвичай 'false', якщо user-agent не вказує оглядач або командний інструмент для роботи з HTTP (curl та wget). |
resourceVersion | string | resourceVersion встановлює обмеження на те, з яких версій ресурсів може обслуговуватися запит. Див. https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions для деталей. Стандартне значення не встановлено |
resourceVersionMatch | string | resourceVersionMatch визначає, як resourceVersion застосовується до викликів списку. Рекомендується встановлювати resourceVersionMatch для викликів списку, де встановлено resourceVersion. Див. https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions для деталей. Стандартне значення не встановлено |
sendInitialEvents | boolean | sendInitialEvents=true може бути встановлено разом з watch=true. У цьому випадку потік спостереження почнеться з синтетичних подій для відтворення поточного стану обʼєктів у колекції. Після надсилання всіх таких подій буде надіслано синтетичну подію "Bookmark". Закладка повідомить ResourceVersion (RV), що відповідає набору обʼєктів, і буде позначена анотацією "k8s.io/initial-events-end": "true". Після цього потік спостереження продовжиться як зазвичай, надсилаючи події спостереження, що відповідають змінам (після RV) для спостережуваних обʼєктів. Коли встановлено опцію sendInitialEvents, ми вимагаємо також встановлення опції resourceVersionMatch. Семантика запиту спостереження наступна:
|
shardSelector | string | shardSelector обмежує список обʼєктів, що повертаються, за допомогою виразу вибору шардів на основі CEL. Формат використовує функцію shardRange() у поєднанні з || (логічне АБО) для вказівки одного або кількох діапазонів хешів: shardRange(object.metadata.uid, '0x0', '0x8000000000000000') shardRange(object.metadata.uid, '0x0', '0x8000000000000000') || shardRange(object.metadata.uid, '0x8000000000000000', '0x10000000000000000') Шляхи полів використовують синтаксис CEL, що починається з обʼєкта (наприклад, "object.metadata.uid"), а не формат fieldSelector ("metadata.uid"). Наразі підтримуються такі шляхи:
|
timeoutSeconds | integer | Час очікування для виклику list/watch. Це обмежує тривалість виклику, незалежно від будь-якої активності чи неактивності. |
watch | boolean | Спостерігати за змінами описаних ресурсів і повертати їх як потік сповіщень про додавання, оновлення та видалення. Вкажіть resourceVersion. |
Відповідь
| Статус | Опис | Відповідь |
|---|---|---|
| 200 | OK | WorkloadList |
get Watch
HTTP Запит
GET /apis/scheduling.k8s.io/v1beta1/watch/namespaces/{namespace}/workloads/{name}
Параметри шляху
| Назва | Тип | Опис |
|---|---|---|
name | string | Назва Workload |
namespace | string | Назва обʼєкта та область авторизації, наприклад для команд і проєктів |
Параметри запиту
| Назва | Тип | Опис |
|---|---|---|
allowWatchBookmarks | boolean | allowWatchBookmarks запитує події спостереження з типом "BOOKMARK". Сервери, які не реалізують закладки, можуть ігнорувати цей прапорець, а закладки надсилаються на розсуд сервера. Клієнти не повинні припускати, що закладки повертаються через певний інтервал, і не можуть припускати, що сервер надішле будь-яку подію BOOKMARK під час сеансу. Якщо це не спостереження, це поле ігнорується. |
continue | string | Опція continue повинна бути встановлена при отриманні додаткових результатів від сервера. Оскільки це значення визначається сервером, клієнти можуть використовувати значення continue лише з попереднього результату запиту з ідентичними параметрами запиту (крім значення continue), і сервер може відхилити значення continue, яке він не розпізнає. Якщо вказане значення continue більше не дійсне через закінчення терміну дії (зазвичай пʼять-пʼятнадцять хвилин) або зміну конфігурації на сервері, сервер відповість помилкою 410 ResourceExpired разом з токеном continue. Якщо клієнту потрібен послідовний список, він повинен перезапустити свій список без поля continue. В іншому випадку клієнт може надіслати ще один запит списку з токеном, отриманим з помилкою 410, сервер відповість списком, починаючи з наступного ключа, але з останнього знімка, що не відповідає попереднім результатам списку — обʼєкти, які були створені, змінені або видалені після першого запиту списку, будуть включені у відповідь, якщо їх ключі йдуть після "наступного ключа". Це поле не підтримується, коли watch встановлено в true. Клієнти можуть почати спостереження з останнього значення resourceVersion, повернутого сервером, і не пропустити жодних змін. |
fieldSelector | string | Селектор для обмеження списку обʼєктів, що повертаються, за їхніми полями. Зазвичай повертаються всі обʼєкти. |
labelSelector | string | Селектор для обмеження списку обʼєктів, що повертаються, за їхніми мітками. Зазвичай повертаються всі обʼєкти. |
limit | integer | limit є максимальним числом відповідей, які потрібно повернути для виклику списку. Якщо існує більше елементів, сервер встановить поле continue у метаданих списку на значення, яке можна використовувати з тим самим початковим запитом для отримання наступного набору результатів. Встановлення обмеження може повернути менше, ніж запитана кількість елементів (до нуля елементів) у випадку, якщо всі запитані обʼєкти відфільтровані, і клієнти повинні використовувати лише наявність поля continue, щоб визначити, чи доступні додаткові результати. Сервери можуть вирішити не підтримувати аргумент limit і повернуть усі доступні результати. Якщо limit вказано, а поле continue порожнє, клієнти можуть припустити, що результатів більше немає. Це поле не підтримується, якщо watch дорівнює true. Сервер гарантує, що обʼєкти, повернені при використанні continue, будуть ідентичні до виконання одного виклику списку без обмеження — тобто жодні обʼєкти, створені, змінені або видалені після першого запиту, не будуть включені в будь-які наступні продовжені запити. Це іноді називають послідовним знімком, і забезпечує, що клієнт, який використовує limit для отримання менших частин дуже великого результату, може бути впевнений, що він бачить усі можливі обʼєкти. Якщо обʼєкти оновлюються під час отримання часткового списку, повертається версія обʼєкта, яка була присутня на момент обчислення першого результату списку. |
pretty | string | Якщо 'true', то вихідні дані форматуються у зручному для читання вигляді. Зазвичай 'false', якщо user-agent не вказує оглядач або командний інструмент для роботи з HTTP (curl та wget). |
resourceVersion | string | resourceVersion встановлює обмеження на те, з яких версій ресурсів може обслуговуватися запит. Див. https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions для деталей. Стандартне значення не встановлено |
resourceVersionMatch | string | resourceVersionMatch визначає, як resourceVersion застосовується до викликів списку. Рекомендується встановлювати resourceVersionMatch для викликів списку, де встановлено resourceVersion. Див. https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions для деталей. Стандартне значення не встановлено |
sendInitialEvents | boolean | sendInitialEvents=true може бути встановлено разом з watch=true. У цьому випадку потік спостереження почнеться з синтетичних подій для відтворення поточного стану обʼєктів у колекції. Після надсилання всіх таких подій буде надіслано синтетичну подію "Bookmark". Закладка повідомить ResourceVersion (RV), що відповідає набору обʼєктів, і буде позначена анотацією "k8s.io/initial-events-end": "true". Після цього потік спостереження продовжиться як зазвичай, надсилаючи події спостереження, що відповідають змінам (після RV) для спостережуваних обʼєктів. Коли встановлено опцію sendInitialEvents, ми вимагаємо також встановлення опції resourceVersionMatch. Семантика запиту спостереження наступна:
|
shardSelector | string | shardSelector обмежує список обʼєктів, що повертаються, за допомогою виразу вибору шардів на основі CEL. Формат використовує функцію shardRange() у поєднанні з || (логічне АБО) для вказівки одного або кількох діапазонів хешів: shardRange(object.metadata.uid, '0x0', '0x8000000000000000') shardRange(object.metadata.uid, '0x0', '0x8000000000000000') || shardRange(object.metadata.uid, '0x8000000000000000', '0x10000000000000000') Шляхи полів використовують синтаксис CEL, що починається з обʼєкта (наприклад, "object.metadata.uid"), а не формат fieldSelector ("metadata.uid"). Наразі підтримуються такі шляхи:
|
timeoutSeconds | integer | Час очікування для виклику list/watch. Це обмежує тривалість виклику, незалежно від будь-якої активності чи неактивності. |
watch | boolean | Спостерігати за змінами описаних ресурсів і повертати їх як потік сповіщень про додавання, оновлення та видалення. Вкажіть resourceVersion. |
Відповідь
| Статус | Опис | Відповідь |
|---|---|---|
| 200 | OK | WatchEvent |
get Watch List
HTTP Запит
GET /apis/scheduling.k8s.io/v1beta1/watch/namespaces/{namespace}/workloads
Параметри шляху
| Назва | Тип | Опис |
|---|---|---|
namespace | string | Назва обʼєкта та область авторизації, наприклад для команд і проєктів |
Параметри запиту
| Назва | Тип | Опис |
|---|---|---|
allowWatchBookmarks | boolean | allowWatchBookmarks запитує події спостереження з типом "BOOKMARK". Сервери, які не реалізують закладки, можуть ігнорувати цей прапорець, а закладки надсилаються на розсуд сервера. Клієнти не повинні припускати, що закладки повертаються через певний інтервал, і не можуть припускати, що сервер надішле будь-яку подію BOOKMARK під час сеансу. Якщо це не спостереження, це поле ігнорується. |
continue | string | Опція continue повинна бути встановлена при отриманні додаткових результатів від сервера. Оскільки це значення визначається сервером, клієнти можуть використовувати значення continue лише з попереднього результату запиту з ідентичними параметрами запиту (крім значення continue), і сервер може відхилити значення continue, яке він не розпізнає. Якщо вказане значення continue більше не дійсне через закінчення терміну дії (зазвичай пʼять-пʼятнадцять хвилин) або зміну конфігурації на сервері, сервер відповість помилкою 410 ResourceExpired разом з токеном continue. Якщо клієнту потрібен послідовний список, він повинен перезапустити свій список без поля continue. В іншому випадку клієнт може надіслати ще один запит списку з токеном, отриманим з помилкою 410, сервер відповість списком, починаючи з наступного ключа, але з останнього знімка, що не відповідає попереднім результатам списку — обʼєкти, які були створені, змінені або видалені після першого запиту списку, будуть включені у відповідь, якщо їх ключі йдуть після "наступного ключа". Це поле не підтримується, коли watch встановлено в true. Клієнти можуть почати спостереження з останнього значення resourceVersion, повернутого сервером, і не пропустити жодних змін. |
fieldSelector | string | Селектор для обмеження списку обʼєктів, що повертаються, за їхніми полями. Зазвичай повертаються всі обʼєкти. |
labelSelector | string | Селектор для обмеження списку обʼєктів, що повертаються, за їхніми мітками. Зазвичай повертаються всі обʼєкти. |
limit | integer | limit є максимальним числом відповідей, які потрібно повернути для виклику списку. Якщо існує більше елементів, сервер встановить поле continue у метаданих списку на значення, яке можна використовувати з тим самим початковим запитом для отримання наступного набору результатів. Встановлення обмеження може повернути менше, ніж запитана кількість елементів (до нуля елементів) у випадку, якщо всі запитані обʼєкти відфільтровані, і клієнти повинні використовувати лише наявність поля continue, щоб визначити, чи доступні додаткові результати. Сервери можуть вирішити не підтримувати аргумент limit і повернуть усі доступні результати. Якщо limit вказано, а поле continue порожнє, клієнти можуть припустити, що результатів більше немає. Це поле не підтримується, якщо watch дорівнює true. Сервер гарантує, що обʼєкти, повернені при використанні continue, будуть ідентичні до виконання одного виклику списку без обмеження — тобто жодні обʼєкти, створені, змінені або видалені після першого запиту, не будуть включені в будь-які наступні продовжені запити. Це іноді називають послідовним знімком, і забезпечує, що клієнт, який використовує limit для отримання менших частин дуже великого результату, може бути впевнений, що він бачить усі можливі обʼєкти. Якщо обʼєкти оновлюються під час отримання часткового списку, повертається версія обʼєкта, яка була присутня на момент обчислення першого результату списку. |
pretty | string | Якщо 'true', то вихідні дані форматуються у зручному для читання вигляді. Зазвичай 'false', якщо user-agent не вказує оглядач або командний інструмент для роботи з HTTP (curl та wget). |
resourceVersion | string | resourceVersion встановлює обмеження на те, з яких версій ресурсів може обслуговуватися запит. Див. https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions для деталей. Стандартне значення не встановлено |
resourceVersionMatch | string | resourceVersionMatch визначає, як resourceVersion застосовується до викликів списку. Рекомендується встановлювати resourceVersionMatch для викликів списку, де встановлено resourceVersion. Див. https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions для деталей. Стандартне значення не встановлено |
sendInitialEvents | boolean | sendInitialEvents=true може бути встановлено разом з watch=true. У цьому випадку потік спостереження почнеться з синтетичних подій для відтворення поточного стану обʼєктів у колекції. Після надсилання всіх таких подій буде надіслано синтетичну подію "Bookmark". Закладка повідомить ResourceVersion (RV), що відповідає набору обʼєктів, і буде позначена анотацією "k8s.io/initial-events-end": "true". Після цього потік спостереження продовжиться як зазвичай, надсилаючи події спостереження, що відповідають змінам (після RV) для спостережуваних обʼєктів. Коли встановлено опцію sendInitialEvents, ми вимагаємо також встановлення опції resourceVersionMatch. Семантика запиту спостереження наступна:
|
shardSelector | string | shardSelector обмежує список обʼєктів, що повертаються, за допомогою виразу вибору шардів на основі CEL. Формат використовує функцію shardRange() у поєднанні з || (логічне АБО) для вказівки одного або кількох діапазонів хешів: shardRange(object.metadata.uid, '0x0', '0x8000000000000000') shardRange(object.metadata.uid, '0x0', '0x8000000000000000') || shardRange(object.metadata.uid, '0x8000000000000000', '0x10000000000000000') Шляхи полів використовують синтаксис CEL, що починається з обʼєкта (наприклад, "object.metadata.uid"), а не формат fieldSelector ("metadata.uid"). Наразі підтримуються такі шляхи:
|
timeoutSeconds | integer | Час очікування для виклику list/watch. Це обмежує тривалість виклику, незалежно від будь-якої активності чи неактивності. |
watch | boolean | Спостерігати за змінами описаних ресурсів і повертати їх як потік сповіщень про додавання, оновлення та видалення. Вкажіть resourceVersion. |
Відповідь
| Статус | Опис | Відповідь |
|---|---|---|
| 200 | OK | WatchEvent |
get Watch List All Namespaces
HTTP Запит
GET /apis/scheduling.k8s.io/v1beta1/watch/workloads
Параметри запиту
| Назва | Тип | Опис |
|---|---|---|
allowWatchBookmarks | boolean | allowWatchBookmarks запитує події спостереження з типом "BOOKMARK". Сервери, які не реалізують закладки, можуть ігнорувати цей прапорець, а закладки надсилаються на розсуд сервера. Клієнти не повинні припускати, що закладки повертаються через певний інтервал, і не можуть припускати, що сервер надішле будь-яку подію BOOKMARK під час сеансу. Якщо це не спостереження, це поле ігнорується. |
continue | string | Опція continue повинна бути встановлена при отриманні додаткових результатів від сервера. Оскільки це значення визначається сервером, клієнти можуть використовувати значення continue лише з попереднього результату запиту з ідентичними параметрами запиту (крім значення continue), і сервер може відхилити значення continue, яке він не розпізнає. Якщо вказане значення continue більше не дійсне через закінчення терміну дії (зазвичай пʼять-пʼятнадцять хвилин) або зміну конфігурації на сервері, сервер відповість помилкою 410 ResourceExpired разом з токеном continue. Якщо клієнту потрібен послідовний список, він повинен перезапустити свій список без поля continue. В іншому випадку клієнт може надіслати ще один запит списку з токеном, отриманим з помилкою 410, сервер відповість списком, починаючи з наступного ключа, але з останнього знімка, що не відповідає попереднім результатам списку — обʼєкти, які були створені, змінені або видалені після першого запиту списку, будуть включені у відповідь, якщо їх ключі йдуть після "наступного ключа". Це поле не підтримується, коли watch встановлено в true. Клієнти можуть почати спостереження з останнього значення resourceVersion, повернутого сервером, і не пропустити жодних змін. |
fieldSelector | string | Селектор для обмеження списку обʼєктів, що повертаються, за їхніми полями. Зазвичай повертаються всі обʼєкти. |
labelSelector | string | Селектор для обмеження списку обʼєктів, що повертаються, за їхніми мітками. Зазвичай повертаються всі обʼєкти. |
limit | integer | limit є максимальним числом відповідей, які потрібно повернути для виклику списку. Якщо існує більше елементів, сервер встановить поле continue у метаданих списку на значення, яке можна використовувати з тим самим початковим запитом для отримання наступного набору результатів. Встановлення обмеження може повернути менше, ніж запитана кількість елементів (до нуля елементів) у випадку, якщо всі запитані обʼєкти відфільтровані, і клієнти повинні використовувати лише наявність поля continue, щоб визначити, чи доступні додаткові результати. Сервери можуть вирішити не підтримувати аргумент limit і повернуть усі доступні результати. Якщо limit вказано, а поле continue порожнє, клієнти можуть припустити, що результатів більше немає. Це поле не підтримується, якщо watch дорівнює true. Сервер гарантує, що обʼєкти, повернені при використанні continue, будуть ідентичні до виконання одного виклику списку без обмеження — тобто жодні обʼєкти, створені, змінені або видалені після першого запиту, не будуть включені в будь-які наступні продовжені запити. Це іноді називають послідовним знімком, і забезпечує, що клієнт, який використовує limit для отримання менших частин дуже великого результату, може бути впевнений, що він бачить усі можливі обʼєкти. Якщо обʼєкти оновлюються під час отримання часткового списку, повертається версія обʼєкта, яка була присутня на момент обчислення першого результату списку. |
pretty | string | Якщо 'true', то вихідні дані форматуються у зручному для читання вигляді. Зазвичай 'false', якщо user-agent не вказує оглядач або командний інструмент для роботи з HTTP (curl та wget). |
resourceVersion | string | resourceVersion встановлює обмеження на те, з яких версій ресурсів може обслуговуватися запит. Див. https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions для деталей. Стандартне значення не встановлено |
resourceVersionMatch | string | resourceVersionMatch визначає, як resourceVersion застосовується до викликів списку. Рекомендується встановлювати resourceVersionMatch для викликів списку, де встановлено resourceVersion. Див. https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions для деталей. Стандартне значення не встановлено |
sendInitialEvents | boolean | sendInitialEvents=true може бути встановлено разом з watch=true. У цьому випадку потік спостереження почнеться з синтетичних подій для відтворення поточного стану обʼєктів у колекції. Після надсилання всіх таких подій буде надіслано синтетичну подію "Bookmark". Закладка повідомить ResourceVersion (RV), що відповідає набору обʼєктів, і буде позначена анотацією "k8s.io/initial-events-end": "true". Після цього потік спостереження продовжиться як зазвичай, надсилаючи події спостереження, що відповідають змінам (після RV) для спостережуваних обʼєктів. Коли встановлено опцію sendInitialEvents, ми вимагаємо також встановлення опції resourceVersionMatch. Семантика запиту спостереження наступна:
|
shardSelector | string | shardSelector обмежує список обʼєктів, що повертаються, за допомогою виразу вибору шардів на основі CEL. Формат використовує функцію shardRange() у поєднанні з || (логічне АБО) для вказівки одного або кількох діапазонів хешів: shardRange(object.metadata.uid, '0x0', '0x8000000000000000') shardRange(object.metadata.uid, '0x0', '0x8000000000000000') || shardRange(object.metadata.uid, '0x8000000000000000', '0x10000000000000000') Шляхи полів використовують синтаксис CEL, що починається з обʼєкта (наприклад, "object.metadata.uid"), а не формат fieldSelector ("metadata.uid"). Наразі підтримуються такі шляхи:
|
timeoutSeconds | integer | Час очікування для виклику list/watch. Це обмежує тривалість виклику, незалежно від будь-якої активності чи неактивності. |
watch | boolean | Спостерігати за змінами описаних ресурсів і повертати їх як потік сповіщень про додавання, оновлення та видалення. Вкажіть resourceVersion. |
Відповідь
| Статус | Опис | Відповідь |
|---|---|---|
| 200 | OK | WatchEvent |