apiVersion: autoscaling/v2
import "k8s.io/api/autoscaling/v2"
HorizontalPodAutoscaler є конфігурацією для горизонтального автомасштабувальника подів, який автоматично керує кількістю реплік будь-якого ресурсу, що реалізує субресурс масштабування, на основі вказаних метрик.
| Поле | Опис |
|---|---|
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 | metadata визначає стандартні метадані обʼєкта. Детальніше: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata. |
spec *HorizontalPodAutoscalerSpec | spec визначає специфікацію поведінки автомасштабувальника. Детальніше: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status. |
statusHorizontalPodAutoscalerStatus | status визначає поточну інформацію про автомасштабувальника. |
HorizontalPodAutoscalerSpec описує бажану функціональність HorizontalPodAutoscaler.
| Поле | Опис |
|---|---|
behaviorHorizontalPodAutoscalerBehavior | behavior налаштовує поведінку масштабування цільового ресурсу в обох напрямках: вгору та вниз (поля scaleUp та scaleDown відповідно). Якщо не встановлено, використовуються стандартні правила HPAScalingRules для масштабування вгору та вниз. |
maxReplicas *integer | maxReplicas це верхня межа для кількості реплік, до якої автомасштабувальник може масштабуватися вгору. Вона не може бути меншою за minReplicas. |
metricsMetricSpec array | metrics містить специфікації, які використовуються для обчислення бажаної кількості реплік (використовується максимальна кількість реплік серед усіх метрик). Бажана кількість реплік обчислюється шляхом множення співвідношення між цільовим значенням і поточним значенням на поточну кількість подів. Тобто, використані метрики повинні зменшуватися при збільшенні кількості подів і навпаки. Дивіться окремі типи джерел метрик для отримання додаткової інформації про те, як кожен тип метрики повинен реагувати. Якщо не встановлено, за замовчуванням буде встановлено метрику 80% середнього використання CPU. |
minReplicasinteger | minReplicas це нижня межа для кількості реплік, до якої автомасштабувальник може масштабуватися вниз. Стандартно встановлено 1 под. minReplicas може бути 0, якщо увімкнено альфа-функцію HPAScaleToZero і налаштовано принаймні одну метрику Object або External. Масштабування активне, поки доступне принаймні одне значення метрики. |
scaleTargetRef *CrossVersionObjectReference | scaleTargetRef вказує на цільовий ресурс для масштабування і використовується для збору метрик з подів, а також для фактичної зміни кількості реплік. |
HorizontalPodAutoscalerStatus описує поточний стан горизонтального автомасштабувальника подів.
| Поле | Опис |
|---|---|
conditionsHorizontalPodAutoscalerCondition array patch strategy: злиття за ключем type | conditions є набором умов, необхідних для того, щоб цей автомасштабувальник міг масштабувати свою ціль, і вказує, чи виконуються ці умови. |
currentMetricsMetricStatus array | currentMetrics є останнім прочитаним станом метрик, які використовуються цим автомасштабувальником. |
currentReplicasinteger | currentReplicas це поточна кількість реплік подів, якими керує цей автомасштабувальник, станом на останнє спостереження автомасштабувальника. |
desiredReplicas *integer | desiredReplicas це бажана кількість реплік подів, якими керує цей автомасштабувальник, станом на останнє обчислення автомасштабувальником. |
lastScaleTimeTime | lastScaleTime це останній час, коли горизонтальний автомасштабувальник подів змінив кількість подів, використовується автомасштабувальником для контролю частоти зміни кількості подів. |
observedGenerationinteger | observedGeneration це останнє покоління, спостережене цим автомасштабувальником. |
HorizontalPodAutoscalerList список обʼєктів горизонтального автомасштабувальника подів.
| Поле | Опис |
|---|---|
apiVersionstring | APIVersion визначає версію схеми цього представлення обʼєкта. Сервери повинні конвертувати розпізнані схеми до останнього внутрішнього значення і можуть відхиляти нерозпізнані значення. Детальніше: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources |
items *HorizontalPodAutoscaler array | items це список обʼєктів горизонтального автомасштабувальника подів. |
kindstring | Kind визначає тип REST-ресурсу, який представляє цей обʼєкт. Сервери можуть визначати це з точки доступу, до якої клієнт надсилає запити. Не може бути оновлено. У CamelCase. Детальніше: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
metadataListMeta | metadata це стандартні метадані списку. |
ContainerResourceMetricSource показує, як масштабуватися за метрикою ресурсу, відомою Kubernetes, як зазначено в запитах і обмеженнях, описуючи кожен под у поточній цільовій групі масштабування (наприклад, CPU або памʼять). Значення будуть усереднені перед порівнянням з цільовим значенням. Такі метрики вбудовані в Kubernetes і мають спеціальні параметри масштабування поверх тих, що доступні для звичайних метрик для кожного пода, використовуючи джерело "pods". Повинно бути встановлено лише один тип "target".
| Поле | Опис |
|---|---|
container *string | container це назва контейнера в подах цільової групи масштабування |
name *string | name це назва ресурсу, про який йде мова. |
target *MetricTarget | target визначає цільове значення для даної метрики |
ContainerResourceMetricStatus показує поточне значення метрики ресурсу, відомої Kubernetes, як зазначено в запитах і обмеженнях, описуючи один контейнер у кожному поді в поточній цільовій групі масштабування (наприклад, CPU або памʼять). Такі метрики вбудовані в Kubernetes і мають спеціальні параметри масштабування поверх тих, що доступні для звичайних метрик для кожного пода, використовуючи джерело "pods".
| Поле | Опис |
|---|---|
container *string | container це назва контейнера в подах цільової групи масштабування |
current *MetricValueStatus | current містить поточне значення для даної метрики |
name *string | name це назва ресурсу, про який йде мова. |
CrossVersionObjectReference містить достатньо інформації, щоб ідентифікувати посиланий ресурс.
| Поле | Опис |
|---|---|
apiVersionstring | apiVersion це версія API референта |
kind *string | kind це тип референта; Більше інформації: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
name *string | name це назва референта; Більше інформації: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
ExternalMetricSource вказує, як масштабувати за метрикою, яка не повʼязана з жодним обʼєктом Kubernetes (наприклад, довжина черги в хмарному сервісі обміну повідомленнями або QPS від балансувальника навантаження, що працює поза кластером).
| Поле | Опис |
|---|---|
metric *MetricIdentifier | metric визначає цільову метрику за назвою та селектором |
target *MetricTarget | target визначає цільове значення для даної метрики |
ExternalMetricStatus показує поточне значення глобальної метрики, яка не повʼязана з жодним обʼєктом Kubernetes.
| Поле | Опис |
|---|---|
current *MetricValueStatus | current містить поточне значення для даної метрики |
metric *MetricIdentifier | metric визначає цільову метрику за назвою та селектором |
HPAScalingPolicy є окремою політикою, яка повинна дотримуватися протягом зазначеного інтервалу часу.
| Поле | Опис |
|---|---|
periodSeconds *integer | periodSeconds вказує вікно часу, протягом якого політика повинна дотримуватися. PeriodSeconds має бути більше нуля і менше або дорівнювати 1800 (30 хв). |
type *string | type використовується для вказівки політики масштабування. |
value *integer | value містить величину зміни, дозволену політикою. Вона повинна бути більше нуля |
HPAScalingRules налаштовує поведінку масштабування в одному напрямку за допомогою правил політики масштабування та налаштовуваного допуску метрик.
Правила політики масштабування застосовуються після обчислення DesiredReplicas на основі метрик для HPA. Вони можуть обмежувати швидкість масштабування, вказуючи політики масштабування. Вони можуть запобігати коливанням, вказуючи вікно стабілізації, щоб кількість реплік не встановлювалася миттєво, замість цього обирається найбезпечніше значення з вікна стабілізації.
Допуск застосовується до значень метрик і запобігає занадто швидкому масштабуванню при невеликих коливаннях метрик. (Зверніть увагу, що для встановлення допуску потрібно ввімкнути бета-функцію HPAConfigurableTolerance.)
| Поле | Опис |
|---|---|
policiesHPAScalingPolicy array | policies є списком потенційних політик масштабування, які можуть бути використані під час масштабування. Якщо не встановлено, використовуються стандартні значення:
|
selectPolicystring | selectPolicy використовується для вказівки, яка політика повинна бути використана. Якщо не встановлено, використовується стандартне значення Max. |
stabilizationWindowSecondsinteger | stabilizationWindowSeconds вказує кількість секунд, протягом яких слід враховувати попередні рекомендації під час масштабування вгору або вниз. StabilizationWindowSeconds має бути більше або дорівнювати нулю і менше або дорівнювати 3600 (одна година). Якщо не встановлено, використовуються стандартні значення:
|
toleranceQuantity | tolerance є допуском на співвідношення між поточним і бажаним значенням метрики, при якому не вносяться оновлення до бажаної кількості реплік (наприклад, 0.01 для 1%). Має бути більше або дорівнювати нулю. Якщо не встановлено, застосовується стандартний допуск для всього кластера (стандартно — 10%). Наприклад, якщо автомасштабувальник налаштований з цільовим споживанням памʼяті 100Mi, а допуски на зменшення та збільшення масштабу становлять 5% та 1% відповідно, масштабування буде ініційовано, коли фактичне споживання впаде нижче 95Mi або перевищить 101Mi. Це бета-поле і вимагає увімкнення функціональної можливості HPAConfigurableTolerance. |
HorizontalPodAutoscalerBehavior налаштовує поведінку масштабування цілі в обох напрямках: вгору та вниз (поля scaleUp та scaleDown відповідно).
| Поле | Опис |
|---|---|
scaleDownHPAScalingRules | scaleDown є політикою масштабування для зменшення масштабу. Якщо не встановлено, стандартне значення дозволяє зменшити кількість подів до minReplicas з вікном стабілізації 300 секунд (тобто використовується найвища рекомендація за останні 300 секунд). |
scaleUpHPAScalingRules | scaleUp є політикою масштабування для збільшення масштабу. Якщо не встановлено, стандартне значення дозволяє збільшити кількість подів не більше ніж на 4 за 60 секунд або подвоїти кількість подів за 60 секунд. Стабілізація не використовується. |
HorizontalPodAutoscalerCondition описує стан HorizontalPodAutoscaler у певний момент часу.
| Поле | Опис |
|---|---|
lastTransitionTimeTime | lastTransitionTime — це останній час, коли стан перейшов з одного статусу в інший |
messagestring | message зрозуміле людині пояснення, що містить деталі про перехід стану |
reasonstring | reason — це причина останнього переходу стану. |
status *string | status — це статус стану (True, False, Unknown) |
type *string | type описує поточний стан |
MetricIdentifier визначає імʼя та, за бажанням, селектор для метрики
| Поле | Опис |
|---|---|
name *string | name — це імʼя заданої метрики |
selectorLabelSelector | selector — це рядок, закодований у форматі стандартного селектора міток Kubernetes для заданої метрики. Якщо встановлено, він передається як додатковий параметр серверу метрик для більш точного визначення метрик. Якщо не встановлено, використовується лише metricName для збору метрик. |
MetricSpec визначає, як масштабувати на основі однієї метрики (повинні бути встановлені лише type та одне інше відповідне поле одночасно).
| Поле | Опис |
|---|---|
containerResourceContainerResourceMetricSource | containerResource посилається на метрику ресурсу (наприклад, ті, що вказані в параметрах requests та limits), відому Kubernetes, яка описує окремий контейнер у кожному поді поточній цільовій метриці масштабування (наприклад, CPU або памʼять). Такі метрики вбудовані в Kubernetes і мають спеціальні параметри масштабування на додачу до тих, що доступні для звичайних метрик на рівні подів із використанням джерела "pods". |
externalExternalMetricSource | external посилається на глобальну метрику, яка не повʼязана з жодним обʼєктом Kubernetes. Вона дозволяє автоматичне масштабування на основі інформації, що надходить від компонентів, які працюють поза кластером (наприклад, довжина черги в хмарному сервісі обміну повідомленнями або QPS від балансувальника навантаження, що працює поза кластером). |
objectObjectMetricSource | object посилається на метрику, що описує один обʼєкт Kubernetes (наприклад, кількість запитів на секунду для обʼєкта Ingress). |
podsPodsMetricSource | pods посилається на метрику, що описує кожен под у поточному цільовому масштабі (наприклад, транзакції, оброблені за секунду). Значення будуть усереднені перед порівнянням з цільовим значенням. |
resourceResourceMetricSource | resource посилається на метрику ресурсу (наприклад, ті, що вказані в параметрах requests та limits), відому Kubernetes, яка описує кожен под у поточному цільовому масштабі (наприклад, CPU або памʼять). Такі метрики вбудовані в Kubernetes і мають спеціальні параметри масштабування на додачу до тих, що доступні для звичайних метрик на рівні подів із використанням джерела "pods". |
type *string | type є типом джерела метрики. Воно повинно бути одним із "ContainerResource", "External", "Object", "Pods" або "Resource", кожне з яких відповідає відповідному полю в об'єкті. |
MetricStatus описує останній стан однієї метрики.
| Поле | Опис |
|---|---|
containerResourceContainerResourceMetricStatus | container resource посилається на метрику ресурсу (наприклад, ті, що вказані в параметрах requests та limits), відому Kubernetes, яка описує один контейнер у кожному поді поточній цільовій метриці масштабування (наприклад, CPU або памʼять). Такі метрики вбудовані в Kubernetes і мають спеціальні параметри масштабування на додачу до тих, що доступні для звичайних метрик на рівні подів із використанням джерела "pods". |
externalExternalMetricStatus | external посилається на глобальну метрику, яка не пов'язана з жодним об'єктом Kubernetes. Вона дозволяє автоматичне масштабування на основі інформації, що надходить від компонентів, які працюють поза кластером (наприклад, довжина черги в хмарному сервісі обміну повідомленнями або QPS від балансувальника навантаження, що працює поза кластером). |
objectObjectMetricStatus | object посилається на метрику, що описує один обʼєкт Kubernetes (наприклад, кількість запитів на секунду для обʼєкта Ingress). |
podsPodsMetricStatus | pods посилається на метрику, що описує кожен под у поточному цільовому масштабі (наприклад, кількість оброблених транзакцій за секунду). Значення будуть усереднені перед порівнянням із цільовим значенням. |
resourceResourceMetricStatus | resource посилається на метрику ресурсу (наприклад, ті, що вказані в параметрах requests та limits), відому Kubernetes, яка описує кожен под у поточному цільовому масштабі (наприклад, CPU або памʼять). Такі метрики вбудовані в Kubernetes і мають спеціальні параметри масштабування на додачу до тих, що доступні для звичайних метрик на рівні подів із використанням джерела "pods". |
type *string | type є типом джерела метрики. Воно повинно бути одним із "ContainerResource", "External", "Object", "Pods" або "Resource", кожне з яких відповідає відповідному полю в об'єкті. |
MetricTarget визначає цільове значення, середнє значення або середнє використання конкретної метрики
| Поле | Опис |
|---|---|
averageUtilizationinteger | averageUtilization є цільовим значенням середнього значення метрики ресурсу для всіх відповідних подів, представленим у відсотках від запитуваного значення ресурсу для подів. Наразі дійсно лише для типу джерела метрики Resource. |
averageValueQuantity | averageValue є цільовим значенням середнього значення метрики для всіх відповідних подів (як кількість) |
type *string | type визначає, чи є тип метрики Utilization, Value або AverageValue |
valueQuantity | value є цільовим значенням метрики (як кількість). |
MetricValueStatus визначає поточне значення метрики
| Поле | Опис |
|---|---|
averageUtilizationinteger | currentAverageUtilization є поточним значенням середнього значення метрики ресурсу для всіх відповідних подів, представленим у відсотках від запитуваного значення ресурсу для подів. |
averageValueQuantity | averageValue є поточним значенням середнього значення метрики для всіх відповідних подів (як кількість) |
valueQuantity | value є поточним значенням метрики (як кількість). |
ObjectMetricSource визначає, як масштабуватися за метрикою, що описує обʼєкт Kubernetes (наприклад, кількість запитів на секунду для обʼєкта Ingress).
| Поле | Опис |
|---|---|
describedObject *CrossVersionObjectReference | describedObject визначає опис обʼєкта, такого як kind, name, apiVersion |
metric *MetricIdentifier | metric визначає цільову метрику за назвою та селектором |
target *MetricTarget | target визначає цільове значення для даної метрики |
ObjectMetricStatus визначає поточне значення метрики, що описує обʼєкт Kubernetes (наприклад, кількість запитів на секунду для обʼєкта Ingress).
| Поле | Опис |
|---|---|
current *MetricValueStatus | current містить поточне значення для даної метрики |
describedObject *CrossVersionObjectReference | describedObject визначає опис обʼєкта, такого як kind, name, apiVersion |
metric *MetricIdentifier | metric визначає цільову метрику за назвою та селектором |
PodsMetricSource визначає, як масштабуватися за метрикою, що описує кожен под у поточному цільовому масштабі (наприклад, кількість оброблених транзакцій за секунду). Значення будуть усереднені перед порівнянням з цільовим значенням.
| Поле | Опис |
|---|---|
metric *MetricIdentifier | metric визначає цільову метрику за назвою та селектором |
target *MetricTarget | target визначає цільове значення для даної метрики |
PodsMetricStatus визначає поточне значення метрики, що описує кожен под у поточному цільовому масштабі (наприклад, кількість оброблених транзакцій за секунду).
| Поле | Опис |
|---|---|
current *MetricValueStatus | current містить поточне значення для даної метрики |
metric *MetricIdentifier | metric визначає цільову метрику за назвою та селектором |
ResourceMetricSource визначає, як масштабуватися за метрикою ресурсу, відомою Kubernetes, як зазначено в запитах і обмеженнях, описуючи кожен под у поточному цільовому масштабі (наприклад, CPU або памʼять). Значення будуть усереднені перед порівнянням з цільовим значенням. Такі метрики вбудовані в Kubernetes і мають спеціальні параметри масштабування поверх тих, що доступні для звичайних метрик на поди за допомогою джерела "pods". Повинно бути встановлено лише один тип "target".
| Поле | Опис |
|---|---|
name *string | name визначає назву ресурсу, про який йде мова. |
target *MetricTarget | target визначає цільове значення для даної метрики |
ResourceMetricStatus визначає поточне значення метрики ресурсу, відомої Kubernetes, як зазначено в запитах і обмеженнях, описуючи кожен под у поточному цільовому масштабі (наприклад, CPU або памʼять). Такі метрики вбудовані в Kubernetes і мають спеціальні параметри масштабування поверх тих, що доступні для звичайних метрик на поди за допомогою джерела "pods".
| Поле | Опис |
|---|---|
current *MetricValueStatus | current містить поточне значення для даної метрики |
name *string | name визначає назву ресурсу, про який йде мова. |
post CreatePOST /apis/autoscaling/v2/namespaces/{namespace}/horizontalpodautoscalers
| Назва | Тип | Опис |
|---|---|---|
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 | HorizontalPodAutoscaler |
| Статус | Опис | Відповідь |
|---|---|---|
| 200 | OK | HorizontalPodAutoscaler |
| 201 | Created | HorizontalPodAutoscaler |
| 202 | Accepted | HorizontalPodAutoscaler |
patch PatchPATCH /apis/autoscaling/v2/namespaces/{namespace}/horizontalpodautoscalers/{name}
| Назва | Тип | Опис |
|---|---|---|
name | string | Назва HorizontalPodAutoscaler |
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 | HorizontalPodAutoscaler |
| 201 | Created | HorizontalPodAutoscaler |
put ReplacePUT /apis/autoscaling/v2/namespaces/{namespace}/horizontalpodautoscalers/{name}
| Назва | Тип | Опис |
|---|---|---|
name | string | Назва HorizontalPodAutoscaler |
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 | HorizontalPodAutoscaler |
| Статус | Опис | Відповідь |
|---|---|---|
| 200 | OK | HorizontalPodAutoscaler |
| 201 | Created | HorizontalPodAutoscaler |
delete DeleteDELETE /apis/autoscaling/v2/namespaces/{namespace}/horizontalpodautoscalers/{name}
| Назва | Тип | Опис |
|---|---|---|
name | string | Назва HorizontalPodAutoscaler |
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 CollectionDELETE /apis/autoscaling/v2/namespaces/{namespace}/horizontalpodautoscalers
| Назва | Тип | Опис |
|---|---|---|
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 ReadGET /apis/autoscaling/v2/namespaces/{namespace}/horizontalpodautoscalers/{name}
| Назва | Тип | Опис |
|---|---|---|
name | string | Назва HorizontalPodAutoscaler |
namespace | string | Назва обʼєкта та область авторизації, наприклад для команд і проєктів |
| Назва | Тип | Опис |
|---|---|---|
pretty | string | Якщо 'true', то вихідні дані форматуються у зручному для читання вигляді. Зазвичай 'false', якщо user-agent не вказує оглядач або командний інструмент для роботи з HTTP (curl та wget). |
| Статус | Опис | Відповідь |
|---|---|---|
| 200 | OK | HorizontalPodAutoscaler |
get ListGET /apis/autoscaling/v2/namespaces/{namespace}/horizontalpodautoscalers
| Назва | Тип | Опис |
|---|---|---|
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 | HorizontalPodAutoscalerList |
get List All NamespacesGET /apis/autoscaling/v2/horizontalpodautoscalers
| Назва | Тип | Опис |
|---|---|---|
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 | HorizontalPodAutoscalerList |
get WatchGET /apis/autoscaling/v2/watch/namespaces/{namespace}/horizontalpodautoscalers/{name}
| Назва | Тип | Опис |
|---|---|---|
name | string | Назва HorizontalPodAutoscaler |
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 ListGET /apis/autoscaling/v2/watch/namespaces/{namespace}/horizontalpodautoscalers
| Назва | Тип | Опис |
|---|---|---|
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 NamespacesGET /apis/autoscaling/v2/watch/horizontalpodautoscalers
| Назва | Тип | Опис |
|---|---|---|
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 StatusPATCH /apis/autoscaling/v2/namespaces/{namespace}/horizontalpodautoscalers/{name}/status
| Назва | Тип | Опис |
|---|---|---|
name | string | Назва HorizontalPodAutoscaler |
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 | HorizontalPodAutoscaler |
| 201 | Created | HorizontalPodAutoscaler |
get Read StatusGET /apis/autoscaling/v2/namespaces/{namespace}/horizontalpodautoscalers/{name}/status
| Назва | Тип | Опис |
|---|---|---|
name | string | Назва HorizontalPodAutoscaler |
namespace | string | Назва обʼєкта та область авторизації, наприклад для команд і проєктів |
| Назва | Тип | Опис |
|---|---|---|
pretty | string | Якщо 'true', то вихідні дані форматуються у зручному для читання вигляді. Зазвичай 'false', якщо user-agent не вказує оглядач або командний інструмент для роботи з HTTP (curl та wget). |
| Статус | Опис | Відповідь |
|---|---|---|
| 200 | OK | HorizontalPodAutoscaler |
put Replace StatusPUT /apis/autoscaling/v2/namespaces/{namespace}/horizontalpodautoscalers/{name}/status
| Назва | Тип | Опис |
|---|---|---|
name | string | Назва HorizontalPodAutoscaler |
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 | HorizontalPodAutoscaler |
| Статус | Опис | Відповідь |
|---|---|---|
| 200 | OK | HorizontalPodAutoscaler |
| 201 | Created | HorizontalPodAutoscaler |