Це багатосторінкова версія цього розділу для друку. Натисніть тут, щоб надрукувати.
Core
- 1: ComponentStatus
- 2: ConfigMap
- 3: Endpoints
- 4: Event
- 5: LimitRange
- 6: Namespace
- 7: Node
- 8: PersistentVolume
- 9: PersistentVolumeClaim
- 10: Pod
- 11: PodTemplate
- 12: ReplicationController
- 13: ResourceQuota
- 14: Secret
- 15: Service
- 16: ServiceAccount
1 - ComponentStatus
apiVersion: v1
import "k8s.io/api/core/v1"
ComponentStatus
ComponentStatus (та ComponentStatusList) містить інформацію про стан кластера. Застаріло: цей API застарів у v1.19+
| Поле | Опис |
|---|---|
apiVersionstring | APIVersion визначає версію схеми цього представлення обʼєкта. Сервери повинні конвертувати розпізнані схеми до останнього внутрішнього значення і можуть відхиляти нерозпізнані значення. Детальніше: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources |
conditionsComponentCondition array patch strategy: merge on key type | Список станів компонента, які спостерігаються |
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 |
ComponentStatusList
Стан усіх станів для компонента у вигляді списку обʼєктів ComponentStatus. Застаріло: цей API застарів у v1.19+
| Поле | Опис |
|---|---|
apiVersionstring | APIVersion визначає версію схеми цього представлення обʼєкта. Сервери повинні конвертувати розпізнані схеми до останнього внутрішнього значення і можуть відхиляти нерозпізнані значення. Детальніше: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources |
items *ComponentStatus array | Список обʼєктів ComponentStatus. |
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#types-kinds |
ComponentCondition
Інформація про стан компонента.
| Поле | Опис |
|---|---|
errorstring | Код помилки стану для компонента. Наприклад, код помилки перевірки стану. |
messagestring | Повідомлення про стан компонента. Наприклад, інформація про перевірку стану. |
status *string | Стан стану для компонента. Дійсні значення для "Healthy": "True", "False" або "Unknown". |
type *string | Тип стану для компонента. Дійсне значення: "Healthy" |
Операції
get Read
HTTP Запит
GET /api/v1/componentstatuses/{name}
Параметри шляху
| Назва | Тип | Опис |
|---|---|---|
name | string | Назва компонента ComponentStatus |
Параметри запиту
| Назва | Тип | Опис |
|---|---|---|
pretty | string | Якщо 'true', то вихідні дані форматуються у зручному для читання вигляді. Зазвичай 'false', якщо user-agent не вказує оглядач або командний інструмент для роботи з HTTP (curl та wget). |
Відповідь
| Статус | Опис | Відповідь |
|---|---|---|
| 200 | OK | ComponentStatus |
get List
HTTP Запит
GET /api/v1/componentstatuses
Параметри запиту
| Назва | Тип | Опис |
|---|---|---|
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 | ComponentStatusList |
2 - ConfigMap
apiVersion: v1
import "k8s.io/api/core/v1"
ConfigMap
ConfigMap містить конфігураційні дані для використання подами.
| Поле | Опис |
|---|---|
apiVersionstring | APIVersion визначає версію схеми цього представлення обʼєкта. Сервери повинні конвертувати розпізнані схеми до останнього внутрішнього значення і можуть відхиляти нерозпізнані значення. Детальніше: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources |
binaryDataobject | BinaryData містить бінарні дані. Кожен ключ повинен складатися з буквено-цифрових символів, '-', '_' або '.'. BinaryData може містити послідовності байтів, які не входять до діапазону UTF-8. Ключі, збережені в BinaryData, не повинні перекриватися з ключами в полі Data, це перевіряється під час процесу валідації. Використання цього поля вимагатиме apiserver і kubelet версії 1.10+. |
dataobject | Data містить конфігураційні дані. Кожен ключ повинен складатися з буквено-цифрових символів, '-', '_' або '.'. Значення з послідовностями байтів, які не входять до діапазону UTF-8, повинні використовувати поле BinaryData. Ключі, збережені в Data, не повинні перекриватися з ключами в полі BinaryData, це перевіряється під час процесу валідації. |
immutableboolean | Immutable, якщо встановлено в true, гарантує, що дані, збережені в ConfigMap, не можуть бути оновлені (можна змінювати лише метадані обʼєкта). Якщо не встановлено в true, поле можна змінювати в будь-який час. Стандартно — nil. |
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 |
ConfigMapList
ConfigMapList містить список обʼєктів ConfigMap.
| Поле | Опис |
|---|---|
apiVersionstring | APIVersion визначає версію схеми цього представлення обʼєкта. Сервери повинні конвертувати розпізнані схеми до останнього внутрішнього значення і можуть відхиляти нерозпізнані значення. Детальніше: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources |
items *ConfigMap array | Items містить список обʼєктів ConfigMap. |
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 /api/v1/namespaces/{namespace}/configmaps
Параметри шляху
| Назва | Тип | Опис |
|---|---|---|
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 | ConfigMap |
Відповідь
| Статус | Опис | Відповідь |
|---|---|---|
| 200 | OK | ConfigMap |
| 201 | Created | ConfigMap |
| 202 | Accepted | ConfigMap |
patch Patch
HTTP Запит
PATCH /api/v1/namespaces/{namespace}/configmaps/{name}
Параметри шляху
| Назва | Тип | Опис |
|---|---|---|
name | string | Назва ConfigMap |
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 | ConfigMap |
| 201 | Created | ConfigMap |
put Replace
HTTP Запит
PUT /api/v1/namespaces/{namespace}/configmaps/{name}
Параметри шляху
| Назва | Тип | Опис |
|---|---|---|
name | string | Назва ConfigMap |
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 | ConfigMap |
Відповідь
| Статус | Опис | Відповідь |
|---|---|---|
| 200 | OK | ConfigMap |
| 201 | Created | ConfigMap |
delete Delete
HTTP Запит
DELETE /api/v1/namespaces/{namespace}/configmaps/{name}
Параметри шляху
| Назва | Тип | Опис |
|---|---|---|
name | string | Назва ConfigMap |
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 /api/v1/namespaces/{namespace}/configmaps
Параметри шляху
| Назва | Тип | Опис |
|---|---|---|
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 /api/v1/namespaces/{namespace}/configmaps/{name}
Параметри шляху
| Назва | Тип | Опис |
|---|---|---|
name | string | Назва ConfigMap |
namespace | string | Назва обʼєкта та область авторизації, наприклад для команд і проєктів |
Параметри запиту
| Назва | Тип | Опис |
|---|---|---|
pretty | string | Якщо 'true', то вихідні дані форматуються у зручному для читання вигляді. Зазвичай 'false', якщо user-agent не вказує оглядач або командний інструмент для роботи з HTTP (curl та wget). |
Відповідь
| Статус | Опис | Відповідь |
|---|---|---|
| 200 | OK | ConfigMap |
get List
HTTP Запит
GET /api/v1/namespaces/{namespace}/configmaps
Параметри шляху
| Назва | Тип | Опис |
|---|---|---|
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 | ConfigMapList |
get List All Namespaces
HTTP Запит
GET /api/v1/configmaps
Параметри запиту
| Назва | Тип | Опис |
|---|---|---|
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 | ConfigMapList |
get Watch
HTTP Запит
GET /api/v1/watch/namespaces/{namespace}/configmaps/{name}
Параметри шляху
| Назва | Тип | Опис |
|---|---|---|
name | string | Назва ConfigMap |
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 /api/v1/watch/namespaces/{namespace}/configmaps
Параметри шляху
| Назва | Тип | Опис |
|---|---|---|
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 /api/v1/watch/configmaps
Параметри запиту
| Назва | Тип | Опис |
|---|---|---|
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 |
3 - Endpoints
Endpoints є колекцією точок доступу, які реалізують фактичний сервіс. Приклад:
Name: "mysvc",
Subsets: [
{
Addresses: [{"ip": "10.10.1.1"}, {"ip": "10.10.2.2"}],
Ports: [{"name": "a", "port": 8675}, {"name": "b", "port": 309}]
},
{
Addresses: [{"ip": "10.10.3.3"}],
Ports: [{"name": "a", "port": 93}, {"name": "b", "port": 76}]
},
]
Endpoints є застарілим API і не містить інформації про всі функції Service. Використовуйте discoveryv1.EndpointSlice для повної інформації про точки доступу Service.
Застаріле: Цей API було визнано застарілим у v1.33+. Використовуйте discoveryv1.EndpointSlice.
apiVersion: v1
import "k8s.io/api/core/v1"
Endpoints
Endpoints є колекцією точок доступу, які реалізують фактичний сервіс. Приклад:
Name: "mysvc",
Subsets: [
{
Addresses: [{"ip": "10.10.1.1"}, {"ip": "10.10.2.2"}],
Ports: [{"name": "a", "port": 8675}, {"name": "b", "port": 309}]
},
{
Addresses: [{"ip": "10.10.3.3"}],
Ports: [{"name": "a", "port": 93}, {"name": "b", "port": 76}]
},
]
Endpoints є застарілим API і не містить інформації про всі функції Service. Використовуйте discoveryv1.EndpointSlice для повної інформації про точки доступу Service.
Deprecated: This API is deprecated in v1.33+. Use discoveryv1.EndpointSlice.
| Поле | Опис |
|---|---|
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 |
subsetsEndpointSubset array | Набір всіх точок доступу є обʼєднанням усіх підмножин. Адреси розміщуються в підмножинах відповідно до IP-адрес, які вони мають спільними. Одна адреса з кількома портами, деякі з яких готові, а деякі ні (оскільки вони походять з різних контейнерів), призведе до того, що адреса буде відображатися в різних підмножинах для різних портів. Жодна адреса не зʼявиться одночасно в Addresses і NotReadyAddresses в одній підмножині. Набори адрес і портів, що складають сервіс. |
EndpointsList
EndpointsList список точок доступу. Застаріле: Цей API було визнано застарілим у v1.33+.
| Поле | Опис |
|---|---|
apiVersionstring | APIVersion визначає версію схеми цього представлення обʼєкта. Сервери повинні конвертувати розпізнані схеми до останнього внутрішнього значення і можуть відхиляти нерозпізнані значення. Детальніше: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources |
items *Endpoints array | Список точок доступу. |
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#types-kinds |
EndpointAddress
EndpointAddress це кортеж, який описує одну IP-адресу. Застаріле: Цей API було визнано застарілим у v1.33+.
| Поле | Опис |
|---|---|
hostnamestring | Імʼя хосту цієї точки доступу |
ip *string | IP-адреса цієї точки доступу. Не може бути loopback (127.0.0.0/8 або ::1), link-local (169.254.0.0/16 або fe80::/10) або link-local multicast (224.0.0.0/24 або ff02::/16). |
nodeNamestring | Опціонально: Вузол, який розміщує цю точку доступу. Це можна використовувати для визначення точок доступу, локальних для вузла. |
targetRefObjectReference | Посилання на обʼєкт, що надає точку доступу. |
EndpointPort
EndpointPort це кортеж, який описує один порт. Застаріле: Цей API було визнано застарілим у v1.33+.
| Поле | Опис |
|---|---|
appProtocolstring | Протокол застосунку для цього порту. Використовується як підказка для реалізацій, щоб запропонувати більш багатий функціонал для протоколів, які вони розуміють. Це поле дотримується стандартного синтаксису міток Kubernetes. Дійсні значення можуть бути:
|
namestring | Імʼя цього порту. Воно повинно збігатися з полем 'name' у відповідному ServicePort. Має бути DNS_LABEL. Опціонально лише якщо визначено один порт. |
port *integer | Номер порту цієї точки доступу. |
protocolstring | IP протокол для цього порту. Має бути UDP, TCP або SCTP. За замовчуванням TCP. Можливі значення enum:
|
EndpointSubset
EndpointSubset це група адрес з спільним набором портів. Розширений набір точок доступу є декартовим добутком Addresses x Ports. Наприклад, якщо задано:
{
"Addresses": [{"ip": "10.10.1.1"}, {"ip": "10.10.2.2"}],
"Ports": [{"name": "a", "port": 8675}, {"name": "b", "port": 309}]
}
Результуючий набір точок доступу можна уявити як:
a: [ 10.10.1.1:8675, 10.10.2.2:8675 ],
b: [ 10.10.1.1:309, 10.10.2.2:309 ]
Застаріле: Цей API було визнано застарілим у v1.33+.
| Поле | Опис |
|---|---|
addressesEndpointAddress array | IP-адреси, які пропонують відповідні порти, позначені як готові. Ці точки доступу слід вважати безпечними для використання балансувальниками навантаження та клієнтами. |
notReadyAddressesEndpointAddress array | IP-адреси, які пропонують відповідні порти, але наразі не позначені як готові, оскільки вони ще не завершили запуск, нещодавно не пройшли перевірку готовності або нещодавно не пройшли перевірку життєздатності. |
portsEndpointPort array | Номери портів, доступні на відповідних IP-адресах. |
Операції
post Create
HTTP Запит
POST /api/v1/namespaces/{namespace}/endpoints
Параметри шляху
| Назва | Тип | Опис |
|---|---|---|
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 | Endpoints |
Відповідь
| Статус | Опис | Відповідь |
|---|---|---|
| 200 | OK | Endpoints |
| 201 | Created | Endpoints |
| 202 | Accepted | Endpoints |
patch Patch
HTTP Запит
PATCH /api/v1/namespaces/{namespace}/endpoints/{name}
Параметри шляху
| Назва | Тип | Опис |
|---|---|---|
name | string | Назва Endpoints |
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 | Endpoints |
| 201 | Created | Endpoints |
put Replace
HTTP Запит
PUT /api/v1/namespaces/{namespace}/endpoints/{name}
Параметри шляху
| Назва | Тип | Опис |
|---|---|---|
name | string | Назва Endpoints |
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 | Endpoints |
Відповідь
| Статус | Опис | Відповідь |
|---|---|---|
| 200 | OK | Endpoints |
| 201 | Created | Endpoints |
delete Delete
HTTP Запит
DELETE /api/v1/namespaces/{namespace}/endpoints/{name}
Параметри шляху
| Назва | Тип | Опис |
|---|---|---|
name | string | Назва Endpoints |
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 /api/v1/namespaces/{namespace}/endpoints
Параметри шляху
| Назва | Тип | Опис |
|---|---|---|
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 /api/v1/namespaces/{namespace}/endpoints/{name}
Параметри шляху
| Назва | Тип | Опис |
|---|---|---|
name | string | Назва Endpoints |
namespace | string | Назва обʼєкта та область авторизації, наприклад для команд і проєктів |
Параметри запиту
| Назва | Тип | Опис |
|---|---|---|
pretty | string | Якщо 'true', то вихідні дані форматуються у зручному для читання вигляді. Зазвичай 'false', якщо user-agent не вказує оглядач або командний інструмент для роботи з HTTP (curl та wget). |
Відповідь
| Статус | Опис | Відповідь |
|---|---|---|
| 200 | OK | Endpoints |
get List
HTTP Запит
GET /api/v1/namespaces/{namespace}/endpoints
Параметри шляху
| Назва | Тип | Опис |
|---|---|---|
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 | EndpointsList |
get List All Namespaces
HTTP Запит
GET /api/v1/endpoints
Параметри запиту
| Назва | Тип | Опис |
|---|---|---|
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 | EndpointsList |
get Watch
HTTP Запит
GET /api/v1/watch/namespaces/{namespace}/endpoints/{name}
Параметри шляху
| Назва | Тип | Опис |
|---|---|---|
name | string | Назва Endpoints |
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 /api/v1/watch/namespaces/{namespace}/endpoints
Параметри шляху
| Назва | Тип | Опис |
|---|---|---|
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 /api/v1/watch/endpoints
Параметри запиту
| Назва | Тип | Опис |
|---|---|---|
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 - Event
apiVersion: v1
import "k8s.io/api/core/v1"
Event
Event є звітом про подію десь у кластері. Події мають обмежений час зберігання, а тригери та повідомлення можуть змінюватися з часом. Споживачі подій не повинні покладатися на час події з певною причиною, що відображає послідовний основний тригер, або на подальше існування подій з цією причиною. Події слід розглядати як інформативні, надані за принципом «максимальних зусиль» та допоміжні дані.
| Поле | Опис |
|---|---|
actionstring | Яку дію було виконано/не вдалося виконати щодо обʼєкта Regarding. |
apiVersionstring | APIVersion визначає версію схеми цього представлення обʼєкта. Сервери повинні конвертувати розпізнані схеми до останнього внутрішнього значення і можуть відхиляти нерозпізнані значення. Детальніше: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources |
countinteger | Кількість разів, коли ця подія відбулася. |
eventTimeMicroTime | Час, коли ця подія була вперше зафіксована. |
firstTimestampTime | Час, коли подія була вперше зафіксована. (Час отримання сервером знаходиться в TypeMeta.) |
involvedObject *ObjectReference | Обʼєкт, до якого відноситься ця подія. |
kindstring | Kind визначає тип REST-ресурсу, який представляє цей обʼєкт. Сервери можуть визначати це з точки доступу, до якої клієнт надсилає запити. Не може бути оновлено. У CamelCase. Детальніше: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
lastTimestampTime | Час, коли остання подія була зафіксована. |
messagestring | Зрозумілий для людини опис статусу цієї операції. |
metadata *ObjectMeta | Метадані стандартного обʼєкта. Детальніше: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata |
reasonstring | Це має бути короткий рядок, придатний для машинного зчитування, який пояснює причину переходу об’єкта до поточного стану. |
relatedObjectReference | Додатковий обʼєкт для більш складних дій. |
reportingComponentstring | Назва контролера, який створив цю подію, наприклад `kubernetes.io/kubelet`. |
reportingInstancestring | ID екземпляра контролера, наприклад `kubelet-xyzf`. |
seriesEventSeries | Дані про серію подій, яку представляє ця подія, або nil, якщо це одиночна подія. |
sourceEventSource | Компонент, який повідомляє про цю подію. Має бути коротким рядком, придатним для машинного зчитування. |
typestring | Тип цієї події (Normal, Warning), нові типи можуть бути додані в майбутньому |
EventList
EventList є списком подій.
| Поле | Опис |
|---|---|
apiVersionstring | APIVersion визначає версію схеми цього представлення обʼєкта. Сервери повинні конвертувати розпізнані схеми до останнього внутрішнього значення і можуть відхиляти нерозпізнані значення. Детальніше: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources |
items *Event array | List of events |
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#types-kinds |
EventSeries
EventSeries містить інформацію про серії подій, тобто про те, що відбувалося або відбувається безперервно протягом певного часу.
| Поле | Опис |
|---|---|
countinteger | Кількість випадків у цій серії до часу останнього сигналу серця |
lastObservedTimeMicroTime | Час останнього зафіксованого випадку |
Операції
post Create
HTTP Запит
POST /api/v1/namespaces/{namespace}/events
Параметри шляху
| Назва | Тип | Опис |
|---|---|---|
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 | Event |
Відповідь
| Статус | Опис | Відповідь |
|---|---|---|
| 200 | OK | Event |
| 201 | Created | Event |
| 202 | Accepted | Event |
patch Patch
HTTP Запит
PATCH /api/v1/namespaces/{namespace}/events/{name}
Параметри шляху
| Назва | Тип | Опис |
|---|---|---|
name | string | Назва Event |
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 | Event |
| 201 | Created | Event |
put Replace
HTTP Запит
PUT /api/v1/namespaces/{namespace}/events/{name}
Параметри шляху
| Назва | Тип | Опис |
|---|---|---|
name | string | Назва Event |
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 | Event |
Відповідь
| Статус | Опис | Відповідь |
|---|---|---|
| 200 | OK | Event |
| 201 | Created | Event |
delete Delete
HTTP Запит
DELETE /api/v1/namespaces/{namespace}/events/{name}
Параметри шляху
| Назва | Тип | Опис |
|---|---|---|
name | string | Назва Event |
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 /api/v1/namespaces/{namespace}/events
Параметри шляху
| Назва | Тип | Опис |
|---|---|---|
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 /api/v1/namespaces/{namespace}/events/{name}
Параметри шляху
| Назва | Тип | Опис |
|---|---|---|
name | string | Назва Event |
namespace | string | Назва обʼєкта та область авторизації, наприклад для команд і проєктів |
Параметри запиту
| Назва | Тип | Опис |
|---|---|---|
pretty | string | Якщо 'true', то вихідні дані форматуються у зручному для читання вигляді. Зазвичай 'false', якщо user-agent не вказує оглядач або командний інструмент для роботи з HTTP (curl та wget). |
Відповідь
| Статус | Опис | Відповідь |
|---|---|---|
| 200 | OK | Event |
get List
HTTP Запит
GET /api/v1/namespaces/{namespace}/events
Параметри шляху
| Назва | Тип | Опис |
|---|---|---|
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 | EventList |
get List All Namespaces
HTTP Запит
GET /api/v1/events
Параметри запиту
| Назва | Тип | Опис |
|---|---|---|
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 | EventList |
get Watch
HTTP Запит
GET /api/v1/watch/namespaces/{namespace}/events/{name}
Параметри шляху
| Назва | Тип | Опис |
|---|---|---|
name | string | Назва Event |
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 /api/v1/watch/namespaces/{namespace}/events
Параметри шляху
| Назва | Тип | Опис |
|---|---|---|
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 /api/v1/watch/events
Параметри запиту
| Назва | Тип | Опис |
|---|---|---|
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 |
5 - LimitRange
apiVersion: v1
import "k8s.io/api/core/v1"
LimitRange
LimitRange встановлює обмеження використання ресурсів для кожного типу ресурсу в Namespace.
| Поле | Опис |
|---|---|
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 |
specLimitRangeSpec | Spec визначає обмеження, що застосовуються. Детальніше: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status |
LimitRangeSpec
LimitRangeSpec визначає мінімальні та максимальні обмеження використання ресурсів для ресурсів, що відповідають певному типу.
| Поле | Опис |
|---|---|
limits *LimitRangeItem array | Limits визначає список обʼєктів LimitRangeItem, які застосовуються. |
LimitRangeList
LimitRangeList є списком обʼєктів LimitRange.
| Поле | Опис |
|---|---|
apiVersionstring | APIVersion визначає версію схеми цього представлення обʼєкта. Сервери повинні конвертувати розпізнані схеми до останнього внутрішнього значення і можуть відхиляти нерозпізнані значення. Детальніше: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources |
items *LimitRange array | Items є списком обʼєктів LimitRange. Детальніше: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ |
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#types-kinds |
LimitRangeItem
LimitRangeItem визначає мінімальні та максимальні обмеження використання ресурсів для ресурсів, що відповідають певному типу.
| Поле | Опис |
|---|---|
defaultobject | Стандартне значення обмеження ресурсів за назвою ресурсу, якщо обмеження ресурсу не вказано. |
defaultRequestobject | Стандартне значення запиту ресурсів за назвою ресурсу, якщо запит ресурсу не вказано. |
maxobject | Максимальні обмеження використання для цього типу за назвою ресурсу. |
maxLimitRequestRatioobject | Якщо вказано MaxLimitRequestRatio, названий ресурс повинен мати запит і ліміт, які обидва не дорівнюють нулю, де ліміт, поділений на запит, менше або дорівнює перерахованому значенню; це представляє максимальний сплеск для названого ресурсу. |
minobject | Мінімальні обмеження використання для цього типу за назвою ресурсу. |
type *string | Тип ресурсу, до якого застосовується це обмеження. |
Операції
post Create
HTTP Запит
POST /api/v1/namespaces/{namespace}/limitranges
Параметри шляху
| Назва | Тип | Опис |
|---|---|---|
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 | LimitRange |
Відповідь
| Статус | Опис | Відповідь |
|---|---|---|
| 200 | OK | LimitRange |
| 201 | Created | LimitRange |
| 202 | Accepted | LimitRange |
patch Patch
HTTP Запит
PATCH /api/v1/namespaces/{namespace}/limitranges/{name}
Параметри шляху
| Назва | Тип | Опис |
|---|---|---|
name | string | Назва LimitRange |
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 | LimitRange |
| 201 | Created | LimitRange |
put Replace
HTTP Запит
PUT /api/v1/namespaces/{namespace}/limitranges/{name}
Параметри шляху
| Назва | Тип | Опис |
|---|---|---|
name | string | Назва LimitRange |
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 | LimitRange |
Відповідь
| Статус | Опис | Відповідь |
|---|---|---|
| 200 | OK | LimitRange |
| 201 | Created | LimitRange |
delete Delete
HTTP Запит
DELETE /api/v1/namespaces/{namespace}/limitranges/{name}
Параметри шляху
| Назва | Тип | Опис |
|---|---|---|
name | string | Назва LimitRange |
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 /api/v1/namespaces/{namespace}/limitranges
Параметри шляху
| Назва | Тип | Опис |
|---|---|---|
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 /api/v1/namespaces/{namespace}/limitranges/{name}
Параметри шляху
| Назва | Тип | Опис |
|---|---|---|
name | string | Назва LimitRange |
namespace | string | Назва обʼєкта та область авторизації, наприклад для команд і проєктів |
Параметри запиту
| Назва | Тип | Опис |
|---|---|---|
pretty | string | Якщо 'true', то вихідні дані форматуються у зручному для читання вигляді. Зазвичай 'false', якщо user-agent не вказує оглядач або командний інструмент для роботи з HTTP (curl та wget). |
Відповідь
| Статус | Опис | Відповідь |
|---|---|---|
| 200 | OK | LimitRange |
get List
HTTP Запит
GET /api/v1/namespaces/{namespace}/limitranges
Параметри шляху
| Назва | Тип | Опис |
|---|---|---|
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 | LimitRangeList |
get List All Namespaces
HTTP Запит
GET /api/v1/limitranges
Параметри запиту
| Назва | Тип | Опис |
|---|---|---|
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 | LimitRangeList |
get Watch
HTTP Запит
GET /api/v1/watch/namespaces/{namespace}/limitranges/{name}
Параметри шляху
| Назва | Тип | Опис |
|---|---|---|
name | string | Назва LimitRange |
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 /api/v1/watch/namespaces/{namespace}/limitranges
Параметри шляху
| Назва | Тип | Опис |
|---|---|---|
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 /api/v1/watch/limitranges
Параметри запиту
| Назва | Тип | Опис |
|---|---|---|
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 |
6 - Namespace
apiVersion: v1
import "k8s.io/api/core/v1"
Namespace
Namespace визначає область Імен. Використання кількох просторів імен є опціональним.
| Поле | Опис |
|---|---|
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 |
specNamespaceSpec | Spec визначає поведінку Namespace. Детальніше: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status |
statusNamespaceStatus | Status описує поточний статус Namespace. Детальніше: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status |
NamespaceSpec
NamespaceSpec описує атрибути Namespace.
| Поле | Опис |
|---|---|
finalizersstring array | Finalizers є непрозорим списком значень, який повинен бути порожнім для остаточного видалення обʼєкта зі сховища. Детальніше: https://kubernetes.io/docs/tasks/administer-cluster/namespaces/ |
NamespaceStatus
NamespaceStatus містить інформацію про поточний стан Namespace.
| Поле | Опис |
|---|---|
conditionsNamespaceCondition array patch strategy: merge on key type | Представляє останні доступні спостереження за поточним станом простору імен. |
phasestring | Phase визначає поточну фазу життєвого циклу простору імен. Детальніше: https://kubernetes.io/docs/tasks/administer-cluster/namespaces/ Можливі значення enum:
|
NamespaceList
NamespaceList є списком просторов імен.
| Поле | Опис |
|---|---|
apiVersionstring | APIVersion визначає версію схеми цього представлення обʼєкта. Сервери повинні конвертувати розпізнані схеми до останнього внутрішнього значення і можуть відхиляти нерозпізнані значення. Детальніше: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources |
items *Namespace array | Items є списком обʼєктів Namespace у списку. Детальніше: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/ |
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#types-kinds |
NamespaceCondition
NamespaceCondition містить деталі про стан простору імен.
| Поле | Опис |
|---|---|
lastTransitionTimeTime | Останній раз, коли стан простору імен змінився з одного на інший. |
messagestring | Зрозуміле для людини повідомлення, що вказує деталі останньої зміни стану. |
reasonstring | Унікальна, однослівна, CamelCase причина останньої зміни стану. |
status *string | Статус стану, одне з значень: True, False, Unknown. |
type *string | Тип стану контролера простору імен. |
Операції
post Create
HTTP Запит
POST /api/v1/namespaces
Параметри запиту
| Назва | Тип | Опис |
|---|---|---|
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 | Namespace |
Відповідь
| Статус | Опис | Відповідь |
|---|---|---|
| 200 | OK | Namespace |
| 201 | Created | Namespace |
| 202 | Accepted | Namespace |
patch Patch
HTTP Запит
PATCH /api/v1/namespaces/{name}
Параметри шляху
| Назва | Тип | Опис |
|---|---|---|
name | string | Назва Namespace |
Параметри запиту
| Назва | Тип | Опис |
|---|---|---|
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 | Namespace |
| 201 | Created | Namespace |
put Replace
HTTP Запит
PUT /api/v1/namespaces/{name}
Параметри шляху
| Назва | Тип | Опис |
|---|---|---|
name | string | Назва Namespace |
Параметри запиту
| Назва | Тип | Опис |
|---|---|---|
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 | Namespace |
Відповідь
| Статус | Опис | Відповідь |
|---|---|---|
| 200 | OK | Namespace |
| 201 | Created | Namespace |
delete Delete
HTTP Запит
DELETE /api/v1/namespaces/{name}
Параметри шляху
| Назва | Тип | Опис |
|---|---|---|
name | string | Назва Namespace |
Параметри запиту
| Назва | Тип | Опис |
|---|---|---|
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 |
get Read
HTTP Запит
GET /api/v1/namespaces/{name}
Параметри шляху
| Назва | Тип | Опис |
|---|---|---|
name | string | Назва Namespace |
Параметри запиту
| Назва | Тип | Опис |
|---|---|---|
pretty | string | Якщо 'true', то вихідні дані форматуються у зручному для читання вигляді. Зазвичай 'false', якщо user-agent не вказує оглядач або командний інструмент для роботи з HTTP (curl та wget). |
Відповідь
| Статус | Опис | Відповідь |
|---|---|---|
| 200 | OK | Namespace |
get List
HTTP Запит
GET /api/v1/namespaces
Параметри запиту
| Назва | Тип | Опис |
|---|---|---|
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 | NamespaceList |
get Watch
HTTP Запит
GET /api/v1/watch/namespaces/{name}
Параметри шляху
| Назва | Тип | Опис |
|---|---|---|
name | string | Назва Namespace |
Параметри запиту
| Назва | Тип | Опис |
|---|---|---|
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 /api/v1/watch/namespaces
Параметри запиту
| Назва | Тип | Опис |
|---|---|---|
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 /api/v1/namespaces/{name}/status
Параметри шляху
| Назва | Тип | Опис |
|---|---|---|
name | string | Назва Namespace |
Параметри запиту
| Назва | Тип | Опис |
|---|---|---|
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 | Namespace |
| 201 | Created | Namespace |
get Read Status
HTTP Запит
GET /api/v1/namespaces/{name}/status
Параметри шляху
| Назва | Тип | Опис |
|---|---|---|
name | string | Назва Namespace |
Параметри запиту
| Назва | Тип | Опис |
|---|---|---|
pretty | string | Якщо 'true', то вихідні дані форматуються у зручному для читання вигляді. Зазвичай 'false', якщо user-agent не вказує оглядач або командний інструмент для роботи з HTTP (curl та wget). |
Відповідь
| Статус | Опис | Відповідь |
|---|---|---|
| 200 | OK | Namespace |
put Replace Status
HTTP Запит
PUT /api/v1/namespaces/{name}/status
Параметри шляху
| Назва | Тип | Опис |
|---|---|---|
name | string | Назва Namespace |
Параметри запиту
| Назва | Тип | Опис |
|---|---|---|
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 | Namespace |
Відповідь
| Статус | Опис | Відповідь |
|---|---|---|
| 200 | OK | Namespace |
| 201 | Created | Namespace |
7 - Node
apiVersion: v1
import "k8s.io/api/core/v1"
Node
Node є робочим вузлом у Kubernetes. Кожен вузол матиме унікальний ідентифікатор у кеші (тобто в etcd).
| Поле | Опис |
|---|---|
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 |
specNodeSpec | Spec визначає поведінку вузла. Детальніше: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status |
statusNodeStatus | Останній спостережуваний стан вузла. Заповнюється системою. Тільки для читання. Детальніше: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status |
NodeSpec
NodeSpec описує атрибути, з якими створюється вузол.
| Поле | Опис |
|---|---|
configSourceNodeConfigSource | Застаріле: Раніше використовувалося для вказівки джерела конфігурації вузла для функції DynamicKubeletConfig. Ця функція видалена. |
externalIDstring | Застаріле. Не всі kubelet встановлюватимуть це поле. Поле видалено після 1.13. Див.: https://issues.k8s.io/61966 |
podCIDRstring | PodCIDR представляє діапазон IP-адрес для подів, призначений вузлу. |
podCIDRsstring array patch strategy: merge | podCIDRs представляє діапазони IP-адрес, призначені вузлу для використання подами на цьому вузлі. Якщо це поле вказано, 0-й елемент повинен відповідати полю podCIDR. Воно може містити не більше 1 значення для кожного з IPv4 та IPv6. |
providerIDstring | ID вузла, призначений постачальником хмари у форматі: <ProviderName>://<ProviderSpecificNodeID> |
taintsTaint array | Якщо вказано, то це taints вузла. |
unschedulableboolean | Поле unschedulable контролює можливість планування нових подів на вузлі. Зазвичай вузол доступний для планування. Детальніше: https://kubernetes.io/docs/concepts/nodes/node/#manual-node-administration |
NodeStatus
NodeStatus is information about the current status of a node.
| Поле | Опис |
|---|---|
addressesNodeAddress array patch strategy: злиття за ключем type | Список адрес, доступних для вузла. Отримується від постачальника хмари, якщо доступно. Детальніше: https://kubernetes.io/docs/reference/node/node-status/#addresses Примітка: Це поле оголошено як придатне до злиття, але ключ злиття недостатньо унікальний, що може призвести до пошкодження даних при злитті. Використовуйте патч з повним заміщенням. Див.: https://pr.k8s.io/79391 для прикладу. Споживачі повинні припускати, що адреси можуть змінюватися протягом життя вузла. Однак є деякі винятки, коли це може бути неможливо, наприклад, поди, які успадковують адресу вузла у своєму статусі, або споживачі API вниз (status.hostIP). |
allocatableobject | Allocatable представляє ресурси вузла, доступні для планування. Зазвичай дорівнює Capacity. |
capacityobject | Capacity представляє загальні ресурси вузла. Детальніше: https://kubernetes.io/docs/reference/node/node-status/#capacity |
conditionsNodeCondition array patch strategy: злиття за ключем type | Conditions є масивом поточних спостережуваних станів вузла. Детальніше: https://kubernetes.io/docs/reference/node/node-status/#condition |
configNodeConfigStatus | Статус конфігурації, призначеної вузлу через функцію динамічної конфігурації Kubelet. |
daemonEndpointsNodeDaemonEndpoints | Точки доступу демонів, що працюють на вузлі. |
declaredFeaturesstring array | DeclaredFeatures представляє функції, повʼязані з функціональними можливостями (feature gates), які оголошені вузлом. |
featuresNodeFeatures | Features описує набір функцій, реалізованих у CRI. |
imagesContainerImage array | Список образів контейнерів на цьому вузлі |
nodeInfoNodeSystemInfo | Набір ідентифікаторів/UUID для унікальної ідентифікації вузла. Детальніше: https://kubernetes.io/docs/reference/node/node-status/#info |
phasestring | NodePhase є нещодавно спостережуваною фазою життєвого циклу вузла. Детальніше: https://kubernetes.io/docs/concepts/nodes/node/#phase Це поле ніколи не заповнюється і зараз застаріле. Можливі значення enum:
|
runtimeHandlersNodeRuntimeHandler array | Доступні обробники середовища виконання. |
volumesAttachedAttachedVolume array | Список томів, які прикріплені до вузла. |
volumesInUsestring array | Список томів, які використовуються (підключені) вузлом. |
NodeList
NodeList це повний список всіх вузлів, які були зареєстровані на вузлі панелі управління.
| Поле | Опис |
|---|---|
apiVersionstring | APIVersion визначає версію схеми цього представлення обʼєкта. Сервери повинні конвертувати розпізнані схеми до останнього внутрішнього значення і можуть відхиляти нерозпізнані значення. Детальніше: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources |
items *Node array | List of nodes |
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#types-kinds |
AttachedVolume
AttachedVolume описує том, прикріплений до вузла
| Поле | Опис |
|---|---|
devicePath *string | DevicePath представляє шлях до пристрою, де том повинен бути доступний |
name *string | Назва прикріпленого тому |
ConfigMapNodeConfigSource
ConfigMapNodeConfigSource містить інформацію для посилання на ConfigMap як джерело конфігурації для вузла. Цей API застарів з версії 1.22: https://git.k8s.io/enhancements/keps/sig-node/281-dynamic-kubelet-configuration
| Поле | Опис |
|---|---|
kubeletConfigKey *string | KubeletConfigKey визначає, який ключ посилання на ConfigMap відповідає структурі KubeletConfiguration. Це поле обовʼязкове у всіх випадках. |
name *string | Назва metadata.name посилання на ConfigMap. Це поле обовʼязкове у всіх випадках. |
namespace *string | Namespace це metadata.namespace посилання на ConfigMap. Це поле обовʼязкове у всіх випадках. |
resourceVersionstring | ResourceVersion це metadata.ResourceVersion посилання на ConfigMap. Це поле заборонене в Node.Spec і обовʼязкове в Node.Status. |
uidstring | UID це metadata.UID посилання на ConfigMap. Це поле заборонене в Node.Spec і обовʼязкове в Node.Status. |
ContainerImage
Описує образ контейнера
| Поле | Опис |
|---|---|
namesstring array | Назви, за якими відомий цей образ. Наприклад: ["kubernetes.example/hyperkube:v1.0.7", "cloud-vendor.registry.example/cloud-vendor/hyperkube:v1.0.7"] |
sizeBytesinteger | Розмір образу в байтах. |
DaemonEndpoint
DaemonEndpoint містить інформацію про одну точку доступу Daemon.
| Поле | Опис |
|---|---|
Port *integer | Номер порту даної точки доступу. |
NodeAddress
NodeAddress містить інформацію про адресу вузла.
| Поле | Опис |
|---|---|
address *string | Адреса вузла. |
type *string | Тип адреси вузла, один з Hostname, ExternalIP або InternalIP. |
NodeCondition
NodeCondition містить інформацію про стан вузла.
| Поле | Опис |
|---|---|
lastHeartbeatTimeTime | Останній раз, коли ми отримали оновлення щодо вказаного стану. |
lastTransitionTimeTime | Останній раз, коли стан змінився з одного на інший. |
messagestring | Зрозуміле для людини повідомлення, що вказує деталі останнього переходу стану. |
reasonstring | (коротко) причина останнього переходу стану. |
status *string | Статус стану, один з True, False, Unknown. |
type *string | Тип стану вузла. |
NodeConfigSource
NodeConfigSource визначає джерело конфігурації вузла. Точно одне субполе (за винятком метаданих) повинно бути ненульовим. Цей API застарів з версії 1.22.
| Поле | Опис |
|---|---|
configMapConfigMapNodeConfigSource | ConfigMap є посиланням на ConfigMap вузла. |
NodeConfigStatus
NodeConfigStatus описує стан конфігурації, призначеної через Node.Spec.ConfigSource.
| Поле | Опис |
|---|---|
activeNodeConfigSource | Active повідомляє про перевірену конфігурацію, яку вузол активно використовує. Параметр «Active» показує або поточну версію призначеної конфігурації, або поточну версію конфігурації LastKnownGood, залежно від того, чи призводить спроба використання призначеної конфігурації до помилки. |
assignedNodeConfigSource | Assigned повідомляє про перевірену конфігурацію, яку вузол намагається використовувати. Коли Node.Spec.ConfigSource оновлюється, вузол зберігає повʼязаний пакунок конфігурації на локальному диску разом із записом, що вказує на призначену конфігурацію. Вузол звертається до цього запису, щоб вибрати свій контрольний пункт конфігурації, і повідомляє про цей запис у Assigned. Assigned оновлюється в статусі лише після того, як запис був збережений на диску. Коли Kubelet перезапускається, він намагається зробити Assigned конфігурацію Active, завантажуючи та перевіряючи контрольний пакет, визначений Assigned. |
errorstring | Error описує будь-які проблеми з узгодженням Spec.ConfigSource з Active конфігурацією. Помилки можуть виникати, наприклад, при спробі зберегти Spec.ConfigSource у локальному записі Assigned, при спробі зберегти пов'язаний з Spec.ConfigSource пакет, при спробі завантажити або перевірити Assigned конфігурацію тощо. Помилки можуть виникати на різних етапах синхронізації конфігурації. Ранні помилки (наприклад, помилки завантаження або збереження) не призведуть до відкату до LastKnownGood і можуть вирішитися під час повторних спроб Kubelet. Пізніші помилки (наприклад, завантаження або перевірка збереженої конфігурації) призведуть до відкату до LastKnownGood. У останньому випадку зазвичай можливо вирішити помилку, виправивши конфігурацію, призначену в Spec.ConfigSource. Додаткову інформацію для налагодження можна знайти, шукаючи повідомлення про помилку в журналі Kubelet. Error є описом стану помилки для людини; машини можуть перевіряти, чи порожнє поле Error, але не повинні покладатися на стабільність тексту Error між версіями Kubelet. |
lastKnownGoodNodeConfigSource | LastKnownGood повідомляє про збережену конфігурацію, до якої вузол повернеться у разі виникнення помилки при спробі використати Assigned конфігурацію. Assigned конфігурація стає LastKnownGood конфігурацією, коли вузол визначає, що Assigned конфігурація є стабільною та правильною. Це наразі реалізовано як 10-хвилинний період витримки, що починається з моменту оновлення локального запису Assigned конфігурації. Якщо Assigned конфігурація є Active наприкінці цього періоду, вона стає LastKnownGood. Зверніть увагу, що якщо Spec.ConfigSource скидається до nil (використовуються локальні стандартні значення), LastKnownGood також негайно скидається до nil, оскільки локальна стандартна конфігурація завжди вважається прийнятною. Не слід робити припущення щодо методу визначення стабільності та правильності конфігурації вузлом, оскільки це може змінитися або стати налаштовуваним у майбутньому. |
NodeDaemonEndpoints
NodeDaemonEndpoints перераховує порти, відкриті демонами, що працюють на вузлі.
| Поле | Опис |
|---|---|
kubeletEndpointDaemonEndpoint | Endpoint, на якому слухає Kubelet. |
NodeFeatures
NodeFeatures описує набір функцій, реалізованих у CRI. Функції, що містяться в NodeFeatures, повинні залежати лише від реалізації CRI, незалежно від обробників середовища виконання.
| Поле | Опис |
|---|---|
supplementalGroupsPolicyboolean | SupplementalGroupsPolicy встановлено в true, якщо середовище виконання підтримує SupplementalGroupsPolicy та ContainerUser. |
NodeRuntimeHandler
NodeRuntimeHandler є набором інформації про обробники середовища виконання.
| Поле | Опис |
|---|---|
featuresNodeRuntimeHandlerFeatures | Підтримувані функції. |
namestring | Назва обробника середовища виконання. Порожнє значення для обробника середовища виконання за замовчуванням. |
NodeRuntimeHandlerFeatures
NodeRuntimeHandlerFeatures описує набір функцій, реалізованих обробником середовища виконання.
| Поле | Опис |
|---|---|
recursiveReadOnlyMountsboolean | RecursiveReadOnlyMounts встановлено в true, якщо обробник середовища виконання підтримує RecursiveReadOnlyMounts. |
userNamespacesboolean | UserNamespaces встановлено в true, якщо обробник середовища виконання підтримує UserNamespaces, включаючи для томів. |
NodeSwapStatus
NodeSwapStatus представляє інформацію про swap памʼять.
| Поле | Опис |
|---|---|
capacityinteger | Загальний обсяг swap памʼяті в байтах. |
NodeSystemInfo
NodeSystemInfo є набором ідентифікаторів/UUID для унікальної ідентифікації вузла.
| Поле | Опис |
|---|---|
architecture *string | Архітектура, про яку повідомляє вузол |
bootID *string | Boot ID, про який повідомляє вузол. |
containerRuntimeVersion *string | Версія середовища виконання контейнерів, про яку повідомляє вузол через віддалений API середовища виконання (наприклад, containerd://1.4.2). |
kernelVersion *string | Версія ядра, про яку повідомляє вузол з 'uname -r' (наприклад, 3.16.0-0.bpo.4-amd64). |
kubeProxyVersion *string | Застаріле: версія KubeProxy, про яку повідомляє вузол. |
kubeletVersion *string | Версія Kubelet, про яку повідомляє вузол. |
machineID *string | MachineID, про який повідомляє вузол. Для унікальної ідентифікації машини в кластері цей параметр є пріоритетним. Дізнайтеся більше з man(5) machine-id: http://man7.org/linux/man-pages/man5/machine-id.5.html |
operatingSystem *string | Операційна система, про яку повідомляє вузол |
osImage *string | Образ операційної системи, про який повідомляє вузол з /etc/os-release (наприклад, Debian GNU/Linux 7 (wheezy)). |
swapNodeSwapStatus | Інформація про swap, про яку повідомляє вузол. |
systemUUID *string | SystemUUID, про який повідомляє вузол. Для унікальної ідентифікації машини MachineID є пріоритетним. Це поле специфічне для хостів Red Hat: https://access.redhat.com/documentation/en-us/red_hat_subscription_management/1/html/rhsm/uuid |
Taint
Вузол, до якого прикріплено цей Taint, має "ефект" на будь-який pod, який не толерує цей Taint.
| Поле | Опис |
|---|---|
effect *string | Обовʼязково. Ефект Taint на поди, які не толерують цей Taint. Дійсні ефекти: NoSchedule, PreferNoSchedule та NoExecute. Можливі значення enum:
|
key *string | Обовʼязково. Ключ Taint, який буде застосовано до вузла. |
timeAddedTime | TimeAdded показує час, коли Taint був доданий. |
valuestring | Значення Taint, що відповідає ключу Taint. |
Операції
post Create
HTTP Запит
POST /api/v1/nodes
Параметри запиту
| Назва | Тип | Опис |
|---|---|---|
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 | Node |
Відповідь
| Статус | Опис | Відповідь |
|---|---|---|
| 200 | OK | Node |
| 201 | Created | Node |
| 202 | Accepted | Node |
patch Patch
HTTP Запит
PATCH /api/v1/nodes/{name}
Параметри шляху
| Назва | Тип | Опис |
|---|---|---|
name | string | Назва Node |
Параметри запиту
| Назва | Тип | Опис |
|---|---|---|
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 | Node |
| 201 | Created | Node |
put Replace
HTTP Запит
PUT /api/v1/nodes/{name}
Параметри шляху
| Назва | Тип | Опис |
|---|---|---|
name | string | Назва Node |
Параметри запиту
| Назва | Тип | Опис |
|---|---|---|
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 | Node |
Відповідь
| Статус | Опис | Відповідь |
|---|---|---|
| 200 | OK | Node |
| 201 | Created | Node |
delete Delete
HTTP ReЗапит#http-request-3}
DELETE /api/v1/nodes/{name}
Параметри шляху
| Назва | Тип | Опис |
|---|---|---|
name | string | Назва Node |
Параметри запиту
| Назва | Тип | Опис |
|---|---|---|
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 /api/v1/nodes
Параметри запиту
| Назва | Тип | Опис |
|---|---|---|
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 /api/v1/nodes/{name}
Параметри шляху
| Назва | Тип | Опис |
|---|---|---|
name | string | Назва Node |
Параметри запиту
| Назва | Тип | Опис |
|---|---|---|
pretty | string | Якщо 'true', то вихідні дані форматуються у зручному для читання вигляді. Зазвичай 'false', якщо user-agent не вказує оглядач або командний інструмент для роботи з HTTP (curl та wget). |
Відповідь
| Статус | Опис | Відповідь |
|---|---|---|
| 200 | OK | Node |
get List
HTTP Запит
GET /api/v1/nodes
Параметри запиту
| Назва | Тип | Опис |
|---|---|---|
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 | NodeList |
get Watch
HTTP Запит
GET /api/v1/watch/nodes/{name}
Параметри шляху
| Назва | Тип | Опис |
|---|---|---|
name | string | Назва Node |
Параметри запиту
| Назва | Тип | Опис |
|---|---|---|
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 /api/v1/watch/nodes
Параметри запиту
| Назва | Тип | Опис |
|---|---|---|
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 /api/v1/nodes/{name}/status
Параметри шляху
| Назва | Тип | Опис |
|---|---|---|
name | string | Назва Node |
Параметри запиту
| Назва | Тип | Опис |
|---|---|---|
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 | Node |
| 201 | Created | Node |
get Read Status
HTTP Запит
GET /api/v1/nodes/{name}/status
Параметри шляху
| Назва | Тип | Опис |
|---|---|---|
name | string | Назва Node |
Параметри запиту
| Назва | Тип | Опис |
|---|---|---|
pretty | string | Якщо 'true', то вихідні дані форматуються у зручному для читання вигляді. Зазвичай 'false', якщо user-agent не вказує оглядач або командний інструмент для роботи з HTTP (curl та wget). |
Відповідь
| Статус | Опис | Відповідь |
|---|---|---|
| 200 | OK | Node |
put Replace Status
HTTP Запит
PUT /api/v1/nodes/{name}/status
Параметри шляху
| Назва | Тип | Опис |
|---|---|---|
name | string | Назва Node |
Параметри запиту
| Назва | Тип | Опис |
|---|---|---|
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 | Node |
Відповідь
| Статус | Опис | Відповідь |
|---|---|---|
| 200 | OK | Node |
| 201 | Created | Node |
post Create Connect Proxy
HTTP Запит
POST /api/v1/nodes/{name}/proxy
Параметри шляху
| Назва | Тип | Опис |
|---|---|---|
name | string | Назва NodeProxyOptions |
Параметри запиту
| Назва | Тип | Опис |
|---|---|---|
path | string | Path — це URL-адреса, яку слід використовувати для поточного проксі-запиту до вузла. |
Відповідь
| Статус | Опис | Відповідь |
|---|---|---|
| 200 | OK | string |
post Create Connect Proxy Path
HTTP Запит
POST /api/v1/nodes/{name}/proxy/{path}
Параметри шляху
| Назва | Тип | Опис |
|---|---|---|
name | string | Назва NodeProxyOptions |
path | string | шлях до ресурсу |
Параметри запиту
| Назва | Тип | Опис |
|---|---|---|
path | string | Path — це URL-адреса, яку слід використовувати для поточного проксі-запиту до вузла. |
Відповідь
| Статус | Опис | Відповідь |
|---|---|---|
| 200 | OK | string |
delete Delete Connect Proxy
HTTP Запит
DELETE /api/v1/nodes/{name}/proxy
Параметри шляху
| Назва | Тип | Опис |
|---|---|---|
name | string | Назва NodeProxyOptions |
Параметри запиту
| Назва | Тип | Опис |
|---|---|---|
path | string | Path — це URL-адреса, яку слід використовувати для поточного проксі-запиту до вузла. |
Відповідь
| Статус | Опис | Відповідь |
|---|---|---|
| 200 | OK | string |
delete Delete Connect Proxy Path
HTTP Запит
DELETE /api/v1/nodes/{name}/proxy/{path}
Параметри шляху
| Назва | Тип | Опис |
|---|---|---|
name | string | Назва NodeProxyOptions |
path | string | шлях до ресурсу |
Параметри запиту
| Назва | Тип | Опис |
|---|---|---|
path | string | Path — це URL-адреса, яку слід використовувати для поточного проксі-запиту до вузла. |
Відповідь
| Статус | Опис | Відповідь |
|---|---|---|
| 200 | OK | string |
get Get Connect Proxy
HTTP Запит
GET /api/v1/nodes/{name}/proxy
Параметри шляху
| Назва | Тип | Опис |
|---|---|---|
name | string | Назва NodeProxyOptions |
Параметри запиту
| Назва | Тип | Опис |
|---|---|---|
path | string | Path — це URL-адреса, яку слід використовувати для поточного проксі-запиту до вузла. |
Відповідь
| Статус | Опис | Відповідь |
|---|---|---|
| 200 | OK | string |
get Get Connect Proxy Path
HTTP Запит
GET /api/v1/nodes/{name}/proxy/{path}
Параметри шляху
| Назва | Тип | Опис |
|---|---|---|
name | string | Назва NodeProxyOptions |
path | string | шлях до ресурсу |
Параметри запиту
| Назва | Тип | Опис |
|---|---|---|
path | string | Path — це URL-адреса, яку слід використовувати для поточного проксі-запиту до вузла. |
Відповідь
| Статус | Опис | Відповідь |
|---|---|---|
| 200 | OK | string |
head Head Connect Proxy
HTTP Запит
HEAD /api/v1/nodes/{name}/proxy
Параметри шляху
| Назва | Тип | Опис |
|---|---|---|
name | string | Назва NodeProxyOptions |
Параметри запиту
| Назва | Тип | Опис |
|---|---|---|
path | string | Path — це URL-адреса, яку слід використовувати для поточного проксі-запиту до вузла. |
Відповідь
| Статус | Опис | Відповідь |
|---|---|---|
| 200 | OK | string |
head Head Connect Proxy Path
HTTP Запит
HEAD /api/v1/nodes/{name}/proxy/{path}
Параметри шляху
| Назва | Тип | Опис |
|---|---|---|
name | string | Назва NodeProxyOptions |
path | string | шлях до ресурсу |
Параметри запиту
| Назва | Тип | Опис |
|---|---|---|
path | string | Path — це URL-адреса, яку слід використовувати для поточного проксі-запиту до вузла. |
Відповідь
| Статус | Опис | Відповідь |
|---|---|---|
| 200 | OK | string |
put Replace Connect Proxy
HTTP Запит
PUT /api/v1/nodes/{name}/proxy
Параметри шляху
| Назва | Тип | Опис |
|---|---|---|
name | string | Назва NodeProxyOptions |
Параметри запиту
| Назва | Тип | Опис |
|---|---|---|
path | string | Path — це URL-адреса, яку слід використовувати для поточного проксі-запиту до вузла. |
Відповідь
| Статус | Опис | Відповідь |
|---|---|---|
| 200 | OK | string |
put Replace Connect Proxy Path
HTTP Запит
PUT /api/v1/nodes/{name}/proxy/{path}
Параметри шляху
| Назва | Тип | Опис |
|---|---|---|
name | string | Назва NodeProxyOptions |
path | string | шлях до ресурсу |
Параметри запиту
| Назва | Тип | Опис |
|---|---|---|
path | string | Path — це URL-адреса, яку слід використовувати для поточного проксі-запиту до вузла. |
Відповідь
| Статус | Опис | Відповідь |
|---|---|---|
| 200 | OK | string |
8 - PersistentVolume
apiVersion: v1
import "k8s.io/api/core/v1"
PersistentVolume
PersistentVolume (PV) є ресурсом зберігання, який надається адміністратором. Він аналогічний вузлу. Детальніше: https://kubernetes.io/docs/concepts/storage/persistent-volumes
| Поле | Опис |
|---|---|
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 |
specPersistentVolumeSpec | spec визначає специфікацію постійного тому, що належить кластеру. Надається адміністратором. Детальніше: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistent-volumes |
statusPersistentVolumeStatus | status представляє поточну інформацію/стан постійного тому. Заповнюється системою. Тільки для читання. Детальніше: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistent-volumes |
PersistentVolumeSpec
PersistentVolumeSpec є специфікацією постійного тому.
| Поле | Опис |
|---|---|
accessModesstring array | accessModes містить всі способи, якими том може бути змонтований. Детальніше: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes |
awsElasticBlockStoreAWSElasticBlockStoreVolumeSource | awsElasticBlockStore представляє ресурс диска AWS, який підключається до хост-машини kubelet і потім надається поду. Застаріло: AWSElasticBlockStore застарів. Всі операції для типу awsElasticBlockStore перенаправляються до драйвера CSI ebs.csi.aws.com. Детальніше: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore |
azureDiskAzureDiskVolumeSource | azureDisk представляє монтування диска Azure Data на хості та привʼязку до поду. Застаріло: AzureDisk застарів. Всі операції для типу azureDisk перенаправляються до драйвера CSI disk.csi.azure.com. |
azureFileAzureFilePersistentVolumeSource | azureFile представляє монтування служби Azure File на хості та привʼязку до поду. Застаріло: AzureFile застарів. Всі операції для типу azureFile перенаправляються до драйвера CSI file.csi.azure.com. |
capacityobject | capacity є описом ресурсів та ємності постійного тому. Детальніше: https://kubernetes.io/docs/concepts/storage/persistent-volumes#capacity |
cephfsCephFSPersistentVolumeSource | cephFS представляє монтування Ceph FS на хості, яке ділить життєвий цикл поду. Застаріло: CephFS застарів, і тип cephfs більше не підтримується. |
cinderCinderPersistentVolumeSource | cinder представляє том Cinder, підключений і змонтований на хості kubelet. Застаріло: Cinder застарів. Всі операції для типу cinder перенаправляються до драйвера CSI cinder.csi.openstack.org. Детальніше: https://examples.k8s.io/mysql-cinder-pd/README.md |
claimRefObjectReference | claimRef є частиною двостороннього звʼязку між PersistentVolume та PersistentVolumeClaim. Очікується, що буде ненульовим, коли звʼязок встановлено. claim.VolumeName є авторитетним звʼязком між PV та PVC. Детальніше: https://kubernetes.io/docs/concepts/storage/persistent-volumes#binding |
csiCSIPersistentVolumeSource | csi представляє сховище, яке обробляється зовнішнім драйвером CSI. |
fcFCVolumeSource | fc представляє ресурс Fibre Channel, який підключається до хост-машини kubelet і потім надається поду. |
flexVolumeFlexPersistentVolumeSource | flexVolume представляє загальний ресурс тому, який надається/підключається за допомогою втулка на основі exec. Застаріло: FlexVolume застарів. Розгляньте можливість використання CSIDriver замість цього. |
flockerFlockerVolumeSource | flocker представляє том Flocker, підключений до хост-машини kubelet і наданий поду для використання. Це залежить від того, що служба керування Flocker працює. Застаріло: Flocker застарів, і тип flocker більше не підтримується. |
gcePersistentDiskGCEPersistentDiskVolumeSource | gcePersistentDisk представляє ресурс диска GCE, який підключається до хост-машини kubelet і потім надається поду. Надається адміністратором. Застаріло: GCEPersistentDisk застарів. Всі операції для типу gcePersistentDisk перенаправляються до драйвера CSI pd.csi.storage.gke.io. Детальніше: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk |
glusterfsGlusterfsPersistentVolumeSource | glusterfs представляє том Glusterfs, який підключається до хост-машини і надається поду. Надається адміністратором. Застаріло: Glusterfs застарів, і тип glusterfs більше не підтримується. Детальніше: https://examples.k8s.io/volumes/glusterfs/README.md |
hostPathHostPathVolumeSource | hostPath представляє теку на хості. Надається розробником або тестувальником. Це корисно лише для розробки та тестування на одновузловій системі! Зберігання на хості не підтримується і НЕ ПРАЦЮВАТИМЕ в багатовузловому кластері. Детальніше: https://kubernetes.io/docs/concepts/storage/volumes#hostpath |
iscsiISCSIPersistentVolumeSource | iscsi представляє ресурс диска ISCSI, який підключається до хост-машини kubelet і потім надається поду. Надається адміністратором. |
localLocalVolumeSource | local представляє безпосередньо підключене сховище зі спорідненістю до вузла |
mountOptionsstring array | mountOptions є списком параметрів монтування, наприклад ["ro", "soft"]. Не перевіряється — монтування просто не вдасться, якщо один з параметрів недійсний. Детальніше: https://kubernetes.io/docs/concepts/storage/persistent-volumes/#mount-options |
nfsNFSVolumeSource | nfs представляє монтування NFS на хості. Надається адміністратором. Детальніше: https://kubernetes.io/docs/concepts/storage/volumes#nfs |
nodeAffinityVolumeNodeAffinity | nodeAffinity визначає обмеження, які обмежують, з яких вузлів цей том може бути доступний. Це поле впливає на планування подів, які використовують цей том. Це поле можна змінювати, якщо увімкнено функціональну можливість MutablePVNodeAffinity. |
persistentVolumeReclaimPolicystring | persistentVolumeReclaimPolicy визначає, що відбувається з постійним томом після його звільнення від заявки. Дійсні варіанти: Retain (стандартно для створених вручну PersistentVolumes), Delete (стандартно для динамічно створених PersistentVolumes) та Recycle (застарілий). Recycle повинен підтримуватися втулком томів, що лежить в основі цього PersistentVolume. Детальніше: https://kubernetes.io/docs/concepts/storage/persistent-volumes#reclaiming Можливі значення enum:
|
photonPersistentDiskPhotonPersistentDiskVolumeSource | photonPersistentDisk представляє постійний диск PhotonController, підключений і змонтований на хості kubelets. Застаріло: PhotonPersistentDisk застарів, і внутрішній тип photonPersistentDisk більше не підтримується. |
portworxVolumePortworxVolumeSource | portworxVolume представляє том portworx, підключений і змонтований на хості kubelets. Застаріло: PortworxVolume застарів. Усі операції для внутрішнього типу portworxVolume перенаправляються до драйвера CSI pxd.portworx.com. |
quobyteQuobyteVolumeSource | quobyte представляє монтування Quobyte на хості, яке триває протягом життєвого циклу пода. Застаріло: Quobyte застарів, і внутрішній тип quobyte більше не підтримується. |
rbdRBDPersistentVolumeSource | rbd представляє монтування Rados Block Device на хості, яке триває протягом життєвого циклу пода. Застаріло: RBD застарів, і внутрішній тип rbd більше не підтримується. Більше інформації: https://examples.k8s.io/volumes/rbd/README.md |
scaleIOScaleIOPersistentVolumeSource | scaleIO представляє постійний том ScaleIO, підключений і змонтований на вузлах Kubernetes. Застаріло: ScaleIO застарів, і внутрішній тип scaleIO більше не підтримується. |
storageClassNamestring | storageClassName — це назва StorageClass, до якої належить цей постійний том. Порожнє значення означає, що цей том не належить до жодного StorageClass. |
storageosStorageOSPersistentVolumeSource | storageOS представляє том StorageOS, підключений до хост-машини kubelet і змонтований у поді. Застаріло: StorageOS застарів, і внутрішній тип storageos більше не підтримується. Більше інформації: https://examples.k8s.io/volumes/storageos/README.md |
volumeAttributesClassNamestring | volumeAttributesClassName — це назва VolumeAttributesClass, до якої належить цей постійний том. Порожнє значення не дозволяється. Якщо це поле не встановлено, це означає, що цей том не належить до жодного VolumeAttributesClass. Це поле є змінним і може бути змінене драйвером CSI після успішного оновлення тому до нового класу. Для незвʼязаного PersistentVolume, volumeAttributesClassName буде співставлено з незвʼязаними PersistentVolumeClaims під час процесу звʼязування. |
volumeModestring | volumeMode визначає, чи призначено том для використання з форматованою файловою системою, чи залишити його у стані сирого блоку. Значення Filesystem передбачається, якщо не включено в spec. Можливі значення enum:
|
vsphereVolumeVsphereVirtualDiskVolumeSource | vsphereVolume представляє vSphere том, підключений і змонтований на хості kubelet. Застаріло: VsphereVolume застарів. Всі операції для внутрішнього типу vsphereVolume перенаправляються до CSI драйвера csi.vsphere.vmware.com. |
PersistentVolumeStatus
PersistentVolumeStatus є поточним станом постійного тому.
| Поле | Опис |
|---|---|
lastPhaseTransitionTimeTime | lastPhaseTransitionTime — це час, коли фаза перейшла з однієї в іншу, і автоматично скидається на поточний час щоразу, коли фаза тому змінюється. |
messagestring | message є зрозумілим для людини повідомленням, яке вказує деталі про те, чому том знаходиться в цьому стані. |
phasestring | phase вказує, чи том доступний, привʼязаний до запиту, або звільнений з запиту. Детальніше: https://kubernetes.io/docs/concepts/storage/persistent-volumes#phase Можливі значення enum:
|
reasonstring | reason є коротким рядком у CamelCase, який описує будь-яку помилку і призначений для машинного аналізу та акуратного відображення в CLI. |
PersistentVolumeList
PersistentVolumeList є списком елементів PersistentVolume.
| Поле | Опис |
|---|---|
apiVersionstring | APIVersion визначає версію схеми цього представлення обʼєкта. Сервери повинні конвертувати розпізнані схеми до останнього внутрішнього значення і можуть відхиляти нерозпізнані значення. Детальніше: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources |
items *Масив PersistentVolume | items є списком постійних томів. Детальніше: https://kubernetes.io/docs/concepts/storage/persistent-volumes |
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#types-kinds |
AWSElasticBlockStoreVolumeSource
Представляє ресурс Persistent Disk в AWS.
Диск AWS EBS повинен існувати перед монтуванням до контейнера. Диск також повинен знаходитися в тій же зоні AWS, що й kubelet. Диск AWS EBS можна монтувати лише як читання/запис один раз. Томи AWS EBS підтримують управління власністю та переназначення SELinux.
| Поле | Опис |
|---|---|
fsTypestring | fsType є типом файлової системи тому, який ви хочете змонтувати. Порада: переконайтеся, що тип файлової системи підтримується операційною системою хоста. Приклади: "ext4", "xfs", "ntfs". Якщо не вказано, зазвичай використовується "ext4". Детальніше: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore |
partitioninteger | partition є розділом у томі, який ви хочете змонтувати. Якщо не вказано, зазвичай монтується за іменем тому. Приклади: для тому /dev/sda1 вкажіть розділ як "1". Аналогічно, розділ тому для /dev/sda - "0" (або можна залишити властивість порожньою). |
readOnlyboolean | readOnly значення true змусить встановити параметр readOnly у VolumeMounts. Детальніше: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore |
volumeID *string | volumeID є унікальним ідентифікатором ресурсу постійного диска в AWS (том Amazon EBS). Детальніше: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore |
AzureDiskVolumeSource
AzureDisk представляє монтування диска даних Azure на хості та привʼязку до поду.
| Поле | Опис |
|---|---|
cachingModestring | cachingMode є режимом кешування хоста: None, Read Only, Read Write. Можливі значення enum:
|
diskName *string | diskName є імʼям диска даних у сховищі блобів |
diskURI *string | diskURI є URI диска даних у сховищі блобів |
fsTypestring | fsType є типом файлової системи для монтування. Повинно бути типом файлової системи, підтримуваним операційною системою хоста. Наприклад: "ext4", "xfs", "ntfs". Якщо не вказано, за замовчуванням використовується "ext4". |
kindstring | Очікуваними значеннями kind є
|
readOnlyboolean | readOnly Стандартне значення — false (читання/запис). Якщо встановлено true, це змусить встановити параметр readOnly у VolumeMounts. |
AzureFilePersistentVolumeSource
AzureFile представляє монтування Azure File Service на хості та привʼязку до поду.
| Поле | Опис |
|---|---|
readOnlyboolean | readOnly Стандартне значення — false (читання/запис). Якщо встановлено true, це змусить встановити параметр readOnly у VolumeMounts. |
secretName *string | secretName є імʼям секрету, який містить імʼя облікового запису Azure Storage та ключ |
secretNamespacestring | secretNamespace є простором імен секрету, який містить імʼя облікового запису Azure Storage та ключ. Зазвичай використовується той самий простір імен, що й для Pod |
shareName *string | shareName є імʼям спільного ресурсу Azure |
CSIPersistentVolumeSource
CSIPersistentVolumeSource представляє сховище, яке керується зовнішнім драйвером CSI.
| Поле | Опис |
|---|---|
controllerExpandSecretRefSecretReference | controllerExpandSecretRef є посиланням на обʼєкт секрету, який містить конфіденційну інформацію для передачі драйверу CSI для завершення виклику CSI ControllerExpandVolume. Це поле є опціональним і може бути порожнім, якщо секрет не потрібен. Якщо обʼєкт секрету містить більше одного секрету, передаються всі секрети. |
controllerPublishSecretRefSecretReference | controllerPublishSecretRef є посиланням на обʼєкт секрету, який містить конфіденційну інформацію для передачі драйверу CSI для завершення виклику CSI ControllerPublishVolume та ControllerUnpublishVolume. Це поле є опціональним і може бути порожнім, якщо секрет не потрібен. Якщо обʼєкт секрету містить більше одного секрету, передаються всі секрети. |
driver *string | driver є імʼям драйвера, який використовується для цього тома. Обовʼязково. |
fsTypestring | fsType для монтування. Повинно бути типом файлової системи, підтримуваним операційною системою хоста. Напр. "ext4", "xfs", "ntfs". |
nodeExpandSecretRefSecretReference | nodeExpandSecretRef є посиланням на обʼєкт секрету, який містить конфіденційну інформацію для передачі драйверу CSI для завершення виклику CSI NodeExpandVolume. Це поле є опціональним і може бути порожнім, якщо секрет не потрібен. Якщо обʼєкт секрету містить більше одного секрету, передаються всі секрети. |
nodePublishSecretRefSecretReference | nodePublishSecretRef є посиланням на обʼєкт секрету, який містить конфіденційну інформацію для передачі драйверу CSI для завершення виклику CSI NodePublishVolume та NodeUnpublishVolume. Це поле є опціональним і може бути порожнім, якщо секрет не потрібен. Якщо обʼєкт секрету містить більше одного секрету, передаються всі секрети. |
nodeStageSecretRefSecretReference | nodeStageSecretRef є посиланням на обʼєкт секрету, який містить конфіденційну інформацію для передачі драйверу CSI для завершення виклику CSI NodeStageVolume та NodeUnstageVolume. Це поле є опціональним і може бути порожнім, якщо секрет не потрібен. Якщо обʼєкт секрету містить більше одного секрету, передаються всі секрети. |
readOnlyboolean | readOnly значення для передачі в ControllerPublishVolumeRequest. За замовчуванням false (читання/запис). |
volumeAttributesobject | volumeAttributes тома для публікації. |
volumeHandle *string | volumeHandle є унікальним імʼям тома, яке повертається втулком CSI під час виклику CreateVolume для посилання на том у всіх наступних викликах. Обовʼязково. |
CephFSPersistentVolumeSource
Представляє монтування файлової системи Ceph, яке триває протягом життя поду. Томи Cephfs не підтримують управління власністю або переназначення SELinux.
| Поле | Опис |
|---|---|
monitors *string array | monitors є обовʼязковим: Monitors є колекцією моніторів Ceph. Більше інформації: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it |
pathstring | path є опціональним: Використовується як змонтований корінь, а не повне дерево Ceph, стандартно / |
readOnlyboolean | readOnly є опціональним: Зазвичай false (читання/запис). ReadOnly тут примусово встановить параметр ReadOnly у VolumeMounts. Більше інформації: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it |
secretFilestring | secretFile є опціональним: SecretFile є шляхом до вʼязки ключів користувача, зазвичай /etc/ceph/user.secret. Більше інформації: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it |
secretRefSecretReference | secretRef є опціональним: SecretRef є посиланням на обʼєкт секрету для автентифікації користувача, зазвичай порожнє. Більше інформації: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it |
userstring | user є опціональним: User є імʼям користувача rados, за звичай — admin. Більше інформації: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it |
CinderPersistentVolumeSource
Представляє ресурс тома Cinder в Openstack. Том Cinder повинен існувати перед монтуванням до контейнера. Том також повинен бути в тому ж регіоні, що й kubelet. Томи Cinder підтримують управління власністю та переназначення SELinux.
| Поле | Опис |
|---|---|
fsTypestring | fsType є типом файлової системи для монтування. Повинно бути типом файлової системи, підтримуваним операційною системою хоста. Приклади: "ext4", "xfs", "ntfs". Якщо не вказано, зазвичай використовується "ext4". Більше інформації: https://examples.k8s.io/mysql-cinder-pd/README.md |
readOnlyboolean | readOnly є опціональним: Зазвичай false (читання/запис). ReadOnly тут примусово встановить параметр ReadOnly у VolumeMounts. Більше інформації: https://examples.k8s.io/mysql-cinder-pd/README.md |
secretRefSecretReference | secretRef є опціональним: вказує на обʼєкт секрету, що містить параметри для підключення до OpenStack. |
volumeID *string | volumeID використовується для ідентифікації тому в Cinder. Більше інформації: https://examples.k8s.io/mysql-cinder-pd/README.md |
FCVolumeSource
Представляє ресурс тома Fibre Channel. Томи Fibre Channel можна монтувати лише для читання/запису один раз. Томи Fibre Channel підтримують управління власністю та переназначення SELinux.
| Поле | Опис |
|---|---|
fsTypestring | fsType є типом файлової системи для монтування. Повинно бути типом файлової системи, підтримуваним операційною системою хоста. Приклади: "ext4", "xfs", "ntfs". Якщо не вказано, зазвичай використовується "ext4". |
luninteger | lun є опціональним: номер цільового lun для FC |
readOnlyboolean | readOnly є опціональним: зазвичай false (читання/запис). ReadOnly тут примусово встановить параметр ReadOnly у VolumeMounts. |
targetWWNsstring array | targetWWNs є опціональним: FC вказує всесвітні імена (worldwide names, WWN). |
wwidsstring array | wwids є опціональним: всесвітні ідентифікатори томів FC (wwids). Потрібно встановити або wwids, або комбінацію targetWWNs і lun, але не обидва одночасно. |
FlexPersistentVolumeSource
FlexPersistentVolumeSource представляє загальний ресурс постійного тому, який надається/підключається за допомогою втулка на основі виконуваного файлу.
| Поле | Опис |
|---|---|
driver *string | driver є імʼям драйвера, який використовується для цього тому. |
fsTypestring | fsType є типом файлової системи для монтування. Повинно бути типом файлової системи, підтримуваним операційною системою хоста. Приклади: "ext4", "xfs", "ntfs". Зазвичай файлову систему визначає скрипт FlexVolume. |
optionsobject | options є опціональним: це поле містить додаткові параметри команд, якщо вони є. |
readOnlyboolean | readOnly є опціональним: зазвичай false (читання/запис). ReadOnly тут примусово встановить параметр ReadOnly у VolumeMounts. |
secretRefSecretReference | secretRef є опціональним: SecretRef є посиланням на обʼєкт секрету, що містить конфіденційну інформацію для передачі скриптам втулка. Це поле може бути порожнім, якщо обʼєкт секрету не вказано. Якщо обʼєкт секрету містить більше одного секрету, всі секрети передаються скриптам плагіна. |
FlockerVolumeSource
Представляє том Flocker, змонтований агентом Flocker. Потрібно встановити лише одне з полів datasetName або datasetUUID. Томи Flocker не підтримують управління власністю або переназначення SELinux.
| Поле | Опис |
|---|---|
datasetNamestring | datasetName є імʼям набору даних, збереженого як метадані -> імʼя набору даних для Flocker слід вважати за застаріле |
datasetUUIDstring | datasetUUID є UUID набору даних. Це унікальний ідентифікатор набору даних Flocker |
GCEPersistentDiskVolumeSource
Представляє ресурс Persistent Disk у Google Compute Engine.
Том GCE PD повинен існувати перед монтуванням у контейнер. Диск також повинен знаходитися в тому ж проєкті та зоні GCE, що й kubelet. GCE PD можна монтувати лише як читання/запис один раз або як тільки для читання багато разів. GCE PD підтримує управління власністю та переназначення SELinux.
| Поле | Опис |
|---|---|
fsTypestring | fsType є типом файлової системи для монтування. Порада: переконайтеся, що тип файлової системи підтримується операційною системою хоста. Приклади: "ext4", "xfs", "ntfs". Якщо не вказано, неявно вважається "ext4". Більше інформації: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk |
partitioninteger | partition є розділом у томі, який ви хочете змонтувати. Якщо не вказано, зазвичай монтується за іменем тому. Приклади: для тому /dev/sda1 вкажіть розділ як "1". Аналогічно, розділ тому для /dev/sda - "0" (або можна залишити властивість порожньою). Більше інформації: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk |
pdName *string | pdName є унікальним імʼям ресурсу PD у GCE. Використовується для ідентифікації диска в GCE. Більше інформації: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk |
readOnlyboolean | readOnly тут примусово встановлює параметр ReadOnly у VolumeMounts. Зазвичай — false. Більше інформації: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk |
GlusterfsPersistentVolumeSource
Представляє монтування Glusterfs, яке триває протягом життя поду. Томи Glusterfs не підтримують управління власністю або переназначення SELinux.
| Поле | Опис |
|---|---|
endpoints *string | endpoints є іменем точки доступу, яка описує топологію Glusterfs. Більше інформації: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod |
endpointsNamespacestring | endpointsNamespace є простором імен, який містить точку доступу Glusterfs. Якщо це поле порожнє, EndpointNamespace зазвичай буде таким самим, як і простір імен привʼязаного PVC. Більше інформації: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod |
path *string | path є шляхом до тому Glusterfs. Більше інформації: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod |
readOnlyboolean | readOnly тут примусово встановлює параметр ReadOnly у VolumeMounts. Зазвичай — false. Більше інформації: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod |
HostPathVolumeSource
Представляє шлях хоста, змонтований у под. Томи HostPath не підтримують управління власністю або переназначення SELinux.
| Поле | Опис |
|---|---|
path *string | шлях до теки на хості. Якщо шлях є символічним посиланням, воно буде слідувати до реального шляху. Більше інформації: https://kubernetes.io/docs/concepts/storage/volumes#hostpath |
typestring | type для тома HostPath. Зазвичай порожнє. Більше інформації: https://kubernetes.io/docs/concepts/storage/volumes#hostpath Можливі значення enum:
|
ISCSIPersistentVolumeSource
ISCSIPersistentVolumeSource представляє iSCSI диск. iSCSI томи можна монтувати лише як читання/запис один раз. iSCSI томи підтримують управління власністю та переназначення SELinux.
| Поле | Опис |
|---|---|
chapAuthDiscoveryboolean | chapAuthDiscovery визначає, чи підтримується автентифікація iSCSI Discovery CHAP |
chapAuthSessionboolean | chapAuthSession визначає, чи підтримується автентифікація iSCSI Session CHAP |
fsTypestring | fsType визначає тип файлової системи тому, який ви хочете змонтувати. Порада: переконайтеся, що тип файлової системи підтримується операційною системою хоста. Приклади: "ext4", "xfs", "ntfs". Якщо не вказано, неявно вважається "ext4". Більше інформації: https://kubernetes.io/docs/concepts/storage/volumes#iscsi |
initiatorNamestring | initiatorName визначає користувацьке імʼя ініціатора iSCSI. Якщо initiatorName вказано разом з iscsiInterface, буде створено новий інтерфейс iSCSI <target portal>:\<volume name> для підключення. |
iqn *string | iqn визначає iSCSI Qualified Name цільового пристрою. |
iscsiInterfacestring | iscsiInterface визначає імʼя інтерфейсу, який використовує iSCSI транспорт. Зазвичай 'default' (tcp). |
lun *integer | lun визначає номер iSCSI Target Lun. |
portalsstring array | portals визначає список iSCSI Target Portal. Портал може бути або IP-адресою, або ip_addr:port, якщо порт відрізняється від стандартного (зазвичай TCP порти 860 та 3260). |
readOnlyboolean | readOnly визначає, чи буде примусово встановлено режим лише для читання в VolumeMounts. Зазвичай — false. |
secretRefSecretReference | secretRef визначає CHAP Secret для автентифікації iSCSI цілі та ініціатора |
targetPortal *string | targetPortal визначає iSCSI Target Portal. Портал може бути або IP-адресою, або ip_addr:port, якщо порт відрізняється від стандартного (зазвичай TCP порти 860 та 3260). |
LocalVolumeSource
Local представляє безпосередньо підключене сховище зі спорідненістю до вузла
| Поле | Опис |
|---|---|
fsTypestring | fsType визначає тип файлової системи тому, який ви хочете змонтувати. Застосовується лише тоді, коли Path є блочним пристроєм. Повинно бути типом файлової системи, підтримуваним операційною системою хоста. Наприклад: "ext4", "xfs", "ntfs". Стандартно — автоматичний вибір файлової системи, якщо не вказано. |
path *string | path визначає повний шлях до тому на вузлі. Це може бути або тека, або блочний пристрій (диск, розділ тощо). |
NFSVolumeSource
Представляє NFS монтування, яке триває протягом життя поду. NFS томи не підтримують управління власністю або переназначення SELinux.
| Поле | Опис |
|---|---|
path *string | path визначає шлях, який експортується NFS сервером. Більше інформації: https://kubernetes.io/docs/concepts/storage/volumes#nfs |
readOnlyboolean | readOnly визначає, чи буде примусово встановлено режим лише для читання при монтуванні NFS експорту. Стандартно — false. Більше інформації: https://kubernetes.io/docs/concepts/storage/volumes#nfs |
server *string | server визначає імʼя хоста або IP-адресу NFS сервера. Більше інформації: https://kubernetes.io/docs/concepts/storage/volumes#nfs |
PhotonPersistentDiskVolumeSource
Представляє ресурс постійного диска Photon Controller.
| Поле | Опис |
|---|---|
fsTypestring | fsType визначає тип файлової системи тому, який ви хочете змонтувати. Повинно бути типом файлової системи, підтримуваним операційною системою хоста. Наприклад: "ext4", "xfs", "ntfs". Стандартно — автоматичний вибір файлової системи, якщо не вказано. |
pdID *string | pdID визначає ідентифікатор постійного диска Photon Controller |
PortworxVolumeSource
PortworxVolumeSource представляє ресурс тому Portworx.
| Поле | Опис |
|---|---|
fsTypestring | fsType визначає тип файлової системи тому, який ви хочете змонтувати. Повинно бути типом файлової системи, підтримуваним операційною системою хоста. Наприклад: "ext4", "xfs". Стандартно — автоматичний вибір файлової системи, якщо не вказано. |
readOnlyboolean | readOnly визначає, чи буде примусово встановлено режим лише для читання при монтуванні тому. Стандартно — false. Більше інформації: https://kubernetes.io/docs/concepts/storage/volumes#portworx |
volumeID *string | volumeID визначає унікальний ідентифікатор тому Portworx |
QuobyteVolumeSource
Представляє Quobyte монтування, яке триває протягом життя поду. Quobyte томи не підтримують управління власністю або переназначення SELinux.
| Поле | Опис |
|---|---|
groupstring | group для відображення доступу до тому. Стандартно — група не вказана. |
readOnlyboolean | readOnly визначає, чи буде примусово встановлено режим лише для читання при монтуванні Quobyte тому. Стандартно — false. |
registry *string | registry представляє один або кілька сервісів Quobyte Registry, вказаних як рядок у форматі host:port (кілька записів розділяються комами), який виступає центральним реєстром для томів |
tenantstring | tenant визначає власника даного Quobyte тому в бекенді. Використовується з динамічно створеними Quobyte томами, значення встановлюється плагіном |
userstring | user для відображення доступу до тому. Стандартно — користувач облікового запису сервісу. |
volume *string | volume визначає рядок, який посилається на вже створений Quobyte том за назвою. |
RBDPersistentVolumeSource
Представляє монтування Rados Block Device, яке триває протягом життя поду. RBD томи підтримують управління власністю та переназначення SELinux.
| Поле | Опис |
|---|---|
fsTypestring | fsType визначає тип файлової системи тому, який ви хочете змонтувати. Порада: переконайтеся, що тип файлової системи підтримується операційною системою хоста. Приклади: "ext4", "xfs", "ntfs". Якщо не вказано, зазвичай використовується "ext4". Більше інформації: https://kubernetes.io/docs/concepts/storage/volumes#rbd |
image *string | image визначає назву rados image. Більше інформації: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it |
keyringstring | keyring визначає шлях до key ring для RBDUser. Зазвичай /etc/ceph/keyring. Більше інформації: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it |
monitors *string array | monitors визначає колекцію Ceph моніторів. Більше інформації: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it |
poolstring | pool визначає назву rados pool. Зазвичай використовується rbd. Більше інформації: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it |
readOnlyboolean | readOnly тут примусово встановлює параметр ReadOnly у VolumeMounts. За замовчуванням false. Більше інформації: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it |
secretRefSecretReference | secretRef визначає назву секрету для автентифікації RBDUser. Якщо вказано, перевизначає keyring. За замовчуванням nil. Більше інформації: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it |
userstring | user визначає імʼя користувача rados. За замовчуванням admin. Більше інформації: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it |
ScaleIOPersistentVolumeSource
ScaleIOPersistentVolumeSource представляє постійний том ScaleIO
| Поле | Опис |
|---|---|
fsTypestring | fsType визначає тип файлової системи для монтування. Повинно бути типом файлової системи, підтримуваним операційною системою хоста. Наприклад: "ext4", "xfs", "ntfs". Зазвичай "xfs" |
gateway *string | gateway визначає адресу хоста ScaleIO API Gateway. |
protectionDomainstring | protectionDomain визначає назву ScaleIO Protection Domain для налаштованого сховища. |
readOnlyboolean | readOnly зазвичай — false (читання/запис). readOnly тут примусово встановлює параметр ReadOnly у VolumeMounts. |
secretRef *SecretReference | secretRef визначає секрет для користувача ScaleIO та іншої конфіденційної інформації. Якщо не вказано, операція входу завершиться невдачею. |
sslEnabledboolean | sslEnabled визначає прапорець для увімкнення/вимкнення SSL-зʼєднання з Gateway, зазвичай — false. |
storageModestring | storageMode визначає, чи має сховище для тому бути ThickProvisioned або ThinProvisioned. Зазвичай — ThinProvisioned. |
storagePoolstring | storagePool визначає пул сховища ScaleIO, повʼязаний із доменом захисту. |
system *string | system визначає назву системи зберігання, як налаштовано в ScaleIO. |
volumeNamestring | volumeName визначає назву тому, який вже створено в системі ScaleIO і який повʼязаний із цим джерелом тому. |
SecretReference
SecretReference представляє Secret Reference. Містить достатньо інформації для отримання секрету в будь-якому просторі імен.
| Поле | Опис |
|---|---|
namestring | name є унікальним у межах простору імен для посилання на ресурс секрету. |
namespacestring | namespace визначає простір, у межах якого імʼя секрету має бути унікальним. |
StorageOSPersistentVolumeSource
Представляє ресурс постійного тому StorageOS.
| Поле | Опис |
|---|---|
fsTypestring | fsType визначає тип файлової системи для монтування. Повинно бути типом файлової системи, підтримуваним операційною системою хоста. Наприклад: "ext4", "xfs", "ntfs". Зазвичай "ext4" |
readOnlyboolean | readOnly зазвичай — false (читання/запис). readOnly тут примусово встановлює параметр ReadOnly у VolumeMounts. |
secretRefObjectReference | secretRef визначає секрет для отримання облікових даних API StorageOS. Якщо не вказано, будуть використані стандартнізначення. |
volumeNamestring | volumeName є зрозумілим для людини імʼям тому StorageOS. Імена томів унікальні лише в межах простору імен. |
volumeNamespacestring | volumeNamespace визначає область дії тому в межах StorageOS. Якщо простір імен не вказано, буде використано простір імен Pod. Це дозволяє відобразити область дії імен Kubernetes у StorageOS для більш тісної інтеграції. Встановіть VolumeName на будь-яке імʼя, щоб перевизначити стандартну поведінку. Встановіть "default", якщо ви не використовуєте простори імен у StorageOS. Простори імен, які не існують у StorageOS, будуть створені. |
VolumeNodeAffinity
VolumeNodeAffinity визначає обмеження, які обмежують, з яких вузлів можна отримати доступ до цього тому.
| Поле | Опис |
|---|---|
requiredNodeSelector | required визначає жорсткі обмеження для вузлів, які повинні бути виконані. |
VsphereVirtualDiskVolumeSource
Представляє ресурс тому vSphere.
| Поле | Опис |
|---|---|
fsTypestring | fsType визначає тип файлової системи для монтування. Повинно бути типом файлової системи, підтримуваним операційною системою хоста. Наприклад: "ext4", "xfs", "ntfs". Якщо не вказано, зазвичай використовується "ext4". |
storagePolicyIDstring | storagePolicyID є ідентифікатором профілю управління політиками зберігання (SPBM), повʼязаного з StoragePolicyName. |
storagePolicyNamestring | storagePolicyName є імʼям профілю управління політиками зберігання (SPBM). |
volumePath *string | volumePath визначає шлях, який ідентифікує vSphere том vmdk. |
Операції
post Create
HTTP Запит
POST /api/v1/persistentvolumes
Параметри запиту
| Назва | Тип | Опис |
|---|---|---|
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 | PersistentVolume |
Відповідь
| Статус | Опис | Відповідь |
|---|---|---|
| 200 | OK | PersistentVolume |
| 201 | Created | PersistentVolume |
| 202 | Accepted | PersistentVolume |
patch Patch
HTTP Запит
PATCH /api/v1/persistentvolumes/{name}
Параметри шляху
| Назва | Тип | Опис |
|---|---|---|
name | string | Назва PersistentVolume |
Параметри запиту
| Назва | Тип | Опис |
|---|---|---|
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 | PersistentVolume |
| 201 | Created | PersistentVolume |
put Replace
HTTP Запит
PUT /api/v1/persistentvolumes/{name}
Параметри шляху
| Назва | Тип | Опис |
|---|---|---|
name | string | Назва PersistentVolume |
Параметри запиту
| Назва | Тип | Опис |
|---|---|---|
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 | PersistentVolume |
Відповідь
| Статус | Опис | Відповідь |
|---|---|---|
| 200 | OK | PersistentVolume |
| 201 | Created | PersistentVolume |
delete Delete
HTTP Запит
DELETE /api/v1/persistentvolumes/{name}
Параметри шляху
| Назва | Тип | Опис |
|---|---|---|
name | string | Назва PersistentVolume |
Параметри запиту
| Назва | Тип | Опис |
|---|---|---|
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 | PersistentVolume |
| 202 | Accepted | PersistentVolume |
delete Delete Collection
HTTP Запит
DELETE /api/v1/persistentvolumes
Параметри запиту
| Назва | Тип | Опис |
|---|---|---|
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 /api/v1/persistentvolumes/{name}
Параметри шляху
| Назва | Тип | Опис |
|---|---|---|
name | string | Назва PersistentVolume |
Параметри запиту
| Назва | Тип | Опис |
|---|---|---|
pretty | string | Якщо 'true', то вихідні дані форматуються у зручному для читання вигляді. Зазвичай 'false', якщо user-agent не вказує оглядач або командний інструмент для роботи з HTTP (curl та wget). |
Відповідь
| Статус | Опис | Відповідь |
|---|---|---|
| 200 | OK | PersistentVolume |
get List
HTTP Запит
GET /api/v1/persistentvolumes
Параметри запиту
| Назва | Тип | Опис |
|---|---|---|
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 | PersistentVolumeList |
get Watch
HTTP Запит
GET /api/v1/watch/persistentvolumes/{name}
Параметри шляху
| Назва | Тип | Опис |
|---|---|---|
name | string | Назва PersistentVolume |
Параметри запиту
| Назва | Тип | Опис |
|---|---|---|
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 /api/v1/watch/persistentvolumes
Параметри запиту
| Назва | Тип | Опис |
|---|---|---|
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 /api/v1/persistentvolumes/{name}/status
Параметри шляху
| Назва | Тип | Опис |
|---|---|---|
name | string | Назва PersistentVolume |
Параметри запиту
| Назва | Тип | Опис |
|---|---|---|
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 | PersistentVolume |
| 201 | Created | PersistentVolume |
get Read Status
HTTP Запит
GET /api/v1/persistentvolumes/{name}/status
Параметри шляху
| Назва | Тип | Опис |
|---|---|---|
name | string | Назва PersistentVolume |
Параметри запиту
| Назва | Тип | Опис |
|---|---|---|
pretty | string | Якщо 'true', то вихідні дані форматуються у зручному для читання вигляді. Зазвичай 'false', якщо user-agent не вказує оглядач або командний інструмент для роботи з HTTP (curl та wget). |
Відповідь
| Статус | Опис | Відповідь |
|---|---|---|
| 200 | OK | PersistentVolume |
put Replace Status
HTTP Запит
PUT /api/v1/persistentvolumes/{name}/status
Параметри шляху
| Назва | Тип | Опис |
|---|---|---|
name | string | Назва PersistentVolume |
Параметри запиту
| Назва | Тип | Опис |
|---|---|---|
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 | PersistentVolume |
Відповідь
| Статус | Опис | Відповідь |
|---|---|---|
| 200 | OK | PersistentVolume |
| 201 | Created | PersistentVolume |
9 - PersistentVolumeClaim
apiVersion: v1
import "k8s.io/api/core/v1"
PersistentVolumeClaim
PersistentVolumeClaim є запитом користувача на постійний том і заявкою на його використання
| Поле | Опис |
|---|---|
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 |
specPersistentVolumeClaimSpec | spec визначає бажані характеристики тому, запитаного автором поду. Детальніше: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims |
statusPersistentVolumeClaimStatus | status представляє поточну інформацію/стан запиту на постійний том. Тільки для читання. Детальніше: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims |
PersistentVolumeClaimSpec
PersistentVolumeClaimSpec описує загальні атрибути пристроїв зберігання та дозволяє вказати джерело для специфічних атрибутів провайдера
| Поле | Опис |
|---|---|
accessModesstring array | accessModes містить бажані режими доступу, які повинен мати том. Детальніше: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1 |
dataSourceTypedLocalObjectReference | Поле dataSource можна використовувати для вказівки одного з наступного:
|
dataSourceRefTypedObjectReference | dataSourceRef визначає обʼєкт, з якого слід заповнити том даними, якщо потрібен не порожній том. Це може бути будь-який обʼєкт з непорожньої групи API (не основний обʼєкт) або обʼєкт PersistentVolumeClaim. Коли це поле вказано, привʼязка томів буде успішною лише в тому випадку, якщо тип вказаного обʼєкта відповідає деякому встановленому заповнювачу томів або динамічному провайдеру. Це поле замінює функціональність поля dataSource, і тому, якщо обидва поля не порожні, вони повинні мати однакове значення. Для зворотної сумісності, коли namespace не вказано в dataSourceRef, обидва поля (dataSource і dataSourceRef) будуть автоматично встановлені на одне й те саме значення, якщо одне з них порожнє, а інше не порожнє. Коли namespace вказано в dataSourceRef, dataSource не встановлюється на те саме значення і повинно бути порожнім. Існують три важливі відмінності між dataSource і dataSourceRef:
|
resourcesVolumeResourceRequirements | resources представляє мінімальні ресурси, які повинен мати том. Користувачам дозволяється вказувати вимоги до ресурсів, які нижчі за попереднє значення, але все ще повинні бути вищими за ємність, зафіксовану в полі статусу запиту. Більше інформації: https://kubernetes.io/docs/concepts/storage/persistent-volumes#resources |
selectorLabelSelector | selector є запитом міток для томів, які слід розглянути для привʼязки. |
storageClassNamestring | storageClassName є назвою StorageClass, необхідного для запиту. Більше інформації: https://kubernetes.io/docs/concepts/storage/persistent-volumes#class-1 |
volumeAttributesClassNamestring | volumeAttributesClassName може використовуватися для встановлення VolumeAttributesClass, який буде використовуватися цим запитом. Якщо вказано, драйвер CSI створить або оновить том з атрибутами, визначеними у відповідному VolumeAttributesClass. Це має іншу мету, ніж storageClassName, і може бути змінено після створення запиту. Порожній рядок або значення nil вказує, що жоден VolumeAttributesClass не буде застосований до запиту. Якщо запит потрапляє в стан помилки Infeasible, це поле може бути скинуто до попереднього значення (включаючи nil), щоб скасувати зміну. Якщо ресурс, на який посилається volumeAttributesClass, не існує, цей PersistentVolumeClaim буде встановлено в стан Pending, як відображено в полі modifyVolumeStatus, до тих пір, поки такий ресурс не з'явиться. Більше інформації: https://kubernetes.io/docs/concepts/storage/volume-attributes-classes/ |
volumeModestring | volumeMode визначає, який тип тому потрібен для запиту. Значення Filesystem передбачається, якщо не вказано в специфікації запиту. Можливі значення enum:
|
volumeNamestring | volumeName є посиланням на PersistentVolume, який підтримує цей запит. |
PersistentVolumeClaimStatus
PersistentVolumeClaimStatus є поточним станом запиту на постійний том.
| Поле | Опис |
|---|---|
accessModesstring array | accessModes містить фактичні режими доступу, які має том, що підтримує цей PVC. Більше інформації: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1 |
allocatedResourceStatusesobject | allocatedResourceStatuses зберігає стан ресурсу, що змінюється для даного PVC. Імена ключів відповідають стандартному синтаксису міток Kubernetes. Дійсні значення можуть бути такими:
ClaimResourceStatus може бути в будь-якому з наступних станів:
Якщо це поле не встановлено, це означає, що для даного PVC не виконується жодна операція зміни розміру. Контролер, який отримує оновлення PVC з раніше невідомим resourceName або ClaimResourceStatus, повинен ігнорувати оновлення для призначеної мети. Наприклад, контролер, який відповідає лише за зміну розміру ємності тому, повинен ігнорувати оновлення PVC, які змінюють інші дійсні ресурси, повʼязані з PVC. |
allocatedResourcesobject | allocatedResources відстежує ресурси, виділені для PVC, включаючи його ємність. Імена ключів відповідають стандартному синтаксису міток Kubernetes. Допустимі значення можуть бути такими:
Окрім зазначених значень — ключі без префікса або з префіксом kubernetes.io вважаються зарезервованими і тому не можуть використовуватися. Ємність, зазначена тут, може бути більшою за фактичну ємність, коли запитується операція розширення тому. Для квоти зберігання використовується більше значення з allocatedResources та PVC.spec.resources. Якщо allocatedResources не встановлено, для розрахунку квоти використовується лише PVC.spec.resources. Якщо запит на зменшення ємності тому, allocatedResources зменшується лише якщо немає операцій розширення в процесі та фактична ємність тому дорівнює або менша за запитану. Контролер, який отримує оновлення PVC з раніше невідомим resourceName, повинен ігнорувати оновлення для призначеної мети. Наприклад, контролер, який відповідає лише за зміну розміру ємності тому, повинен ігнорувати оновлення PVC, які змінюють інші дійсні ресурси, повʼязані з PVC. |
capacityobject | capacity представляє фактичні ресурси базового тому. |
conditionsPersistentVolumeClaimCondition array patch strategy: злиття за ключем type | conditions є поточним станом PersistentVolumeClaim. Якщо базовий PersistentVolume змінює розмір, то стан буде встановлено на 'Resizing'. |
currentVolumeAttributesClassNamestring | currentVolumeAttributesClassName є поточним іменем VolumeAttributesClass, який використовує PVC. Якщо не встановлено, до цього PersistentVolumeClaim не застосовується жоден VolumeAttributeClass. |
modifyVolumeStatusModifyVolumeStatus | ModifyVolumeStatus представляє обʼєкт стану операції ControllerModifyVolume. Якщо це поле не встановлено, жодна операція ModifyVolume не виконується. |
phasestring | phase представляє поточну фазу PersistentVolumeClaim. Можливі значення enum:
|
PersistentVolumeClaimList
PersistentVolumeClaimList є списком обʼєктів PersistentVolumeClaim.
| Поле | Опис |
|---|---|
apiVersionstring | APIVersion визначає версію схеми цього представлення обʼєкта. Сервери повинні конвертувати розпізнані схеми до останнього внутрішнього значення і можуть відхиляти нерозпізнані значення. Детальніше: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources |
items *PersistentVolumeClaim array | items є списком обʼєктів PersistentVolumeClaim. Детальніше: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims |
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#types-kinds |
ModifyVolumeStatus
ModifyVolumeStatus представляє обʼєкт стану операції ControllerModifyVolume
| Поле | Опис |
|---|---|
status *string | status є статусом операції ControllerModifyVolume. Він може бути в будь-якому з наступних станів:
Можливі значення enum:
|
targetVolumeAttributesClassNamestring | targetVolumeAttributesClassName is the name of the VolumeAttributesClass the PVC currently being reconciled |
PersistentVolumeClaimCondition
PersistentVolumeClaimCondition містить деталі про стан PVC
| Поле | Опис |
|---|---|
lastProbeTimeTime | lastProbeTime є часом, коли ми перевірили стан. |
lastTransitionTimeTime | lastTransitionTime є часом, коли стан змінився з одного на інший. |
messagestring | message є повідомленням, зрозумілим для людини, що вказує на деталі останньої зміни стану. |
reasonstring | reason є унікальним, коротким рядком, придатним для обробки машиною, який вказує на причину останньої зміни стану. Якщо він повідомляє "Resizing", це означає, що базовий постійний том змінюється. |
status *string | Status є статусом стану. Може бути True, False, Unknown. Більше інформації: https://kubernetes.io/docs/reference/kubernetes-api/core/persistent-volume-claim-v1/#PersistentVolumeClaimCondition |
type *string | Type є типом стану. Більше інформації: https://kubernetes.io/docs/reference/kubernetes-api/core/persistent-volume-claim-v1/#PersistentVolumeClaimCondition |
TypedObjectReference
TypedObjectReference містить достатньо інформації, щоб дозволити вам знайти типізований обʼєкт, на який посилаються
| Поле | Опис |
|---|---|
apiGroupstring | APIGroup є групою для ресурсу, на який посилаються. Якщо APIGroup не вказано, зазначений Kind повинен бути в основній групі API. Для будь-яких інших сторонніх типів APIGroup є обовʼязковим. |
kind *string | Kind є типом ресурсу, на який посилаються |
name *string | Name є назвою ресурсу, на який посилаються |
namespacestring | Namespace є простором імен ресурсу, на який посилаються. Зверніть увагу, що коли вказано простір імен, обʼєкт gateway.networking.k8s.io/ReferenceGrant потрібен у просторі імен референта, щоб дозволити власнику цього простору імен прийняти посилання. Див. документацію ReferenceGrant для деталей. (Alpha) Це поле вимагає увімкнення функціонального прапора CrossNamespaceVolumeDataSource. |
VolumeResourceRequirements
VolumeResourceRequirements описує вимоги до ресурсів зберігання для тома.
| Поле | Опис |
|---|---|
limitsobject | Limits описує максимальну кількість обчислювальних ресурсів, дозволених для використання. Більше інформації: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ |
requestsobject | Requests описує мінімальну кількість обчислювальних ресурсів, необхідних для використання. Якщо Requests не вказано для контейнера, воно зазвичай дорівнює Limits, якщо воно явно вказано, або значенню, визначеному реалізацією. Requests не може перевищувати Limits. Більше інформації: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ |
Операції
post Create
HTTP Запит
POST /api/v1/namespaces/{namespace}/persistentvolumeclaims
Параметри шляху
| Назва | Тип | Опис |
|---|---|---|
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 | PersistentVolumeClaim |
Відповідь
| Статус | Опис | Відповідь |
|---|---|---|
| 200 | OK | PersistentVolumeClaim |
| 201 | Created | PersistentVolumeClaim |
| 202 | Accepted | PersistentVolumeClaim |
patch Patch
HTTP Запит
PATCH /api/v1/namespaces/{namespace}/persistentvolumeclaims/{name}
Параметри шляху
| Назва | Тип | Опис |
|---|---|---|
name | string | Назва PersistentVolumeClaim |
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 | PersistentVolumeClaim |
| 201 | Created | PersistentVolumeClaim |
put Replace
HTTP Запит
PUT /api/v1/namespaces/{namespace}/persistentvolumeclaims/{name}
Параметри шляху
| Назва | Тип | Опис |
|---|---|---|
name | string | Назва PersistentVolumeClaim |
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 | PersistentVolumeClaim |
Відповідь
| Статус | Опис | Відповідь |
|---|---|---|
| 200 | OK | PersistentVolumeClaim |
| 201 | Created | PersistentVolumeClaim |
delete Delete
HTTP Запит
DELETE /api/v1/namespaces/{namespace}/persistentvolumeclaims/{name}
Параметри шляху
| Назва | Тип | Опис |
|---|---|---|
name | string | Назва PersistentVolumeClaim |
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 | PersistentVolumeClaim |
| 202 | Accepted | PersistentVolumeClaim |
delete Delete Collection
HTTP Запит
DELETE /api/v1/namespaces/{namespace}/persistentvolumeclaims
Параметри шляху
| Назва | Тип | Опис |
|---|---|---|
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 /api/v1/namespaces/{namespace}/persistentvolumeclaims/{name}
Параметри шляху
| Назва | Тип | Опис |
|---|---|---|
name | string | Назва PersistentVolumeClaim |
namespace | string | Назва обʼєкта та область авторизації, наприклад для команд і проєктів |
Параметри запиту
| Назва | Тип | Опис |
|---|---|---|
pretty | string | Якщо 'true', то вихідні дані форматуються у зручному для читання вигляді. Зазвичай 'false', якщо user-agent не вказує оглядач або командний інструмент для роботи з HTTP (curl та wget). |
Відповідь
| Статус | Опис | Відповідь |
|---|---|---|
| 200 | OK | PersistentVolumeClaim |
get List
HTTP Запит
GET /api/v1/namespaces/{namespace}/persistentvolumeclaims
Параметри шляху
| Назва | Тип | Опис |
|---|---|---|
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 | PersistentVolumeClaimList |
get List All Namespaces
HTTP Запит
GET /api/v1/persistentvolumeclaims
Параметри запиту
| Назва | Тип | Опис |
|---|---|---|
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 | PersistentVolumeClaimList |
get Watch
HTTP Запит
GET /api/v1/watch/namespaces/{namespace}/persistentvolumeclaims/{name}
Параметри шляху
| Назва | Тип | Опис |
|---|---|---|
name | string | Назва PersistentVolumeClaim |
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 /api/v1/watch/namespaces/{namespace}/persistentvolumeclaims
Параметри шляху
| Назва | Тип | Опис |
|---|---|---|
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 /api/v1/watch/persistentvolumeclaims
Параметри запиту
| Назва | Тип | Опис |
|---|---|---|
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 /api/v1/namespaces/{namespace}/persistentvolumeclaims/{name}/status
Параметри шляху
| Назва | Тип | Опис |
|---|---|---|
name | string | Назва PersistentVolumeClaim |
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 | PersistentVolumeClaim |
| 201 | Created | PersistentVolumeClaim |
get Read Status
HTTP Запит
GET /api/v1/namespaces/{namespace}/persistentvolumeclaims/{name}/status
Параметри шляху
| Назва | Тип | Опис |
|---|---|---|
name | string | Назва PersistentVolumeClaim |
namespace | string | Назва обʼєкта та область авторизації, наприклад для команд і проєктів |
Параметри запиту
| Назва | Тип | Опис |
|---|---|---|
pretty | string | Якщо 'true', то вихідні дані форматуються у зручному для читання вигляді. Зазвичай 'false', якщо user-agent не вказує оглядач або командний інструмент для роботи з HTTP (curl та wget). |
Відповідь
| Статус | Опис | Відповідь |
|---|---|---|
| 200 | OK | PersistentVolumeClaim |
put Replace Status
HTTP Запит
PUT /api/v1/namespaces/{namespace}/persistentvolumeclaims/{name}/status
Параметри шляху
| Назва | Тип | Опис |
|---|---|---|
name | string | Назва PersistentVolumeClaim |
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 | PersistentVolumeClaim |
Відповідь
| Статус | Опис | Відповідь |
|---|---|---|
| 200 | OK | PersistentVolumeClaim |
| 201 | Created | PersistentVolumeClaim |
10 - Pod
apiVersion: v1
import "k8s.io/api/core/v1"
Pod
Pod є колекцією контейнерів, які можуть працювати на хості. Цей ресурс створюється клієнтами та планується на хости.
| Поле | Опис |
|---|---|
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 |
specPodSpec | Специфікація бажаної поведінки пода. Детальніше: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status |
statusPodStatus | Найбільш недавно спостережуваний стан пода. Ці дані можуть бути не актуальними. Заповнюється системою. Тільки для читання. Детальніше: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status |
PodSpec
PodSpec є описом пода.
| Поле | Опис |
|---|---|
activeDeadlineSecondsinteger | Опціональна тривалість у секундах, протягом якої под може бути активним на вузлі відносно StartTime, перш ніж система активно спробує позначити його як невдалий і завершити повʼязані контейнери. Значення повинно бути додатним цілим числом. |
affinityAffinity | Якщо вказано, обмеження планування пода |
automountServiceAccountTokenboolean | AutomountServiceAccountToken вказує, чи слід автоматично монтувати токен службового облікового запису. |
containers *Container array patch strategy: злиття за ключем name | Список контейнерів, що належать поду. Контейнери наразі не можна додавати або видаляти. У поді має бути принаймні один контейнер. Не можна оновлювати. |
dnsConfigPodDNSConfig | Вказує параметри DNS для пода. Параметри, вказані тут, будуть обʼєднані зі згенерованою конфігурацією DNS на основі DNSPolicy. |
dnsPolicystring | Встановлює політику DNS для пода. Зазвичай "ClusterFirst". Дійсні значення: 'ClusterFirstWithHostNet', 'ClusterFirst', 'Default' або 'None'. Параметри DNS, вказані в DNSConfig, будуть обʼєднані з політикою, обраною за допомогою DNSPolicy. Щоб мати можливість встановлювати параметри DNS разом з hostNetwork, потрібно явно вказати політику DNS як 'ClusterFirstWithHostNet'. Можливі значення enum:
|
enableServiceLinksboolean | EnableServiceLinks вказує, чи слід робити інʼєкцію інформації про сервіси в змінні середовища пода, відповідно до синтаксису Docker links. Опціонально: зазвичай — true. |
ephemeralContainersEphemeralContainer array patch strategy: злиття за ключем name | Список ефермерних контейнерів, що запускаються в цьому поді. Ефермерні контейнери можуть запускатися в наявному поді для виконання дій, ініційованих користувачем, таких як налагодження. Цей список не можна вказати при створенні пода, і його не можна змінити, оновлюючи специфікацію пода. Щоб додати ефермерний контейнер до наявного пода, використовуйте субресурс ephemeralcontainers пода. |
hostAliasesHostAlias array patch strategy: злиття за ключем ip | HostAliases є опціональним списком хостів та IP-адрес, які будуть додані до файлу hosts пода, якщо вони вказані. |
hostIPCboolean | Використовувати простір імен IPC хоста. Опціонально: зазвичай — false. |
hostNetworkboolean | Для цього пода запрошено мережу хоста. Використовується простір імен мережі хоста. При використанні HostNetwork слід вказати порти, щоб планувальник мав про це інформацію. Якщо `hostNetwork` має значення true, вказані поля hostPort у визначеннях портів повинні збігатися з containerPort, а для полів hostPort, що не вказані у визначеннях портів, стандартно встановлюється значення, яке збігається з containerPort. Стандартно — false. |
hostPIDboolean | Використовувати простір імен PID хоста. Опціонально: зазвичай — false. |
hostUsersboolean | Використовувати простір імен користувачів хоста. Опціонально: зазвичай — true. Якщо встановлено true або не вказано, под буде запущено в просторі імен користувачів хоста, що корисно, коли под потребує функції, доступної лише в просторі імен користувачів хоста, наприклад, завантаження модуля ядра з CAP_SYS_MODULE. Якщо встановлено false, для пода створюється новий userns. Встановлення false корисне для зменшення ризику виходу з контейнера, навіть дозволяючи користувачам запускати свої контейнери як root без фактичних привілеїв root на хості. |
hostnamestring | Вказує імʼя хоста пода. Якщо не вказано, імʼя хоста пода буде встановлено на системно визначене значення. |
hostnameOverridestring | HostnameOverride вказує явне перевизначення імені хоста пода, як його сприймає под. Це поле лише вказує імʼя хоста пода і не впливає на його DNS-записи. Коли це поле встановлено на непорожній рядок:
|
imagePullSecretsLocalObjectReference array patch strategy: злиття за ключем name | ImagePullSecrets є опціональним списком посилань на секрети в тому ж просторі імен, які використовуються для витягування будь-яких образів, що використовуються цим PodSpec. Якщо вказано, ці секрети будуть передані окремим реалізаціям витягування для їх використання. Більше інформації: https://kubernetes.io/docs/concepts/containers/images#specifying-imagepullsecrets-on-a-pod |
initContainersContainer array patch strategy: злиття за ключем name | Список контейнерів ініціалізації, що належатьт поду. Інітконтейнери виконується послідовно перед запуском основних контейнерів. Якщо будь-який інітконтейнер не вдається, под вважається таким, що зазнав невдачі, і обробляється відповідно до його restartPolicy. Імʼя для інітконтейнера або звичайного контейнера має бути унікальним серед усіх контейнерів. Інітконтейнери не можуть мати дії Lifecycle, проб Readiness, Liveness або Startup. Вимоги до ресурсів інітконтейнера враховуються під час планування шляхом знаходження найвищого запиту/обмеження для кожного типу ресурсу, а потім використання максимуму цього значення або суми звичайних контейнерів. Обмеження застосовуються до інітконтейнерів аналогічним чином. Інітконтейнери наразі не можна додавати або видаляти. Не можна оновлювати. Більше інформації: https://kubernetes.io/docs/concepts/workloads/pods/init-containers/ |
nodeNamestring | NodeName вказує, на якому вузлі заплановано цей под. Якщо порожньо, цей под є кандидатом для планування за допомогою планувальника, визначеного в schedulerName. Після встановлення цього поля kubelet для цього вузла стає відповідальним за життєвий цикл цього поду. Це поле не слід використовувати для вираження намірів того, щоб под був запланований на конкретному вузлі. https://kubernetes.io/docs/concepts/scheduling-eviction/assign-pod-node/#nodename |
nodeSelectorobject | NodeSelector є селектором, який повинен бути істинним, щоб под підходив для вузла. Селектор повинен відповідати міткам вузла, щоб под був запланований на цьому вузлі. Більше інформації: https://kubernetes.io/docs/concepts/configuration/assign-pod-node/ |
osPodOS | Визначає операційну систему контейнерів у поді. Деякі поля поду та контейнера обмежені, якщо це поле встановлено. Якщо в поле OS встановлено значення linux, наступні поля не повинні бути встановл:
Якщо в поле OS встановлено значення windows, наступні поля не повинні бути встановлені :
|
overheadobject | Overhead представляє ресурси накладних витрат пода для вказаного RuntimeClass. Це поле буде автоматично заповнене під час допуску контролером RuntimeClass. Якщо контролер допуску RuntimeClass увімкнено, overhead не повинен бути встановлений у запитах на створення Podʼа. Контролер допуску RuntimeClass відхилить запити на створення Podʼа, у яких overhead вже встановлено. Якщо RuntimeClass налаштовано та вибрано в PodSpec, Overhead буде встановлено на значення, визначене у відповідному RuntimeClass, інакше воно залишиться невстановленим і буде розглядатися як нуль. Більше інформації: https://git.k8s.io/enhancements/keps/sig-node/688-pod-overhead/README.md |
preemptionPolicystring | PreemptionPolicy є Політикою випередження подів з нижчим пріоритетом. Одне з: Never, PreemptLowerPriority. Стандартно встановлено PreemptLowerPriority, якщо не вказано. Можливі значення enum:
|
priorityinteger | Значення пріоритету. Різні системні компоненти використовують це поле для визначення пріоритету пода. Коли Priority Admission Controller увімкнено, він запобігає користувачам встановлювати це поле. Контролер допуску заповнює це поле з PriorityClassName. Чим вище значення, тим вищий пріоритет. |
priorityClassNamestring | Якщо вказано, визначає пріоритет пода. "system-node-critical" та "system-cluster-critical" є двома спеціальними ключовими словами, які вказують на найвищі пріоритети, при цьому перше є найвищим пріоритетом. Будь-яке інше імʼя повинно бути визначене шляхом створення обʼєкта PriorityClass з цим імʼям. Якщо не вказано, пріоритет пода буде зазвичай або нульовим, якщо немає стандартного значення. |
readinessGatesPodReadinessGate array | Якщо вказано, всі readiness gates будуть оцінюватися для готовності пода. Под вважається готовим, коли всі його контейнери готові І (AND) всі стани, зазначені в readiness gates, мають статус "True". Більше інформації: https://git.k8s.io/enhancements/keps/sig-network/580-pod-readiness-gates |
resourceClaimsPodResourceClaim array patch strategy: merge,retainKeys за ключем name | ResourceClaims визначає, які ResourceClaims повинні бути виділені та зарезервовані перед тим, як поду буде дозволено запуститися. Ресурси будуть доступні тим контейнерам, які їх споживають за іменем. Це стабільне поле, але вимагає, щоб було увімкнено функціональну можливість DynamicResourceAllocation. Це поле є незмінним. |
resourcesResourceRequirements | Resources визначає загальну кількість ресурсів CPU та памʼяті, необхідних для всіх контейнерів у поді. Підтримується вказівка запитів (Requests) та обмежень (Limits) лише для ресурсів "cpu", "memory" та "hugepages-". ResourceClaims не підтримуються. Це поле дозволяє тонко керувати розподілом ресурсів для всього пода, дозволяючи спільне використання ресурсів між контейнерами в поді. Це альфа-поле і вимагає увімкнення функціональної можливості PodLevelResources. |
restartPolicystring | Політика перезапуску для всіх контейнерів у поді. Одне з значень: Always, OnFailure, Never. У деяких контекстах може бути дозволено лише підмножину цих значень. Стандартно — Always. Більше інформації: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle/#restart-policy Можливі значення enum:
|
runtimeClassNamestring | RuntimeClassName посилається на обʼєкт RuntimeClass у групі node.k8s.io, який повинен бути використаний для запуску цього пода. Якщо жоден ресурс RuntimeClass не відповідає вказаному імені класу, под не буде запущено. Якщо не встановлено або порожньо, буде використано "legacy" RuntimeClass, який є неявним класом з порожнім визначенням, що використовує стандартний обробник. Більше інформації: https://git.k8s.io/enhancements/keps/sig-node/585-runtime-class |
schedulerNamestring | Якщо вказано, под буде оброблено вказаним планувальником. Якщо не вказано, под буде оброблено стандартним планувальником. |
schedulingGatesPodSchedulingGate array patch strategy: злиття за ключем name | SchedulingGates є непрозорим списком значень, які, якщо вказані, блокуватимуть планування пода. Якщо schedulingGates не порожній, под залишатиметься в стані SchedulingGated, і планувальник не намагатиметься його запланувати. SchedulingGates можна встановити лише під час створення пода і видалити лише згодом. |
schedulingGroupPodSchedulingGroup | SchedulingGroup надає посилання на обʼєкт групування середовища виконання безпосереднього планування, до якого належить цей Pod. Це поле використовується планувальником для ідентифікації групи та застосування правильних політик планування групи. Ассоціація з групою також впливає на інші аспекти життєвого циклу Podʼів, які мають значення в ширшому контексті планування, такі як передача пріоритетів, приєднання ресурсів тощо. Якщо не вказано, Pod розглядається як одиниця у всіх цих аспектах. Обʼєкт групи, на який посилається це поле, може не існувати на момент створення Podʼа. Це поле є незмінним, але обʼєкт групи з тим самим імʼям може бути відтворений з іншими політиками. Роблячи це під час планування Podʼа, розміщення може не відповідати очікуваним політикам. |
securityContextPodSecurityContext | SecurityContext містить атрибути безпеки на рівні пода та загальні налаштування контейнера. Опціонально: зазвичай порожньо. Див. опис типу для стандартних значень кожного поля. |
serviceAccountstring | DeprecatedServiceAccount є застарілим псевдонімом для ServiceAccountName. Застаріло: використовуйте serviceAccountName замість цього. |
serviceAccountNamestring | ServiceAccountName є імʼям ServiceAccount, який використовується для запуску цього пода. Більше інформації: https://kubernetes.io/docs/tasks/configure-pod-container/configure-service-account/ |
setHostnameAsFQDNboolean | Якщо true, імʼя хоста пода буде налаштовано як повне доменне імʼя (FQDN) Podʼа, а не просто коротке імʼя (стандартно). У контейнерах Linux це означає встановлення FQDN у полі hostname ядра (поле nodename структури utsname). У контейнерах Windows це означає встановлення значення реєстру hostname для ключа реєстру HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Services\Tcpip\Parameters на FQDN. Якщо под не має FQDN, це не має ефекту. Стандартне значення — false. |
shareProcessNamespaceboolean | Спільний простір імен процесів між усіма контейнерами в поді. Якщо це встановлено, контейнери зможуть бачити та надсилати сигнали процесам з інших контейнерів у тому ж поді, і перший процес у кожному контейнері не буде мати PID 1. HostPID і ShareProcessNamespace не можуть бути встановлені одночасно. Опціонально: стандартне значення — false. |
subdomainstring | Якщо вказано, повне доменне імʼя хоста Podʼа буде "<hostname>.<subdomain>.<pod namespace>.svc.<cluster domain>". Якщо не вказано, под не матиме доменного імені взагалі. |
terminationGracePeriodSecondsinteger | Опціональна тривалість у секундах, необхідна для належного завершення роботи пода. Може бути зменшена в запиті на видалення. Значення повинно бути невідʼємним цілим числом. Значення нуль означає негайну зупинку через сигнал завершення (немає можливості для завершення роботи). Якщо це значення дорівнює nil, буде використано стандартний період очікування. Період очікування — це тривалість у секундах після того, як процеси, що працюють у поді, отримують сигнал завершення, і час, коли процеси примусово зупиняються за допомогою сигналу kill. Встановіть це значення довше, ніж очікуваний час очищення для вашого процесу. Стандартне значення — 30 секунд. |
tolerationsToleration array | Якщо вказано, толерантності пода. |
topologySpreadConstraintsTopologySpreadConstraint array patch strategy: злиття за ключем topologyKey | TopologySpreadConstraints описує, як група подів повинна розподілятися по топологічних доменах. Планувальник буде розміщувати поди таким чином, щоб дотримуватися цих обмежень. Всі topologySpreadConstraints обʼєднуються за логікою AND. |
volumesVolume array patch strategy: merge,retainKeys on key name | Список томів, які можуть бути змонтовані контейнерами, що належать до пода. Більше інформації: https://kubernetes.io/docs/concepts/storage/volumes |
PodStatus
PodStatus представляє інформацію про стан пода. Стан може відставати від фактичного стану системи, особливо якщо вузол, на якому розміщено под, не може звʼязатися з вузлом панелі управління.
| Поле | Опис |
|---|---|
allocatedResourcesobject | AllocatedResources є загальною кількістю запитів, виділених для цього пода вузлом. Якщо запити на рівні пода не встановлені, це буде загальна кількість запитів, агрегованих по контейнерах у поді. |
conditionsPodCondition array patch strategy: злиття за ключем type | Поточний стан обслуговування пода. Більше інформації: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#pod-conditions |
containerStatusesContainerStatus array | Стани контейнерів у цьому поді. Кожен контейнер у поді повинен мати не більше одного стану в цьому списку, і всі стани повинні належати контейнерам у поді. Однак це не контролюється. Якщо стан для відсутнього контейнера присутній у списку, або список містить дублікати імен, поведінка різних компонентів Kubernetes не визначена, і ці стани можуть бути проігноровані. Більше інформації: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#pod-and-container-status |
ephemeralContainerStatusesContainerStatus array | Стани будь-яких ефермерних контейнерів, які запускалися в цьому поді. Кожен ефермерний контейнер у поді повинен мати не більше одного стану в цьому списку, і всі стани повинні належати контейнерам у поді. Однак це не контролюється. Якщо стан для відсутнього контейнера присутній у списку, або список містить дублікати імен, поведінка різних компонентів Kubernetes не визначена, і ці стани можуть бути проігноровані. Більше інформації: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#pod-and-container-status |
extendedResourceClaimStatusPodExtendedResourceClaimStatus | Стан розширеного запиту ресурсів, підтримуваного DRA. |
hostIPstring | hostIP містить IP-адресу хоста, до якого призначено под. Порожнє, якщо под ще не запущено. Под може бути призначений вузлу, який має проблему в kubelet, що, в свою чергу, означає, що HostIP не буде оновлено, навіть якщо вузол призначено поду. |
hostIPsHostIP array patch strategy: злиття за ключем ip | hostIPs містить IP-адреси, виділені хосту. Якщо це поле вказано, перший запис повинен відповідати полю hostIP. Цей список порожній, якщо под ще не запущено. Под може бути призначений вузлу, який має проблему в kubelet, що, в свою чергу, означає, що HostIPs не буде оновлено, навіть якщо вузол призначено цьому поду. |
initContainerStatusesContainerStatus array | Стан ініціалізаційних контейнерів у цьому поді. Останній успішно запущений ініціалізаційний контейнер, який не підлягає перезапуску, матиме ready = true, а останній запущений контейнер матиме встановлений startTime. Кожен ініціалізаційний контейнер у поді повинен мати не більше одного стану в цьому списку, і всі стани повинні належати контейнерам у поді. Однак це не контролюється. Якщо стан для відсутнього контейнера присутній у списку, або список містить дублікати імен, поведінка різних компонентів Kubernetes не визначена, і ці стани можуть бути проігноровані. Більше інформації: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle/#pod-and-container-status |
messagestring | Зрозуміле для людини повідомлення, що вказує деталі щодо того, чому под знаходиться в цьому стані. |
nodeAllocatableResourceClaimStatusesNodeAllocatableResourceClaimStatus array | NodeAllocatableResourceClaimStatuses містить стан ресурсів, доступних вузлу, які були виділені для цього пода через запити DRA. Це включає ресурси, які наразі повідомляються у v1.Node status.allocatable, але не є розширеними ресурсами (див. https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/#extended-resources). Приклади включають "cpu", "memory", "ephemeral-storage" та hugepages. |
nominatedNodeNamestring | nominatedNodeName встановлюється лише тоді, коли цей под передує іншим подам на вузлі, але його не можна запланувати негайно, оскільки жертви випередження отримують свої періоди належного завершення. Це поле не гарантує, що под буде заплановано на цьому вузлі. Планувальник може вирішити розмістити под в іншому місці, якщо інші вузли стануть доступними раніше. Планувальник також може вирішити надати ресурси на цьому вузлі поду з вищим пріоритетом, який створено після випередження. В результаті це поле може відрізнятися від PodSpec.nodeName, коли под заплановано. |
observedGenerationinteger | Якщо встановлено, це представляє .metadata.generation, на основі якого було встановлено стан пода. Щоб використовувати це поле, потрібно ввімкнути функціональну можливість PodObservedGenerationTracking. |
phasestring | Фаза пода є простим, високорівневим підсумком того, на якому етапі життєвого циклу знаходиться под. Масив conditions, поля reason і message, а також масиви станів окремих контейнерів містять більше деталей про стан пода. Існує пʼять можливих значень фази:
Можливі значення enum:
|
podIPstring | podIP адреса, виділена поду. Доступна принаймні всередині кластера. Порожньо, якщо ще не виділено. |
podIPsPodIP array patch strategy: злиття за ключем ip | podIPs містить IP-адреси, виділені поду. Якщо це поле вказано, 0-й елемент повинен відповідати полю podIP. Подам може бути виділено не більше одного значення для кожного з IPv4 та IPv6. Цей список порожній, якщо IP-адреси ще не були виділені. |
qosClassstring | Класифікація якості обслуговування (Quality of Service, QOS) призначена поду на основі вимог до ресурсів. Див. тип PodQOSClass для доступних класів QOS. Більше інформації: https://kubernetes.io/docs/concepts/workloads/pods/pod-qos/#quality-of-service-classes Можливі значення enum:
|
reasonstring | Коротке повідомлення у форматі CamelCase, що вказує на деталі того, чому под знаходиться в цьому стані. Наприклад, 'Evicted' |
resizestring | Статус зміни ресурсів, бажаних для контейнерів поду. Порожньо, якщо зміна ресурсів не очікується. Будь-які зміни ресурсів контейнера автоматично встановлять це значення на "Proposed". Застаріло: Статус зміни ресурсів переміщено до двох станів поду PodResizePending та PodResizeInProgress. PodResizePending відстежує стани, коли специфікація була змінена, але Kubelet ще не виділив ресурси. PodResizeInProgress відстежує зміни в процесі виконання і має бути присутнім, коли виділені ресурси != підтверджені ресурси. |
resourceClaimStatusesPodResourceClaimStatus array patch strategy: merge,retainKeys за ключем name | Статус заявок на ресурси. |
resourcesResourceRequirements | Resources представляє запити та обмеження обчислювальних ресурсів, які були застосовані на рівні поду, якщо запити або обмеження на рівні поду встановлені в PodSpec.Resources |
startTimeTime | Дата та час у форматі RFC 3339, коли обʼєкт був підтверджений Kubelet. Це відбувається до того, як Kubelet завантажив образ(и) контейнера для поду. |
PodList
PodList is a list of Pods.
| Поле | Опис |
|---|---|
apiVersionstring | APIVersion визначає версію схеми цього представлення обʼєкта. Сервери повинні конвертувати розпізнані схеми до останнього внутрішнього значення і можуть відхиляти нерозпізнані значення. Детальніше: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources |
items *Pod array | Список подів. Детальніше: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md |
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#types-kinds |
Affinity
Affinity є групою правил планування за спорідненістю.
| Поле | Опис |
|---|---|
nodeAffinityNodeAffinity | Описує правила планування за спорідненістю вузлів для пода. |
podAffinityPodAffinity | Описує правила планування за спорідненістю подів (наприклад, розміщення цього пода на тому ж вузлі, у тій же зоні тощо, що й інші поди). |
podAntiAffinityPodAntiAffinity | Описує правила планування за антиспорідненістю подів (наприклад, уникати розміщення цього пода на тому ж вузлі, у тій же зоні тощо, що й інші поди). |
AppArmorProfile
AppArmorProfile визначає налаштування AppArmor для пода або контейнера.
| Поле | Опис |
|---|---|
localhostProfilestring | localhostProfile вказує на профіль, завантажений на вузлі, який слід використовувати. Профіль повинен бути попередньо налаштований на вузлі для роботи. Повинен відповідати завантаженій назві профілю. Повинен бути встановлений лише тоді, коли type дорівнює "Localhost". |
type *string | type вказує, який тип профілю AppArmor буде застосовано. Дійсні варіанти:
Можливі значення enum:
|
AzureFileVolumeSource
AzureFile представляє монтування Azure File Service на хості та привʼязку до пода.
| Поле | Опис |
|---|---|
readOnlyboolean | readOnly зазвичай дорівнює false (читання/запис). Встановлення ReadOnly тут примусово встановить параметр ReadOnly у VolumeMounts. |
secretName *string | secretName вказує на назву секрету, який містить імʼя облікового запису Azure Storage та ключ |
shareName *string | shareName вказує на назву Azure File Share |
CSIVolumeSource
Представляє джерело розташування тому для монтування, кероване зовнішнім драйвером CSI.
| Поле | Опис |
|---|---|
driver *string | driver є назвою CSI драйвера, який працює з цим томом. Зверніться до адміністратора для отримання правильної назви, як зареєстровано в кластері. |
fsTypestring | fsType вказує файлову систему для монтування. Наприклад: "ext4", "xfs", "ntfs". Якщо не вказано, порожнє значення передається відповідному CSI драйверу, який визначить стандартну файлову систему. |
nodePublishSecretRefLocalObjectReference | nodePublishSecretRef є посиланням на обʼєкт секрету, який містить конфіденційну інформацію для передачі CSI драйверу для завершення викликів CSI NodePublishVolume та NodeUnpublishVolume. Це поле є необовʼязковим і може бути порожнім, якщо секрет не потрібен. Якщо обʼєкт секрету містить більше одного секрету, передаються всі посилання на секрети. |
readOnlyboolean | readOnly вказує на конфігурацію лише для читання для тому. Стандартне значення — false (читання/запис). |
volumeAttributesobject | volumeAttributes зберігає властивості, специфічні для драйвера, які передаються CSI драйверу. Зверніться до документації вашого драйвера для отримання підтримуваних значень. |
Capabilities
Додає та видаляє POSIX-можливості з працюючих контейнерів.
| Поле | Опис |
|---|---|
addstring array | Додані можливості |
dropstring array | Видалені можливості |
CephFSVolumeSource
Представляє монтування файлової системи Ceph, яке триває протягом життя пода. Томи Cephfs не підтримують управління власністю або переназначення SELinux.
| Поле | Опис |
|---|---|
monitors *string array | monitors є обовʼязковим: Monitors є колекцією Ceph моніторів. Більше інформації: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it |
pathstring | path є опціональним: Використовується як змонтований корінь, а не повне дерево Ceph, стандартно — / |
readOnlyboolean | readOnly є опціональним: Стандартне значення — false (читання/запис). ReadOnly тут примусово встановлює налаштування ReadOnly у VolumeMounts. Більше інформації: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it |
secretFilestring | secretFile є опціональним: SecretFile є шляхом до вʼязки ключів для користувача, стандартно — /etc/ceph/user.secret. Більше інформації: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it |
secretRefLocalObjectReference | secretRef є опціональним: SecretRef є посиланням на секрет для автентифікації користувача, стандартно — порожній. Більше інформації: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it |
userstring | user є опціональним: User є імʼям користувача rados, стандартно — admin. Більше інформації: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it |
CinderVolumeSource
Представляє ресурс тома Cinder в Openstack. Том Cinder повинен існувати перед монтуванням до контейнера. Том також повинен знаходитися в тому ж регіоні, що й kubelet. Томи Cinder підтримують управління власністю та переназначення SELinux.
| Поле | Опис |
|---|---|
fsTypestring | fsType є типом файлової системи для монтування. Повинен бути підтримуваним типом файлової системи операційної системи хоста. Приклади: "ext4", "xfs", "ntfs". Якщо не вказано, неявно вважається "ext4". Більше інформації: https://examples.k8s.io/mysql-cinder-pd/README.md |
readOnlyboolean | readOnly є опціональним: Стандартне значення — false (читання/запис). ReadOnly тут примусово встановлює налаштування ReadOnly у VolumeMounts. Більше інформації: https://examples.k8s.io/mysql-cinder-pd/README.md |
secretRefLocalObjectReference | secretRef є опціональним: Посилання на обʼєкт секрету, що містить параметри для підключення до OpenStack. Більше інформації: https://examples.k8s.io/mysql-cinder-pd/README.md |
volumeID *string | volumeID використовується для ідентифікації тому в Cinder. Більше інформації: https://examples.k8s.io/mysql-cinder-pd/README.md |
ClusterTrustBundleProjection
ClusterTrustBundleProjection описує, як вибрати набір обʼєктів ClusterTrustBundle і зробити проєкцію їх вмісту у файлову систему пода.
| Поле | Опис |
|---|---|
labelSelectorLabelSelector | Вибирає всі ClusterTrustBundles, що відповідають цьому селектору міток. Діє лише якщо встановлено signerName. Взаємовиключно з name. Якщо не встановлено, інтерпретується як "не мати збігу ні з чим". Якщо встановлено, але порожньо, інтерпретується як "мати збіг з усіма". |
namestring | Вибирає один ClusterTrustBundle за імʼям об'єкта. Взаємовиключно з signerName та labelSelector. |
optionalboolean | Якщо true, не блокувати запуск пода, якщо посилання на ClusterTrustBundle(s) недоступне. Якщо використовується name, то дозволяється, щоб вказаний ClusterTrustBundle не існував. Якщо використовується signerName, то комбінація signerName та labelSelector може не відповідати жодному ClusterTrustBundle. |
path *string | Відносний шлях від кореня тому до файлу, куди буде записано пакунок. |
signerNamestring | Вибирає всі ClusterTrustBundles, що відповідають цьому імені підписувача. Взаємовиключно з name. Вміст усіх вибраних ClusterTrustBundles буде обʼєднано та видалено дублікати. |
ConfigMapEnvSource
ConfigMapEnvSource вибирає ConfigMap для заповнення змінних середовища.
Вміст поля Data цільової ConfigMap буде представляти пари ключ-значення як змінні середовища.
| Поле | Опис |
|---|---|
namestring | Імʼя референта. Це поле фактично обовʼязкове, але через зворотну сумісність дозволяється залишати його порожнім. Екземпляри цього типу з порожнім значенням тут майже напевно неправильні. Більше інформації: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
optionalboolean | Вказує, чи має бути визначено ConfigMap |
ConfigMapKeySelector
Вибирає ключ з ConfigMap.
| Поле | Опис |
|---|---|
key *string | Ключ для вибору. |
namestring | Імʼя референта. Це поле фактично обовʼязкове, але через зворотну сумісність дозволяється залишати його порожнім. Екземпляри цього типу з порожнім значенням тут майже напевно неправильні. Більше інформації: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
optionalboolean | Вказує, чи має бути визначено ConfigMap або його ключ |
ConfigMapProjection
Перетворює ConfigMap у проєкційний том.
Вміст поля Data цільової ConfigMap буде представлено в проєкційному томі як файли, використовуючи ключі з поля Data як імена файлів, якщо елемент items не заповнений конкретними відображеннями ключів на шляхи. Зверніть увагу, що це ідентично джерелу тома configmap без стандартного режиму.
| Поле | Опис |
|---|---|
itemsKeyToPath array | Якщо не вказано, кожну пару ключ-значення в полі Data вказаного ConfigMap буде спроєцьовано в том як файл, імʼя якого є ключем, а вміст — значенням. Якщо вказано, перелічені ключі будуть спроєцьовані в зазначені шляхи, а невказані ключі не будуть присутні. Якщо вказано ключ, якого немає в ConfigMap, налаштування тому завершиться помилкою, якщо він не позначений як необовʼязковий. Шляхи повинні бути відносними і не можуть містити '..' або починатися з '..'. |
namestring | Імʼя референта. Це поле фактично обовʼязкове, але через зворотну сумісність дозволяється залишати його порожнім. Екземпляри цього типу з порожнім значенням тут майже напевно неправильні. Більше інформації: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
optionalboolean | Вказує, чи має бути визначено ConfigMap або його ключ |
ConfigMapVolumeSource
Перетворює ConfigMap у том.
Вміст поля Data цільового ConfigMap буде представлено в томі як файли, використовуючи ключі з поля Data як імена файлів, якщо елемент items не заповнений конкретними зіставленням ключів на шляхи. Томи ConfigMap підтримують управління власністю та переназначення SELinux.
| Поле | Опис |
|---|---|
defaultModeinteger | defaultMode є опціональним: біти режиму, які використовуються для встановлення стандартних дозволів на створені файли. Має бути восьмеричне значення від 0000 до 0777 або десяткове значення від 0 до 511. YAML приймає як восьмеричні, так і десяткові значення, JSON вимагає десяткових значень для бітів режиму. Стандартно — 0644. Теки всередині шляху не впливають на це налаштування. Це може конфліктувати з іншими параметрами, які впливають на режим файлу, такими як fsGroup, і результатом можуть бути інші встановлені біти режиму. |
itemsKeyToPath array | Якщо не вказано, кожну пару ключ-значення в полі Data вказаного ConfigMap буде спроєцьовано в том як файл, імʼя якого є ключем, а вміст — значенням. Якщо вказано, перелічені ключі будуть спроєцьовані в зазначені шляхи, а невказані ключі не будуть присутні. Якщо вказано ключ, якого немає в ConfigMap, налаштування тому завершиться помилкою, якщо він не позначений як необовʼязковий. Шляхи повинні бути відносними і не можуть містити '..' або починатися з '..'. |
namestring | Імʼя референта. Це поле фактично обовʼязкове, але через зворотну сумісність дозволяється залишати його порожнім. Екземпляри цього типу з порожнім значенням тут майже напевно неправильні. Більше інформації: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
optionalboolean | optional вказує, чи повинен бути визначений ConfigMap або його ключі |
Container
Один контейнер застосунку, який ви хочете запустити всередині пода.
| Поле | Опис |
|---|---|
argsstring array | Аргументи для точки входу. Використовується CMD образу контейнера, якщо це не вказано. Посилання на змінні $(VAR_NAME) розгортаються за допомогою середовища контейнера. Якщо змінну не вдається розпізнати, посилання у вхідному рядку залишиться без змін. Подвійні $$ зменшуються до одного $, що дозволяє екранувати синтаксис $(VAR_NAME): тобто "$$(VAR_NAME)" створить рядок "$(VAR_NAME)". Екрановані посилання ніколи не будуть розгортатись, незалежно від того, чи існує змінна. Не можна оновлювати. Більше інформації: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell |
commandstring array | Масив точок входу. Не виконується в межах оболонки. Використовується ENTRYPOINT образу контейнера, якщо це не вказано. Посилання на змінні $(VAR_NAME) розгортаються за допомогою середовища контейнера. Якщо змінну не вдається розпізнати, посилання у вхідному рядку залишиться без змін. Подвійні $$ зменшуються до одного $, що дозволяє екранувати синтаксис $(VAR_NAME): тобто "$$(VAR_NAME)" створить рядок "$(VAR_NAME)". Екрановані посилання ніколи не будуть розгортатись, незалежно від того, чи існує змінна. Не можна оновлювати. Більше інформації: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell |
envEnvVar array patch strategy: злиття за ключем name | Список змінних середовища для встановлення в контейнері. Не можна оновлювати. |
envFromEnvFromSource array | Список джерел для заповнення змінних середовища в контейнері. Ключі, визначені в джерелі, можуть складатися з будь-яких друкованих ASCII-символів, крім '='. Якщо ключ існує в кількох джерелах, значення, повʼязане з останнім джерелом, матиме пріоритет. Значення, визначені в Env з дубльованим ключем, матимуть пріоритет. Не можна оновлювати. |
imagestring | Назва образу контейнера. Більше інформації: https://kubernetes.io/docs/concepts/containers/images. Це поле є необовʼязковим, щоб дозволити вищому рівню керування конфігурацією встановлювати стандартні значення або перевизначати образи контейнерів у контролерах робочих навантажень, таких як Deployments і StatefulSets. |
imagePullPolicystring | Політика витягування образу. Одне з Always, Never, IfNotPresent. Стандартно — Always, якщо вказано тег :latest, або IfNotPresent в іншому випадку. Не можна оновлювати. Більше інформації: https://kubernetes.io/docs/concepts/containers/images#updating-images Можливі значення enum:
|
lifecycleLifecycle | Дії, які система керування повинна виконати у відповідь на події життєвого циклу контейнера. Не можна оновлювати. |
livenessProbeProbe | Періодична перевірка життєздатності контейнера. Контейнер буде перезапущено, якщо перевірка не вдасться. Не можна оновлювати. Більше інформації: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes |
name *string | Імʼя контейнера, вказане як DNS_LABEL. Кожен контейнер у поді повинен мати унікальне імʼя (DNS_LABEL). Не можна оновлювати. |
portsContainerPort array patch strategy: злиття за ключем containerPort | Список портів для експонування з контейнера. Не вказуючи порт тут, НЕ забороняє його експонування. Будь-який порт, який слухає на стандартній адресі "0.0.0.0" всередині контейнера, буде доступний з мережі. Зміна цього масиву за допомогою стратегічного злиття може пошкодити дані. Для отримання додаткової інформації див. https://github.com/kubernetes/kubernetes/issues/108255. Не можна оновлювати. |
readinessProbeProbe | Періодична перевірка готовності контейнера. Контейнер буде видалено з точок доступу сервісу, якщо перевірка не вдасться. Не можна оновлювати. Більше інформації: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes |
resizePolicyContainerResizePolicy array | Політика зміни ресурсів для контейнера. Це поле не можна встановлювати для ефермерних контейнерів. |
resourcesResourceRequirements | Обчислювальні ресурси, необхідні для цього контейнера. Не можна оновлювати. Більше інформації: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ |
restartPolicystring | RestartPolicy визначає поведінку перезапуску окремих контейнерів у поді. Перевизначає політику перезапуску на рівні пода. Якщо це поле не вказано, поведінка перезапуску визначається політикою перезапуску пода та типом контейнера. Крім того, встановлення RestartPolicy як "Always" для init-контейнера матиме наступний ефект: цей init-контейнер буде постійно перезапускатися при виході, поки всі звичайні контейнери не завершать роботу. Після завершення роботи всіх звичайних контейнерів, всі init-контейнери з restartPolicy "Always" будуть завершені. Цей життєвий цикл відрізняється від звичайних init-контейнерів і часто називається "sidecar" контейнером. Хоча цей init-контейнер все ще запускається в послідовності init-контейнерів, він не чекає завершення контейнера перед переходом до наступного init-контейнера. Замість цього наступний init-контейнер запускається відразу після запуску цього init-контейнера або після успішного завершення будь-якого startupProbe. |
restartPolicyRulesContainerRestartRule array | Представляє список правил, які перевіряються для визначення, чи слід перезапустити контейнер при виході. Правила оцінюються в порядку їхнього визначення. Як тільки правило відповідає умові виходу контейнера, решта правил ігноруються. Якщо жодне правило не відповідає умові виходу контейнера, політика перезапуску на рівні контейнера визначає, чи буде контейнер перезапущено. Обмеження для правил:
|
securityContextSecurityContext | SecurityContext визначає параметри безпеки, з якими повинен запускатися контейнер. Якщо встановлено, поля SecurityContext перевизначають еквівалентні поля PodSecurityContext. Більше інформації: https://kubernetes.io/docs/tasks/configure-pod-container/security-context/ |
startupProbeProbe | StartupProbe вказує, що Pod успішно ініціалізовано. Якщо вказано, жодні інші перевірки не виконуються, поки ця не завершиться успішно. Якщо ця перевірка не вдасться, Pod буде перезапущено, так само, як якщо б не вдалася livenessProbe. Можна використовувати для надання різних параметрів перевірки на початку життєвого циклу Podʼа, коли може знадобитися багато часу для завантаження даних або прогріву кешу, ніж під час стабільної роботи. Поле не можна оновити. Більше інформації: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes |
stdinboolean | Чи цей контейнер повинен виділяти буфер для stdin у середовищі виконання контейнера. Якщо це не встановлено, читання з stdin у контейнері завжди призведе до EOF. Стандартно — false. |
stdinOnceboolean | Чи середовище виконання контейнера повинно закрити канал stdin після того, як він був відкритий одним підключенням. Коли stdin встановлено в true, потік stdin залишатиметься відкритим під час кількох сеансів підключення. Якщо stdinOnce встановлено в true, stdin відкривається при запуску контейнера, залишається порожнім до першого підключення клієнта до stdin, а потім залишається відкритим і приймає дані до відключення клієнта, після чого stdin закривається і залишається закритим до перезапуску контейнера. Якщо цей прапорець встановлено в false, процеси контейнера, які читають з stdin, ніколи не отримають EOF. Стандартно — false. |
terminationMessagePathstring | Опціонально: Шлях, за яким файл, у який буде записано повідомлення про завершення контейнера, буде змонтовано в файлову систему контейнера. Повідомлення призначене для короткого підсумкового статусу, такого як повідомлення про помилку перевірки. Буде обрізано вузлом, якщо перевищує 4096 байт. Загальна довжина повідомлення для всіх контейнерів буде обмежена 12 КБ. Стандартно — /dev/termination-log. Не можна оновити. |
terminationMessagePolicystring | Вказує, як має бути заповнене повідомлення про завершення. Файл використовуватиме вміст terminationMessagePath для заповнення повідомлення про стан контейнера як у разі успіху, так і у разі помилки. FallbackToLogsOnError використовуватиме останній фрагмент журналу контейнера, якщо файл повідомлення про завершення порожній і контейнер завершився з помилкою. Вихідні дані журналу обмежені 2048 байтами або 80 рядками, залежно від того, що менше. Стандартно — File. Не можна оновити. Можливі значення enum:
|
ttyboolean | Чи цей контейнер повинен виділяти TTY для себе, також вимагає, щоб 'stdin' було встановлено в true. Стандартно — false. |
volumeDevicesVolumeDevice array patch strategy: злиття за ключем devicePath | volumeDevices є списком блочних пристроїв, які будуть використовуватися контейнером. |
volumeMountsVolumeMount array patch strategy: злиття за ключем mountPath | Томи Podʼа для монтування в файлову систему контейнера. Не можна оновити. |
workingDirstring | Робоча тека контейнера. Якщо не вказано, буде використано стандартне значення середовища виконання контейнера, яке може бути налаштоване в образі контейнера. Не можна оновити. |
ContainerExtendedResourceRequest
ContainerExtendedResourceRequest містить зіставлення імені контейнера, імені розширеного ресурсу з іменем запиту пристрою.
| Поле | Опис |
|---|---|
containerName *string | Імʼя контейнера, який запитує ресурси. |
requestName *string | Імʼя запиту в спеціальному ResourceClaim, який відповідає розширеному ресурсу. |
resourceName *string | Імʼя розширеного ресурсу в цьому контейнері, який підтримується DRA. |
ContainerPort
ContainerPort представляє мережевий порт в одному контейнері.
| Поле | Опис |
|---|---|
containerPort *integer | Номер порту для експонування в IP-адресі Podʼа. Це має бути дійсний номер порту, 0 < x < 65536. |
hostIPstring | Яку IP-адресу хосту привʼязати до зовнішнього порту. |
hostPortinteger | Номер порту для експонування на хості. Якщо вказано, це має бути дійсний номер порту, 0 < x < 65536. Якщо вказано HostNetwork, це має відповідати ContainerPort. Більшість контейнерів цього не потребує. |
namestring | Якщо вказано, це має бути IANA_SVC_NAME і унікальним в межах pod. Кожен іменований порт у pod повинен мати унікальне імʼя. Імʼя порту, на який можна посилатися з сервісів. |
protocolstring | Протокол для порту. Має бути UDP, TCP або SCTP. Зазвичай — "TCP". Можливі значення enum:
|
ContainerResizePolicy
ContainerResizePolicy представляє політику зміни розміру ресурсу для контейнера.
| Поле | Опис |
|---|---|
resourceName *string | Імʼя ресурсу, до якого застосовується ця політика зміни розміру ресурсу. Підтримувані значення: cpu, memory. |
restartPolicy *string | Політика перезапуску, яка застосовується при зміні розміру вказаного ресурсу. Якщо не вказано, стандартно використовується NotRequired. |
ContainerRestartRule
ContainerRestartRule описує, як обробляється вихід контейнера.
| Поле | Опис |
|---|---|
action *string | Вказує дію, яка виконується при виході контейнера, якщо вимоги виконані. Єдине можливе значення — "Restart" для перезапуску контейнера. |
exitCodesContainerRestartRuleOnExitCodes | Представляє коди виходу, які потрібно перевіряти при виході контейнера. |
ContainerRestartRuleOnExitCodes
ContainerRestartRuleOnExitCodes описує умову для обробки виходу контейнера на основі його кодів виходу.
| Поле | Опис |
|---|---|
operator *string | Вказує відношення між кодом(ами) виходу контейнера та зазначеними значеннями. Можливі значення:
|
valuesinteger array | Набір значень, які потрібно перевіряти для кодів виходу контейнера. Дозволяється не більше 255 елементів. |
ContainerState
ContainerState описує можливий стан контейнера. Може бути вказаний лише один з його членів. Якщо жоден з них не вказано, за замовчуванням використовується ContainerStateWaiting.
| Поле | Опис |
|---|---|
runningContainerStateRunning | Деталі про контейнер, що працює |
terminatedContainerStateTerminated | Деталі про контейнер, що завершився |
waitingContainerStateWaiting | Деталі про контейнер, що очікує |
ContainerStateRunning
ContainerStateRunning описує стан контейнера, що працює.
| Поле | Опис |
|---|---|
startedAtTime | Час, коли контейнер був останній раз (пере)запущений |
ContainerStateTerminated
ContainerStateTerminated описує стан контейнера, що завершився.
| Поле | Опис |
|---|---|
containerIDstring | ID контейнера у форматі '<type>://<container_id>' |
exitCode *integer | Код виходу з останнього завершення контейнера |
finishedAtTime | Час, коли контейнер останній раз завершився |
messagestring | Повідомлення щодо останнього завершення контейнера |
reasonstring | (коротка) причина останнього завершення контейнера |
signalinteger | Сигнал останнього завершення контейнера |
startedAtTime | Час, коли попереднє виконання контейнера розпочалося |
ContainerStateWaiting
ContainerStateWaiting описує стан контейнера, що очікує.
| Поле | Опис |
|---|---|
messagestring | Повідомлення щодо того, чому контейнер ще не працює. |
reasonstring | (коротка) причина того, чому контейнер ще не працює. |
ContainerUser
ContainerUser описує інформацію про ідентичність користувача
| Поле | Опис |
|---|---|
linuxLinuxContainerUser | Linux містить інформацію про ідентичність користувача, спочатку прикріплену до першого процесу контейнерів у Linux. Зверніть увагу, що фактична ідентичність під час виконання може бути змінена, якщо процес має достатні привілеї для цього. |
DownwardAPIProjection
Представляє інформацію про downward API для виконання проєкції у проєцьований том. Зверніть увагу, що це ідентично джерелу тому downwardAPI без стандартного режиму.
| Поле | Опис |
|---|---|
itemsDownwardAPIVolumeFile array | Items є списком файлів DownwardAPIVolume |
DownwardAPIVolumeFile
DownwardAPIVolumeFile описує інформацію для створення файлу, що містить поле поду
| Поле | Опис |
|---|---|
fieldRefObjectFieldSelector | Обовʼязково: Вибирає поле поду: підтримуються лише анотації, мітки, імʼя, простір імен та uid. |
modeinteger | Опціонально: біти режиму, що використовуються для встановлення дозволів на цей файл, повинні бути вісімковим значенням від 0000 до 0777 або десятковим значенням від 0 до 511. YAML приймає як вісімкові, так і десяткові значення, JSON вимагає десяткових значень для бітів режиму. Якщо не вказано, буде використано volume defaultMode. Це може конфліктувати з іншими параметрами, що впливають на режим файлу, такими як fsGroup, і результатом можуть бути встановлені інші біти режиму. |
path *string | Обовʼязково: шлях є відносним іменем файлу, що буде створено. Не повинен бути абсолютним або містити шлях '..'. Повинен бути закодований у UTF-8. Перший елемент відносного шляху не повинен починатися з '..' |
resourceFieldRefResourceFieldSelector | Обирає ресурс контейнера: наразі підтримуються лише обмеження та запити ресурсів (limits.cpu, limits.memory, requests.cpu та requests.memory). |
DownwardAPIVolumeSource
DownwardAPIVolumeSource описує том, що містить інформацію downward API. Том downward API підтримує керування власністю та переназначення SELinux.
| Поле | Опис |
|---|---|
defaultModeinteger | Опціонально: біти режиму, що використовуються для встановлення дозволів на створені файли за замовчуванням. Повинні бути вісімковим значенням від 0000 до 0777 або десятковим значенням від 0 до 511. YAML приймає як вісімкові, так і десяткові значення, JSON вимагає десяткових значень для бітів режиму. За замовчуванням 0644. Каталоги всередині шляху не впливають на це налаштування. Це може конфліктувати з іншими параметрами, що впливають на режим файлу, такими як fsGroup, і результатом можуть бути встановлені інші біти режиму. |
itemsDownwardAPIVolumeFile array | Items є списком файлів downward API |
EmptyDirVolumeSource
Представляє порожню теку для пода. Том порожньої теки підтримує керування власністю та переназначення SELinux.
| Поле | Опис |
|---|---|
mediumstring | medium представляє тип носія зберігання, який повинен підтримувати цю теку. Зазвичай "" означає використання стандартного носія вузла. Повинно бути порожнім рядком (типово) або Memory. Більше інформації: https://kubernetes.io/docs/concepts/storage/volumes#emptydir. |
sizeLimitQuantity | sizeLimit є загальною кількістю локального сховища, необхідного для цього тома EmptyDir. Обмеження розміру також застосовується до носія памʼяті. Максимальне використання на носії памʼяті EmptyDir буде мінімальним значенням між зазначеним тут SizeLimit та сумою обмежень памʼяті всіх контейнерів у поді. ЗСтандартно — nil, що означає, що обмеження не визначено. Більше інформації: https://kubernetes.io/docs/concepts/storage/volumes#emptydir. |
EnvFromSource
EnvFromSource представляє джерело набору ConfigMaps або Secrets
| Поле | Опис |
|---|---|
configMapRefConfigMapEnvSource | ConfigMap для вибору |
prefixstring | Опційний текст для додавання на початок імені кожної змінної середовища. Може складатися з будь-яких друкованих ASCII-символів, крім '='. |
secretRefSecretEnvSource | Secret для вибору |
EnvVar
EnvVar представляє змінну середовища, присутню в контейнері.
| Поле | Опис |
|---|---|
name *string | Імʼя змінної середовища. Може складатися з будь-яких друкованих ASCII-символів, крім '='. |
valuestring | Посилання на змінні $(VAR_NAME) розширюються з використанням раніше визначених змінних середовища в контейнері та будь-яких змінних середовища сервісу. Якщо змінну не можна розвʼязати, посилання у вхідному рядку залишиться незмінним. Подвійні $$ зменшуються до одного $, що дозволяє екранувати синтаксис $(VAR_NAME): тобто "$$(VAR_NAME)" створить рядковий літерал "$(VAR_NAME)". Екрановані посилання ніколи не будуть розширюватися, незалежно від того, чи існує змінна. Стандартно — "". |
valueFromEnvVarSource | Джерело значення змінної середовища. Не можна використовувати, якщо value не порожнє. |
EnvVarSource
EnvVarSource представляє джерело значення для EnvVar.
| Поле | Опис |
|---|---|
configMapKeyRefConfigMapKeySelector | Вибір ключа з ConfigMap. |
fieldRefObjectFieldSelector | Вибір поля пода: підтримуються metadata.name, metadata.namespace, `metadata.labels['<KEY>']`, `metadata.annotations['<KEY>']`, spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs. |
fileKeyRefFileKeySelector | FileKeyRef вибирає ключ з файлу змінних середовища. Потрібно, щоб функціональна можливість EnvFiles була увімкнена. |
resourceFieldRefResourceFieldSelector | Вибір ресурсу контейнера: наразі підтримуються лише обмеження та запити ресурсів (limits.cpu, limits.memory, limits.ephemeral-storage, requests.cpu, requests.memory та requests.ephemeral-storage). |
secretKeyRefSecretKeySelector | Вибір ключа з секрету в просторі імен пода. |
EphemeralContainer
EphemeralContainer є тимчасовим контейнером, який можна додати до наявного пода для ініційованих користувачем дій, таких як налагодження. Тимчасові контейнери не мають гарантій щодо ресурсів або планування, і вони не будуть перезапущені після виходу або видалення пода. Kubelet може виселити под, якщо тимчасовий контейнер призведе до перевищення виділених ресурсів пода.
Щоб додати тимчасовий контейнер, використовуйте субресурс ephemeralcontainers наявного пода. Тимчасові контейнери не можуть бути видалені або перезапущені.
| Поле | Опис |
|---|---|
argsstring array | Аргументи для точки входу. Використовується CMD образу, якщо це не вказано. Посилання на змінні $(VAR_NAME) розгортаються за допомогою середовища контейнера. Якщо змінну не вдається знайти, посилання вхідного рядка залишиться без змін. Подвійні $$ зменшуються до одного $, що дозволяє екранувати синтаксис $(VAR_NAME): тобто "$$(VAR_NAME)" створить рядок літералів "$(VAR_NAME)". Екрановані посилання ніколи не будуть розгорнуті, незалежно від того, чи існує змінна. Не можна оновлювати. Більше інформації: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell |
commandstring array | Масив точок входу. Не виконується в межах оболонки. Використовується ENTRYPOINT образу, якщо це не вказано. Посилання на змінні $(VAR_NAME) розгортаються за допомогою середовища контейнера. Якщо змінну не вдається знайти, посилання вхідного рядка залишиться без змін. Подвійні $$ зменшуються до одного $, що дозволяє екранувати синтаксис $(VAR_NAME): тобто "$$(VAR_NAME)" створить рядок літералів "$(VAR_NAME)". Екрановані посилання ніколи не будуть розгорнуті, незалежно від того, чи існує змінна. Не можна оновлювати. Більше інформації: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell |
envEnvVar array patch strategy: злиття за ключем name | Список змінних середовища для встановлення в контейнері. Не можна оновлювати. |
envFromEnvFromSource array | Список джерел для заповнення змінних середовища в контейнері. Ключі, визначені в джерелі, можуть складатися з будь-яких друкованих ASCII-символів, крім '='. Якщо ключ існує в кількох джерелах, значення, пов'язане з останнім джерелом, матиме пріоритет. Значення, визначені за допомогою Env з дубльованим ключем, матимуть пріоритет. Не можна оновлювати. |
imagestring | Назва образу контейнера. Більше інформації: https://kubernetes.io/docs/concepts/containers/images |
imagePullPolicystring | Політика витягування образу. Одне з Always, Never, IfNotPresent. За замовчуванням Always, якщо вказано тег :latest, або IfNotPresent в іншому випадку. Не можна оновлювати. Більше інформації: https://kubernetes.io/docs/concepts/containers/images#updating-images Можливі значення enum:
|
lifecycleLifecycle | Lifecycle не дозволено для епhemeral контейнерів. |
livenessProbeProbe | Probes не дозволено для епhemeral контейнерів. |
name *string | Назва епhemeral контейнера, вказана як DNS_LABEL. Ця назва повинна бути унікальною серед усіх контейнерів, init контейнерів та епhemeral контейнерів. |
portsContainerPort array patch strategy: злиття за ключем containerPort | Ports не дозволено для епhemeral контейнерів. |
readinessProbeProbe | Probes не дозволено для епhemeral контейнерів. |
resizePolicyContainerResizePolicy array | Правила зміни розміру ресурсів для контейнера. |
resourcesResourceRequirements | Resources не дозволено для епhemeral контейнерів. Епhemeral контейнери використовують вільні ресурси, вже виділені для поду. |
restartPolicystring | Політика перезапуску для контейнера для керування поведінкою перезапуску кожного контейнера в поді. Ви не можете встановлювати це поле для епhemeral контейнерів. |
restartPolicyRulesContainerRestartRule array | Представляє список правил, які перевіряються, щоб визначити, чи слід перезапустити контейнер після виходу. Ви не можете встановлювати це поле для епhemeral контейнерів. |
securityContextSecurityContext | Опційно: SecurityContext визначає параметри безпеки, з якими слід запускати епhemeral контейнер. Якщо встановлено, поля SecurityContext перевизначають еквівалентні поля PodSecurityContext. |
startupProbeProbe | Probes не дозволено для епhemeral контейнерів. |
stdinboolean | Чи повинен цей контейнер виділяти буфер для stdin у середовищі виконання контейнера. Якщо це не встановлено, читання з stdin у контейнері завжди призведе до EOF. Стандартно — false. |
stdinOnceboolean | Чи повинен середовище виконання контейнера закривати канал stdin після того, як він був відкритий одним підключенням. Коли stdin встановлено в true, потік stdin залишатиметься відкритим під час кількох сеансів підключення. Якщо stdinOnce встановлено в true, stdin відкривається при запуску контейнера, порожній до першого підключення клієнта до stdin, а потім залишається відкритим і приймає дані до відключення клієнта, після чого stdin закривається і залишається закритим до перезапуску контейнера. Якщо цей прапорець встановлено в false, процеси контейнера, які читають зі stdin, ніколи не отримають EOF. Стандартно — false. |
targetContainerNamestring | Якщо встановлено, імʼя контейнера з PodSpec, на який націлений цей епhemeral контейнер. Епhemeral контейнер буде запущений у просторах імен (IPC, PID тощо) цього контейнера. Якщо не встановлено, епhemeral контейнер використовує простори імен, налаштовані в Pod spec. Середовище виконання контейнера повинно підтримувати цю функцію. Якщо середовище виконання не підтримує націлювання на простори імен, результат встановлення цього поля невизначений. |
terminationMessagePathstring | Опційно: Шлях, за яким файл, у який буде записано повідомлення про завершення контейнера, монтується в файлову систему контейнера. Повідомлення призначене для короткого підсумкового статусу, такого як повідомлення про помилку перевірки. Буде обрізано вузлом, якщо перевищує 4096 байт. Загальна довжина повідомлення для всіх контейнерів буде обмежена 12 КБ. Стандартно — /dev/termination-log. Не можна оновлювати. |
terminationMessagePolicystring | Вказує, як має бути заповнене повідомлення про завершення. Файл використовуватиме вміст terminationMessagePath для заповнення повідомлення про стан контейнера як у разі успіху, так і у разі помилки. FallbackToLogsOnError використовуватиме останній фрагмент журналу контейнера, якщо файл повідомлення про завершення порожній і контейнер завершився з помилкою. Вихідні дані журналу обмежені 2048 байтами або 80 рядками, залежно від того, що менше. Стандартно використовується File. Не можна оновлювати. Можливі значення enum:
|
ttyboolean | Чи повинен цей контейнер виділяти TTY для себе, також вимагає, щоб 'stdin' було встановлено в true. Стандартно — false. |
volumeDevicesVolumeDevice array patch strategy: злиття за ключем devicePath | volumeDevices є списком блочних пристроїв, які будуть використовуватися контейнером. |
volumeMountsVolumeMount array patch strategy: злиття за ключем mountPath | Томи Podʼа для монтування у файлову систему контейнера. Subpath mounts не дозволені для епhemeral контейнерів. Не можна оновлювати. |
workingDirstring | Робоча тека контейнера. Якщо не вказано, буде використано стандартне значення середовища виконання контейнера, яке може бути налаштоване в образі контейнера. Не можна оновлювати. |
EphemeralVolumeSource
Представляє епhemeral том, який обробляється звичайним драйвером зберігання.
| Поле | Опис |
|---|---|
volumeClaimTemplatePersistentVolumeClaimTemplate | Буде використано для створення окремого PVC для забезпечення тому. Под, у якому вбудовано цей EphemeralVolumeSource, буде власником PVC, тобто PVC буде видалено разом із подом. Імʼя PVC буде <pod name>-<volume name>, де <volume name> — це імʼя з масиву PodSpec.Volumes. Валідація пода відхилить под, якщо обʼєднане імʼя не є дійсним для PVC (наприклад, занадто довге). Наявний PVC з таким імʼям, який не належить поду, *не* буде використаний для пода, щоб уникнути випадкового використання стороннього тому. Запуск пода буде заблоковано, поки не буде видалено сторонній PVC. Якщо такий попередньо створений PVC призначений для використання подом, PVC потрібно оновити з посиланням на власника пода після його створення. Зазвичай це не потрібно, але може бути корисним при ручному відновленні пошкодженого кластера. Це поле лише для читання, і Kubernetes не вноситиме зміни до PVC після його створення. Обовʼязкове, не може бути nil. |
ExecAction
ExecAction описує дію "запуск в контейнері".
| Поле | Опис |
|---|---|
commandstring array | Команда для виконання всередині контейнера. Робоча тека для команди — коренева ('/') у файловій системі контейнера. Команда просто виконується, вона не запускається всередині оболонки, тому традиційні інструкції оболонки ('|', тощо) не працюватимуть. Щоб використовувати оболонку, потрібно явно викликати цю оболонку. Статус виходу 0 вважається життєздатним/справним, а ненульовий — несправним. |
FileKeySelector
FileKeySelector вибирає ключ з файлу середовища.
| Поле | Опис |
|---|---|
key *string | Ключ у файлі середовища. Недійсний ключ запобігатиме запуску пода. Ключі, визначені в джерелі, можуть складатися з будь-яких друкованих ASCII-символів, крім '='. Під час альфа-етапу функції EnvFiles розмір ключа обмежений 128 символами. |
optionalboolean | Вказує, чи файл або його ключ мають бути визначені. Якщо файл або ключ не існує, змінна середовища не буде опублікована. Якщо optional встановлено в true і вказаний ключ не існує, змінна середовища не буде встановлена в контейнерах пода. Якщо optional встановлено в false і вказаний ключ не існує, під час створення пода буде повернено помилку. |
path *string | Шлях у межах тому, з якого потрібно вибрати файл. Має бути відносним і не може містити '..' або починатися з '..'. |
volumeName *string | Імʼя тому, що містить файл середовища. |
FlexVolumeSource
FlexVolume представляє собою загальний ресурс тому, який надається/підключається за допомогою втулка на основі exec.
| Поле | Опис |
|---|---|
driver *string | driver є імʼям драйвера, який використовується для цього тому. |
fsTypestring | fsType є типом файлової системи для монтування. Має бути типом файлової системи, підтримуваним операційною системою хоста. Наприклад, "ext4", "xfs", "ntfs". Стандартна файлова система залежить від скрипта FlexVolume. |
optionsobject | options є опціональним: це поле містить додаткові параметри команди, якщо вони є. |
readOnlyboolean | readOnly є опціональним: стандартно — false (читання/запис). Встановлення ReadOnly тут примусово встановить параметр ReadOnly у VolumeMounts. |
secretRefLocalObjectReference | secretRef є опціональним: secretRef є посиланням на обʼєкт секрету, що містить конфіденційну інформацію для передачі скриптам плагіна. Це поле може бути порожнім, якщо обʼєкт секрету не вказано. Якщо обʼєкт секрету містить більше одного секрету, усі секрети передаються скриптам плагіна. |
GRPCAction
GRPCAction визначає дію, повʼязану з сервісом GRPC.
| Поле | Опис |
|---|---|
port *integer | Номер порту сервісу gRPC. Значення має бути в діапазоні від 1 до 65535. |
servicestring | Service є імʼям сервісу, який буде вказано в gRPC HealthCheckRequest (див. https://github.com/grpc/grpc/blob/master/doc/health-checking.md). Якщо не вказано, стандартна поведінка визначається gRPC. |
GitRepoVolumeSource
Представляє том, який заповнюється вмістом репозиторію git. Томи git не підтримують управління власністю. Томи git підтримують переназначення SELinux.
ЗАСТАРІЛО: GitRepo застарів. Щоб забезпечити контейнер репозиторієм git, змонтуйте EmptyDir в InitContainer, який клонує репозиторій за допомогою git, а потім змонтуйте EmptyDir в контейнер Podʼа.
| Поле | Опис |
|---|---|
directorystring | directory є імʼям цільової теки. Не може містити або починатися з '..'. Якщо вказано '.', тека тому буде репозиторієм git. В іншому випадку, якщо вказано, том міститиме репозиторій git у вкладеній теці з вказаним імʼям. |
repository *string | repository є URL-адресою репозиторію git. |
revisionstring | revision є хешем коміту для вказаної ревізії. |
GlusterfsVolumeSource
Представляє собою монтування Glusterfs, яке триває протягом життя Podʼа. Томи Glusterfs не підтримують управління власністю або переназначення SELinux.
| Поле | Опис |
|---|---|
endpoints *string | endpoints є імʼям точки доступу, яка описує топологію Glusterfs. |
path *string | path є шляхом до тому Glusterfs. Більше інформації: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod |
readOnlyboolean | readOnly тут примусово встановить том Glusterfs у режимі лише для читання. Стандартно — false. Більше інформації: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod |
HTTPGetAction
HTTPGetAction описує дію, засновану на HTTP Get запитах.
| Поле | Опис |
|---|---|
hoststring | Імʼя хоста для підключення, зазвичай використовується IP-адреса Pod. Ймовірно, ви захочете встановити "Host" у httpHeaders замість цього. |
httpHeadersHTTPHeader array | Власні заголовки для встановлення в запиті. HTTP дозволяє повторювані заголовки. |
pathstring | Шлях для доступу на HTTP сервері. |
port * | Імʼя або номер порту для доступу на контейнері. Номер повинен бути в діапазоні від 1 до 65535. Імʼя повинно бути IANA_SVC_NAME. |
schemestring | Схема для підключення до хоста. Стандартно — HTTP. Можливі значення enum:
|
HTTPHeader
HTTPHeader описує власний заголовок, який буде використано в HTTP-запитах.
| Поле | Опис |
|---|---|
name *string | Імʼя заголовка. Воно буде канонізоване при виведенні, тому варіанти з різним регістром будуть розумітися як один і той же заголовок. |
value *string | Значення заголовка. |
HostAlias
HostAlias представляє відповідність між IP та іменами хостів, які будуть вставлені як запис у файлі hosts Podʼа.
| Поле | Опис |
|---|---|
hostnamesstring array | Імена хостів для вказаної IP-адреси. |
ip *string | IP-адреса для запису у файлі hosts. |
HostIP
HostIP представляє одну IP-адресу, виділену для хоста.
| Поле | Опис |
|---|---|
ip *string | IP є IP-адресою, виділеною для хосту. |
ISCSIVolumeSource
Представляє диск ISCSI. Томи ISCSI можна монтувати лише як читання/запис один раз. Томи ISCSI підтримують управління власністю та переназначення міток SELinux.
| Поле | Опис |
|---|---|
chapAuthDiscoveryboolean | chapAuthDiscovery визначає, чи підтримується автентифікація iSCSI Discovery CHAP |
chapAuthSessionboolean | chapAuthSession визначає, чи підтримується автентифікація iSCSI Session CHAP |
fsTypestring | fsType визначає тип файлової системи тому, який ви хочете змонтувати. Порада: Переконайтеся, що тип файлової системи підтримується операційною системою хосту. Приклади: "ext4", "xfs", "ntfs". Якщо не вказано, зазвичай використовується "ext4". Більше інформації: https://kubernetes.io/docs/concepts/storage/volumes#iscsi. |
initiatorNamestring | initiatorName є власним iSCSI Initiator Name. Якщо initiatorName вказано разом з iscsiInterface, буде створено новий iSCSI інтерфейс <target portal>:\<volume name> для підключення. |
iqn *string | iqn є iSCSI Qualified Name цілі. |
iscsiInterfacestring | iscsiInterface є імʼям інтерфейсу, який використовує iSCSI транспорт. Стандартно — 'default' (tcp). |
lun *integer | lun представляє номер iSCSI Target Lun. |
portalsstring array | portals є списком iSCSI Target Portal. Портал може бути або IP-адресою, або ip_addr:port, якщо порт відрізняється від стандартного (зазвичай TCP порти 860 та 3260). |
readOnlyboolean | readOnly тут примусово встановлює параметр ReadOnly у VolumeMounts. Стандартно — false. |
secretRefLocalObjectReference | secretRef є CHAP Secret для автентифікації iSCSI цілі та ініціатора |
targetPortal *string | targetPortal є iSCSI Target Portal. Портал може бути або IP-адресою, або ip_addr:port, якщо порт відрізняється від стандартного (зазвичай TCP порти 860 та 3260). |
ImageVolumeSource
ImageVolumeSource представляє ресурс образу тома.
| Поле | Опис |
|---|---|
pullPolicystring | Політика отримання обʼєктів OCI. Можливі значення: Always: kubelet завжди намагається отримати образ за посиланням. Створення контейнера зазнає невдачі, якщо отримання не вдається. Never: kubelet ніколи не намагається отримати образ за посиланням і використовує лише локальний образ або артефакт. Створення контейнера зазнає невдачі, якщо посилання відсутнє. IfNotPresent: kubelet намагається отримати обʼєкт, якщо він ще не присутній на диску. Створення контейнера зазнає невдачі, якщо посилання відсутнє і отримання не вдається. Стандартно — Always, якщо вказано тег :latest, або IfNotPresent в іншому випадку. Можливі значення enum:
|
referencestring | Обовʼязково: Образ або посилання на артефакт для використання. Поводиться так само, як pod.spec.containers[*].image. Секрети для отримання образу будуть зібрані так само, як для образу контейнера, шляхом перевірки облікових даних вузла, секретів для отримання образу SA та секретів для отримання образу pod spec. Більше інформації: https://kubernetes.io/docs/concepts/containers/images. Це поле є необовʼязковим, щоб дозволити вищому рівню керування конфігурацією встановлювати стандартне значення або перевизначати образи контейнерів у контролерах робочих навантажень, таких як Deployments та StatefulSets. |
ImageVolumeStatus
ImageVolumeStatus представляє стан тому на основі образу.
| Поле | Опис |
|---|---|
imageRef *string | ImageRef є дайджестом образу, використаного для цього тому. Він повинен мати значення, подібне до pod.status.containerStatuses[i].imageID. Довжина ImageRef не повинна перевищувати 256 символів. |
KeyToPath
Зіставлення рядка ключа з шляхом у межах тому.
| Поле | Опис |
|---|---|
key *string | key є ключем для проєкції. |
modeinteger | mode є опціональним: біти режиму, які використовуються для встановлення дозволів на цей файл. Має бути вісімкове значення від 0000 до 0777 або десяткове значення від 0 до 511. YAML приймає як вісімкові, так і десяткові значення, JSON вимагає десяткові значення для бітів режиму. Якщо не вказано, буде використано стандартне значення для тому. Може конфліктувати з іншими параметрами, які впливають на режим файлу, такими як fsGroup, і результатом можуть бути інші встановлені біти режиму. |
path *string | path є відносним шляхом файлу для зіставлення ключа. Не може бути абсолютним шляхом. Не може містити елемент шляху '..'. Не може починатися зі рядка '..'. |
Lifecycle
Lifecycle описує дії, які система керування повинна виконувати у відповідь на події життєвого циклу контейнера. Для обробників життєвого циклу PostStart і PreStop керування контейнером блокується до завершення дії, якщо процес контейнера не зазнає невдачі, у такому випадку робота обробника переривається.
| Поле | Опис |
|---|---|
postStartLifecycleHandler | PostStart викликається одразу після створення контейнера. У разі збою обробника, робота контейнера завершується і перезапускається відповідно до його політики перезапуску. Інше керування контейнером блокується до завершення роботи обробника. Більше інформації: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks. |
preStopLifecycleHandler | PreStop викликається одразу перед завершенням роботи контейнера через запит API або подію керування, таку як збій перевірки життєздатності/запуску, примусове завершення, конфлікт ресурсів тощо. Обробник не викликається, якщо контейнер аварійно завершує роботу або виходить. Зворотний відлік періоду завершення роботи Podʼа починається перед виконанням обробника PreStop. Незалежно від результату роботи обробника, контейнер зрештою завершить роботу в межах періоду завершення роботи Podʼа (якщо не затримано завершувачами). Інше керування контейнером блокується до завершення роботи обробника або до досягнення періоду завершення роботи. Більше інформації: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks. |
stopSignalstring | StopSignal визначає, який сигнал буде надіслано контейнеру під час його зупинки. Якщо не вказано, стандартне значення визначається середовищем виконання контейнера. StopSignal можна встановити лише для Podʼів з непорожнім .spec.os.name Можливі значення enum:
|
LifecycleHandler
LifecycleHandler визначає конкретну дію, яка повинна бути виконана в хуку життєвого циклу. Повинно бути вказано лише одне з полів, за винятком TCPSocket.
| Поле | Опис |
|---|---|
execExecAction | Exec визначає команду, яку потрібно виконати в контейнері. |
httpGetHTTPGetAction | HTTPGet визначає HTTP GET запит, який потрібно виконати. |
sleepSleepAction | Sleep визначає тривалість, протягом якої контейнер повинен спати. |
tcpSocketTCPSocketAction | Застаріло. TCPSocket не підтримується як LifecycleHandler і зберігається для зворотної сумісності. Валідація цього поля не проводиться, і хуки життєвого циклу не працюватимуть під час виконання, якщо воно вказане. |
LinuxContainerUser
LinuxContainerUser представляє інформацію про ідентичність користувача в Linux-контейнерах
| Поле | Опис |
|---|---|
gid *integer | GID є основним GID, спочатку прикріпленим до першого процесу в контейнері |
supplementalGroupsinteger array | SupplementalGroups є додатковими групами, спочатку прикріпленими до першого процесу в контейнері |
uid *integer | UID є основним UID, спочатку прикріпленим до першого процесу в контейнері |
NodeAffinity
Node affinity є групою правил планування на основі спорідненості вузлів.
| Поле | Опис |
|---|---|
preferredDuringSchedulingIgnoredDuringExecutionPreferredSchedulingTerm array | Планувальник надаватиме перевагу розміщенню подів на вузлах, які задовольняють виразам спорідненості, зазначеним в цьому полі, але він може обрати вузол, який порушує один або кілька виразів. Найбільш бажаним вузлом є той, який має найбільшу суму ваг, тобто для кожного вузла, який відповідає всім вимогам планування (запит ресурсів, вирази спорідненості requiredDuringScheduling тощо), обчислить суму, перебираючи елементи цього поля та додаючи "вагу" до суми, якщо вузол відповідає відповідним matchExpressions; вузол(и) з найвищою сумою є найбільш бажаними. |
requiredDuringSchedulingIgnoredDuringExecutionNodeSelector | Якщо вимоги спорідненості, зазначені в цьому полі, не виконуються під час планування, под не буде заплановано на вузол. Якщо вимоги спорідненості, зазначені в цьому полі, перестануть виконуватися під час виконання поду (наприклад, через оновлення), система може або не може спробувати в кінцевому підсумку виселити под з його вузла. |
NodeAllocatableResourceClaimStatus
NodeAllocatableResourceClaimStatus описує стан ресурсів, доступних на вузлі, які були виділені через DRA.
| Поле | Опис |
|---|---|
containersstring array | Список контейнерів у цьому поді, які посилаються на цей запит ресурсів. |
resourceClaimName *string | ResourceClaimName є запитом ресурсів, на який посилається под, що призвів до цього виділення ресурсів на вузлі. |
resources *object | Resources є мапою імен ресурсів, доступних на вузлі, до загальної кількості, виділеної для цього запиту. |
ObjectFieldSelector
ObjectFieldSelector обирає поле обʼєкта з вказаною версією API.
| Поле | Опис |
|---|---|
apiVersionstring | Версія схеми, у термінах якої записано FieldPath, стандартно — "v1". |
fieldPath *string | Шлях до поля, яке потрібно обрати у вказаній версії API. |
PersistentVolumeClaimTemplate
PersistentVolumeClaimTemplate використовується для створення обʼєктів PersistentVolumeClaim як частини EphemeralVolumeSource.
| Поле | Опис |
|---|---|
metadataObjectMeta | Може містити мітки та анотації, які будуть скопійовані в PVC під час його створення. Жодні інші поля не дозволяються і будуть відхилені під час перевірки. |
spec *PersistentVolumeClaimSpec | Специфікація для PersistentVolumeClaim. Весь вміст копіюється без змін у PVC, який створюється з цього шаблону. Ті самі поля, що й у PersistentVolumeClaim, також дійсні тут. |
PersistentVolumeClaimVolumeSource
PersistentVolumeClaimVolumeSource посилається на PVC користувача в тому ж просторі імен. Цей том знаходить привʼязаний PV і монтує цей том для пода. PersistentVolumeClaimVolumeSource, по суті, є обгорткою навколо іншого типу тому, який належить комусь іншому (системі).
| Поле | Опис |
|---|---|
claimName *string | claimName є імʼям PersistentVolumeClaim у тому ж просторі імен, що й под, який використовує цей том. Більше інформації: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims |
readOnlyboolean | readOnly Встановлює режим лише для читання в VolumeMounts. Стандартнт — false. |
PodAffinity
Спорідненість подів (Pod affinity) — це група правил планування, що визначають взаємне розташування подів.
| Поле | Опис |
|---|---|
preferredDuringSchedulingIgnoredDuringExecutionWeightedPodAffinityTerm array | Планувальник віддає перевагу розміщенню подів на вузлах, які задовольняють виразам спорідненості, зазначених в цьому полі, але може обрати вузол, який порушує один або кілька виразів. Найбільш бажаним вузлом є той, у якого найбільша сума ваг, тобто для кожного вузла, який відповідає всім вимогам планування (запит ресурсів, вирази requiredDuringScheduling спорідненості тощо), обчислюється сума, перебираючи елементи цього поля та додаючи "вагу" до суми, якщо вузол має поди, які відповідають відповідному podAffinityTerm; вузол(и) з найвищою сумою є найбільш бажаними. |
requiredDuringSchedulingIgnoredDuringExecutionPodAffinityTerm array | Якщо вимоги спорідненості, зазначені в цьому полі, не виконуються під час планування, под не буде заплановано на вузол. Якщо вимоги спорідненості, зазначені в цьому полі, перестануть виконуватися під час виконання пода (наприклад, через оновлення мітки пода), система може або не може спробувати в кінцевому підсумку виселити под з його вузла. Коли є кілька елементів, списки вузлів, що відповідають кожному podAffinityTerm, перетинаються, тобто всі умови повинні бути виконані. |
PodAffinityTerm
Визначає набір подів (а саме тих, що відповідають labelSelector відносно заданих namespace(s)), з якими цей под повинен бути розташований разом (affinity) або не розташований разом (anti-affinity), де розташування разом визначається як виконання на вузлі, значення мітки з ключем <topologyKey> якого відповідає будь-якому вузлу, на якому виконується под з набору подів.
| Поле | Опис |
|---|---|
labelSelectorLabelSelector | Запит міток для набору ресурсів, у цьому випадку подів. Якщо він дорівнює null, цей PodAffinityTerm не відповідає жодному поду. |
matchLabelKeysstring array | MatchLabelKeys є набором міток ключів подів для вибору, які поди будуть враховані. Ключі використовуються для пошуку значень у вхідних мітках подів, ці ключ-значення мітки обʼєднуються з labelSelector як key in (value) для вибору групи наявних подів, які будуть враховані для (анти) спорідненості вхідного пода. Ключі, які не існують у вхідних мітках подів, будуть ігноруватися. Стандартне значення є порожнім. Той самий ключ заборонено використовувати як у matchLabelKeys, так і в labelSelector. Також matchLabelKeys не може бути встановлено, якщо labelSelector не встановлено. |
mismatchLabelKeysstring array | MismatchLabelKeys є набором міток ключів подів для вибору, які поди будуть враховані. Ключі використовуються для пошуку значень у вхідних мітках подів, ці ключ-значення мітки обʼєднуються з labelSelector як key notin (value) для вибору групи наявних подів, які будуть враховані для (анти) спорідненості вхідного пода. Ключі, які не існують у вхідних мітках подів, будуть ігноруватися. Стандартне значення є порожнім. Той самий ключ заборонено використовувати як у mismatchLabelKeys, так і в labelSelector. Також mismatchLabelKeys не може бути встановлено, якщо labelSelector не встановлено. |
namespaceSelectorLabelSelector | Запит міток для набору просторів імен, до яких застосовується цей термін. Термін застосовується до обʼєднання просторів імен, вибраних цим полем, та тих, що перелічені в полі namespaces. Null селектор і null або порожній список просторів імен означає "простір імен цього пода". Порожній селектор ({}) відповідає всім просторам імен. |
namespacesstring array | namespaces визначає статичний список назв просторів імен, до яких застосовується цей термін. Термін застосовується до обʼєднання просторів імен, перелічених у цьому полі, та тих, що вибрані за допомогою namespaceSelector. null або порожній список просторів імен і null namespaceSelector означає "простір імен цього пода". |
topologyKey *string | Цей под має бути розташований разом (affinity) або не разом (anti-affinity) з подами, що відповідають labelSelector у зазначених просторах імен, де "разом" визначається як запуск на вузлі, значення мітки з ключем topologyKey якого відповідає будь-якому вузлу, на якому запущено будь-який з вибраних подів. Порожній topologyKey не дозволяється. |
PodAntiAffinity
Pod anti affinity є групою правил планування між подами, що визначають анти-спорідненість.
| Поле | Опис |
|---|---|
preferredDuringSchedulingIgnoredDuringExecutionWeightedPodAffinityTerm array | Планувальник віддає перевагу розміщенню подів на вузлах, які задовольняють вирази анти-спорідненості, зазначені в цьому полі, але може обрати вузол, який порушує один або кілька виразів. Найбільш бажаним вузлом є той, у якого найбільша сума ваг, тобто для кожного вузла, який відповідає всім вимогам планування (запит ресурсів, requiredDuringScheduling вирази анти-спорідненості тощо), обчислюється сума, перебираючи елементи цього поля і віднімаючи "вагу" з суми, якщо вузол має поди, які відповідають відповідному podAffinityTerm; вузол(и) з найвищою сумою є найбільш бажаними. |
requiredDuringSchedulingIgnoredDuringExecutionPodAffinityTerm array | Якщо вимоги анти-спорідненості, зазначені в цьому полі, не виконуються під час планування, под не буде заплановано на вузол. Якщо вимоги анти-спорідненості, зазначені в цьому полі, перестануть виконуватися під час виконання пода (наприклад, через оновлення мітки пода), система може або не може спробувати в кінцевому підсумку виселити под з його вузла. Коли є кілька елементів, списки вузлів, що відповідають кожному podAffinityTerm, перетинаються, тобто всі умови повинні бути виконані. |
PodCertificateProjection
PodCertificateProjection надає приватний ключ та X.509 сертифікат у файловій системі пода.
| Поле | Опис |
|---|---|
certificateChainPathstring | Записує ланцюжок сертифікатів за цим шляхом у спроєцьованому томі. Більшість застосунків повинні використовувати credentialBundlePath. При використанні keyPath і certificateChainPath ваш застосунок повинен перевіряти, що ключ і сертифікат листа узгоджені, оскільки можливо прочитати файли під час ротації. |
credentialBundlePathstring | Записує пакет облікових даних за цим шляхом у спроєцьованому томі. Пакет облікових даних є одним файлом, який містить кілька блоків PEM. Перший блок PEM є блоком PRIVATE KEY, що містить приватний ключ PKCS#8. Решта блоків є блоками CERTIFICATE, що містять виданий ланцюжок сертифікатів від підписувача (лист і будь-які проміжні сертифікати). Використання credentialBundlePath дозволяє коду вашого застосунку в поді виконати одну атомарну операцію читання, яка отримує узгоджений ключ і ланцюжок сертифікатів. Якщо ви проєцюєте їх в окремі файли, коду вашого застосунку потрібно додатково перевіряти, що листовий сертифікат був виданий для ключа. |
keyPathstring | Записує ключ за цим шляхом у спроєцьованому томі. Більшість застосунків повинні використовувати credentialBundlePath. При використанні keyPath і certificateChainPath ваш застосунок повинен перевіряти, що ключ і сертифікат листа узгоджені, оскільки можливо прочитати файли під час ротації. |
keyType *string | Тип ключа, який Kubelet згенерує для пода. Дійсні значення: "RSA3072", "RSA4096", "ECDSAP256", "ECDSAP384", "ECDSAP521" та "ED25519". |
maxExpirationSecondsinteger | maxExpirationSeconds є максимально дозволеним терміном дії сертифіката. Kubelet копіює це значення без змін у PodCertificateRequests, які він генерує для цієї проєкції. Якщо не вказано, kube-apiserver встановить його на 86400 (24 години). kube-apiserver відхилить значення менші за 3600 (1 година). Максимально допустиме значення — 7862400 (91 день). Реалізація підписувача може видавати сертифікат з будь-яким терміном дії *коротшим* за MaxExpirationSeconds, але не менше ніж 3600 секунд (1 година). Це обмеження контролюється kube-apiserver. Підписувачіkubernetes.io ніколи не видаватимуть сертифікати з терміном дії більше ніж 24 години. |
signerName *string | CSR, згенеровані Kubelet, будуть адресовані цьому підписувачу. |
userAnnotationsobject | userAnnotations дозволяють авторам подів передавати додаткову інформацію реалізації підписувача. Kubernetes ніяким чином не обмежує і не перевіряє ці метадані. Ці значення копіюються без змін у поле spec.unverifiedUserAnnotations обʼєктів PodCertificateRequest, які створює Kubelet. Записи підлягають такій же перевірці, як і анотації метаданих обʼєктів, з додатковою вимогою, що всі ключі повинні мати доменне префіксування. Ніяких обмежень на значення не накладається, крім загального обмеження на розмір всього поля. Підписувачі повинні документувати підтримувані ключі та значення. Підписувачі повинні відхиляти запити, що містять ключі, які вони не розпізнають. |
PodCondition
PodCondition містить деталі щодо поточного стану цього пода.
| Поле | Опис |
|---|---|
lastProbeTimeTime | Останній раз, коли ми перевіряли стан. |
lastTransitionTimeTime | Останній раз, коли стан змінився з одного на інший. |
messagestring | Зрозуміле для людини повідомлення, що вказує деталі останнього переходу. |
observedGenerationinteger | Якщо встановлено, це представляє .metadata.generation, на основі якого було встановлено стан пода. |
reasonstring | Унікальна, однословна, CamelCase причина останнього переходу стану. |
status *string | Status є статусом стану. Може бути True, False, Unknown. Більше інформації: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#pod-conditions |
type *string | Type є типом стану. Більше інформації: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#pod-conditions |
PodDNSConfig
PodDNSConfig визначає параметри DNS пода, додатково до тих, що генеруються з DNSPolicy.
| Поле | Опис |
|---|---|
nameserversstring array | Список IP-адрес DNS-серверів. Він буде доданий до базових серверів імен, згенерованих з DNSPolicy. Дублікати серверів імен будуть видалені. |
optionsPodDNSConfigOption array | Список параметрів DNS-резолвера. Він буде обʼєднаний з базовими параметрами, згенерованими з DNSPolicy. Дублікати будуть видалені. Параметри, задані в Options, перевизначать ті, що зʼявляються в базовій DNSPolicy. |
searchesstring array | Список доменів пошуку DNS для пошуку імен хостів. Він буде доданий до базових шляхів пошуку, згенерованих з DNSPolicy. Дублікати шляхів пошуку будуть видалені. |
PodDNSConfigOption
PodDNSConfigOption визначає параметри DNS-резолвера пода.
| Поле | Опис |
|---|---|
namestring | Name є імʼям цієї опції DNS-резолвера. Обовʼязково. |
valuestring | Value є значенням цієї опції DNS-резолвера. |
PodExtendedResourceClaimStatus
PodExtendedResourceClaimStatus зберігається в PodStatus для розширених запитів ресурсів, підтримуваних DRA. Він зберігає згенероване імʼя для відповідного спеціального ResourceClaim, створеного планувальником.
| Поле | Опис |
|---|---|
requestMappings *ContainerExtendedResourceRequest array | RequestMappings ідентифікує зіставлення <container, розширений ресурс, підтримуваний DRA> на запит пристрою в згенерованому ResourceClaim. |
resourceClaimName *string | ResourceClaimName є імʼям ResourceClaim, який був згенерований для Podʼа у просторі імен Podʼа. |
PodIP
PodIP представляє одну IP-адресу, виділену поду.
| Поле | Опис |
|---|---|
ip *string | IP є IP-адресою, призначеною поду |
PodOS
PodOS визначає параметри операційної системи пода.
| Поле | Опис |
|---|---|
name *string | Name є імʼям операційної системи. Поточні підтримувані значення: linux та windows. Додаткові значення можуть бути визначені в майбутньому і можуть бути одними з: https://github.com/opencontainers/runtime-spec/blob/master/config.md#platform-specific-configuration. Клієнти повинні очікувати обробки додаткових значень і трактувати невпізнані значення в цьому полі як os: null |
PodReadinessGate
PodReadinessGate містить посилання на стан пода.
| Поле | Опис |
|---|---|
conditionType *string | ConditionType посилається на стан у списку станів пода з відповідним типом. |
PodResourceClaim
PodResourceClaim посилається на точно один ResourceClaim, або безпосередньо, або шляхом вказівки ResourceClaimTemplate, який потім перетворюється на ResourceClaim для пода.
Він додає імʼя, яке унікально ідентифікує ResourceClaim всередині Podʼа. Контейнери, які потребують доступу до ResourceClaim, посилаються на нього за цим імʼям.
Коли функціональна можливість DRAWorkloadResourceClaims увімкнена і цей Pod належить до PodGroup, PodResourceClaim співставляється з PodGroupResourceClaim, якщо всі їхні поля однакові (Name, ResourceClaimName та ResourceClaimTemplateName). Співставлена вимога посилається на один ResourceClaim, спільний для всіх Podʼів у PodGroup, зарезервований для PodGroup у ResourceClaimStatus.ReservedFor, а не для окремих Podʼів.
| Поле | Опис |
|---|---|
name *string | Name унікально ідентифікує цю заявку на ресурс всередині пода. Це має бути DNS_LABEL. |
resourceClaimNamestring | ResourceClaimName є імʼям обʼєкта ResourceClaim у тому ж просторі імен, що й цей под. Точно одне з полів ResourceClaimName або ResourceClaimTemplateName має бути встановлено. |
resourceClaimTemplateNamestring | ResourceClaimTemplateName є імʼям обʼєкта ResourceClaimTemplate у тому ж просторі імен, що й цей под. Шаблон буде використано для створення нового ResourceClaim, який буде привʼязаний до цього пода. Коли цей под буде видалено, ResourceClaim також буде видалено. Імʼя пода та імʼя ресурсу, разом із згенерованим компонентом, будуть використані для формування унікального імені для ResourceClaim, яке буде зафіксовано в pod.status.resourceClaimStatuses. Коли функціональна можливість DRAWorkloadResourceClaims увімкнена і под належить до PodGroup, яка визначає PodGroupResourceClaim з тим самим Name та ResourceClaimTemplateName, цей PodResourceClaim вирішується у ResourceClaim, згенерований для PodGroup. Всі поди в групі, які визначають еквівалентний PodResourceClaim, що відповідає Name та ResourceClaimTemplateName PodGroupResourceClaim, спільно використовують той самий згенерований ResourceClaim. ResourceClaims, згенеровані для PodGroup, належать PodGroup, і їхній життєвий цикл повʼязаний з PodGroup, а не з окремим подом. Це поле є незмінним, і жодні зміни не будуть внесені до відповідного ResourceClaim контрольним механізмом після створення ResourceClaim. Точно одне з полів ResourceClaimName або ResourceClaimTemplateName має бути встановлено. |
PodSchedulingGate
PodSchedulingGate є повʼязаним з Podʼом для захисту його планування.
| Поле | Опис |
|---|---|
name *string | Імʼя шлюзу планування. Кожен шлюз планування повинен мати унікальне поле name. |
PodSchedulingGroup
PodSchedulingGroup ідентифікує екземпляр групи планування часу виконання, до якої належить Pod. Планувальник використовує цю інформацію для застосування семантики планування з урахуванням навантаження. Має бути вказане точно одне поле.
| Поле | Опис |
|---|---|
podGroupNamestring | PodGroupName вказує імʼя окремого обʼєкта PodGroup, який представляє екземпляр групи часу виконання. Має бути DNS-субдоменом. |
PodSecurityContext
PodSecurityContext містить атрибути безпеки на рівні Podʼа та загальні налаштування контейнера. Деякі поля також присутні в container.securityContext. Значення полів container.securityContext мають пріоритет над значеннями полів PodSecurityContext.
| Поле | Опис |
|---|---|
appArmorProfileAppArmorProfile | appArmorProfile містить параметри AppArmor, які використовуються контейнерами в цьому Podʼі. Зверніть увагу, що це поле не можна встановлювати, коли spec.os.name є windows. |
fsGroupinteger | Спеціальна додаткова група, яка застосовується до всіх контейнерів у Podʼі. Деякі типи томів дозволяють Kubelet змінювати власника цього тому на власника Podʼа:
|
fsGroupChangePolicystring | fsGroupChangePolicy визначає поведінку зміни власника та прав доступу до тому перед його використанням у Podʼі. Це поле застосовується лише до типів томів, які підтримують власність на основі fsGroup (і права доступу). Воно не впливає на епhemeral томи, такі як: secret, configmaps та emptydir. Дійсні значення: "OnRootMismatch" та "Always". Якщо не вказано, використовується "Always". Зверніть увагу, що це поле не можна встановлювати, коли spec.os.name є windows. Можливі значення enum:
|
runAsGroupinteger | GID, з яким запускається точка входу процесу контейнера. Якщо значення не вказано, використовується стандартне значення середовища виконання. Також може бути задано в SecurityContext. Якщо встановлено як у SecurityContext, так і в PodSecurityContext, значення, вказане в SecurityContext, має пріоритет для цього контейнера. Зверніть увагу, що це поле не можна встановлювати, коли spec.os.name є windows. |
runAsNonRootboolean | Вказує на те, що контейнер повинен запускатися не від імені root. Якщо значення true, Kubelet перевірятиме образ під час виконання, щоб переконатися, що він не запускається з UID 0 (root), і не вдасться запустити контейнер, якщо це так. Якщо значення не вказано або воно false, така перевірка не проводиться. Також може бути задано в SecurityContext. Якщо встановлено як у SecurityContext, так і в PodSecurityContext, значення, вказане в SecurityContext, має пріоритет для цього контейнера. |
runAsUserinteger | UID, з яким запускається точка входу процесу контейнера. Якщо значення не вказано, використовується стандартне значення середовища виконання. Також може бути задано в SecurityContext. Якщо встановлено як у SecurityContext, так і в PodSecurityContext, значення, вказане в SecurityContext, має пріоритет для цього контейнера. Зверніть увагу, що це поле не можна встановлювати, коли spec.os.name є windows. |
seLinuxChangePolicystring | seLinuxChangePolicy визначає, як мітка SELinux контейнера застосовується до всіх томів, що використовуються Podʼом. Не впливає на вузли, які не підтримують SELinux, або на томи, які не підтримують SELinux. Дійсні значення: "MountOption" та "Recursive". "Recursive" означає повторне маркування всіх файлів на всіх томах Podʼа за допомогою середовища виконання контейнера. Це може бути повільно для великих томів, але дозволяє змішувати привілейовані та непривілейовані Podʼи, що використовують один і той же том на одному вузлі. "MountOption" монтує всі відповідні томи Podʼа з опцією монтування -o context. Це вимагає, щоб всі Podʼи, що використовують один і той же том, використовували одну й ту ж мітку SELinux. Неможливо використовувати один і той же том серед привілейованих та непривілейованих Podʼів. Відповідні томи включають вбудовані механізми підтримки томів FibreChannel та iSCSI, а також всі CSI томи, драйвер CSI яких оголошує підтримку SELinux, встановлюючи spec.seLinuxMount: true у своєму екземплярі CSIDriver. Інші томи завжди повторно маркуються рекурсивно. Значення "MountOption" дозволено лише тоді, коли увімкнено функціональний прапорець SELinuxMount. Якщо не вказано і функціональний прапорець SELinuxMount увімкнено, використовується "MountOption". Якщо не вказано і функціональний прапорець SELinuxMount вимкнено, для томів ReadWriteOncePod використовується "MountOption", а для всіх інших томів — "Recursive". Це поле впливає лише на Podʼи, які мають встановлену мітку SELinux, або в PodSecurityContext, або в SecurityContext усіх контейнерів. Всі Podʼи, що використовують один і той же том, повинні використовувати одну й ту ж seLinuxChangePolicy, інакше деякі Podʼи можуть застрягти в стані ContainerCreating. Зверніть увагу, що це поле не можна встановлювати, коли spec.os.name є windows. |
seLinuxOptionsSELinuxOptions | Контекст SELinux, який застосовується до всіх контейнерів. Якщо не вказано, середовище виконання контейнера призначить випадковий контекст SELinux для кожного контейнера. Також може бути задано в SecurityContext. Якщо встановлено як у SecurityContext, так і в PodSecurityContext, значення, вказане в SecurityContext, має пріоритет для цього контейнера. Зверніть увагу, що це поле не можна встановлювати, коли spec.os.name є windows. |
seccompProfileSeccompProfile | Параметри seccomp, які використовуються контейнерами в цьому поді. Зверніть увагу, що це поле не можна встановлювати, коли spec.os.name є windows. |
supplementalGroupsinteger array | Список груп, які застосовуються до першого процесу, що запускається в кожному контейнері, на додачу до основного GID контейнера та fsGroup (якщо вказано). Якщо функція SupplementalGroupsPolicy увімкнена, поле supplementalGroupsPolicy визначає, чи ці групи додаються до будь-яких членств у групах, визначених у образі контейнера, чи замінюють їх. Якщо не вказано, додаткові групи не додаються, хоча членства в групах, визначені в образі контейнера, можуть все ще використовуватися залежно від поля supplementalGroupsPolicy. Зверніть увагу, що це поле не можна встановлювати, коли spec.os.name є windows. |
supplementalGroupsPolicystring | Визначає, як обчислюються додаткові групи перших процесів контейнера. Дійсні значення: "Merge" та "Strict". Якщо не вказано, використовується "Merge". (Alpha) Використання цього поля вимагає увімкнення функціональної можливості SupplementalGroupsPolicy, а середовище виконання контейнера повинно підтримувати цю функцію. Зверніть увагу, що це поле не можна встановлювати, коли spec.os.name є windows. Можливі значення enum:
|
sysctlsSysctl array | Sysctls містить список іменованих sysctl, які використовуються для пода. Поди з непідтримуваними sysctl (з боку середовища виконання контейнера) можуть не запускатися. Зверніть увагу, що це поле не можна встановлювати, коли spec.os.name є windows. |
windowsOptionsWindowsSecurityContextOptions | Специфічні для Windows налаштування, які застосовуються до всіх контейнерів. Якщо не вказано, будуть використані параметри з SecurityContext контейнера. Якщо встановлено як у SecurityContext, так і в PodSecurityContext, перевага надається значенню, вказаному в SecurityContext. Зверніть увагу, що це поле не можна встановлювати, коли spec.os.name є linux. |
PreferredSchedulingTerm
Порожній preferred scheduling term відповідає всім обʼєктам з неявною вагою 0 (тобто це no-op). Null preferred scheduling term не відповідає жодним обʼєктам (тобто також є no-op).
| Поле | Опис |
|---|---|
preference *NodeSelectorTerm | Термін вибору вузла, повʼязаний з відповідною вагою. |
weight *integer | Вага, повʼязана з відповідним терміном вибору вузла, у діапазоні від 1 до 100. |
Probe
Probe описує перевірку стану справності, яка виконується для контейнера, щоб визначити, чи він життєздатний або готовий приймати трафік.
| Поле | Опис |
|---|---|
execExecAction | Exec вказує команду для виконання в контейнері. |
failureThresholdinteger | Мінімальна кількість послідовних невдач, щоб перевірка вважалася невдалою після успішного виконання. Зазвичай — 3. Мінімальне значення — 1. |
grpcGRPCAction | GRPC вказує GRPC HealthCheckRequest. |
httpGetHTTPGetAction | HTTPGet вказує HTTP GET запит для виконання. |
initialDelaySecondsinteger | Кількість секунд після запуску контейнера, перш ніж ініціюються перевірки життєздатності. Більше інформації: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes |
periodSecondsinteger | Як часто (у секундах) виконувати перевірку. Стандартно — 10 секунд. Мінімальне значення — 1. |
successThresholdinteger | Мінімальна кількість послідовних успішних перевірок, щоб перевірка вважалася успішною після невдачі. Зазвичай — 1. Має бути 1 для перевірок життєздатності та запуску. Мінімальне значення — 1. |
tcpSocketTCPSocketAction | TCPSocket вказує підключення до TCP порту. |
terminationGracePeriodSecondsinteger | Опціональна тривалість у секундах, протягом якої под має завершити роботу після невдачі перевірки. Період належного завершення — це тривалість у секундах після того, як процеси, що працюють у поді, отримують сигнал завершення, і час, коли процеси примусово зупиняються за допомогою сигналу kill. Встановіть це значення довше, ніж очікуваний час очищення для вашого процесу. Якщо це значення nil, буде використано terminationGracePeriodSeconds пода. В іншому випадку це значення перевизначає значення, надане у специфікації пода. Значення має бути невід’ємним цілим числом. Значення нуль означає негайну зупинку за допомогою сигналу kill (немає можливості завершити роботу). Це бета-поле і вимагає увімкнення функціональної можливості ProbeTerminationGracePeriod. Мінімальне значення — 1. Використовується spec.terminationGracePeriodSeconds, якщо не встановлено. |
timeoutSecondsinteger | Кількість секунд після якої перевірка завершується з тайм-аутом. Стандартно — 1 секунда. Мінімальне значення — 1. Більше інформації: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes |
ProjectedVolumeSource
Представляє джерело спроєцьованого тому
| Поле | Опис |
|---|---|
defaultModeinteger | defaultMode визначає біти режиму, які стандартно використовуються для встановлення дозволів на створені файли. Має бути восьмеричним значенням від 0000 до 0777 або десятковим значенням від 0 до 511. YAML приймає як восьмеричні, так і десяткові значення, JSON вимагає десяткових значень для бітів режиму. Теки всередині шляху не впливають на цю настройку. Це може конфліктувати з іншими параметрами, які впливають на режим файлу, такими як fsGroup, і результатом можуть бути інші встановлені біти режиму. |
sourcesVolumeProjection array | sources є списком проєкцій томів. Кожен елемент у цьому списку обробляє одне джерело. |
RBDVolumeSource
Представляє підключення Rados Block Device, яке триває протягом життя пода. RBD томи підтримують управління власністю та переназначення SELinux.
| Поле | Опис |
|---|---|
fsTypestring | fsType є типом файлової системи тому, який ви хочете змонтувати. Порада: переконайтеся, що тип файлової системи підтримується операційною системою хоста. Приклади: "ext4", "xfs", "ntfs". Якщо не вказано, неявно вважається "ext4". Більше інформації: https://kubernetes.io/docs/concepts/storage/volumes#rbd |
image *string | image є імʼям образу Rados. Більше інформації: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it |
keyringstring | keyring є шляхом до вʼязки ключів для RBDUser. Зазвичай /etc/ceph/keyring. Більше інформації: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it |
monitors *string array | monitors є колекцією моніторів Ceph. Більше інформації: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it |
poolstring | pool є імʼям пулу Rados. Стандартно — rbd. Більше інформації: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it |
readOnlyboolean | readOnly тут примусово встановлює параметр ReadOnly у VolumeMounts. Стандартно — false. Більше інформації: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it |
secretRefLocalObjectReference | secretRef є імʼям секрету автентифікації для RBDUser. Якщо вказано, перевизначає keyring. Стандартно — nil. Більше інформації: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it |
userstring | user є імʼям користувача Rados. Стандартно — admin. Більше інформації: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it |
ResourceClaim
ResourceClaim вказує на один запис у PodSpec.ResourceClaims.
| Поле | Опис |
|---|---|
name *string | Name має відповідати імені одного запису в pod.spec.resourceClaims пода, де використовується це поле. Це робить ресурс доступним всередині контейнера. |
requeststring | Request є імʼям, обраним для запиту в посиланні на претензію. Якщо порожньо, доступні всі ресурси з заявки, інакше лише результат цього запиту. |
ResourceFieldSelector
ResourceFieldSelector представляє ресурси контейнера (cpu, memory) та їх формат виводу
| Поле | Опис |
|---|---|
containerNamestring | Імʼя контейнера: обовʼязково для томів, необовʼязково для змінних середовища |
divisorQuantity | Визначає формат виводу відкритих ресурсів, стандартно — "1" |
resource *string | Обовʼязково: ресурс для вибору |
ResourceHealth
ResourceHealth представляє стан ресурсу. Він містить останню інформацію про стан пристрою. Це частина KEP https://kep.k8s.io/4680.
| Поле | Опис |
|---|---|
healthstring | Стан ресурсу. Може бути одним з наступних:
|
messagestring | Message надає контекст, зрозумілий людині, для Health (наприклад, "ECC error count exceeded threshold"). Це поле заповнюється kubelet, коли ResourceHealthStatusMessage увімкнено, якщо втулок DRA повертає повідомлення, інакше воно дорівнює null. |
resourceID *string | ResourceID є унікальним ідентифікатором ресурсу. Див. тип ResourceID для отримання додаткової інформації. |
ResourceRequirements
ResourceRequirements описує вимоги до обчислювальних ресурсів.
| Поле | Опис |
|---|---|
claimsResourceClaim array | Claims є списком імен ресурсів, визначених у spec.resourceClaims, які використовуються цим контейнером. Це поле залежить від функціональної можливості DynamicResourceAllocation. Це поле є незмінним. Воно може бути встановлено лише для контейнерів. |
limitsobject | Limits описує максимальну кількість обчислювальних ресурсів, дозволених для використання. Більше інформації: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ |
requestsobject | Requests описує мінімальну кількість обчислювальних ресурсів, необхідних для роботи. Якщо Requests опущено для контейнера, воно зазвичай дорівнює Limits, якщо воно явно вказано, інакше значенню, визначеному реалізацією. Requests не може перевищувати Limits. Більше інформації: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ |
ResourceStatus
ResourceStatus представляє стан одного ресурсу, виділеного для Podʼа.
| Поле | Опис |
|---|---|
name *string | Назва ресурсу. Має бути унікальною в межах Podʼа і, у випадку ресурсу без DRA, відповідати одному з ресурсів з специфікації Podʼа. Для ресурсів DRA значення має бути "claim:<claim_name>/<request>". Коли цей статус повідомляється про контейнер, "claim_name" і "request" мають відповідати одній з заявок цього контейнера. |
resourcesResourceHealth array | Список станів унікальних ресурсів. Кожен елемент списку містить унікальний ідентифікатор ресурсу та його стан. Як мінімум, протягом життєвого циклу Podʼа, ідентифікатор ресурсу повинен унікально ідентифікувати ресурс, виділений Podʼу на вузлі. Якщо інший Pod на тому ж вузлі повідомляє про стан з тим самим ідентифікатором ресурсу, це повинен бути той самий ресурс, який вони спільно використовують. Див. визначення типу ResourceID для конкретного формату, який він має у різних випадках використання. |
SELinuxOptions
SELinuxOptions описує мітки, які будуть застосовані до контейнера.
| Поле | Опис |
|---|---|
levelstring | Level є міткою рівня SELinux, яка застосовується до контейнера. |
rolestring | Role є міткою ролі SELinux, яка застосовується до контейнера. |
typestring | Type є міткою типу SELinux, яка застосовується до контейнера. |
userstring | User є міткою користувача SELinux, яка застосовується до контейнера. |
ScaleIOVolumeSource
ScaleIOVolumeSource представляє постійний том ScaleIO
| Поле | Опис |
|---|---|
fsTypestring | fsType є типом файлової системи для монтування. Має бути типом файлової системи, підтримуваним операційною системою хоста. Наприклад: "ext4", "xfs", "ntfs". Зазвичай — "xfs". |
gateway *string | gateway є адресою хоста ScaleIO API Gateway. |
protectionDomainstring | protectionDomain є назвою домену захисту ScaleIO для налаштованого сховища. |
readOnlyboolean | readOnly стандартно — false (читання/запис). ReadOnly тут примусово встановить параметр ReadOnly у VolumeMounts. |
secretRef *LocalObjectReference | secretRef посилається на секрет для користувача ScaleIO та іншої конфіденційної інформації. Якщо це не надано, операція входу завершиться невдачею. |
sslEnabledboolean | Прапорець sslEnabled вмикає/вимикає SSL-з'єднання з Gateway, зазвичай — false |
storageModestring | storageMode вказує, чи має сховище для тому бути ThickProvisioned або ThinProvisioned. Стандартно — ThinProvisioned. |
storagePoolstring | storagePool є пулом сховища ScaleIO, повʼязаним із доменом захисту. |
system *string | system є назвою системи зберігання, налаштованої в ScaleIO. |
volumeNamestring | volumeName є назвою тому, який вже створено в системі ScaleIO і який повʼязаний із цим джерелом тому. |
SeccompProfile
SeccompProfile визначає налаштування профілю seccomp для поду/контейнера. Може бути встановлено лише одне джерело профілю.
| Поле | Опис |
|---|---|
localhostProfilestring | localhostProfile вказує, що слід використовувати профіль, визначений у файлі на вузлі. Профіль повинен бути попередньо налаштований на вузлі для роботи. Має бути низхідним шляхом, відносно налаштованого розташування профілю seccomp kubelet. Має бути встановлено, якщо type дорівнює "Localhost". Не повинно бути встановлено для будь-якого іншого типу. |
type *string | type вказує, який тип профілю seccomp буде застосовано. Дійсні варіанти:
|
SecretEnvSource
SecretEnvSource вибирає Secret для заповнення змінних середовища.
Вміст поля Data цільового Secret буде представляти пари ключ-значення як змінні середовища.
| Поле | Опис |
|---|---|
namestring | Назва референта. Це поле фактично обовʼязкове, але через зворотну сумісність дозволяється залишати його порожнім. Екземпляри цього типу з порожнім значенням тут майже напевно неправильні. Більше інформації: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
optionalboolean | Вкажіть, чи повинен Secret бути визначений |
SecretKeySelector
SecretKeySelector вибирає ключ із Secret.
| Поле | Опис |
|---|---|
key *string | Ключ секрету для вибору. Повинен бути дійсним ключем секрету. |
namestring | Назва референта. Це поле фактично обовʼязкове, але через зворотну сумісність дозволяється залишати його порожнім. Екземпляри цього типу з порожнім значенням тут майже напевно неправильні. Більше інформації: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
optionalboolean | Вкажіть, чи повинен Secret або його ключ бути визначений |
SecretProjection
Перетворює секрет у проєкційний том.
Вміст поля Data цільового Secret буде представлений у проєкційному томі як файли, використовуючи ключі з поля Data як імена файлів. Зверніть увагу, що це ідентично джерелу тома секрету без режиму.
| Поле | Опис |
|---|---|
itemsKeyToPath array | items якщо не вказано, кожна пара ключ-значення в полі Data Secretʼу, на який є посилання, буде проєцюватись в том як файл, імʼя якого є ключем, а вміст — значенням. Якщо вказано, перелічені ключі будуть спроєцьовані в зазначені шляхи, а не перелічені ключі не будуть присутні. Якщо вказано ключ, якого немає в Secret, налаштування тому завершиться помилкою, якщо він не позначений як необовʼязковий. Шляхи повинні бути відносними і не можуть містити шлях '..' або починатися з '..'. |
namestring | Назва референта. Це поле фактично обовʼязкове, але через зворотну сумісність дозволяється залишати його порожнім. Екземпляри цього типу з порожнім значенням тут майже напевно неправильні. Більше інформації: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
optionalboolean | Вкажіть, чи повинен Secret або його ключ бути визначений |
SecretVolumeSource
Перетворює секрет у том.
Вміст поля Data цільового Secret буде представлений у томі як файли, використовуючи ключі з поля Data як імена файлів. Томи секретів підтримують управління власністю та переназначення міток SELinux.
| Поле | Опис |
|---|---|
defaultModeinteger | defaultMode опціональним: біти режиму, які стандартно використовуються для встановлення дозволів на створені файли. Має бути вісімкове значення від 0000 до 0777 або десяткове значення від 0 до 511. YAML приймає як вісімкові, так і десяткові значення, JSON вимагає десяткові значення для бітів режиму. Стандартно — 0644. Теки всередині шляху не впливають на це налаштування. Це може конфліктувати з іншими параметрами, які впливають на режим файлу, наприклад fsGroup, і результатом можуть бути інші встановлені біти режиму. |
itemsKeyToPath array | items Якщо не вказано, кожна пара ключ-значення в полі Data Secretʼу, на який є посилання, буде проєцюватись в том як файл, імʼя якого є ключем, а вміст — значенням. Якщо вказано, перелічені ключі будуть спроєцьовані в зазначені шляхи, а не перелічені ключі не будуть присутні. Якщо вказано ключ, якого немає в Secret, налаштування тому завершиться помилкою, якщо він не позначений як необовʼязковий. Шляхи повинні бути відносними і не можуть містити шлях '..' або починатися з '..'. |
optionalboolean | Вкажіть, чи повинен Secret або його ключ бути визначений |
secretNamestring | secretName є назвою секрету в просторі імен пода, який слід використовувати. Більше інформації: https://kubernetes.io/docs/concepts/storage/volumes#secret |
SecurityContext
SecurityContext містить конфігурацію безпеки, яка буде застосована до контейнера. Деякі поля присутні як у SecurityContext, так і у PodSecurityContext. Коли обидва встановлені, значення в SecurityContext мають пріоритет.
| Поле | Опис |
|---|---|
allowPrivilegeEscalationboolean | AllowPrivilegeEscalation контролює, чи може процес отримати більше привілеїв, ніж його батьківський процес. Цей булевий параметр безпосередньо контролює, чи буде встановлено прапорець no_new_privs для процесу контейнера. AllowPrivilegeEscalation завжди true, коли контейнер:
|
appArmorProfileAppArmorProfile | appArmorProfile є параметром AppArmor, який слід використовувати для цього контейнера. Якщо встановлено, цей профіль замінює appArmorProfile пода. Зверніть увагу, що це поле не можна встановлювати, коли spec.os.name є windows. |
capabilitiesCapabilities | Можливості для додавання/видалення під час запуску контейнерів. За звичай використовується набір можливостей, наданих середовищем виконання контейнера. Зверніть увагу, що це поле не можна встановлювати, коли spec.os.name є windows. |
privilegedboolean | Запуск контейнера в привілейованому режимі. Процеси в привілейованих контейнерах фактично еквівалентні root на хості. Зазвичай — false. Зверніть увагу, що це поле не можна встановлювати, коли spec.os.name є windows. |
procMountstring | procMount позначає тип монтування proc, який слід використовувати для контейнерів. Стандартне значення — Default, яке використовує налаштування середовища виконання контейнера для шляхів лише для читання та замаскованих шляхів. Зверніть увагу, що це поле не можна встановлювати, коли spec.os.name є windows. Можливі значення enum:
|
readOnlyRootFilesystemboolean | Чи має цей контейнер файлову систему root лише для читання. Стандартно — false. Зверніть увагу, що це поле не можна встановлювати, коли spec.os.name є windows. |
runAsGroupinteger | GID для запуску точки входу процесу контейнера. Використовує стандартне значення середовища виконання, якщо не встановлено. Може також бути встановлено в PodSecurityContext. Якщо встановлено як у SecurityContext, так і в PodSecurityContext, перевага надається значенню, вказаному в SecurityContext. Зверніть увагу, що це поле не можна встановлювати, коли spec.os.name є windows. |
runAsNonRootboolean | Вказує, що контейнер повинен запускатися не від імені root. Якщо true, Kubelet перевірить образ під час виконання, щоб переконатися, що він не запускається з UID 0 (root), і не вдасться запустити контейнер, якщо це так. Якщо не встановлено або false, така перевірка не проводиться. Може також бути встановлено в PodSecurityContext. Якщо встановлено як у SecurityContext, так і в PodSecurityContext, перевага надається значенню, вказаному в SecurityContext. |
runAsUserinteger | UID для запуску точки входу процесу контейнера. Використовує стандартне значення середовища виконання, якщо не встановлено. Може також бути встановлено в PodSecurityContext. Якщо встановлено як у SecurityContext, так і в PodSecurityContext, перевага надається значенню, вказаному в SecurityContext. Зверніть увагу, що це поле не можна встановлювати, коли spec.os.name є windows. |
seLinuxOptionsSELinuxOptions | SELinux контекст, який буде застосовано до контейнера. Якщо не вказано, середовище виконання контейнера виділить випадковий SELinux контекст для кожного контейнера. Може також бути встановлено в PodSecurityContext. Якщо встановлено як у SecurityContext, так і в PodSecurityContext, перевага надається значенню, вказаному в SecurityContext. Зверніть увагу, що це поле не можна встановлювати, коли spec.os.name є windows. |
seccompProfileSeccompProfile | Параметри seccomp, які використовуються цим контейнером. Якщо параметри seccomp надаються як на рівні пода, так і на рівні контейнера, параметри контейнера переважають над параметрами пода. Зверніть увагу, що це поле не можна встановлювати, коли spec.os.name є windows. |
windowsOptionsWindowsSecurityContextOptions | Специфічні для Windows налаштування, які застосовуються до всіх контейнерів. Якщо не вказано, будуть використані параметри з PodSecurityContext. Якщо встановлено як у SecurityContext, так і в PodSecurityContext, перевага надається значенню, вказаному в SecurityContext. Зверніть увагу, що це поле не можна встановлювати, коли spec.os.name є linux. |
ServiceAccountTokenProjection
ServiceAccountTokenProjection представляє спроєцьований том токенів службового облікового запису. Цей спроєцьований том можна використовувати для вставлення токенів службового облікового запису у файлову систему подів для використання з API (Kubernetes API Server або інших).
| Поле | Опис |
|---|---|
audiencestring | audience є призначеною аудиторією токена. Отримувач токена повинен ідентифікувати себе за допомогою ідентифікатора, вказаного в аудиторії токена, інакше слід відхилити токен. Стандартно аудиторія встановлюється як ідентифікатор apiserver. |
expirationSecondsinteger | expirationSeconds є запитуваною тривалістю дії токена службового облікового запису. Коли токен наближається до закінчення терміну дії, втулок томів kubelet буде проактивно оновлювати токен службового облікового запису. Kubelet почне намагатися оновити токен, якщо токен старший за 80 відсотків свого часу життя або якщо токен старший за 24 години. Стандартне значення становить 1 годину і має бути не менше 10 хвилин. |
path *string | path є шляхом відносно точки монтування файлу, куди буде вставлено токен. |
SleepAction
SleepAction описує дію "sleep".
| Поле | Опис |
|---|---|
seconds *integer | Seconds є кількістю секунд для сну. |
StorageOSVolumeSource
Представляє ресурс постійного тома StorageOS.
| Поле | Опис |
|---|---|
fsTypestring | fsType є типом файлової системи для монтування. Має бути тип файлової системи, підтримуваний операційною системою хоста. Наприклад, "ext4", "xfs", "ntfs". Якщо не вказано, неявно вважається "ext4". |
readOnlyboolean | readOnly стандартно встановлено в false (читання/запис). ReadOnly тут примусово встановить параметр ReadOnly у VolumeMounts. |
secretRefLocalObjectReference | secretRef вказує секрет для отримання облікових даних API StorageOS. Якщо не вказано, будуть використані стандартні значення. |
volumeNamestring | volumeName є зрозумілим для людини імʼям тома StorageOS. Імена томів унікальні лише в межах простору імен. |
volumeNamespacestring | volumeNamespace вказує область дії тома в межах StorageOS. Якщо простір імен не вказано, буде використано простір імен пода. Це дозволяє відобразити іменування Kubernetes у StorageOS для тіснішої інтеграції. Встановіть VolumeName на будь-яке імʼя, щоб перевизначити стандартну поведінку. Встановіть на "default", якщо ви не використовуєте простори імен у StorageOS. Простори імен, які не існують у StorageOS, будуть створені. |
Sysctl
Sysctl визначає параметр ядра, який потрібно встановити
| Поле | Опис |
|---|---|
name *string | Назва властивості для встановлення |
value *string | Значення властивості для встановлення |
TCPSocketAction
TCPSocketAction описує дію на основі відкриття сокета
| Поле | Опис |
|---|---|
hoststring | Опційно: Імʼя хосту для підключення, зазвичай використовується IP пода. |
port * | Номер або імʼя порту для доступу до контейнера. Номер повинен бути в діапазоні від 1 до 65535. Імʼя повинно бути IANA_SVC_NAME. |
TopologySpreadConstraint
TopologySpreadConstraint визначає, як розподіляти відповідні поди серед заданої топології.
| Поле | Опис |
|---|---|
labelSelectorLabelSelector | LabelSelector використовується для пошуку відповідних подів. Поди, які відповідають цьому селектору міток, враховуються для визначення кількості подів у їх відповідному топологічному домені. |
matchLabelKeysstring array | MatchLabelKeys є набором ключів міток подів для вибору подів, для яких буде обчислюватися розподіл. Ключі використовуються для пошуку значень у мітках вхідного пода, ці ключ-значення мітки обʼєднуються з labelSelector для вибору групи наявних подів, для яких буде обчислюватися розподіл для вхідного пода. Один і той же ключ заборонено використовувати як у MatchLabelKeys, так і в LabelSelector. MatchLabelKeys не можна встановлювати, якщо LabelSelector не встановлено. Ключі, яких немає в мітках вхідного пода, будуть ігноруватися. Null або порожній список означає, що буде враховуватися лише labelSelector. Це бета-поле і вимагає увімкнення функціональної можливості MatchLabelKeysInPodTopologySpread (стандартно увімкнено). |
maxSkew *integer | MaxSkew описує ступінь нерівномірного розподілу подів. Коли whenUnsatisfiable=DoNotSchedule, це максимальна дозволена різниця між кількістю відповідних подів у цільовій топології та глобальним мінімумом. Глобальний мінімум — це мінімальна кількість відповідних подів у допустимому домені або нуль, якщо кількість допустимих доменів менша за MinDomains. Наприклад, у кластері з 3 зонами, MaxSkew встановлено на 1, а поди з однаковим labelSelector розподілені як 2/2/1: У цьому випадку глобальний мінімум дорівнює 1.graph TD;
subgraph zone3["zone 3"]
P3_1("Pod")
end
subgraph zone2["zone 2"]
P2_1("Pod")
P2_2("Pod")
end
subgraph zone1["zone 1"]
P1_1("Pod")
P1_2("Pod")
end
classDef plain fill:#ddd,stroke:#fff,stroke-width:4px,color:#000;
classDef k8s fill:#326ce5,stroke:#fff,stroke-width:4px,color:#fff;
classDef cluster fill:#fff,stroke:#bbb,stroke-width:2px,color:#326ce5;
class P1_1,P1_2,P2_1,P2_2,P3_1 k8s;
class zone1,zone2,zone3 cluster;
|
minDomainsinteger | MinDomains вказує мінімальну кількість допустимих доменів. Коли кількість допустимих доменів з відповідними ключами топології менша за minDomains, Pod Topology Spread розглядає "глобальний мінімум" як 0, а потім виконується обчислення Skew. Коли кількість допустимих доменів з відповідними ключами топології дорівнює або перевищує minDomains, це значення не впливає на планування. В результаті, коли кількість допустимих доменів менша за minDomains, планувальник не буде планувати більше maxSkew Pod у ці домени. Якщо значення nil, обмеження поводиться так, ніби MinDomains дорівнює 1. Допустимі значення — це цілі числа більше 0. Коли значення не nil, WhenUnsatisfiable має бути DoNotSchedule. Наприклад, у кластері з 3 зонами, MaxSkew встановлено на 2, MinDomains встановлено на 5, а поди з тим самим labelSelector розподілені як 2/2/2: graph TD;
subgraph zone3["zone 3"]
P3_1("Pod")
P3_2("Pod")
end
subgraph zone2["zone 2"]
P2_1("Pod")
P2_2("Pod")
end
subgraph zone1["zone 1"]
P1_1("Pod")
P1_2("Pod")
end
classDef plain fill:#ddd,stroke:#fff,stroke-width:4px,color:#000;
classDef k8s fill:#326ce5,stroke:#fff,stroke-width:4px,color:#fff;
classDef cluster fill:#fff,stroke:#bbb,stroke-width:2px,color:#326ce5;
class P1_1,P1_2,P2_1,P2_2,P3_1,P3_2 k8s;
class zone1,zone2,zone3 cluster; |
nodeAffinityPolicystring | NodeAffinityPolicy вказує, як ми будемо обробляти nodeAffinity/nodeSelector пода при обчисленні перекосу топології пода. Варіанти:
Якщо це значення дорівнює nil, поведінка еквівалентна політиці Honor. Можливі значення enum:
|
nodeTaintsPolicystring | NodeTaintsPolicy вказує, як ми будемо обробляти node taints при обчисленні перекосу топології пода. Варіанти:
Якщо це значення дорівнює nil, поведінка еквівалентна політиці Ignore. Можливі значення enum:
|
topologyKey *string | TopologyKey є ключем міток вузлів. Вузли, які мають мітку з цим ключем і однаковими значеннями, вважаються частиною однієї топології. Ми розглядаємо кожну пару <ключ, значення> як "кошик" і намагаємося розподілити поди рівномірно між кошиками. Ми визначаємо домен як конкретний екземпляр топології. Також ми визначаємо допустимий домен як домен, вузли якого відповідають вимогам nodeAffinityPolicy і nodeTaintsPolicy. Наприклад, якщо TopologyKey дорівнює "kubernetes.io/hostname", кожен вузол є доменом цієї топології. А якщо TopologyKey дорівнює "topology.kubernetes.io/zone", кожна зона є доменом цієї топології. Це обов'язкове поле. |
whenUnsatisfiable *string | WhenUnsatisfiable вказує, як діяти з подом, якщо він не задовольняє обмеження розподілу.
graph TD;
subgraph zone3["zone 3"]
P3_1("Pod")
end
subgraph zone2["zone 2"]
P2_1("Pod")
end
subgraph zone1["zone 1"]
P1_1("Pod")
P1_2("Pod")
P1_3("Pod")
end
classDef plain fill:#ddd,stroke:#fff,stroke-width:4px,color:#000;
classDef k8s fill:#326ce5,stroke:#fff,stroke-width:4px,color:#fff;
classDef cluster fill:#fff,stroke:#bbb,stroke-width:2px,color:#326ce5;
class P1_1,P1_2,P1_3,P2_1,P3_1 k8s;
class zone1,zone2,zone3 cluster; Можливі значення enum:
|
Volume
Volume представляє іменований том у поді, до якого може отримати доступ будь-який контейнер у поді.
| Поле | Опис |
|---|---|
awsElasticBlockStoreAWSElasticBlockStoreVolumeSource | awsElasticBlockStore представляє ресурс диска AWS, який підключається до хост-машини kubelet і потім надається поду. Застаріло: AWSElasticBlockStore застаріло. Всі операції для типу вбудованого awsElasticBlockStore перенаправляються до CSI драйвера ebs.csi.aws.com. Детальніше: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore |
azureDiskAzureDiskVolumeSource | azureDisk представляє монтування диска Azure Data на хості та привʼязку до пода. Застаріло: AzureDisk застаріло. Всі операції для типу вбудованого azureDisk перенаправляються до CSI драйвера disk.csi.azure.com. |
azureFileAzureFileVolumeSource | azureFile представляє монтування Azure File Service на хості та привʼязку до пода. Застаріло: AzureFile застаріло. Всі операції для типу вбудованого azureFile перенаправляються до CSI драйвера file.csi.azure.com. |
cephfsCephFSVolumeSource | cephFS представляє монтування Ceph FS на хості, яке спільно використовує життєвий цикл пода. Застаріло: CephFS застаріло, і тип cephfs більше не підтримується. |
cinderCinderVolumeSource | cinder представляє том cinder, підключений і змонтований на хості kubelet. Застаріло: Cinder застаріло. Всі операції для типу вбудованого cinder перенаправляються до CSI драйвера cinder.csi.openstack.org. Детальніше: https://examples.k8s.io/mysql-cinder-pd/README.md |
configMapConfigMapVolumeSource | configMap представляє configMap, який повинен заповнити цей том |
csiCSIVolumeSource | csi (Container Storage Interface) представляє тимчасове сховище, яке обробляється певними зовнішніми CSI драйверами. |
downwardAPIDownwardAPIVolumeSource | downwardAPI представляє downward API, що стосується пода, який повинен заповнити цей том |
emptyDirEmptyDirVolumeSource | emptyDir представляє тимчасова тека, який спільно використовує життєвий цикл пода. Детальніше: https://kubernetes.io/docs/concepts/storage/volumes#emptydir |
ephemeralEphemeralVolumeSource | ephemeral представляє том, який обробляється драйвером сховища кластера. Життєвий цикл тому повʼязаний з подом, який його визначає — він буде створений перед запуском пода і видалений після його видалення. Використовуйте це, якщо:
|
fcFCVolumeSource | fc представляє ресурс Fibre Channel, який підключається до хост-машини kubelet і потім надається поду. |
flexVolumeFlexVolumeSource | flexVolume представляє загальний ресурс тому, який надається/підключається за допомогою втулка на основі exec. Застаріло: FlexVolume застаріло. Розгляньте можливість використання CSIDriver замість цього. |
flockerFlockerVolumeSource | flocker представляє том Flocker, підключений до хост-машини kubelet. Це залежить від того, що сервіс керування Flocker працює. Застаріло: Flocker застаріло, і вбудований тип flocker більше не підтримується. |
gcePersistentDiskGCEPersistentDiskVolumeSource | gcePersistentDisk представляє ресурс GCE Disk, який підключається до хост-машини kubelet і потім надається поду. Застаріло: GCEPersistentDisk застаріло. Всі операції для вбудованого типу gcePersistentDisk перенаправляються на драйвер CSI pd.csi.storage.gke.io. Більше інформації: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk |
gitRepoGitRepoVolumeSource | gitRepo представляє репозиторій git на певній ревізії. Застаріло: GitRepo застаріло. Щоб забезпечити контейнер репозиторієм git, змонтуйте EmptyDir у InitContainer, який клонує репозиторій за допомогою git, а потім змонтуйте EmptyDir у контейнер Pod. |
glusterfsGlusterfsVolumeSource | glusterfs представляє монтування Glusterfs на хості, яке ділить життєвий цикл пода. Застаріло: Glusterfs застаріло, і вбудований тип glusterfs більше не підтримується. |
hostPathHostPathVolumeSource | hostPath представляє попередньо наявний файл або теку на хост-машині, який безпосередньо відкривається для контейнера. Це зазвичай використовується для системних агентів або інших привілейованих речей, яким дозволено бачити хост-машину. Більшість контейнерів НЕ потребують цього. Більше інформації: https://kubernetes.io/docs/concepts/storage/volumes#hostpath |
imageImageVolumeSource | image представляє обʼєкт OCI (контейнерний образ або артефакт), який отримується та монтується на хост-машині kubelet. Том визначається під час запуску пода залежно від значення PullPolicy:
|
iscsiISCSIVolumeSource | iscsi представляє ресурс ISCSI Disk, який підключається до хост-машини kubelet і потім надається поду. Більше інформації: https://kubernetes.io/docs/concepts/storage/volumes/#iscsi |
name *string | імʼя тому. Повинно бути DNS_LABEL і унікальним в межах пода. Більше інформації: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
nfsNFSVolumeSource | nfs представляє NFS-монтування на хості, яке використовує життєвий цикл пода. Більше інформації: https://kubernetes.io/docs/concepts/storage/volumes#nfs |
persistentVolumeClaimPersistentVolumeClaimVolumeSource | persistentVolumeClaimVolumeSource представляє посилання на PersistentVolumeClaim в тому ж просторі імен. Більше інформації: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims |
photonPersistentDiskPhotonPersistentDiskVolumeSource | photonPersistentDisk представляє постійний диск PhotonController, підключений і змонтований на хості kubelet. Застаріло: PhotonPersistentDisk застарів, і тип photonPersistentDisk більше не підтримується. |
portworxVolumePortworxVolumeSource | portworxVolume представляє том Portworx, підключений і змонтований на хості kubelet. Застаріло: PortworxVolume застарів. Всі операції для типу portworxVolume в дереві перенаправляються на драйвер CSI pxd.portworx.com. |
projectedProjectedVolumeSource | спроєцьовані елементи для всіх ресурсів в одному: secrets, configmaps та downward API |
quobyteQuobyteVolumeSource | quobyte представляє монтування Quobyte на хості, яке використовує життєвий цикл пода. Застаріло: Quobyte застарів, і тип quobyte більше не підтримується. |
rbdRBDVolumeSource | rbd представляє монтування Rados Block Device на хості, яке використовує життєвий цикл пода. Застаріло: RBD застарів, і тип rbd більше не підтримується. |
scaleIOScaleIOVolumeSource | scaleIO представляє постійний том ScaleIO, підключений і змонтований на вузлах Kubernetes. Застаріло: ScaleIO застарів, і тип scaleIO більше не підтримується. |
secretSecretVolumeSource | secret представляє секрет, який повинен заповнювати цей том. Більше інформації: https://kubernetes.io/docs/concepts/storage/volumes#secret |
storageosStorageOSVolumeSource | storageOS представляє том StorageOS, підключений і змонтований на вузлах Kubernetes. Застаріло: StorageOS застарів, і тип storageos більше не підтримується. |
vsphereVolumeVsphereVirtualDiskVolumeSource | vsphereVolume представляє том vSphere, підключений і змонтований на хості kubelet. Застаріло: VsphereVolume застарів. Всі операції для типу vsphereVolume в дереві перенаправляються на драйвер CSI csi.vsphere.vmware.com. |
VolumeDevice
volumeDevice описує зіставлення сирого блочного пристрою всередині контейнера.
| Поле | Опис |
|---|---|
devicePath *string | devicePath є шляхом всередині контейнера, до якого буде змонтовано пристрій. |
name *string | name повинен відповідати імені persistentVolumeClaim у поді |
VolumeMount
VolumeMount описує монтування тому всередині контейнера.
| Поле | Опис |
|---|---|
mountPath *string | Шлях всередині контейнера, до якого буде змонтовано том. Не повинен містити ':'. |
mountPropagationstring | mountPropagation визначає, як монтування поширюються від хоста до контейнера і навпаки. Якщо не встановлено, використовується MountPropagationNone. Це поле є бета-версією в 1.10. Коли RecursiveReadOnly встановлено на IfPossible або Enabled, MountPropagation повинен бути None або невизначеним (що зазвичай дорівнює None). Можливі значення enum:
|
name *string | Поле має збігатись з Name у Volume. |
readOnlyboolean | Монтується тільки для читання, якщо true, для читання та запису в іншому випадку (false або не вказано). Зазвичай — false. |
recursiveReadOnlystring | RecursiveReadOnly визначає, чи повинні монтування тільки для читання оброблятися рекурсивно. Якщо ReadOnly встановлено у false, це поле не має значення і повинно бути невказаним. Якщо ReadOnly встановлено в true, і це поле встановлено в Disabled, монтування не робиться рекурсивно тільки для читання. Якщо це поле встановлено в IfPossible, монтування робиться рекурсивно тільки для читання, якщо це підтримується середовищем виконання контейнера. Якщо це поле встановлено в Enabled, монтування робиться рекурсивно тільки для читання, якщо це підтримується середовищем виконання контейнера, інакше под не буде запущено, і буде згенеровано помилку для вказання причини. Якщо це поле встановлено в IfPossible або Enabled, MountPropagation повинно бути встановлено в None (або бути невказаним, що зазвичай дорівнює None). Якщо це поле не вказано, воно розглядається як еквівалент Disabled. |
subPathstring | Шлях всередині тому, з якого повинен бути змонтований том контейнера. Зазвичай — "" (корінь тому). |
subPathExprstring | Розширений шлях всередині тому, з якого повинен бути змонтований том контейнера. Поводиться аналогічно до SubPath, але посилання на змінні середовища $(VAR_NAME) розширюються за допомогою середовища контейнера. Зазвичай — "" (корінь тому). SubPathExpr і SubPath взаємовиключні. |
VolumeProjection
Проєкція яка може бути спроєцьована разом з іншими підтримуваними типами томів. Повинно бути встановлено тільки одне з цих полів.
| Поле | Опис |
|---|---|
clusterTrustBundleClusterTrustBundleProjection | ClusterTrustBundle дозволяє поду отримувати доступ до поля .spec.trustBundle обʼєктів ClusterTrustBundle у файлі з автоматичним оновленням. Альфа, керується функціональною можливістю ClusterTrustBundleProjection. Обʼєкти ClusterTrustBundle можна вибирати за назвою або за комбінацією імені підписувача та селектора міток. Kubelet виконує агресивну нормалізацію вмісту PEM, записаного в файлову систему пода. Езотеричні функції PEM, такі як коментарі між блоками та заголовки блоків, видаляються. Сертифікати дедуплікуються. Порядок сертифікатів у файлі довільний, і Kubelet може змінювати порядок з часом. |
configMapConfigMapProjection | Інформація про дані configMap для проєкції |
downwardAPIDownwardAPIProjection | Інформація про дані downwardAPI для проєкції |
podCertificatePodCertificateProjection | Проєкція автоматично оновлюваного набору облікових даних (приватний ключ і ланцюжок сертифікатів), який под може використовувати як TLS-клієнт або сервер. Kubelet генерує приватний ключ і використовує його для надсилання PodCertificateRequest до вказаного підписувача. Після того як підписувач схвалить запит і видасть ланцюжок сертифікатів, Kubelet записує ключ і ланцюжок сертифікатів у файлову систему пода. Под не запускається, поки сертифікати не будуть видані для кожного джерела тома podCertificate у його специфікації. Kubelet почне намагатися оновити сертифікат у час, вказаний підписувачем, використовуючи PodCertificateRequest.Status.BeginRefreshAt timestamp. Kubelet може записати один файл, вказаний у полі credentialBundlePath, або окремі файли, вказані у полях keyPath і certificateChainPath. Набір облікових даних є одним файлом у форматі PEM. Перший запис PEM є приватним ключем (у форматі PKCS#8), а решта записів PEM є ланцюжком сертифікатів, виданих підписувачем (зазвичай підписувачі повертають свій ланцюжок сертифікатів у порядку від листа до кореня). Рекомендується використовувати формат набору облікових даних, оскільки код вашого застосунку може читати його атомарно. Якщо ви використовуєте keyPath і certificateChainPath, ваш застосунок повинен виконати два окремі читання файлів. Якщо це збігається з оновленням сертифіката, можливо, що приватний ключ і сертифікат листа, які ви читаєте, можуть не відповідати один одному. Вашому застосунку потрібно перевірити цю умову і перечитати, поки вони не будуть узгоджені. Вказаний підписувач контролює формат сертифіката, який він видає; зверніться до документації реалізації підписувача, щоб дізнатися, як використовувати видані сертифікати. |
secretSecretProjection | Інформація про дані секрету для проєкції |
serviceAccountTokenServiceAccountTokenProjection | Інформація про дані serviceAccountToken для проєкції |
WeightedPodAffinityTerm
Ваги для всіх полів WeightedPodAffinityTerm, що мають збіг, додаються для кожного вузла, щоб знайти найбільш бажані вузли.
| Поле | Опис |
|---|---|
podAffinityTerm *PodAffinityTerm | Обовʼязково. Термін спорідненості пода, повʼязаний з відповідною вагою. |
weight *integer | Вага, повʼязана з відповідним терміном спорідненості пода, у діапазоні від 1 до 100. |
WindowsSecurityContextOptions
WindowsSecurityContextOptions містить параметри та облікові дані, специфічні для Windows.
| Поле | Опис |
|---|---|
gmsaCredentialSpecstring | GMSACredentialSpec — це місце, де вебхук допуску GMSA (https://github.com/kubernetes-sigs/windows-gmsa) вставляє вміст специфікації облікових даних GMSA, визначеної полем GMSACredentialSpecName. |
gmsaCredentialSpecNamestring | GMSACredentialSpecName — це назва специфікації облікових даних GMSA, яку слід використовувати. |
hostProcessboolean | HostProcess визначає, чи слід запускати контейнер як 'Host Process' контейнер. Усі контейнери Pod повинні мати однакове ефективне значення HostProcess (не дозволяється мати суміш HostProcess контейнерів і не-HostProcess контейнерів). Крім того, якщо HostProcess встановлено в true, то HostNetwork також повинен бути встановлений в true. |
runAsUserNamestring | Імʼя користувача в Windows для запуску точки входу процесу контейнера. Зазвичай використовується користувач, вказаний у метаданих образу, якщо не вказано інше. Може також бути встановлено в PodSecurityContext. Якщо встановлено як у SecurityContext, так і в PodSecurityContext, перевага надається значенню, вказаному в SecurityContext. |
Операції
post Create
HTTP Запит
POST /api/v1/namespaces/{namespace}/pods
Параметри шляху
| Назва | Тип | Опис |
|---|---|---|
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 | Pod |
Відповідь
| Статус | Опис | Відповідь |
|---|---|---|
| 200 | OK | Pod |
| 201 | Created | Pod |
| 202 | Accepted | Pod |
post Create Eviction
HTTP Запит
POST /api/v1/namespaces/{namespace}/pods/{name}/eviction
Параметри шляху
| Назва | Тип | Опис |
|---|---|---|
name | string | Імʼя Eviction |
namespace | string | Назва обʼєкта та область авторизації, наприклад для команд і проєктів |
Параметри запиту
| Назва | Тип | Опис |
|---|---|---|
dryRun | string | Коли параметр присутній, це вказує, що зміни не повинні зберігатися. Неправильна або нерозпізнана директива dryRun призведе до помилки та припинення обробки запиту. Дійсні значення:
|
fieldManager | string | fieldManager є імʼям, повʼязаним з а́ктором або сутністю, яка вносить ці зміни. Значення повинно бути менше або дорівнювати 128 символам і містити лише друковані символи, як визначено в https://golang.org/pkg/unicode/#IsPrint. |
fieldValidation | string | fieldValidation інструктує сервер, як обробляти обʼєкти в запиті (POST/PUT/PATCH), що містять невідомі або дубльовані поля. Дійсні значення:
|
pretty | string | Якщо 'true', то вихідні дані форматуються у зручному для читання вигляді. Зазвичай 'false', якщо user-agent не вказує оглядач або командний інструмент для роботи з HTTP (curl та wget). |
Параметри тіла запиту
| Назва | Тип | Опис |
|---|---|---|
body | Eviction |
Відповідь
| Статус | Опис | Відповідь |
|---|---|---|
| 200 | OK | Eviction |
| 201 | Created | Eviction |
| 202 | Accepted | Eviction |
patch Patch
HTTP Запит
PATCH /api/v1/namespaces/{namespace}/pods/{name}
Параметри шляху
| Назва | Тип | Опис |
|---|---|---|
name | string | Імʼя Podʼа |
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 | Pod |
| 201 | Created | Pod |
put Replace
HTTP Запит
PUT /api/v1/namespaces/{namespace}/pods/{name}
Параметри шляху
| Назва | Тип | Опис |
|---|---|---|
name | string | Імʼя Podʼа |
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 | Pod |
Відповідь
| Статус | Опис | Відповідь |
|---|---|---|
| 200 | OK | Pod |
| 201 | Created | Pod |
delete Delete
HTTP Запит
DELETE /api/v1/namespaces/{namespace}/pods/{name}
Параметри шляху
| Назва | Тип | Опис |
|---|---|---|
name | string | Імʼя Podʼа |
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 | Pod |
| 202 | Accepted | Pod |
delete Delete Collection
HTTP Запит
DELETE /api/v1/namespaces/{namespace}/pods
Параметри шляху
| Назва | Тип | Опис |
|---|---|---|
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 /api/v1/namespaces/{namespace}/pods/{name}
Параметри шляху
| Назва | Тип | Опис |
|---|---|---|
name | string | Імʼя Podʼа |
namespace | string | Назва обʼєкта та область авторизації, наприклад для команд і проєктів |
Параметри запиту
| Назва | Тип | Опис |
|---|---|---|
pretty | string | Якщо 'true', то вихідні дані форматуються у зручному для читання вигляді. Зазвичай 'false', якщо user-agent не вказує оглядач або командний інструмент для роботи з HTTP (curl та wget). |
Відповідь
| Статус | Опис | Відповідь |
|---|---|---|
| 200 | OK | Pod |
get List
HTTP Запит
GET /api/v1/namespaces/{namespace}/pods
Параметри шляху
| Назва | Тип | Опис |
|---|---|---|
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 | PodList |
get List All Namespaces
HTTP Запит
GET /api/v1/pods
Параметри запиту
| Назва | Тип | Опис |
|---|---|---|
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 | PodList |
get Watch
HTTP Запит
GET /api/v1/watch/namespaces/{namespace}/pods/{name}
Параметри шляху
| Назва | Тип | Опис |
|---|---|---|
name | string | Імʼя Podʼа |
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 /api/v1/watch/namespaces/{namespace}/pods
Параметри шляху
| Назва | Тип | Опис |
|---|---|---|
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 /api/v1/watch/pods
Параметри запиту
| Назва | Тип | Опис |
|---|---|---|
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 /api/v1/namespaces/{namespace}/pods/{name}/status
Параметри шляху
| Назва | Тип | Опис |
|---|---|---|
name | string | Імʼя Podʼа |
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 | Pod |
| 201 | Created | Pod |
get Read Status
HTTP Запит
GET /api/v1/namespaces/{namespace}/pods/{name}/status
Параметри шляху
| Назва | Тип | Опис |
|---|---|---|
name | string | Імʼя Podʼа |
namespace | string | Назва обʼєкта та область авторизації, наприклад для команд і проєктів |
Параметри запиту
| Назва | Тип | Опис |
|---|---|---|
pretty | string | Якщо 'true', то вихідні дані форматуються у зручному для читання вигляді. Зазвичай 'false', якщо user-agent не вказує оглядач або командний інструмент для роботи з HTTP (curl та wget). |
Відповідь
| Статус | Опис | Відповідь |
|---|---|---|
| 200 | OK | Pod |
put Replace Status
HTTP Запит
PUT /api/v1/namespaces/{namespace}/pods/{name}/status
Параметри шляху
| Назва | Тип | Опис |
|---|---|---|
name | string | Імʼя Podʼа |
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 | Pod |
Відповідь
| Статус | Опис | Відповідь |
|---|---|---|
| 200 | OK | Pod |
| 201 | Created | Pod |
get Read Resize
HTTP Запит
GET /api/v1/namespaces/{namespace}/pods/{name}/resize
Параметри шляху
| Назва | Тип | Опис |
|---|---|---|
name | string | Імʼя Podʼа |
namespace | string | Назва обʼєкта та область авторизації, наприклад для команд і проєктів |
Параметри запиту
| Назва | Тип | Опис |
|---|---|---|
pretty | string | Якщо 'true', то вихідні дані форматуються у зручному для читання вигляді. Зазвичай 'false', якщо user-agent не вказує оглядач або командний інструмент для роботи з HTTP (curl та wget). |
Відповідь
| Статус | Опис | Відповідь |
|---|---|---|
| 200 | OK | Pod |
patch Patch Resize
HTTP Запит
PATCH /api/v1/namespaces/{namespace}/pods/{name}/resize
Параметри шляху
| Назва | Тип | Опис |
|---|---|---|
name | string | Імʼя Podʼа |
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 | Pod |
| 201 | Created | Pod |
put Replace Resize
HTTP Запит
PUT /api/v1/namespaces/{namespace}/pods/{name}/resize
Параметри шляху
| Назва | Тип | Опис |
|---|---|---|
name | string | Імʼя Podʼа |
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 | Pod |
Відповідь
| Статус | Опис | Відповідь |
|---|---|---|
| 200 | OK | Pod |
| 201 | Created | Pod |
patch Patch EphemeralContainers
HTTP Запит
PATCH /api/v1/namespaces/{namespace}/pods/{name}/ephemeralcontainers
Параметри шляху
| Назва | Тип | Опис |
|---|---|---|
name | string | Імʼя Podʼа |
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 | Pod |
| 201 | Created | Pod |
get Read EphemeralContainers
HTTP Запит
GET /api/v1/namespaces/{namespace}/pods/{name}/ephemeralcontainers
Параметри шляху
| Назва | Тип | Опис |
|---|---|---|
name | string | Імʼя Podʼа |
namespace | string | Назва обʼєкта та область авторизації, наприклад для команд і проєктів |
Параметри запиту
| Назва | Тип | Опис |
|---|---|---|
pretty | string | Якщо 'true', то вихідні дані форматуються у зручному для читання вигляді. Зазвичай 'false', якщо user-agent не вказує оглядач або командний інструмент для роботи з HTTP (curl та wget). |
Відповідь
| Статус | Опис | Відповідь |
|---|---|---|
| 200 | OK | Pod |
put Replace EphemeralContainers
HTTP Запит
PUT /api/v1/namespaces/{namespace}/pods/{name}/ephemeralcontainers
Параметри шляху
| Назва | Тип | Опис |
|---|---|---|
name | string | Імʼя Podʼа |
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 | Pod |
Відповідь
| Статус | Опис | Відповідь |
|---|---|---|
| 200 | OK | Pod |
| 201 | Created | Pod |
post Create Connect Portforward
HTTP Запит
POST /api/v1/namespaces/{namespace}/pods/{name}/portforward
Параметри шляху
| Назва | Тип | Опис |
|---|---|---|
name | string | Імʼя PodPortForwardOptions |
namespace | string | Назва обʼєкта та область авторизації, наприклад для команд і проєктів |
Параметри запиту
| Назва | Тип | Опис |
|---|---|---|
ports | integer | Список портів для переадресації. Необхідний при використанні WebSockets |
Відповідь
| Статус | Опис | Відповідь |
|---|---|---|
| 200 | OK | string |
post Create Connect Proxy
HTTP Запит
POST /api/v1/namespaces/{namespace}/pods/{name}/proxy
Параметри шляху
| Назва | Тип | Опис |
|---|---|---|
name | string | Імʼя PodProxyOptions |
namespace | string | Назва обʼєкта та область авторизації, наприклад для команд і проєктів |
Параметри запиту
| Назва | Тип | Опис |
|---|---|---|
path | string | Path є URL-адресою, яку слід використовувати для поточного проксі-запиту до пода. |
Відповідь
| Статус | Опис | Відповідь |
|---|---|---|
| 200 | OK | string |
post Create Connect Proxy Path
HTTP Запит
POST /api/v1/namespaces/{namespace}/pods/{name}/proxy/{path}
Параметри шляху
| Назва | Тип | Опис |
|---|---|---|
name | string | Імʼя PodProxyOptions |
namespace | string | Назва обʼєкта та область авторизації, наприклад для команд і проєктів |
path | string | шлях до ресурсу |
Параметри запиту
| Назва | Тип | Опис |
|---|---|---|
path | string | Path є URL-адресою, яку слід використовувати для поточного проксі-запиту до пода. |
Відповідь
| Статус | Опис | Відповідь |
|---|---|---|
| 200 | OK | string |
delete Delete Connect Proxy
HTTP Запит
DELETE /api/v1/namespaces/{namespace}/pods/{name}/proxy
Параметри шляху
| Назва | Тип | Опис |
|---|---|---|
name | string | Імʼя PodProxyOptions |
namespace | string | Назва обʼєкта та область авторизації, наприклад для команд і проєктів |
Параметри запиту
| Назва | Тип | Опис |
|---|---|---|
path | string | Path є URL-адресою, яку слід використовувати для поточного проксі-запиту до пода. |
Відповідь
| Статус | Опис | Відповідь |
|---|---|---|
| 200 | OK | string |
delete Delete Connect Proxy Path
HTTP Запит
DELETE /api/v1/namespaces/{namespace}/pods/{name}/proxy/{path}
Параметри шляху
| Назва | Тип | Опис |
|---|---|---|
name | string | Імʼя PodProxyOptions |
namespace | string | Назва обʼєкта та область авторизації, наприклад для команд і проєктів |
path | string | шлях до ресурсу |
Параметри запиту
| Назва | Тип | Опис |
|---|---|---|
path | string | Path є URL-адресою, яку слід використовувати для поточного проксі-запиту до пода. |
Відповідь
| Статус | Опис | Відповідь |
|---|---|---|
| 200 | OK | string |
get Get Connect Portforward
HTTP Запит
GET /api/v1/namespaces/{namespace}/pods/{name}/portforward
Параметри шляху
| Назва | Тип | Опис |
|---|---|---|
name | string | Імʼя PodPortForwardOptions |
namespace | string | Назва обʼєкта та область авторизації, наприклад для команд і проєктів |
Параметри запиту
| Назва | Тип | Опис |
|---|---|---|
ports | integer | Список портів для переадресації. Необхідний при використанні WebSockets |
Відповідь
| Статус | Опис | Відповідь |
|---|---|---|
| 200 | OK | string |
get Get Connect Proxy
HTTP Запит
GET /api/v1/namespaces/{namespace}/pods/{name}/proxy
Параметри шляху
| Назва | Тип | Опис |
|---|---|---|
name | string | Імʼя PodProxyOptions |
namespace | string | Назва обʼєкта та область авторизації, наприклад для команд і проєктів |
Параметри запиту
| Назва | Тип | Опис |
|---|---|---|
path | string | Path є URL-адресою, яку слід використовувати для поточного проксі-запиту до пода. |
Відповідь
| Статус | Опис | Відповідь |
|---|---|---|
| 200 | OK | string |
get Get Connect Proxy Path
HTTP Запит
GET /api/v1/namespaces/{namespace}/pods/{name}/proxy/{path}
Параметри шляху
| Назва | Тип | Опис |
|---|---|---|
name | string | Імʼя PodProxyOptions |
namespace | string | Назва обʼєкта та область авторизації, наприклад для команд і проєктів |
path | string | шлях до ресурсу |
Параметри запиту
| Назва | Тип | Опис |
|---|---|---|
path | string | Path є URL-адресою, яку слід використовувати для поточного проксі-запиту до пода. |
Відповідь
| Статус | Опис | Відповідь |
|---|---|---|
| 200 | OK | string |
head Head Connect Proxy
HTTP Запит
HEAD /api/v1/namespaces/{namespace}/pods/{name}/proxy
Параметри шляху
| Назва | Тип | Опис |
|---|---|---|
name | string | Імʼя PodProxyOptions |
namespace | string | Назва обʼєкта та область авторизації, наприклад для команд і проєктів |
Параметри запиту
| Назва | Тип | Опис |
|---|---|---|
path | string | Path є URL-адресою, яку слід використовувати для поточного проксі-запиту до пода. |
Відповідь
| Статус | Опис | Відповідь |
|---|---|---|
| 200 | OK | string |
head Head Connect Proxy Path
HTTP Запит
HEAD /api/v1/namespaces/{namespace}/pods/{name}/proxy/{path}
Параметри шляху
| Назва | Тип | Опис |
|---|---|---|
name | string | Імʼя PodProxyOptions |
namespace | string | Назва обʼєкта та область авторизації, наприклад для команд і проєктів |
path | string | шлях до ресурсу |
Параметри запиту
| Назва | Тип | Опис |
|---|---|---|
path | string | Path є URL-адресою, яку слід використовувати для поточного проксі-запиту до пода. |
Відповідь
| Статус | Опис | Відповідь |
|---|---|---|
| 200 | OK | string |
put Replace Connect Proxy
HTTP Запит
PUT /api/v1/namespaces/{namespace}/pods/{name}/proxy
Параметри шляху
| Назва | Тип | Опис |
|---|---|---|
name | string | Імʼя PodProxyOptions |
namespace | string | Назва обʼєкта та область авторизації, наприклад для команд і проєктів |
Параметри запиту
| Назва | Тип | Опис |
|---|---|---|
path | string | Path є URL-адресою, яку слід використовувати для поточного проксі-запиту до пода. |
Відповідь
| Статус | Опис | Відповідь |
|---|---|---|
| 200 | OK | string |
put Replace Connect Proxy Path
HTTP Запит
PUT /api/v1/namespaces/{namespace}/pods/{name}/proxy/{path}
Параметри шляху
| Назва | Тип | Опис |
|---|---|---|
name | string | Імʼя PodProxyOptions |
namespace | string | Назва обʼєкта та область авторизації, наприклад для команд і проєктів |
path | string | шлях до ресурсу |
Параметри запиту
| Назва | Тип | Опис |
|---|---|---|
path | string | Path є URL-адресою, яку слід використовувати для поточного проксі-запиту до пода. |
Відповідь
| Статус | Опис | Відповідь |
|---|---|---|
| 200 | OK | string |
get Read Log
HTTP Запит
GET /api/v1/namespaces/{namespace}/pods/{name}/log
Параметри шляху
| Назва | Тип | Опис |
|---|---|---|
name | string | Імʼя Podʼа |
namespace | string | Назва обʼєкта та область авторизації, наприклад для команд і проєктів |
Параметри запиту
| Назва | Тип | Опис |
|---|---|---|
container | string | Контейнер, для якого потрібно передавати журнали. Зазвичай використовується лише один контейнер, якщо в поді є лише один контейнер. |
follow | boolean | Слідкувати за потоком журналів пода. Стандартно — false. |
insecureSkipTLSVerifyBackend | boolean | insecureSkipTLSVerifyBackend вказує, що apiserver не повинен підтверджувати дійсність сертифіката обслуговуючого сервера бекенду, до якого він підключається. Це зробить HTTPS-зʼєднання між apiserver і бекендом небезпечним. Це означає, що apiserver не може перевірити, чи дані журналу, які він отримує, походять від реального kubelet. Якщо kubelet налаштований на перевірку облікових даних TLS apiserver, це не означає, що зʼєднання з реальним kubelet вразливе до атаки "людина посередині" (наприклад, зловмисник не зможе перехопити фактичні дані журналу, що надходять від реального kubelet). |
limitBytes | integer | Якщо встановлено, кількість байтів для читання з сервера перед завершенням виводу журналу. Це може не відобразити повну останню лінію журналу і може повернути трохи більше або трохи менше, ніж вказаний ліміт. |
pretty | string | Якщо 'true', то вихідні дані форматуються у зручному для читання вигляді. Зазвичай 'false', якщо user-agent не вказує оглядач або командний інструмент для роботи з HTTP (curl та wget). |
previous | boolean | Повернути журнали попередньо завершеного контейнера. Стандартно — false. |
sinceSeconds | integer | Відносний час у секундах до поточного часу, з якого потрібно показувати журнали. Якщо це значення передує часу запуску пода, будуть повернуті лише журнали з моменту запуску пода. Якщо це значення знаходиться в майбутньому, журнали не будуть повернуті. Можна вказати лише один з параметрів sinceSeconds або sinceTime. |
stream | string | Вкажіть, який потік журналів контейнера потрібно повернути клієнту. Допустимі значення: "All", "Stdout" та "Stderr". Якщо не вказано, використовується "All", і обидва потоки stdout та stderr повертаються змішаними. Зверніть увагу, що коли вказано "TailLines", "Stream" може бути встановлено лише в nil або "All". |
tailLines | integer | Якщо встановлено, кількість рядків з кінця журналів для відображення. Якщо не вказано, журнали відображаються з моменту створення контейнера або з параметрів sinceSeconds або sinceTime. Зверніть увагу, що коли вказано "TailLines", "Stream" може бути встановлено лише в nil або "All". |
timestamps | boolean | Якщо true, додає мітку часу у форматі RFC3339 або RFC3339Nano на початку кожного рядка виводу журналу. Стандартно — false. |
Відповідь
| Статус | Опис | Відповідь |
|---|---|---|
| 200 | OK | string |
get Get Connect Exec
HTTP Запит
GET /api/v1/namespaces/{namespace}/pods/{name}/exec
Параметри шляху
| Назва | Тип | Опис |
|---|---|---|
name | string | Імʼя PodExecOptions |
namespace | string | Назва обʼєкта та область авторизації, наприклад для команд і проєктів |
Параметри запиту
| Назва | Тип | Опис |
|---|---|---|
command | string | Command є віддаленою командою, яку потрібно виконати. Масив argv. Не виконується в оболонці. |
container | string | Контейнер, у якому буде виконано команду. Стандартно використовується лише один контейнер, якщо в поді є лише один контейнер. |
stderr | boolean | Переспрямовує стандартний потік помилок пода для цього виклику. |
stdin | boolean | Переспрямовує стандартний потік введення пода для цього виклику. Стандартно — false. |
stdout | boolean | Переспрямовує стандартний потік виводу пода для цього виклику. Стандартно — false. |
tty | boolean | TTY якщо true вказує, що для виклику exec буде виділено tty. Стандартно — false. |
Відповідь
| Статус | Опис | Відповідь |
|---|---|---|
| 200 | OK | string |
post Create Connect Exec
HTTP Запит
POST /api/v1/namespaces/{namespace}/pods/{name}/exec
Параметри шляху
| Назва | Тип | Опис |
|---|---|---|
name | string | Імʼя PodExecOptions |
namespace | string | Назва обʼєкта та область авторизації, наприклад для команд і проєктів |
Параметри запиту
| Назва | Тип | Опис |
|---|---|---|
command | string | Command є віддаленою командою, яку потрібно виконати. Масив argv. Не виконується в оболонці. |
container | string | Контейнер, у якому буде виконано команду. Стандартно використовується лише один контейнер, якщо в поді є лише один контейнер. |
stderr | boolean | Переспрямовує стандартний потік помилок пода для цього виклику. |
stdin | boolean | Переспрямовує стандартний потік введення пода для цього виклику. Стандартно — false. |
stdout | boolean | Переспрямовує стандартний потік виводу пода для цього виклику. Стандартно — false. |
tty | boolean | TTY якщо true вказує, що для виклику exec буде виділено tty. Стандартно — false. |
Відповідь
| Статус | Опис | Відповідь |
|---|---|---|
| 200 | OK | string |
get Get Connect Attach
HTTP Запит
GET /api/v1/namespaces/{namespace}/pods/{name}/attach
Параметри шляху
| Назва | Тип | Опис |
|---|---|---|
name | string | Імʼя PodAttachOptions |
namespace | string | Назва обʼєкта та область авторизації, наприклад для команд і проєктів |
Параметри запиту
| Назва | Тип | Опис |
|---|---|---|
container | string | The Контейнер, у якому буде виконано команду. Стандартно використовується лише один контейнер, якщо в поді є лише один контейнер. |
stderr | boolean | Якщо Stderr має значення true, це означає, що стандартний вивід помилок (stderr) має бути перенаправлений під час виклику attach. Стандартне значення — true. |
stdin | boolean | Якщо Stdin має значення true, для цього виклику виконується перенаправлення потоку стандартного вводу пода. Стандартне значення — false. |
stdout | boolean | Якщо Stdout має значення true, це означає, що stdout має бути перенаправлено для виклику attach. Стандартне значення — true. |
tty | boolean | Параметр TTY, якщо має значення true, вказує, що для виклику attach буде виділено термінал TTY. Цей параметр передається через середовище виконання контейнера, тому термінал TTY виділяється на робочому вузлі саме цим середовищем. Стандартне значення — false. |
Відповідь
| Статус | Опис | Відповідь |
|---|---|---|
| 200 | OK | string |
post Create Connect Attach
HTTP Запит
POST /api/v1/namespaces/{namespace}/pods/{name}/attach
Параметри шляху
| Назва | Тип | Опис |
|---|---|---|
name | string | Імʼя PodAttachOptions |
namespace | string | Назва обʼєкта та область авторизації, наприклад для команд і проєктів |
Параметри запиту
| Назва | Тип | Опис |
|---|---|---|
container | string | The Контейнер, у якому буде виконано команду. Стандартно використовується лише один контейнер, якщо в поді є лише один контейнер. |
stderr | boolean | Якщо Stderr має значення true, це означає, що стандартний вивід помилок (stderr) має бути перенаправлений під час виклику attach. Стандартне значення — true. |
stdin | boolean | Якщо Stdin має значення true, для цього виклику виконується перенаправлення потоку стандартного вводу пода. Стандартне значення — false. |
stdout | boolean | Якщо Stdout має значення true, це означає, що stdout має бути перенаправлено для виклику attach. Стандартне значення — true. |
tty | boolean | Параметр TTY, якщо має значення true, вказує, що для виклику attach буде виділено термінал TTY. Цей параметр передається через середовище виконання контейнера, тому термінал TTY виділяється на робочому вузлі саме цим середовищем. Стандартне значення — false. |
Відповідь
| Статус | Опис | Відповідь |
|---|---|---|
| 200 | OK | string |
11 - PodTemplate
apiVersion: v1
import "k8s.io/api/core/v1"
PodTemplate
PodTemplate описує шаблон для створення копій попередньо визначеного пода.
| Поле | Опис |
|---|---|
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 |
templatePodTemplateSpec | Template визначає поди, які будуть створені з цього шаблону пода. Детальніше: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status |
PodTemplateSpec
PodTemplateSpec описує дані, які повинен мати под при створенні з шаблону.
| Поле | Опис |
|---|---|
metadataObjectMeta | Стан стандартних метаданих обʼєкта. Детальніше: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata |
specPodSpec | Specification описує бажану поведінку пода. Детальніше: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status |
PodTemplateList
PodTemplateList описує список PodTemplates.
| Поле | Опис |
|---|---|
apiVersionstring | APIVersion визначає версію схеми цього представлення обʼєкта. Сервери повинні конвертувати розпізнані схеми до останнього внутрішнього значення і можуть відхиляти нерозпізнані значення. Детальніше: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources |
items *PodTemplate array | Список шаблонів подів |
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#types-kinds |
Операції
post Create
HTTP Запит
POST /api/v1/namespaces/{namespace}/podtemplates
Параметри шляху
| Назва | Тип | Опис |
|---|---|---|
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 | PodTemplate |
Відповідь
| Статус | Опис | Відповідь |
|---|---|---|
| 200 | OK | PodTemplate |
| 201 | Created | PodTemplate |
| 202 | Accepted | PodTemplate |
patch Patch
HTTP Запит
PATCH /api/v1/namespaces/{namespace}/podtemplates/{name}
Параметри шляху
| Назва | Тип | Опис |
|---|---|---|
name | string | Назва PodTemplate |
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 | PodTemplate |
| 201 | Created | PodTemplate |
put Replace
HTTP Запит
PUT /api/v1/namespaces/{namespace}/podtemplates/{name}
Параметри шляху
| Назва | Тип | Опис |
|---|---|---|
name | string | Назва PodTemplate |
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 | PodTemplate |
Відповідь
| Статус | Опис | Відповідь |
|---|---|---|
| 200 | OK | PodTemplate |
| 201 | Created | PodTemplate |
delete Delete
HTTP Запит
DELETE /api/v1/namespaces/{namespace}/podtemplates/{name}
Параметри шляху
| Назва | Тип | Опис |
|---|---|---|
name | string | Назва PodTemplate |
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 | PodTemplate |
| 202 | Accepted | PodTemplate |
delete Delete Collection
HTTP Запит
DELETE /api/v1/namespaces/{namespace}/podtemplates
Параметри шляху
| Назва | Тип | Опис |
|---|---|---|
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 /api/v1/namespaces/{namespace}/podtemplates/{name}
Параметри шляху
| Назва | Тип | Опис |
|---|---|---|
name | string | Назва PodTemplate |
namespace | string | Назва обʼєкта та область авторизації, наприклад для команд і проєктів |
Параметри запиту
| Назва | Тип | Опис |
|---|---|---|
pretty | string | Якщо 'true', то вихідні дані форматуються у зручному для читання вигляді. Зазвичай 'false', якщо user-agent не вказує оглядач або командний інструмент для роботи з HTTP (curl та wget). |
Відповідь
| Статус | Опис | Відповідь |
|---|---|---|
| 200 | OK | PodTemplate |
get List
HTTP Запит
GET /api/v1/namespaces/{namespace}/podtemplates
Параметри шляху
| Назва | Тип | Опис |
|---|---|---|
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 | PodTemplateList |
get List All Namespaces
HTTP Запит
GET /api/v1/podtemplates
Параметри запиту
| Назва | Тип | Опис |
|---|---|---|
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 | PodTemplateList |
get Watch
HTTP Запит
GET /api/v1/watch/namespaces/{namespace}/podtemplates/{name}
Параметри шляху
| Назва | Тип | Опис |
|---|---|---|
name | string | Назва PodTemplate |
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 /api/v1/watch/namespaces/{namespace}/podtemplates
Параметри шляху
| Назва | Тип | Опис |
|---|---|---|
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 /api/v1/watch/podtemplates
Параметри запиту
| Назва | Тип | Опис |
|---|---|---|
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 |
12 - ReplicationController
apiVersion: v1
import "k8s.io/api/core/v1"
ReplicationController
ReplicationController представляє конфігурацію контролера реплікації.
| Поле | Опис |
|---|---|
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 | Якщо Labels ReplicationController порожні, вони за звичай будуть такими ж, як у Pod(ів), якими керує контролер реплікації. Стандартні метадані обʼєкта. Детальніше: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata |
specReplicationControllerSpec | Spec визначає специфікацію бажаної поведінки контролера реплікації. Детальніше: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status |
statusReplicationControllerStatus | Status визначає останній спостережуваний стан контролера реплікації. Ці дані можуть бути застарілими на деякий проміжок часу. Заповнюється системою. Тільки для читання. Детальніше: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status |
ReplicationControllerSpec
ReplicationControllerSpec визначає специфікацію контролера реплікації.
| Поле | Опис |
|---|---|
minReadySecondsinteger | Мінімальна кількість секунд, протягом яких новостворений под повинен бути готовим без аварійного завершення будь-якого з його контейнерів, щоб вважатися доступним. Зазвичай 0 (pod вважається доступним, як тільки він готовий) |
replicasinteger | Replicas є кількістю бажаних реплік. Це вказівник, щоб відрізнити явний нуль від невказаного значення. Стандартно — 1. Детальніше: https://kubernetes.io/docs/concepts/workloads/controllers/replicationcontroller#what-is-a-replicationcontroller |
selectorobject | Selector є запитом міток подів, які повинні відповідати кількості реплік. Якщо Selector порожній, він зазвичай встановлюється на мітки, присутні в шаблоні Podʼа. Ключі та значення міток, які повинні збігатись, щоб контролюватися цим контролером реплікації, якщо порожні, зазвичай встановлюються на мітки шаблону Podʼа. Детальніше: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#label-selectors |
templatePodTemplateSpec | Template є обʼєктом, який описує под, що буде створений, якщо виявиться недостатня кількість реплік. Він має пріоритет над TemplateRef. Єдине дозволене значення template.spec.restartPolicy — "Always". Детальніше: https://kubernetes.io/docs/concepts/workloads/controllers/replicationcontroller#pod-template |
ReplicationControllerStatus
ReplicationControllerStatus представляє поточний стан контролера реплікації.
| Поле | Опис |
|---|---|
availableReplicasinteger | Кількість доступних реплік (готових принаймні протягом minReadySeconds) для цього контролера реплікації. |
conditionsReplicationControllerCondition array patch strategy: злиття за ключем type | Представляє останні доступні спостереження за поточним станом контролера реплікації. |
fullyLabeledReplicasinteger | Кількість подів, які мають мітки, що відповідають міткам шаблону пода контролера реплікації. |
observedGenerationinteger | ObservedGeneration відображає покоління найбільш недавно спостережуваного контролера реплікації. |
readyReplicasinteger | Кількість готових реплік для цього контролера реплікації. |
replicas *integer | Replicas є кількістю найбільш недавно спостережуваних реплік. Детальніше: https://kubernetes.io/docs/concepts/workloads/controllers/replicationcontroller#what-is-a-replicationcontroller |
ReplicationControllerList
ReplicationControllerList є колекцією контролерів реплікації.
| Поле | Опис |
|---|---|
apiVersionstring | APIVersion визначає версію схеми цього представлення обʼєкта. Сервери повинні конвертувати розпізнані схеми до останнього внутрішнього значення і можуть відхиляти нерозпізнані значення. Детальніше: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources |
items *ReplicationController array | Список контролерів реплікації. Детальніше: https://kubernetes.io/docs/concepts/workloads/controllers/replicationcontroller |
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#types-kinds |
ReplicationControllerCondition
ReplicationControllerCondition описує стан контролера реплікації в певний момент часу.
| Поле | Опис |
|---|---|
lastTransitionTimeTime | Останній раз, коли стан змінився з одного на інший. |
messagestring | Зрозуміле для людини повідомлення, що вказує деталі переходу. |
reasonstring | Причина останнього переходу стану. |
status *string | Статус стану, одне з True, False, Unknown. |
type *string | Тип стану контролера реплікації. |
Операції
post Create
HTTP Запит
POST /api/v1/namespaces/{namespace}/replicationcontrollers
Параметри шляху
| Назва | Тип | Опис |
|---|---|---|
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 | ReplicationController |
Відповідь
| Статус | Опис | Відповідь |
|---|---|---|
| 200 | OK | ReplicationController |
| 201 | Created | ReplicationController |
| 202 | Accepted | ReplicationController |
patch Patch
HTTP Запит
PATCH /api/v1/namespaces/{namespace}/replicationcontrollers/{name}
Параметри шляху
| Назва | Тип | Опис |
|---|---|---|
name | string | Назва ReplicationController |
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 | ReplicationController |
| 201 | Created | ReplicationController |
put Replace
HTTP Запит
PUT /api/v1/namespaces/{namespace}/replicationcontrollers/{name}
Параметри шляху
| Назва | Тип | Опис |
|---|---|---|
name | string | Назва ReplicationController |
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 | ReplicationController |
Відповідь
| Статус | Опис | Відповідь |
|---|---|---|
| 200 | OK | ReplicationController |
| 201 | Created | ReplicationController |
delete Delete
HTTP Запит
DELETE /api/v1/namespaces/{namespace}/replicationcontrollers/{name}
Параметри шляху
| Назва | Тип | Опис |
|---|---|---|
name | string | Назва ReplicationController |
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 /api/v1/namespaces/{namespace}/replicationcontrollers
Параметри шляху
| Назва | Тип | Опис |
|---|---|---|
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 /api/v1/namespaces/{namespace}/replicationcontrollers/{name}
Параметри шляху
| Назва | Тип | Опис |
|---|---|---|
name | string | Назва ReplicationController |
namespace | string | Назва обʼєкта та область авторизації, наприклад для команд і проєктів |
Параметри запиту
| Назва | Тип | Опис |
|---|---|---|
pretty | string | Якщо 'true', то вихідні дані форматуються у зручному для читання вигляді. Зазвичай 'false', якщо user-agent не вказує оглядач або командний інструмент для роботи з HTTP (curl та wget). |
Відповідь
| Статус | Опис | Відповідь |
|---|---|---|
| 200 | OK | ReplicationController |
get List
HTTP Запит
GET /api/v1/namespaces/{namespace}/replicationcontrollers
Параметри шляху
| Назва | Тип | Опис |
|---|---|---|
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 | ReplicationControllerList |
get List All Namespaces
HTTP Запит
GET /api/v1/replicationcontrollers
Параметри запиту
| Назва | Тип | Опис |
|---|---|---|
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 | ReplicationControllerList |
get Watch
HTTP Запит
GET /api/v1/watch/namespaces/{namespace}/replicationcontrollers/{name}
Параметри шляху
| Назва | Тип | Опис |
|---|---|---|
name | string | Назва ReplicationController |
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 /api/v1/watch/namespaces/{namespace}/replicationcontrollers
Параметри шляху
| Назва | Тип | Опис |
|---|---|---|
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 /api/v1/watch/replicationcontrollers
Параметри запиту
| Назва | Тип | Опис |
|---|---|---|
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 /api/v1/namespaces/{namespace}/replicationcontrollers/{name}/status
Параметри шляху
| Назва | Тип | Опис |
|---|---|---|
name | string | Назва ReplicationController |
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 | ReplicationController |
| 201 | Created | ReplicationController |
get Read Status
HTTP Запит
GET /api/v1/namespaces/{namespace}/replicationcontrollers/{name}/status
Параметри шляху
| Назва | Тип | Опис |
|---|---|---|
name | string | Назва ReplicationController |
namespace | string | Назва обʼєкта та область авторизації, наприклад для команд і проєктів |
Параметри запиту
| Назва | Тип | Опис |
|---|---|---|
pretty | string | Якщо 'true', то вихідні дані форматуються у зручному для читання вигляді. Зазвичай 'false', якщо user-agent не вказує оглядач або командний інструмент для роботи з HTTP (curl та wget). |
Відповідь
| Статус | Опис | Відповідь |
|---|---|---|
| 200 | OK | ReplicationController |
put Replace Status
HTTP Запит
PUT /api/v1/namespaces/{namespace}/replicationcontrollers/{name}/status
Параметри шляху
| Назва | Тип | Опис |
|---|---|---|
name | string | Назва ReplicationController |
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 | ReplicationController |
Відповідь
| Статус | Опис | Відповідь |
|---|---|---|
| 200 | OK | ReplicationController |
| 201 | Created | ReplicationController |
get Read Scale
HTTP Запит
GET /api/v1/namespaces/{namespace}/replicationcontrollers/{name}/scale
Параметри шляху
| Назва | Тип | Опис |
|---|---|---|
name | string | Назва Scale |
namespace | string | Назва обʼєкта та область авторизації, наприклад для команд і проєктів |
Параметри запиту
| Назва | Тип | Опис |
|---|---|---|
pretty | string | Якщо 'true', то вихідні дані форматуються у зручному для читання вигляді. Зазвичай 'false', якщо user-agent не вказує оглядач або командний інструмент для роботи з HTTP (curl та wget). |
Відповідь
| Статус | Опис | Відповідь |
|---|---|---|
| 200 | OK | Scale |
put Replace Scale
HTTP Запит
PUT /api/v1/namespaces/{namespace}/replicationcontrollers/{name}/scale
Параметри шляху
| Назва | Тип | Опис |
|---|---|---|
name | string | Назва Scale |
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 | Scale |
Відповідь
| Статус | Опис | Відповідь |
|---|---|---|
| 200 | OK | Scale |
| 201 | Created | Scale |
patch Patch Scale
HTTP Запит
PATCH /api/v1/namespaces/{namespace}/replicationcontrollers/{name}/scale
Параметри шляху
| Назва | Тип | Опис |
|---|---|---|
name | string | Назва Scale |
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 | Scale |
| 201 | Created | Scale |
13 - ResourceQuota
apiVersion: v1
import "k8s.io/api/core/v1"
ResourceQuota
ResourceQuota встановлює агреговані обмеження квот, що застосовуються на рівні простору імен
| Поле | Опис |
|---|---|
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 |
specResourceQuotaSpec | Spec визначає бажану квоту. Детальніше: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status |
statusResourceQuotaStatus | Status визначає фактичну застосовану квоту та її поточне використання. Детальніше: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status |
ResourceQuotaSpec
ResourceQuotaSpec визначає бажані жорсткі обмеження для застосування квоти.
| Поле | Опис |
|---|---|
hardobject | hard визначає набір бажаних жорстких обмежень для кожного іменованого ресурсу. Детальніше: https://kubernetes.io/docs/concepts/policy/resource-quotas/ |
scopeSelectorScopeSelector | scopeSelector також є колекцією фільтрів, подібних до scopes, які повинні відповідати кожному обʼєкту, відстежуваному квотою, але виражені за допомогою ScopeSelectorOperator у поєднанні з можливими значеннями. Щоб ресурс відповідав, обидва scopes І scopeSelector (якщо вказано в spec) повинні відповідати. |
scopesstring array | Колекція фільтрів, які повинні відповідати кожному обʼєкту, відстежуваному квотою. Якщо не вказано, квота відповідає всім обʼєктам. |
ResourceQuotaStatus
ResourceQuotaStatus визначає фактичні застосовані жорсткі обмеження та спостережуване використання.
| Поле | Опис |
|---|---|
hardobject | Hard визначає набір фактично застосованих жорстких обмежень для кожного іменованого ресурсу. Детальніше: https://kubernetes.io/docs/concepts/policy/resource-quotas/ |
usedobject | Used визначає поточне спостережуване загальне використання ресурсу в просторі імен. |
ResourceQuotaList
ResourceQuotaList є списком елементів ResourceQuota.
| Поле | Опис |
|---|---|
apiVersionstring | APIVersion визначає версію схеми цього представлення обʼєкта. Сервери повинні конвертувати розпізнані схеми до останнього внутрішнього значення і можуть відхиляти нерозпізнані значення. Детальніше: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources |
items *ResourceQuota array | Items є списком обʼєктів ResourceQuota. Детальніше: https://kubernetes.io/docs/concepts/policy/resource-quotas/ |
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#types-kinds |
ScopeSelector
Селектор області дії представляє логічну операцію AND між селекторами, представленими вимогами селектора ресурсів з областю дії.
| Поле | Опис |
|---|---|
matchExpressionsScopedResourceSelectorRequirement array | Список вимог селектора області дії за областю ресурсів. |
ScopedResourceSelectorRequirement
Вимога селектора ресурсів з областю дії є селектором, який містить значення, імʼя області дії та оператор, що повʼязує імʼя області дії та значення.
| Поле | Опис |
|---|---|
operator *string | Представляє відношення області дії до набору значень. Дійсні оператори: In, NotIn, Exists, DoesNotExist. Можливі значення enum:
|
scopeName *string | Імʼя області дії, до якої застосовується селектор. Можливі значення enum:
|
valuesstring array | Масив рядків. Якщо оператор In або NotIn, масив values повинен бути непорожнім. Якщо оператор Exists або DoesNotExist, масив values повинен бути порожнім. Цей масив замінюється під час стратегічного злиття патчу. |
Операції
post Create
HTTP Запит
POST /api/v1/namespaces/{namespace}/resourcequotas
Параметри шляху
| Назва | Тип | Опис |
|---|---|---|
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 | ResourceQuota |
Відповідь
| Статус | Опис | Відповідь |
|---|---|---|
| 200 | OK | ResourceQuota |
| 201 | Created | ResourceQuota |
| 202 | Accepted | ResourceQuota |
patch Patch
HTTP Запит
PATCH /api/v1/namespaces/{namespace}/resourcequotas/{name}
Параметри шляху
| Назва | Тип | Опис |
|---|---|---|
name | string | Назва ResourceQuota |
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 | ResourceQuota |
| 201 | Created | ResourceQuota |
put Replace
HTTP Запит
PUT /api/v1/namespaces/{namespace}/resourcequotas/{name}
Параметри шляху
| Назва | Тип | Опис |
|---|---|---|
name | string | Назва ResourceQuota |
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 | ResourceQuota |
Відповідь
| Статус | Опис | Відповідь |
|---|---|---|
| 200 | OK | ResourceQuota |
| 201 | Created | ResourceQuota |
delete Delete
HTTP Запит
DELETE /api/v1/namespaces/{namespace}/resourcequotas/{name}
Параметри шляху
| Назва | Тип | Опис |
|---|---|---|
name | string | Назва ResourceQuota |
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 | ResourceQuota |
| 202 | Accepted | ResourceQuota |
delete Delete Collection
HTTP Запит
DELETE /api/v1/namespaces/{namespace}/resourcequotas
Параметри шляху
| Назва | Тип | Опис |
|---|---|---|
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 /api/v1/namespaces/{namespace}/resourcequotas/{name}
Параметри шляху
| Назва | Тип | Опис |
|---|---|---|
name | string | Назва ResourceQuota |
namespace | string | Назва обʼєкта та область авторизації, наприклад для команд і проєктів |
Параметри запиту
| Назва | Тип | Опис |
|---|---|---|
pretty | string | Якщо 'true', то вихідні дані форматуються у зручному для читання вигляді. Зазвичай 'false', якщо user-agent не вказує оглядач або командний інструмент для роботи з HTTP (curl та wget). |
Відповідь
| Статус | Опис | Відповідь |
|---|---|---|
| 200 | OK | ResourceQuota |
get List
HTTP Запит
GET /api/v1/namespaces/{namespace}/resourcequotas
Параметри шляху
| Назва | Тип | Опис |
|---|---|---|
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 | ResourceQuotaList |
get List All Namespaces
HTTP Запит
GET /api/v1/resourcequotas
Параметри запиту
| Назва | Тип | Опис |
|---|---|---|
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 | ResourceQuotaList |
get Watch
HTTP Запит
GET /api/v1/watch/namespaces/{namespace}/resourcequotas/{name}
Параметри шляху
| Назва | Тип | Опис |
|---|---|---|
name | string | Назва ResourceQuota |
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 /api/v1/watch/namespaces/{namespace}/resourcequotas
Параметри шляху
| Назва | Тип | Опис |
|---|---|---|
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 /api/v1/watch/resourcequotas
Параметри запиту
| Назва | Тип | Опис |
|---|---|---|
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 /api/v1/namespaces/{namespace}/resourcequotas/{name}/status
Параметри шляху
| Назва | Тип | Опис |
|---|---|---|
name | string | Назва ResourceQuota |
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 | ResourceQuota |
| 201 | Created | ResourceQuota |
get Read Status
HTTP Запит
GET /api/v1/namespaces/{namespace}/resourcequotas/{name}/status
Параметри шляху
| Назва | Тип | Опис |
|---|---|---|
name | string | Назва ResourceQuota |
namespace | string | Назва обʼєкта та область авторизації, наприклад для команд і проєктів |
Параметри запиту
| Назва | Тип | Опис |
|---|---|---|
pretty | string | Якщо 'true', то вихідні дані форматуються у зручному для читання вигляді. Зазвичай 'false', якщо user-agent не вказує оглядач або командний інструмент для роботи з HTTP (curl та wget). |
Відповідь
| Статус | Опис | Відповідь |
|---|---|---|
| 200 | OK | ResourceQuota |
put Replace Status
HTTP Запит
PUT /api/v1/namespaces/{namespace}/resourcequotas/{name}/status
Параметри шляху
| Назва | Тип | Опис |
|---|---|---|
name | string | Назва ResourceQuota |
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 | ResourceQuota |
Відповідь
| Статус | Опис | Відповідь |
|---|---|---|
| 200 | OK | ResourceQuota |
| 201 | Created | ResourceQuota |
14 - Secret
apiVersion: v1
import "k8s.io/api/core/v1"
Secret
Secret зберігає секретні дані певного типу. Загальна кількість байтів значень у полі Data повинна бути менше, ніж MaxSecretSize байтів.
| Поле | Опис |
|---|---|
apiVersionstring | APIVersion визначає версію схеми цього представлення обʼєкта. Сервери повинні конвертувати розпізнані схеми до останнього внутрішнього значення і можуть відхиляти нерозпізнані значення. Детальніше: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources |
dataobject | Data містить секретні дані. Кожен ключ повинен складатися з буквено-цифрових символів, '-', '_' або '.'. Серіалізована форма секретних даних є рядком, закодованим у base64, що представляє довільне (можливо, не рядкове) значення даних. Описано в https://tools.ietf.org/html/rfc4648#section-4 |
immutableboolean | Immutable, якщо встановлено в true, гарантує, що дані, збережені в Secret, не можуть бути оновлені (можна змінювати лише метадані обʼєкта). Якщо не встановлено в true, поле можна змінювати в будь-який час. Стандартно — nil. |
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 |
stringDataobject | stringData дозволяє вказувати не бінарні секретні дані у вигляді рядка. Це поле надається як поле для запису лише для зручності. Усі ключі та значення обʼєднуються в поле data під час запису, перезаписуючи будь-які наявні значення. Поле stringData ніколи не виводиться при читанні з API. |
typestring | Використовується для полегшення програмної обробки секретних даних. Детальніше: https://kubernetes.io/docs/concepts/configuration/secret/#secret-types |
SecretList
SecretList є списком обʼєктів Secret.
| Поле | Опис |
|---|---|
apiVersionstring | APIVersion визначає версію схеми цього представлення обʼєкта. Сервери повинні конвертувати розпізнані схеми до останнього внутрішнього значення і можуть відхиляти нерозпізнані значення. Детальніше: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources |
items *Масив Secret | Items є списком обʼєктів Secret. Детальніше: https://kubernetes.io/docs/concepts/configuration/secret |
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#types-kinds |
Операції
post Create
HTTP Запит
POST /api/v1/namespaces/{namespace}/secrets
Параметри шляху
| Назва | Тип | Опис |
|---|---|---|
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 | Secret |
Відповідь
| Статус | Опис | Відповідь |
|---|---|---|
| 200 | OK | Secret |
| 201 | Created | Secret |
| 202 | Accepted | Secret |
patch Patch
HTTP Запит
PATCH /api/v1/namespaces/{namespace}/secrets/{name}
Параметри шляху
| Назва | Тип | Опис |
|---|---|---|
name | string | Назва Secret |
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 | Secret |
| 201 | Created | Secret |
put Replace
HTTP Запит
PUT /api/v1/namespaces/{namespace}/secrets/{name}
Параметри шляху
| Назва | Тип | Опис |
|---|---|---|
name | string | Назва Secret |
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 | Secret |
Відповідь
| Статус | Опис | Відповідь |
|---|---|---|
| 200 | OK | Secret |
| 201 | Created | Secret |
delete Delete
HTTP Запит
DELETE /api/v1/namespaces/{namespace}/secrets/{name}
Параметри шляху
| Назва | Тип | Опис |
|---|---|---|
name | string | Назва Secret |
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 /api/v1/namespaces/{namespace}/secrets
Параметри шляху
| Назва | Тип | Опис |
|---|---|---|
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 /api/v1/namespaces/{namespace}/secrets/{name}
Параметри шляху
| Назва | Тип | Опис |
|---|---|---|
name | string | Назва Secret |
namespace | string | Назва обʼєкта та область авторизації, наприклад для команд і проєктів |
Параметри запиту
| Назва | Тип | Опис |
|---|---|---|
pretty | string | Якщо 'true', то вихідні дані форматуються у зручному для читання вигляді. Зазвичай 'false', якщо user-agent не вказує оглядач або командний інструмент для роботи з HTTP (curl та wget). |
Відповідь
| Статус | Опис | Відповідь |
|---|---|---|
| 200 | OK | Secret |
get List
HTTP Запит
GET /api/v1/namespaces/{namespace}/secrets
Параметри шляху
| Назва | Тип | Опис |
|---|---|---|
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 | SecretList |
get List All Namespaces
HTTP Запит
GET /api/v1/secrets
Параметри запиту
| Назва | Тип | Опис |
|---|---|---|
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 | SecretList |
get Watch
HTTP Запит
GET /api/v1/watch/namespaces/{namespace}/secrets/{name}
Параметри шляху
| Назва | Тип | Опис |
|---|---|---|
name | string | Назва Secret |
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 /api/v1/watch/namespaces/{namespace}/secrets
Параметри шляху
| Назва | Тип | Опис |
|---|---|---|
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 /api/v1/watch/secrets
Параметри запиту
| Назва | Тип | Опис |
|---|---|---|
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 |
15 - Service
apiVersion: v1
import "k8s.io/api/core/v1"
Service
Service є іменованою абстракцією програмного сервісу (наприклад, mysql), що складається з локального порту (наприклад, 3306), на якому прослуховує проксі, та селектора, який визначає, які поди відповідатимуть на запити, надіслані через проксі.
| Поле | Опис |
|---|---|
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 |
specServiceSpec | Spec визначає поведінку сервісу. Детальніше: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status |
statusServiceStatus | Останній спостережуваний стан сервісу. Заповнюється системою. Тільки для читання. Детальніше: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status |
ServiceSpec
ServiceSpec описує атрибути, які користувач створює для сервісу.
| Поле | Опис |
|---|---|
allocateLoadBalancerNodePortsboolean | allocateLoadBalancerNodePorts визначає, чи будуть NodePorts автоматично виділені для сервісів типу LoadBalancer. Зазвичай — "true". Може бути встановлено на "false", якщо кластерний балансувальник навантаження не покладається на NodePorts. Якщо викликач запитує конкретні NodePorts (вказавши значення), ці запити будуть враховані, незалежно від цього поля. Це поле може бути встановлено лише для сервісів типу LoadBalancer і буде очищено, якщо тип буде змінено на будь-який інший тип. |
clusterIPstring | clusterIP — це IP-адреса сервісу, яка зазвичай призначається випадковим чином. Якщо адреса вказана вручну, знаходиться в діапазоні (згідно з конфігурацією системи) і не використовується, вона буде призначена сервісу; в іншому випадку створення сервісу завершиться невдачею. Це поле не може бути змінене через оновлення, якщо поле type також не змінюється на ExternalName (що вимагає, щоб це поле було порожнім) або якщо поле type змінюється з ExternalName (у цьому випадку це поле може бути вказане за бажанням, як описано вище). Дійсні значення: "None", порожній рядок (""), або дійсна IP-адреса. Встановлення цього значення на "None" створює "headless service" (без віртуальної IP), що корисно, коли перевага надається прямим підключенням до точок доступу і проксіювання не потрібне. Застосовується лише до типів ClusterIP, NodePort і LoadBalancer. Якщо це поле вказано при створенні сервісу типу ExternalName, створення завершиться невдачею. Це поле буде очищене при оновленні сервісу до типу ExternalName. Детальніше: https://kubernetes.io/docs/concepts/services-networking/service/#virtual-ips-and-service-proxies |
clusterIPsstring array | ClusterIPs — це список IP-адрес, призначених цьому сервісу, які зазвичай призначаються випадковим чином. Якщо адреса вказана вручну, знаходиться в діапазоні (згідно з конфігурацією системи) і не використовується, вона буде призначена сервісу; в іншому випадку створення сервісу завершиться невдачею. Це поле не може бути змінене через оновлення, якщо поле type також не змінюється на ExternalName (що вимагає, щоб це поле було порожнім) або якщо поле type змінюється з ExternalName (у цьому випадку це поле може бути вказане за бажанням, як описано вище). Дійсні значення: "None", порожній рядок (""), або дійсна IP-адреса. Встановлення цього значення на "None" створює "headless service" (без віртуальної IP), що корисно, коли перевага надається прямим підключенням до точок доступу і проксіювання не потрібне. Застосовується лише до типів ClusterIP, NodePort і LoadBalancer. Якщо це поле вказано при створенні сервісу типу ExternalName, створення завершиться невдачею. Це поле буде очищене при оновленні сервісу до типу ExternalName. Якщо це поле не вказано, воно буде ініціалізоване з поля clusterIP. Якщо це поле вказано, клієнти повинні забезпечити, щоб clusterIPs[0] і clusterIP мали однакове значення. Це поле може містити максимум два записи (двосторонні IP-адреси, у будь-якому порядку). Ці IP-адреси повинні відповідати значенням поля ipFamilies. І clusterIPs, і ipFamilies керуються полем ipFamilyPolicy. Детальніше: https://kubernetes.io/docs/concepts/services-networking/service/#virtual-ips-and-service-proxies |
externalIPsstring array | externalIPs — це список IP-адрес, для яких вузли в кластері також прийматимуть трафік для цього сервісу. Ці IP-адреси не керуються Kubernetes. Користувач несе відповідальність за забезпечення надходження трафіку на вузол з цим IP. Поширеним прикладом є зовнішні балансувальники навантаження, які не є частиною системи Kubernetes. |
externalNamestring | externalName — це зовнішнє посилання, яке механізми виявлення повернуть як псевдонім для цього сервісу (наприклад, запис DNS CNAME). Проксіювання не буде задіяне. Має бути імʼям хосту у нижньому регістрі відповідно до RFC-1123 (https://tools.ietf.org/html/rfc1123) і вимагає, щоб type був "ExternalName". |
externalTrafficPolicystring | externalTrafficPolicy описує, як вузли розподіляють трафік сервісу, який вони отримують на одну з "зовнішньо орієнтованих" адрес сервісу (NodePorts, ExternalIPs та LoadBalancer IPs). Якщо встановлено значення "Local", проксі налаштує сервіс таким чином, що зовнішні балансувальники навантаження будуть відповідальні за балансування трафіку між вузлами, і кожен вузол буде доставляти трафік лише до локальних точок доступу сервісу на цьому вузлі, без маскування IP-адреси джерела клієнта. (Трафік, помилково надісланий на вузол без точок доступу, буде відкинутий.) Стандартне значення, "Cluster", використовує стандартну поведінку маршрутизації до всіх точок доступу рівномірно (можливо, з урахуванням топології та інших функцій). Зверніть увагу, що трафік, надісланий на зовнішню IP-адресу або IP-адресу LoadBalancer зсередини кластера, завжди отримуватиме семантику "Cluster", але клієнти, що надсилають трафік на NodePort зсередини кластера, можуть потребувати врахування політики трафіку при виборі вузла. Можливі значення enum:
|
healthCheckNodePortinteger | healthCheckNodePort визначає порт перевірки стану вузла для сервісу. Це застосовується лише тоді, коли тип встановлено на LoadBalancer, а externalTrafficPolicy встановлено на Local. Якщо значення вказано, воно знаходиться в допустимому діапазоні та не використовується, воно буде використано. Якщо не вказано, значення буде автоматично призначено. Зовнішні системи (наприклад, балансувальники навантаження) можуть використовувати цей порт для визначення, чи має даний вузол точки доступу для цього сервісу. Якщо це поле вказано при створенні сервісу, який його не потребує, створення завершиться помилкою. Це поле буде очищено при оновленні сервісу, щоб воно більше не було потрібне (наприклад, при зміні типу). Це поле не можна оновити після встановлення. |
internalTrafficPolicystring | internalTrafficPolicy описує, як вузли розподіляють трафік сервісу, який вони отримують на ClusterIP. Якщо встановлено значення "Local", проксі припускає, що поди хочуть спілкуватися лише з кінцевими точками сервісу на тому ж вузлі, що й под, відкидаючи трафік, якщо немає локальних точок доступу. Стандартне значення, "Cluster", використовує стандартну поведінку маршрутизації до всіх точок доступу рівномірно (можливо, з урахуванням топології та інших функцій). Можливі значення enum:
|
ipFamiliesstring array | IPFamilies є списком IP-сімейств (наприклад, IPv4, IPv6), призначених цьому сервісу. Це поле зазвичай призначається автоматично на основі конфігурації кластера та поля ipFamilyPolicy. Якщо це поле вказано вручну, запитане сімейство доступне в кластері, і ipFamilyPolicy дозволяє його використання, воно буде використано; в іншому випадку створення сервісу завершиться помилкою. Це поле умовно змінюване: воно дозволяє додавати або видаляти вторинне IP-сімейство, але не дозволяє змінювати основне IP-сімейство сервісу. Дійсні значення: "IPv4" та "IPv6". Це поле застосовується лише до сервісів типів ClusterIP, NodePort та LoadBalancer, і не застосовується до "headless" сервісів. Це поле буде очищено при оновленні сервісу до типу ExternalName. Це поле може містити максимум два записи (двосторонні сімейства, у будь-якому порядку). Ці сімейства повинні відповідати значенням поля clusterIPs, якщо воно вказане. І clusterIPs, і ipFamilies керуються полем ipFamilyPolicy. |
ipFamilyPolicystring | IPFamilyPolicy відображає підтримку подвійного стека, яка запитується або вимагається цим Service. Якщо значення не надано, це поле буде встановлено на SingleStack. Сервіси можуть бути "SingleStack" (одне IP-сімейство), "PreferDualStack" (два IP-сімейства на кластерах з підтримкою подвійного стека або одне IP-сімейство на кластерах з одним стеком), або "RequireDualStack" (два IP-сімейства на кластерах з підтримкою подвійного стека, в іншому випадку помилка). Поля ipFamilies та clusterIPs залежать від значення цього поля. Це поле буде очищено при оновленні сервісу до типу ExternalName. Можливі значення enum:
|
loadBalancerClassstring | loadBalancerClass є класом реалізації балансувальника навантаження, до якого належить цей Service. Якщо вказано, значення цього поля повинно бути ідентифікатором у стилі мітки, з необовʼязковим префіксом, наприклад "internal-vip" або "example.com/internal-vip". Імена без префікса зарезервовані для кінцевих користувачів. Це поле можна встановити лише тоді, коли тип Service — 'LoadBalancer'. Якщо не встановлено, використовується стандартна реалізація балансувальника навантаження, сьогодні це зазвичай робиться через інтеграцію з постачальником хмари, але має застосовуватися для будь-якої стандартної реалізації. Якщо встановлено, вважається, що реалізація балансувальника навантаження стежить за Services з відповідним класом. Будь-яка стандартна реалізація балансувальника навантаження (наприклад, постачальники хмари) повинна ігнорувати Services, які встановлюють це поле. Це поле можна встановити лише при створенні або оновленні Service до типу 'LoadBalancer'. Після встановлення його не можна змінити. Це поле буде очищено, коли сервіс оновлюється до типу, відмінного від 'LoadBalancer'. |
loadBalancerIPstring | Застосовується лише до типу Service: LoadBalancer. Ця функція залежить від того, чи підтримує відповідний постачальник хмари вказівку loadBalancerIP під час створення балансувальника навантаження. Це поле буде ігноруватися, якщо постачальник хмари не підтримує цю функцію. Застаріле: це поле було недостатньо визначене, і його значення варіюється в різних реалізаціях. Використання його є неперееносним і може не підтримувати подвійний стек. Користувачам рекомендується використовувати специфічні для реалізації анотації, коли вони доступні. |
loadBalancerSourceRangesstring array | Якщо вказано та підтримується платформою, це обмежить трафік через балансувальник навантаження постачальника хмари лише до зазначених IP-клієнтів. Це поле буде ігноруватися, якщо постачальник хмари не підтримує цю функцію. Більше інформації: https://kubernetes.io/docs/tasks/access-application-cluster/create-external-load-balancer/ |
portsServicePort array patch strategy: злиття за ключем port | Список портів, які експонуються цим сервісом. Більше інформації: https://kubernetes.io/docs/concepts/services-networking/service/#virtual-ips-and-service-proxies |
publishNotReadyAddressesboolean | publishNotReadyAddresses вказує, що будь-який агент, який працює з точками доступу цього сервісу, повинен ігнорувати будь-які вказівки про готовність/неготовність. Основне використання цього поля — для Headless Service StatefulSet для поширення SRV DNS записів для його Podʼів для цілей виявлення пірів. Контролери Kubernetes, які генерують ресурси Endpoints та EndpointSlice для сервісів, інтерпретують це як те, що всі точки доступу вважаються "готовими", навіть якщо самі Pod не готові. Агенти, які використовують лише точки доступу, згенеровані Kubernetes через ресурси Endpoints або EndpointSlice, можуть безпечно припустити цю поведінку. |
selectorobject | Маршрутизує трафік сервісу до Podʼів з ключами та значеннями міток, що відповідають цьому селектору. Якщо порожній або відсутній, вважається, що сервіс має зовнішній процес, який керує його точками доступу, і Kubernetes не буде його змінювати. Застосовується лише до типів ClusterIP, NodePort та LoadBalancer. Ігнорується, якщо тип ExternalName. Більше інформації: https://kubernetes.io/docs/concepts/services-networking/service/ |
sessionAffinitystring | Підтримує "ClientIP" та "None". Використовується для підтримки спорідненості сесії. Увімкнення спорідненості сесії на основі IP клієнта. Має бути ClientIP або None. Стандартно — None. Більше інформації: https://kubernetes.io/docs/concepts/services-networking/service/#virtual-ips-and-service-proxies Можливі значення enum:
|
sessionAffinityConfigSessionAffinityConfig | sessionAffinityConfig містить конфігурації спорідненості сесії. |
trafficDistributionstring | TrafficDistribution пропонує спосіб виразити переваги щодо того, як трафік розподіляється до точок доступу сервісу. Реалізації можуть використовувати це поле як підказку, але не зобовʼязані гарантувати суворе дотримання. Якщо поле не встановлено, реалізація застосує свою стандартну стратегію маршрутизації. Якщо встановлено значення "PreferClose", реалізації повинні надавати пріоритет точкам доступу, які знаходяться в тій же зоні. |
typestring | type визначає, як сервіс буде доступний. Стандартно — ClusterIP. Доступні варіанти: ExternalName, ClusterIP, NodePort та LoadBalancer. "ClusterIP" виділяє внутрішню IP-адресу кластера для балансування навантаження на точки доступу. Точки доступу визначаються селектором або, якщо він не вказаний, шляхом ручного створення обʼєкта Endpoints або обʼєктів EndpointSlice. Якщо clusterIP встановлено на "None", віртуальна IP-адреса не виділяється, і точки доступу експонуються як набір точок доступу, а не як віртуальна IP-адреса. "NodePort" будується на основі ClusterIP і виділяє порт на кожному вузлі, який маршрутизує до тих самих точок доступу, що й clusterIP. "LoadBalancer" будується на основі NodePort і створює зовнішній балансувальник навантаження (якщо підтримується в поточному хмарному середовищі), який маршрутизує до тих самих точок доступу, що й clusterIP. "ExternalName" створює псевдонім цього сервісу для вказаного externalName. Декілька інших полів не застосовуються до сервісів ExternalName. Більше інформації: https://kubernetes.io/docs/concepts/services-networking/service/#publishing-services-service-types Можливі значення enum:
|
ServiceStatus
ServiceStatus представляє поточний стан сервісу.
| Поле | Опис |
|---|---|
conditionsCondition array patch strategy: злиття за ключем type | Поточний стан сервісу |
loadBalancerLoadBalancerStatus | LoadBalancer містить поточний стан балансувальника навантаження, якщо він присутній. |
ServiceList
ServiceList містить список сервісів.
| Поле | Опис |
|---|---|
apiVersionstring | APIVersion визначає версію схеми цього представлення обʼєкта. Сервери повинні конвертувати розпізнані схеми до останнього внутрішнього значення і можуть відхиляти нерозпізнані значення. Детальніше: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources |
items *Service array | Список сервісів |
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#types-kinds |
ClientIPConfig
ClientIPConfig представляє конфігурації сесійної спорідненості на основі IP клієнта.
| Поле | Опис |
|---|---|
timeoutSecondsinteger | timeoutSeconds вказує кількість секунд для сесійної спорідненості типу ClientIP. Значення повинно бути >0 && <=86400 (для 1 дня), якщо ServiceAffinity == "ClientIP". Стандартне значення — 10800 (для 3 годин). |
LoadBalancerIngress
LoadBalancerIngress представляє стан точки входу балансувальника навантаження: трафік, призначений для сервісу, повинен надсилатися до точки входу.
| Поле | Опис |
|---|---|
hostnamestring | Hostname встановлюється для точок входу балансувальника навантаження, які базуються на DNS (зазвичай балансувальники навантаження AWS) |
ipstring | IP встановлюється для точок входу балансувальника навантаження, які базуються на IP (зазвичай балансувальники навантаження GCE або OpenStack) |
ipModestring | IPMode визначає, як поводиться IP балансувальника навантаження, і може бути вказаний лише тоді, коли поле ip вказане. Встановлення цього значення на "VIP" означає, що трафік доставляється до вузла з призначенням, встановленим на IP та порт балансувальника навантаження. Встановлення цього значення на "Proxy" означає, що трафік доставляється до вузла або поду з призначенням, встановленим на IP вузла та порт вузла або IP поду та порт поду. Реалізації сервісу можуть використовувати цю інформацію для налаштування маршрутизації трафіку. |
portsPortStatus array | Ports є списком записів портів сервісу. Якщо використовується, кожен порт, визначений у сервісі, повинен мати запис у цьому списку. |
LoadBalancerStatus
LoadBalancerStatus представляє стан балансувальника навантаження.
| Поле | Опис |
|---|---|
ingressLoadBalancerIngress array | Ingress є списком точок входу для балансувальника навантаження. Трафік, призначений для сервісу, повинен надсилатися до цих точок входу. |
PortStatus
PortStatus представляє стан порту сервісу
| Поле | Опис |
|---|---|
errorstring | Error використовується для запису проблеми з портом сервісу. Формат помилки повинен відповідати наступним правилам:
|
port *integer | Port є номером порту сервісу, стан якого тут записується. |
protocol *string | Protocol є протоколом порту сервісу, стан якого тут записується. Підтримувані значення: "TCP", "UDP", "SCTP" Можливі значення enum:
|
ServicePort
ServicePort містить інформацію про порт сервісу.
| Поле | Опис |
|---|---|
appProtocolstring | Протокол застосунку для цього порту. Використовується як підказка для реалізацій, щоб запропонувати більш багатий функціонал для протоколів, які вони розуміють. Це поле слідує стандартному синтаксису міток Kubernetes. Дійсні значення можуть бути:
|
namestring | Назва порту всередині сервісу. Повинна бути DNS_LABEL. Всі порти всередині ServiceSpec повинні мати унікальні назви. При розгляді точок доступу для сервісу, повинна відповідати полю 'name' в EndpointPort. Необовʼязково, якщо визначено лише один ServicePort для цього сервісу. |
nodePortinteger | Порт на кожному вузлі, на якому цей сервіс буде доступний, коли тип сервісу NodePort або LoadBalancer. Зазвичай призначається системою. Якщо вказано значення, яке знаходиться в діапазоні та не використовується, воно буде використане, інакше операція завершиться помилкою. Якщо не вказано, порт буде виділено, якщо цей сервіс його потребує. Якщо це поле вказано при створенні сервісу, який його не потребує, створення завершиться помилкою. Це поле буде очищено при оновленні сервісу, який більше його не потребує (наприклад, зміна типу з NodePort на ClusterIP). Більше інформації: https://kubernetes.io/docs/concepts/services-networking/service/#type-nodeport |
port *integer | Порт, який буде експонований цим сервісом. |
protocolstring | IP-протокол для цього порту. Підтримуються "TCP", "UDP" та "SCTP". Стандартно — TCP. Можливі значення enum:
|
targetPort | Номер або назва порту для доступу до подів, на які спрямований сервіс. Номер повинен бути в діапазоні від 1 до 65535. Назва повинна бути IANA_SVC_NAME. Якщо це рядок, він буде шукатися як порт з назвою у контейнерах цільового поду. Якщо не вказано, використовується значення поля 'port' (identity map). Це поле ігнорується для сервісів з clusterIP=None і повинно бути опущене або встановлене рівним полю 'port'. Більше інформації: https://kubernetes.io/docs/concepts/services-networking/service/#defining-a-service |
SessionAffinityConfig
SessionAffinityConfig представляє конфігурації спорідненості сесії.
| Поле | Опис |
|---|---|
clientIPClientIPConfig | clientIP містить конфігурації спорідненості сесії на основі IP клієнта. |
Операції
post Create
HTTP Запит
POST /api/v1/namespaces/{namespace}/services
Параметри шляху
| Назва | Тип | Опис |
|---|---|---|
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 | Service |
Відповідь
| Статус | Опис | Відповідь |
|---|---|---|
| 200 | OK | Service |
| 201 | Created | Service |
| 202 | Accepted | Service |
patch Patch
HTTP Запит
PATCH /api/v1/namespaces/{namespace}/services/{name}
Параметри шляху
| Назва | Тип | Опис |
|---|---|---|
name | string | Назва Service |
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 | Service |
| 201 | Created | Service |
put Replace
HTTP Запит
PUT /api/v1/namespaces/{namespace}/services/{name}
Параметри шляху
| Назва | Тип | Опис |
|---|---|---|
name | string | Назва Service |
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 | Service |
Відповідь
| Статус | Опис | Відповідь |
|---|---|---|
| 200 | OK | Service |
| 201 | Created | Service |
delete Delete
HTTP Запит
DELETE /api/v1/namespaces/{namespace}/services/{name}
Параметри шляху
| Назва | Тип | Опис |
|---|---|---|
name | string | Назва Service |
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 | Service |
| 202 | Accepted | Service |
delete Delete Collection
HTTP Запит
DELETE /api/v1/namespaces/{namespace}/services
Параметри шляху
| Назва | Тип | Опис |
|---|---|---|
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 /api/v1/namespaces/{namespace}/services/{name}
Параметри шляху
| Назва | Тип | Опис |
|---|---|---|
name | string | Назва Service |
namespace | string | Назва обʼєкта та область авторизації, наприклад для команд і проєктів |
Параметри запиту
| Назва | Тип | Опис |
|---|---|---|
pretty | string | Якщо 'true', то вихідні дані форматуються у зручному для читання вигляді. Зазвичай 'false', якщо user-agent не вказує оглядач або командний інструмент для роботи з HTTP (curl та wget). |
Відповідь
| Статус | Опис | Відповідь |
|---|---|---|
| 200 | OK | Service |
get List
HTTP Запит
GET /api/v1/namespaces/{namespace}/services
Параметри шляху
| Назва | Тип | Опис |
|---|---|---|
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 | ServiceList |
get List All Namespaces
HTTP Запит
GET /api/v1/services
Параметри запиту
| Назва | Тип | Опис |
|---|---|---|
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 | ServiceList |
get Watch
HTTP Запит
GET /api/v1/watch/namespaces/{namespace}/services/{name}
Параметри шляху
| Назва | Тип | Опис |
|---|---|---|
name | string | Назва Service |
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 /api/v1/watch/namespaces/{namespace}/services
Параметри шляху
| Назва | Тип | Опис |
|---|---|---|
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 /api/v1/watch/services
Параметри запиту
| Назва | Тип | Опис |
|---|---|---|
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 /api/v1/namespaces/{namespace}/services/{name}/status
Параметри шляху
| Назва | Тип | Опис |
|---|---|---|
name | string | Назва Service |
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 | Service |
| 201 | Created | Service |
get Read Status
HTTP Запит
GET /api/v1/namespaces/{namespace}/services/{name}/status
Параметри шляху
| Назва | Тип | Опис |
|---|---|---|
name | string | Назва Service |
namespace | string | Назва обʼєкта та область авторизації, наприклад для команд і проєктів |
Параметри запиту
| Назва | Тип | Опис |
|---|---|---|
pretty | string | Якщо 'true', то вихідні дані форматуються у зручному для читання вигляді. Зазвичай 'false', якщо user-agent не вказує оглядач або командний інструмент для роботи з HTTP (curl та wget). |
Відповідь
| Статус | Опис | Відповідь |
|---|---|---|
| 200 | OK | Service |
put Replace Status
HTTP Запит
PUT /api/v1/namespaces/{namespace}/services/{name}/status
Параметри шляху
| Назва | Тип | Опис |
|---|---|---|
name | string | Назва Service |
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 | Service |
Відповідь
| Статус | Опис | Відповідь |
|---|---|---|
| 200 | OK | Service |
| 201 | Created | Service |
post Create Connect Proxy
HTTP Запит
POST /api/v1/namespaces/{namespace}/services/{name}/proxy
Параметри шляху
| Назва | Тип | Опис |
|---|---|---|
name | string | Назва ServiceProxyOptions |
namespace | string | Назва обʼєкта та область авторизації, наприклад для команд і проєктів |
Параметри запиту
| Назва | Тип | Опис |
|---|---|---|
path | string | є |
Відповідь
| Статус | Опис | Відповідь |
|---|---|---|
| 200 | OK | string |
post Create Connect Proxy Path
HTTP Запит
POST /api/v1/namespaces/{namespace}/services/{name}/proxy/{path}
Параметри шляху
| Назва | Тип | Опис |
|---|---|---|
name | string | Назва ServiceProxyOptions |
namespace | string | Назва обʼєкта та область авторизації, наприклад для команд і проєктів |
path | string | Шлях до ресурсу |
Параметри запиту
| Назва | Тип | Опис |
|---|---|---|
path | string | є |
Відповідь
| Статус | Опис | Відповідь |
|---|---|---|
| 200 | OK | string |
delete Delete Connect Proxy
HTTP Запит
DELETE /api/v1/namespaces/{namespace}/services/{name}/proxy
Параметри шляху
| Назва | Тип | Опис |
|---|---|---|
name | string | Назва ServiceProxyOptions |
namespace | string | Назва обʼєкта та область авторизації, наприклад для команд і проєктів |
Параметри запиту
| Назва | Тип | Опис |
|---|---|---|
path | string | є |
Відповідь
| Статус | Опис | Відповідь |
|---|---|---|
| 200 | OK | string |
delete Delete Connect Proxy Path
HTTP Запит
DELETE /api/v1/namespaces/{namespace}/services/{name}/proxy/{path}
Параметри шляху
| Назва | Тип | Опис |
|---|---|---|
name | string | Назва ServiceProxyOptions |
namespace | string | Назва обʼєкта та область авторизації, наприклад для команд і проєктів |
path | string | Шлях до ресурсу |
Параметри запиту
| Назва | Тип | Опис |
|---|---|---|
path | string | Path є частиною URL, яка включає точки доступу сервісу, суфікси та параметри, які використовуються для поточного запиту проксі до сервісу. Наприклад, повний URL запиту — http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy. Path — це _search?q=user:kimchy. |
Відповідь
| Статус | Опис | Відповідь |
|---|---|---|
| 200 | OK | string |
get Get Connect Proxy
HTTP Запит
GET /api/v1/namespaces/{namespace}/services/{name}/proxy
Параметри шляху
| Назва | Тип | Опис |
|---|---|---|
name | string | Назва ServiceProxyOptions |
namespace | string | Назва обʼєкта та область авторизації, наприклад для команд і проєктів |
Параметри запиту
| Назва | Тип | Опис |
|---|---|---|
path | string | є |
Відповідь
| Статус | Опис | Відповідь |
|---|---|---|
| 200 | OK | string |
get Get Connect Proxy Path
HTTP Запит
GET /api/v1/namespaces/{namespace}/services/{name}/proxy/{path}
Параметри шляху
| Назва | Тип | Опис |
|---|---|---|
name | string | Назва ServiceProxyOptions |
namespace | string | Назва обʼєкта та область авторизації, наприклад для команд і проєктів |
path | string | Шлях до ресурсу |
Параметри запиту
| Назва | Тип | Опис |
|---|---|---|
path | string | є |
Відповідь
| Статус | Опис | Відповідь |
|---|---|---|
| 200 | OK | string |
head Head Connect Proxy
HTTP Запит
HEAD /api/v1/namespaces/{namespace}/services/{name}/proxy
Параметри шляху
| Назва | Тип | Опис |
|---|---|---|
name | string | Назва ServiceProxyOptions |
namespace | string | Назва обʼєкта та область авторизації, наприклад для команд і проєктів |
Параметри запиту
| Назва | Тип | Опис |
|---|---|---|
path | string | є |
Відповідь
| Статус | Опис | Відповідь |
|---|---|---|
| 200 | OK | string |
head Head Connect Proxy Path
HTTP Запит
HEAD /api/v1/namespaces/{namespace}/services/{name}/proxy/{path}
Параметри шляху
| Назва | Тип | Опис |
|---|---|---|
name | string | Назва ServiceProxyOptions |
namespace | string | Назва обʼєкта та область авторизації, наприклад для команд і проєктів |
path | string | Шлях до ресурсу |
Параметри запиту
| Назва | Тип | Опис |
|---|---|---|
path | string | є |
Відповідь
| Статус | Опис | Відповідь |
|---|---|---|
| 200 | OK | string |
put Replace Connect Proxy
HTTP Запит
PUT /api/v1/namespaces/{namespace}/services/{name}/proxy
Параметри шляху
| Назва | Тип | Опис |
|---|---|---|
name | string | Назва ServiceProxyOptions |
namespace | string | Назва обʼєкта та область авторизації, наприклад для команд і проєктів |
Параметри запиту
| Назва | Тип | Опис |
|---|---|---|
path | string | є |
Відповідь
| Статус | Опис | Відповідь |
|---|---|---|
| 200 | OK | string |
put Replace Connect Proxy Path
HTTP Запит
PUT /api/v1/namespaces/{namespace}/services/{name}/proxy/{path}
Параметри шляху
| Назва | Тип | Опис |
|---|---|---|
name | string | Назва ServiceProxyOptions |
namespace | string | Назва обʼєкта та область авторизації, наприклад для команд і проєктів |
path | string | Шлях до ресурсу |
Параметри запиту
| Назва | Тип | Опис |
|---|---|---|
path | string | є |
Відповідь
| Статус | Опис | Відповідь |
|---|---|---|
| 200 | OK | string |
16 - ServiceAccount
ServiceAccount обʼєднує:
- імʼя, зрозуміле користувачам і, можливо, периферійним системам, для ідентифікації
- принципала, який може бути автентифікований і авторизований
- набір секретів
apiVersion: v1
import "k8s.io/api/core/v1"
ServiceAccount
ServiceAccount обʼєднує:
- імʼя, зрозуміле користувачам і, можливо, периферійним системам, для ідентифікації
- принципала, який може бути автентифікований і авторизований
- набір секретів
| Поле | Опис |
|---|---|
apiVersionstring | APIVersion визначає версію схеми цього представлення обʼєкта. Сервери повинні конвертувати розпізнані схеми до останнього внутрішнього значення і можуть відхиляти нерозпізнані значення. Детальніше: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources |
automountServiceAccountTokenboolean | AutomountServiceAccountToken вказує, чи повинні поди, що працюють під цим службовим обліковим записом, автоматично монтувати токен API. Може бути перевизначено на рівні пода. |
imagePullSecretsLocalObjectReference array | ImagePullSecrets є списком посилань на секрети в тому ж просторі імен, які використовуються для отримання будь-яких образів у подах, що посилаються на цей ServiceAccount. ImagePullSecrets відрізняються від Secrets тим, що Secrets можна монтувати в поді, а ImagePullSecrets доступні лише kubelet. Детальніше: https://kubernetes.io/docs/concepts/containers/images/#specifying-imagepullsecrets-on-a-pod |
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 |
secretsObjectReference array patch strategy: merge on key name | Secrets є списком секретів у тому ж просторі імен, які поди, що працюють під цим ServiceAccount, можуть використовувати. Поди обмежуються лише цим списком, якщо цей службовий обліковий запис має анотацію "kubernetes.io/enforce-mountable-secrets", встановлену на "true". Анотація "kubernetes.io/enforce-mountable-secrets" застаріла з версії v1.32. Рекомендується використовувати окремі простори імен для ізоляції доступу до змонтованих секретів. Це поле не слід використовувати для пошуку автоматично згенерованих секретів токенів службового облікового запису для використання поза подами. Замість цього токени можна запитувати безпосередньо за допомогою API TokenRequest або секрети токенів службового облікового запису можна створювати вручну. Детальніше: https://kubernetes.io/docs/concepts/configuration/secret |
ServiceAccountList
ServiceAccountList є списком обʼєктів ServiceAccount
| Поле | Опис |
|---|---|
apiVersionstring | APIVersion визначає версію схеми цього представлення обʼєкта. Сервери повинні конвертувати розпізнані схеми до останнього внутрішнього значення і можуть відхиляти нерозпізнані значення. Детальніше: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources |
items *ServiceAccount array | Список обʼєктів ServiceAccount. Детальніше: https://kubernetes.io/docs/tasks/configure-pod-container/configure-service-account/ |
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#types-kinds |
Операції
post Create
HTTP Запит
POST /api/v1/namespaces/{namespace}/serviceaccounts
Параметри запиту
| Назва | Тип | Опис |
|---|---|---|
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 | ServiceAccount |
Відповідь
| Статус | Опис | Відповідь |
|---|---|---|
| 200 | OK | ServiceAccount |
| 201 | Created | ServiceAccount |
| 202 | Accepted | ServiceAccount |
patch Patch
HTTP Запит
PATCH /api/v1/namespaces/{namespace}/serviceaccounts/{name}
Параметри запиту
| Назва | Тип | Опис |
|---|---|---|
name | string | Назва ServiceAccount |
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 | ServiceAccount |
| 201 | Created | ServiceAccount |
put Replace
HTTP Запит
PUT /api/v1/namespaces/{namespace}/serviceaccounts/{name}
Параметри запиту
| Назва | Тип | Опис |
|---|---|---|
name | string | Назва ServiceAccount |
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 | ServiceAccount |
Відповідь
| Статус | Опис | Відповідь |
|---|---|---|
| 200 | OK | ServiceAccount |
| 201 | Created | ServiceAccount |
delete Delete
HTTP Запит
DELETE /api/v1/namespaces/{namespace}/serviceaccounts/{name}
Параметри запиту
| Назва | Тип | Опис |
|---|---|---|
name | string | Назва ServiceAccount |
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 | ServiceAccount |
| 202 | Accepted | ServiceAccount |
delete Delete Collection
HTTP Запит
DELETE /api/v1/namespaces/{namespace}/serviceaccounts
Параметри запиту
| Назва | Тип | Опис |
|---|---|---|
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 /api/v1/namespaces/{namespace}/serviceaccounts/{name}
Параметри запиту
| Назва | Тип | Опис |
|---|---|---|
name | string | Назва ServiceAccount |
namespace | string | Назва обʼєкта та область авторизації, наприклад для команд і проєктів |
Параметри запиту
| Назва | Тип | Опис |
|---|---|---|
pretty | string | Якщо 'true', то вихідні дані форматуються у зручному для читання вигляді. Зазвичай 'false', якщо user-agent не вказує оглядач або командний інструмент для роботи з HTTP (curl та wget). |
Відповідь
| Статус | Опис | Відповідь |
|---|---|---|
| 200 | OK | ServiceAccount |
get List
HTTP Запит
GET /api/v1/namespaces/{namespace}/serviceaccounts
Параметри запиту
| Назва | Тип | Опис |
|---|---|---|
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 | ServiceAccountList |
get List All Namespaces
HTTP Запит
GET /api/v1/serviceaccounts
Параметри запиту
| Назва | Тип | Опис |
|---|---|---|
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 | ServiceAccountList |
get Watch
HTTP Запит
GET /api/v1/watch/namespaces/{namespace}/serviceaccounts/{name}
Параметри запиту
| Назва | Тип | Опис |
|---|---|---|
name | string | Назва ServiceAccount |
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 /api/v1/watch/namespaces/{namespace}/serviceaccounts
Параметри запиту
| Назва | Тип | Опис |
|---|---|---|
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 /api/v1/watch/serviceaccounts
Параметри запиту
| Назва | Тип | Опис |
|---|---|---|
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 |