10.2. HorizontalPodAutoscaler [autoscaling/v2]


描述
HorizontalPodAutoscaler 是 pod 横向自动扩展的配置,它根据指定的指标自动管理实施 scale 子资源的任何资源的副本数。
类型
对象

10.2.1. 规格

属性类型描述

apiVersion

字符串

APIVersion 定义对象的这个表示法的版本化的 schema。服务器应该将识别的模式转换为最新的内部值,并可拒绝未识别的值。更多信息: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources

kind

字符串

kind 是一个字符串值,代表此对象所代表的 REST 资源。服务器可以从客户端向其提交请求的端点推断。无法更新。采用驼峰拼写法 (CamelCase)。更多信息: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

元数据

ObjectMeta

metadata 是标准对象元数据。更多信息: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

spec

对象

HorizontalPodAutoscalerSpec 描述了 HorizontalPodAutoscaler 的所需功能。

status

对象

HorizontalPodAutoscalerStatus 描述了 pod 横向自动扩展的当前状态。

10.2.1.1. .spec

描述
HorizontalPodAutoscalerSpec 描述了 HorizontalPodAutoscaler 的所需功能。
类型
对象
必填
  • scaleTargetRef
  • maxReplicas
属性类型描述

行为

对象

HorizontalPodAutoscalerBehavior 在 Up 和 Down directions (scaleUp 和 scaleDown 字段)中配置目标的扩展行为。

maxReplicas

整数

maxReplicas 是自动扩展可以扩展到的副本数的上限。它不能小于 minReplicas。

metrics

array

指标包含用于计算所需副本数(将使用所有指标的最大副本数)的规格。所需的副本数根据当前 pod 数量来计算目标值和当前值之间的比率。Ergo,使用的指标必须减少,因为 pod 数量会增加,反之亦然。如需有关每种指标类型响应的更多信息,请参阅单独的指标源类型。如果没有设置,则默认指标将设置为 80% 平均 CPU 使用率。

metrics[]

对象

MetricSpec 指定如何基于单一指标(仅 类型和 另一个匹配字段应一次性设置)进行扩展。

minReplicas

整数

minReplicas 是自动扩展可以缩减副本数的较低限制。如果启用了 alpha 功能门 HPAScaleToZero,并且至少配置一个 Object 或 External 指标,则默认为 1 个 pod。minReplicas 被允许为 0。只要至少有一个指标值可用,扩展就会处于活跃状态。

scaleTargetRef

对象

CrossVersionObjectReference 包含足够信息,供您识别引用的资源。

10.2.1.2. .spec.behavior

描述
HorizontalPodAutoscalerBehavior 在 Up 和 Down directions (scaleUp 和 scaleDown 字段)中配置目标的扩展行为。
类型
对象
属性类型描述

scaleDown

对象

HPAScalingRules 配置一个方向的扩展行为。在为 HPA 的指标计算 DesiredReplicas 后,会应用这些规则。它们可以通过指定扩展策略来限制扩展速度。它们可以通过指定 stabilization 窗口来防止 flapping,以便不立即设置副本数,而是选择 stabilization 窗口中的安全值。

scaleup

对象

HPAScalingRules 配置一个方向的扩展行为。在为 HPA 的指标计算 DesiredReplicas 后,会应用这些规则。它们可以通过指定扩展策略来限制扩展速度。它们可以通过指定 stabilization 窗口来防止 flapping,以便不立即设置副本数,而是选择 stabilization 窗口中的安全值。

10.2.1.3. .spec.behavior.scaleDown

描述
HPAScalingRules 配置一个方向的扩展行为。在为 HPA 的指标计算 DesiredReplicas 后,会应用这些规则。它们可以通过指定扩展策略来限制扩展速度。它们可以通过指定 stabilization 窗口来防止 flapping,以便不立即设置副本数,而是选择 stabilization 窗口中的安全值。
类型
对象
属性类型描述

policies

array

策略(policy)是一个潜在的扩展策略列表,可在扩展过程中使用。必须至少指定一个策略,否则 HPAScalingRules 将被丢弃为无效

policies[]

对象

HPAScalingPolicy 是一个单一策略,必须为指定过去的时间间隔保存 true。

selectPolicy

字符串

selectPolicy 用于指定应使用哪个策略。如果没有设置,则使用默认值 Max。

stabilizationWindowSeconds

整数

stabilizationWindowSeconds 是扩展或缩减时应考虑过去建议的秒数。stabilizationWindowSeconds 必须大于或等于零,且小于或等于 3600 (一小时)。如果没有设置,使用默认值: - 对于扩展: 0 (不进行稳定)。- 用于缩减:300 (例如,stabilization 窗口为 300 秒)。

10.2.1.4. .spec.behavior.scaleDown.policies

描述
策略(policy)是一个潜在的扩展策略列表,可在扩展过程中使用。必须至少指定一个策略,否则 HPAScalingRules 将被丢弃为无效
类型
array

10.2.1.5. .spec.behavior.scaleDown.policies[]

描述
HPAScalingPolicy 是一个单一策略,必须为指定过去的时间间隔保存 true。
类型
对象
必填
  • type
  • value
  • periodSeconds
属性类型描述

periodSeconds

整数

periodSeconds 指定策略应满足以下条件的时间窗口。periodSeconds 必须大于零,且小于或等于 1800 (30 分钟)。

type

字符串

type 用于指定扩展策略。

value

整数

value 包含策略允许的更改量。它必须大于零

10.2.1.6. .spec.behavior.scaleUp

描述
HPAScalingRules 配置一个方向的扩展行为。在为 HPA 的指标计算 DesiredReplicas 后,会应用这些规则。它们可以通过指定扩展策略来限制扩展速度。它们可以通过指定 stabilization 窗口来防止 flapping,以便不立即设置副本数,而是选择 stabilization 窗口中的安全值。
类型
对象
属性类型描述

policies

array

策略(policy)是一个潜在的扩展策略列表,可在扩展过程中使用。必须至少指定一个策略,否则 HPAScalingRules 将被丢弃为无效

policies[]

对象

HPAScalingPolicy 是一个单一策略,必须为指定过去的时间间隔保存 true。

selectPolicy

字符串

selectPolicy 用于指定应使用哪个策略。如果没有设置,则使用默认值 Max。

stabilizationWindowSeconds

整数

stabilizationWindowSeconds 是扩展或缩减时应考虑过去建议的秒数。stabilizationWindowSeconds 必须大于或等于零,且小于或等于 3600 (一小时)。如果没有设置,使用默认值: - 对于扩展: 0 (不进行稳定)。- 用于缩减:300 (例如,stabilization 窗口为 300 秒)。

10.2.1.7. .spec.behavior.scaleUp.policies

描述
策略(policy)是一个潜在的扩展策略列表,可在扩展过程中使用。必须至少指定一个策略,否则 HPAScalingRules 将被丢弃为无效
类型
array

10.2.1.8. .spec.behavior.scaleUp.policies[]

描述
HPAScalingPolicy 是一个单一策略,必须为指定过去的时间间隔保存 true。
类型
对象
必填
  • type
  • value
  • periodSeconds
属性类型描述

periodSeconds

整数

periodSeconds 指定策略应满足以下条件的时间窗口。periodSeconds 必须大于零,且小于或等于 1800 (30 分钟)。

type

字符串

type 用于指定扩展策略。

value

整数

value 包含策略允许的更改量。它必须大于零

10.2.1.9. .spec.metrics

描述
指标包含用于计算所需副本数(将使用所有指标的最大副本数)的规格。所需的副本数根据当前 pod 数量来计算目标值和当前值之间的比率。Ergo,使用的指标必须减少,因为 pod 数量会增加,反之亦然。如需有关每种指标类型响应的更多信息,请参阅单独的指标源类型。如果没有设置,则默认指标将设置为 80% 平均 CPU 使用率。
类型
array

10.2.1.10. .spec.metrics[]

描述
MetricSpec 指定如何基于单一指标(仅 类型和 另一个匹配字段应一次性设置)进行扩展。
类型
对象
必填
  • type
属性类型描述

containerResource

对象

ContainerResourceMetricSource 指明如何扩展 Kubernetes 的资源指标,如请求和限值中指定的资源指标,描述当前扩展目标中的每个 pod (如 CPU 或内存)。在与目标进行比较前,这些值将平均化在一起。此类指标内置在 Kubernetes 中,并在那些可用于使用 "pods" 源的普通每个 pod 指标上具有特殊的扩展选项。应该只设置一个"target"类型。

external

对象

ExternalMetricSource 指明如何在不与任何 Kubernetes 对象关联的指标上扩展(例如,云消息传递服务中的队列长度,或者从集群外运行的 loadbalancer 中的 QPS)。

对象

对象

ObjectMetricSource 指明如何在描述 kubernetes 对象的指标上扩展(例如,Ingress 对象上的 hits-per-second)。

pods

对象

PodsMetricSource 指明了如何在一个指标上扩展,描述当前扩展目标中的每个 pod (如 transaction-processed-second)。在与目标值进行比较前,这些值将平均化在一起。

resource

对象

ResourceMetricSource 指示如何扩展 Kubernetes 的资源指标,如请求和限值中指定的资源指标,描述当前扩展目标中的每个 pod (如 CPU 或内存)。在与目标进行比较前,这些值将平均化在一起。此类指标内置在 Kubernetes 中,并在那些可用于使用 "pods" 源的普通每个 pod 指标上具有特殊的扩展选项。应该只设置一个"target"类型。

type

字符串

type 是指标源的类型。它应该是 "ContainerResource", "External", "Object", "Pods" 或 "Resource" 之一,每个映射到对象中的匹配字段。注:"ContainerResource" 类型在启用了 feature-gate HPAContainerMetrics 时可用

10.2.1.11. .spec.metrics[].containerResource

描述
ContainerResourceMetricSource 指明如何扩展 Kubernetes 的资源指标,如请求和限值中指定的资源指标,描述当前扩展目标中的每个 pod (如 CPU 或内存)。在与目标进行比较前,这些值将平均化在一起。此类指标内置在 Kubernetes 中,并在那些可用于使用 "pods" 源的普通每个 pod 指标上具有特殊的扩展选项。应该只设置一个"target"类型。
类型
对象
必填
  • name
  • target
  • container
属性类型描述

container

字符串

Container 是扩展目标 pod 中的容器的名称

name

字符串

name 是问题的资源的名称。

target

对象

MetricTarget 定义特定指标的目标值、平均值或平均利用率

10.2.1.12. .spec.metrics[].containerResource.target

描述
MetricTarget 定义特定指标的目标值、平均值或平均利用率
类型
对象
必填
  • type
属性类型描述

averageUtilization

整数

averageUtilization 是所有相关 pod 中资源指标的平均目标值,以 pod 的资源值的百分比表示。目前仅对 Resource metric 源类型有效

averageValue

数量

AverageValue 是所有相关 pod 的指标平均值的目标值(作为数量)

type

字符串

type 代表指标类型是 Utilization、Value 或 AverageValue

value

数量

value 是指标的目标值(作为数量)。

10.2.1.13. .spec.metrics[].external

描述
ExternalMetricSource 指明如何在不与任何 Kubernetes 对象关联的指标上扩展(例如,云消息传递服务中的队列长度,或者从集群外运行的 loadbalancer 中的 QPS)。
类型
对象
必填
  • metric
  • target
属性类型描述

metric

对象

MetricIdentifier 定义指标的名称和可选选择器

target

对象

MetricTarget 定义特定指标的目标值、平均值或平均利用率

10.2.1.14. .spec.metrics[].external.metric

描述
MetricIdentifier 定义指标的名称和可选选择器
类型
对象
必填
  • name
属性类型描述

name

字符串

name 是给定指标的名称

selector

LabelSelector

选择器是给定指标时的标准 kubernetes 标签选择器的字符串编码形式,它将作为额外的参数传递给指标服务器,以获取更具体的指标范围。如果未设置,只需使用 metricName 来收集指标。

10.2.1.15. .spec.metrics[].external.target

描述
MetricTarget 定义特定指标的目标值、平均值或平均利用率
类型
对象
必填
  • type
属性类型描述

averageUtilization

整数

averageUtilization 是所有相关 pod 中资源指标的平均目标值,以 pod 的资源值的百分比表示。目前仅对 Resource metric 源类型有效

averageValue

数量

AverageValue 是所有相关 pod 的指标平均值的目标值(作为数量)

type

字符串

type 代表指标类型是 Utilization、Value 或 AverageValue

value

数量

value 是指标的目标值(作为数量)。

10.2.1.16. .spec.metrics[].object

描述
ObjectMetricSource 指明如何在描述 kubernetes 对象的指标上扩展(例如,Ingress 对象上的 hits-per-second)。
类型
对象
必填
  • describedObject
  • target
  • metric
属性类型描述

describedObject

对象

CrossVersionObjectReference 包含足够信息,供您识别引用的资源。

metric

对象

MetricIdentifier 定义指标的名称和可选选择器

target

对象

MetricTarget 定义特定指标的目标值、平均值或平均利用率

10.2.1.17. .spec.metrics[].object.describedObject

描述
CrossVersionObjectReference 包含足够信息,供您识别引用的资源。
类型
对象
必填
  • kind
  • name
属性类型描述

apiVersion

字符串

apiVersion 是引用的 API 版本

kind

字符串

kind 是引用的类型;更多信息: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

name

字符串

name 是引用的名称 ; 更多信息: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

10.2.1.18. .spec.metrics[].object.metric

描述
MetricIdentifier 定义指标的名称和可选选择器
类型
对象
必填
  • name
属性类型描述

name

字符串

name 是给定指标的名称

selector

LabelSelector

选择器是给定指标时的标准 kubernetes 标签选择器的字符串编码形式,它将作为额外的参数传递给指标服务器,以获取更具体的指标范围。如果未设置,只需使用 metricName 来收集指标。

10.2.1.19. .spec.metrics[].object.target

描述
MetricTarget 定义特定指标的目标值、平均值或平均利用率
类型
对象
必填
  • type
属性类型描述

averageUtilization

整数

averageUtilization 是所有相关 pod 中资源指标的平均目标值,以 pod 的资源值的百分比表示。目前仅对 Resource metric 源类型有效

averageValue

数量

AverageValue 是所有相关 pod 的指标平均值的目标值(作为数量)

type

字符串

type 代表指标类型是 Utilization、Value 或 AverageValue

value

数量

value 是指标的目标值(作为数量)。

10.2.1.20. .spec.metrics[].pods

描述
PodsMetricSource 指明了如何在一个指标上扩展,描述当前扩展目标中的每个 pod (如 transaction-processed-second)。在与目标值进行比较前,这些值将平均化在一起。
类型
对象
必填
  • metric
  • target
属性类型描述

metric

对象

MetricIdentifier 定义指标的名称和可选选择器

target

对象

MetricTarget 定义特定指标的目标值、平均值或平均利用率

10.2.1.21. .spec.metrics[].pods.metric

描述
MetricIdentifier 定义指标的名称和可选选择器
类型
对象
必填
  • name
属性类型描述

name

字符串

name 是给定指标的名称

selector

LabelSelector

选择器是给定指标时的标准 kubernetes 标签选择器的字符串编码形式,它将作为额外的参数传递给指标服务器,以获取更具体的指标范围。如果未设置,只需使用 metricName 来收集指标。

10.2.1.22. .spec.metrics[].pods.target

描述
MetricTarget 定义特定指标的目标值、平均值或平均利用率
类型
对象
必填
  • type
属性类型描述

averageUtilization

整数

averageUtilization 是所有相关 pod 中资源指标的平均目标值,以 pod 的资源值的百分比表示。目前仅对 Resource metric 源类型有效

averageValue

数量

AverageValue 是所有相关 pod 的指标平均值的目标值(作为数量)

type

字符串

type 代表指标类型是 Utilization、Value 或 AverageValue

value

数量

value 是指标的目标值(作为数量)。

10.2.1.23. .spec.metrics[].resource

描述
ResourceMetricSource 指示如何扩展 Kubernetes 的资源指标,如请求和限值中指定的资源指标,描述当前扩展目标中的每个 pod (如 CPU 或内存)。在与目标进行比较前,这些值将平均化在一起。此类指标内置在 Kubernetes 中,并在那些可用于使用 "pods" 源的普通每个 pod 指标上具有特殊的扩展选项。应该只设置一个"target"类型。
类型
对象
必填
  • name
  • target
属性类型描述

name

字符串

name 是问题的资源的名称。

target

对象

MetricTarget 定义特定指标的目标值、平均值或平均利用率

10.2.1.24. .spec.metrics[].resource.target

描述
MetricTarget 定义特定指标的目标值、平均值或平均利用率
类型
对象
必填
  • type
属性类型描述

averageUtilization

整数

averageUtilization 是所有相关 pod 中资源指标的平均目标值,以 pod 的资源值的百分比表示。目前仅对 Resource metric 源类型有效

averageValue

数量

AverageValue 是所有相关 pod 的指标平均值的目标值(作为数量)

type

字符串

type 代表指标类型是 Utilization、Value 或 AverageValue

value

数量

value 是指标的目标值(作为数量)。

10.2.1.25. .spec.scaleTargetRef

描述
CrossVersionObjectReference 包含足够信息,供您识别引用的资源。
类型
对象
必填
  • kind
  • name
属性类型描述

apiVersion

字符串

apiVersion 是引用的 API 版本

kind

字符串

kind 是引用的类型;更多信息: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

name

字符串

name 是引用的名称 ; 更多信息: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

10.2.1.26. .status

描述
HorizontalPodAutoscalerStatus 描述了 pod 横向自动扩展的当前状态。
类型
对象
必填
  • desiredReplicas
属性类型描述

conditions

array

条件是此自动扩展扩展其目标所需的条件集合,指示是否满足这些条件。

conditions[]

对象

HorizontalPodAutoscalerCondition 描述了 HorizontalPodAutoscaler 在特定点的状态。

currentMetrics

array

currentMetrics 是此自动扩展器使用的指标的最后读取状态。

currentMetrics[]

对象

MetricStatus 描述了单个指标的最后读取状态。

currentReplicas

整数

currentReplicas 是此自动扩展管理的 pod 副本数,如自动扩展器的最后一个所示。

desiredReplicas

整数

desiredReplicas 是此自动扩展管理的 pod 所需的副本数,如自动扩展器计算的最后计算。

lastScaleTime

时间

lastScaleTime 是 HorizontalPodAutoscaler 最后一次扩展 pod 数量的时间,供自动扩展器用于控制 pod 数量更改的频率。

observedGeneration

整数

observedGeneration 是此自动扩展观察到的最新生成。

10.2.1.27. .status.conditions

描述
条件是此自动扩展扩展其目标所需的条件集合,指示是否满足这些条件。
类型
array

10.2.1.28. .status.conditions[]

描述
HorizontalPodAutoscalerCondition 描述了 HorizontalPodAutoscaler 在特定点的状态。
类型
对象
必填
  • type
  • status
属性类型描述

lastTransitionTime

时间

lastTransitionTime 是条件从一个状态转换到另一个状态最后一次的时间

message

字符串

Message 是人类可读的解释,其中包含有关转换的详细信息

reason

字符串

reason 是条件最后一次转换的原因。

status

字符串

status 是条件的状态(True, False, Unknown)

type

字符串

type 描述了当前条件

10.2.1.29. .status.currentMetrics

描述
currentMetrics 是此自动扩展器使用的指标的最后读取状态。
类型
array

10.2.1.30. .status.currentMetrics[]

描述
MetricStatus 描述了单个指标的最后读取状态。
类型
对象
必填
  • type
属性类型描述

containerResource

对象

ContainerResourceMetricStatus 表示 Kubernetes 已知资源指标的当前值,如请求和限值中指定的资源指标,描述当前扩展目标中的每个 pod 中的单个容器(如 CPU 或内存)。此类指标内置在 Kubernetes 中,并在那些可用于使用 "pods" 源的普通每个 pod 指标上具有特殊的扩展选项。

external

对象

ExternalMetricStatus 表示没有与任何 Kubernetes 对象关联的全局指标的当前值。

对象

对象

ObjectMetricStatus 表示指标的当前值,描述 kubernetes 对象(如 Ingress 对象上的 hits-per-second)。

pods

对象

PodsMetricStatus 表示指标的当前值,用于描述当前 scale 目标中的每个 pod (如 transaction-processed-second)。

resource

对象

ResourceMetricStatus 表示 Kubernetes 已知的资源指标的当前值,如请求和限值中指定的,描述当前扩展目标中的每个 pod (如 CPU 或内存)。此类指标内置在 Kubernetes 中,并在那些可用于使用 "pods" 源的普通每个 pod 指标上具有特殊的扩展选项。

type

字符串

type 是指标源的类型。它将是 "ContainerResource", "External", "Object", "Pods" 或 "Resource" 之一,每个都对应于对象中的匹配字段。注:"ContainerResource" 类型在启用了 feature-gate HPAContainerMetrics 时可用

10.2.1.31. .status.currentMetrics[].containerResource

描述
ContainerResourceMetricStatus 表示 Kubernetes 已知资源指标的当前值,如请求和限值中指定的资源指标,描述当前扩展目标中的每个 pod 中的单个容器(如 CPU 或内存)。此类指标内置在 Kubernetes 中,并在那些可用于使用 "pods" 源的普通每个 pod 指标上具有特殊的扩展选项。
类型
对象
必填
  • name
  • current
  • container
属性类型描述

container

字符串

Container 是扩展目标 pod 中的容器的名称

current

对象

MetricValueStatus 包含指标的当前值

name

字符串

name 是问题的资源的名称。

10.2.1.32. .status.currentMetrics[].containerResource.current

描述
MetricValueStatus 包含指标的当前值
类型
对象
属性类型描述

averageUtilization

整数

currentAverageUtilization 是所有相关 pod 中资源指标的平均值的当前值,以 pod 的资源请求值的百分比表示。

averageValue

数量

AverageValue 是所有相关 pod 的指标平均值的当前值(作为数量)

value

数量

value 是指标的当前值(作为数量)。

10.2.1.33. .status.currentMetrics[].external

描述
ExternalMetricStatus 表示没有与任何 Kubernetes 对象关联的全局指标的当前值。
类型
对象
必填
  • metric
  • current
属性类型描述

current

对象

MetricValueStatus 包含指标的当前值

metric

对象

MetricIdentifier 定义指标的名称和可选选择器

10.2.1.34. .status.currentMetrics[].external.current

描述
MetricValueStatus 包含指标的当前值
类型
对象
属性类型描述

averageUtilization

整数

currentAverageUtilization 是所有相关 pod 中资源指标的平均值的当前值,以 pod 的资源请求值的百分比表示。

averageValue

数量

AverageValue 是所有相关 pod 的指标平均值的当前值(作为数量)

value

数量

value 是指标的当前值(作为数量)。

10.2.1.35. .status.currentMetrics[].external.metric

描述
MetricIdentifier 定义指标的名称和可选选择器
类型
对象
必填
  • name
属性类型描述

name

字符串

name 是给定指标的名称

selector

LabelSelector

选择器是给定指标时的标准 kubernetes 标签选择器的字符串编码形式,它将作为额外的参数传递给指标服务器,以获取更具体的指标范围。如果未设置,只需使用 metricName 来收集指标。

10.2.1.36. .status.currentMetrics[].object

描述
ObjectMetricStatus 表示指标的当前值,描述 kubernetes 对象(如 Ingress 对象上的 hits-per-second)。
类型
对象
必填
  • metric
  • current
  • describedObject
属性类型描述

current

对象

MetricValueStatus 包含指标的当前值

describedObject

对象

CrossVersionObjectReference 包含足够信息,供您识别引用的资源。

metric

对象

MetricIdentifier 定义指标的名称和可选选择器

10.2.1.37. .status.currentMetrics[].object.current

描述
MetricValueStatus 包含指标的当前值
类型
对象
属性类型描述

averageUtilization

整数

currentAverageUtilization 是所有相关 pod 中资源指标的平均值的当前值,以 pod 的资源请求值的百分比表示。

averageValue

数量

AverageValue 是所有相关 pod 的指标平均值的当前值(作为数量)

value

数量

value 是指标的当前值(作为数量)。

10.2.1.38. .status.currentMetrics[].object.describedObject

描述
CrossVersionObjectReference 包含足够信息,供您识别引用的资源。
类型
对象
必填
  • kind
  • name
属性类型描述

apiVersion

字符串

apiVersion 是引用的 API 版本

kind

字符串

kind 是引用的类型;更多信息: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

name

字符串

name 是引用的名称 ; 更多信息: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

10.2.1.39. .status.currentMetrics[].object.metric

描述
MetricIdentifier 定义指标的名称和可选选择器
类型
对象
必填
  • name
属性类型描述

name

字符串

name 是给定指标的名称

selector

LabelSelector

选择器是给定指标时的标准 kubernetes 标签选择器的字符串编码形式,它将作为额外的参数传递给指标服务器,以获取更具体的指标范围。如果未设置,只需使用 metricName 来收集指标。

10.2.1.40. .status.currentMetrics[].pods

描述
PodsMetricStatus 表示指标的当前值,用于描述当前 scale 目标中的每个 pod (如 transaction-processed-second)。
类型
对象
必填
  • metric
  • current
属性类型描述

current

对象

MetricValueStatus 包含指标的当前值

metric

对象

MetricIdentifier 定义指标的名称和可选选择器

10.2.1.41. .status.currentMetrics[].pods.current

描述
MetricValueStatus 包含指标的当前值
类型
对象
属性类型描述

averageUtilization

整数

currentAverageUtilization 是所有相关 pod 中资源指标的平均值的当前值,以 pod 的资源请求值的百分比表示。

averageValue

数量

AverageValue 是所有相关 pod 的指标平均值的当前值(作为数量)

value

数量

value 是指标的当前值(作为数量)。

10.2.1.42. .status.currentMetrics[].pods.metric

描述
MetricIdentifier 定义指标的名称和可选选择器
类型
对象
必填
  • name
属性类型描述

name

字符串

name 是给定指标的名称

selector

LabelSelector

选择器是给定指标时的标准 kubernetes 标签选择器的字符串编码形式,它将作为额外的参数传递给指标服务器,以获取更具体的指标范围。如果未设置,只需使用 metricName 来收集指标。

10.2.1.43. .status.currentMetrics[].resource

描述
ResourceMetricStatus 表示 Kubernetes 已知的资源指标的当前值,如请求和限值中指定的,描述当前扩展目标中的每个 pod (如 CPU 或内存)。此类指标内置在 Kubernetes 中,并在那些可用于使用 "pods" 源的普通每个 pod 指标上具有特殊的扩展选项。
类型
对象
必填
  • name
  • current
属性类型描述

current

对象

MetricValueStatus 包含指标的当前值

name

字符串

name 是问题的资源的名称。

10.2.1.44. .status.currentMetrics[].resource.current

描述
MetricValueStatus 包含指标的当前值
类型
对象
属性类型描述

averageUtilization

整数

currentAverageUtilization 是所有相关 pod 中资源指标的平均值的当前值,以 pod 的资源请求值的百分比表示。

averageValue

数量

AverageValue 是所有相关 pod 的指标平均值的当前值(作为数量)

value

数量

value 是指标的当前值(作为数量)。

10.2.2. API 端点

可用的 API 端点如下:

  • /apis/autoscaling/v2/horizontalpodautoscalers

    • GET: 列出或监视类型为 HorizontalPodAutoscaler 的对象
  • /apis/autoscaling/v2/watch/horizontalpodautoscalers

    • GET: 观察单个对 HorizontalPodAutoscaler 列表的更改。已弃用:改为使用 'watch' 参数和 list 操作。
  • /apis/autoscaling/v2/namespaces/{namespace}/horizontalpodautoscalers

    • DELETE :删除 HorizontalPodAutoscaler 的集合
    • GET: 列出或监视类型为 HorizontalPodAutoscaler 的对象
    • POST :创建一个 HorizontalPodAutoscaler
  • /apis/autoscaling/v2/watch/namespaces/{namespace}/horizontalpodautoscalers

    • GET: 观察单个对 HorizontalPodAutoscaler 列表的更改。已弃用:改为使用 'watch' 参数和 list 操作。
  • /apis/autoscaling/v2/namespaces/{namespace}/horizontalpodautoscalers/{name}

    • DELETE :删除 HorizontalPodAutoscaler
    • GET: 读取指定的 HorizontalPodAutoscaler
    • PATCH :部分更新指定的 HorizontalPodAutoscaler
    • PUT :替换指定的 HorizontalPodAutoscaler
  • /apis/autoscaling/v2/watch/namespaces/{namespace}/horizontalpodautoscalers/{name}

    • GET: 观察对类型为 HorizontalPodAutoscaler 的对象的更改。已弃用:使用带有列表操作的 'watch' 参数,而是过滤到带有 'fieldSelector' 参数的单个项目。
  • /apis/autoscaling/v2/namespaces/{namespace}/horizontalpodautoscalers/{name}/status

    • GET: 指定的 HorizontalPodAutoscaler 的读取状态
    • PATCH :部分更新指定 HorizontalPodAutoscaler 的状态
    • PUT :替换指定 HorizontalPodAutoscaler 的状态

10.2.2.1. /apis/autoscaling/v2/horizontalpodautoscalers

表 10.1. 全局查询参数
参数类型描述

allowWatchBookmarks

布尔值

allowWatchBookmarks请求类型为“BOOKMARK”的监视事件。没有实现书签的服务器可能会忽略这个标志和书签,由服务器自由裁量发送。客户端不应假设书签在任何特定间隔返回,也不会假定服务器在会话期间发送任何 BOOKMARK 事件。如果这不是监视,则忽略此字段。

继续

字符串

从服务器检索更多结果时,应设置 continue 选项。由于这个值是定义的服务器,因此客户端只能使用之前查询结果中的 continue 值,并带有相同的查询参数(除 continue 值除外),因此服务器可能会拒绝它无法识别的值。如果指定的 continue 值不再有效,无论是因为过期时间(通常为 5 到十五分钟)还是服务器上的配置更改,服务器将会与继续令牌一起响应 410 ResourceExpired 错误。如果客户端需要一致的列表,则必须重启其列表,而无需 continue 字段。否则,客户端可能会发送另一个带有 410 错误的令牌的列表请求,服务器将使用从下一个密钥开始的列表进行响应,但从最新的快照开始,从上一个列表结果(创建、修改或删除)后,创建、修改或删除第一个列表请求将包含在响应中,只要它们的键位于"下一密钥"后。

当监视为 true 时,不支持此字段。客户端可以从服务器返回的最后一个 resourceVersion 值开始监视,而不错过任何修改。

fieldSelector

字符串

用于按字段限制返回对象列表的选择器。默认为任何内容。

labelSelector

字符串

一个选择器,用于按标签限制返回的对象列表。默认为任何内容。

limit

整数

limit 是列表调用返回的最大响应数。如果存在更多项目,服务器会将列表元数据上的 'continue' 字段设置为可用于同一初始查询的值,以检索下一个结果集合。如果过滤了所有请求的对象,设置限制可能会小于请求的项目数量(最多零项),并且客户端应该只使用 continue 字段的存在来确定是否有可用的结果。服务器可能选择不支持 limit 参数,并将返回所有可用结果。如果指定了 limit,并且 continue 字段为空,客户端可能会假设没有更多结果可用。如果 watch 为 true,则不支持此字段。

服务器保证,在使用 continue 时返回的对象与在没有限制的情况下发出单个列表调用时返回的对象将相同,即在发出第一个请求后没有创建、修改或删除的对象。这有时被称为一致的快照,并确保使用限制的客户端接收大量结果的较小的块可以确保它们可以看到所有可能的对象。如果在块列表列表期间更新对象,则返回第一个列表结果时存在的对象版本。

pretty

字符串

如果 'true',则输出会输出。

resourceVersion

字符串

resourceVersion 对可能给请求提供服务的资源版本设置一个约束。详情请查看 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions

默认为未设置

resourceVersionMatch

字符串

resourceVersionMatch 决定 resourceVersion 如何应用到列表调用。强烈建议您为设置 resourceVersion 的列表调用设置 resourceVersionMatch,详情请参阅 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions

默认为未设置

sendInitialEvents

布尔值

'sendInitialEvents=true' 可以与 'watch=true' 一起设置。在这种情况下,监视流将以 synthetic 事件开头,以生成集合中对象的当前状态。发送完所有此类事件后,将发送一个合成"Bookmark"事件。书签将报告与一组对象对应的 ResourceVersion (RV),并标有 '"k8s.io/initial-events-end": "true"' 注解。之后,监视流会照常进行,将与更改对应的监控事件(subsequent to the RV)发送到被监视的对象。

当设置了 'sendInitialEvents' 选项时,我们还需要设置 'resourceVersionMatch' 选项。监视请求的语义如下: - 'resourceVersionMatch' = NotOlderThan 解释为 "data at the provided as the provided as the provided 'resourceVersion'",当状态同步到 'resourceVersion' 时,书签事件至少作为 ListOptions 提供的 "resourceVersion" 提供。如果未设置 'resourceVersion',则会将其解释为 "consistent read",并且当状态在请求开始处理时至少同步时,会发送书签事件。- 'resourceVersionMatch' 设置为任何其他值或取消设置 Invalid 错误。

如果 'resourceVersion="" 或 'resourceVersion="0"' (用于向后兼容的原因)和 false,则默认为 true。

timeoutSeconds

整数

list/watch 调用的超时。这限制了调用的持续时间,而不考虑任何活动或不活跃。

watch

布尔值

观察对上述资源的更改,并将其恢复为添加、更新和删除通知的流。指定 resourceVersion。

HTTP 方法
GET
描述
列出或监视 HorizontalPodAutoscaler 类型的对象
表 10.2. HTTP 响应
HTTP 代码响应正文

200 - OK

HorizontalPodAutoscalerList schema

401 - Unauthorized

10.2.2.2. /apis/autoscaling/v2/watch/horizontalpodautoscalers

表 10.3. 全局查询参数
参数类型描述

allowWatchBookmarks

布尔值

allowWatchBookmarks请求类型为“BOOKMARK”的监视事件。没有实现书签的服务器可能会忽略这个标志和书签,由服务器自由裁量发送。客户端不应假设书签在任何特定间隔返回,也不会假定服务器在会话期间发送任何 BOOKMARK 事件。如果这不是监视,则忽略此字段。

继续

字符串

从服务器检索更多结果时,应设置 continue 选项。由于这个值是定义的服务器,因此客户端只能使用之前查询结果中的 continue 值,并带有相同的查询参数(除 continue 值除外),因此服务器可能会拒绝它无法识别的值。如果指定的 continue 值不再有效,无论是因为过期时间(通常为 5 到十五分钟)还是服务器上的配置更改,服务器将会与继续令牌一起响应 410 ResourceExpired 错误。如果客户端需要一致的列表,则必须重启其列表,而无需 continue 字段。否则,客户端可能会发送另一个带有 410 错误的令牌的列表请求,服务器将使用从下一个密钥开始的列表进行响应,但从最新的快照开始,从上一个列表结果(创建、修改或删除)后,创建、修改或删除第一个列表请求将包含在响应中,只要它们的键位于"下一密钥"后。

当监视为 true 时,不支持此字段。客户端可以从服务器返回的最后一个 resourceVersion 值开始监视,而不错过任何修改。

fieldSelector

字符串

用于按字段限制返回对象列表的选择器。默认为任何内容。

labelSelector

字符串

一个选择器,用于按标签限制返回的对象列表。默认为任何内容。

limit

整数

limit 是列表调用返回的最大响应数。如果存在更多项目,服务器会将列表元数据上的 'continue' 字段设置为可用于同一初始查询的值,以检索下一个结果集合。如果过滤了所有请求的对象,设置限制可能会小于请求的项目数量(最多零项),并且客户端应该只使用 continue 字段的存在来确定是否有可用的结果。服务器可能选择不支持 limit 参数,并将返回所有可用结果。如果指定了 limit,并且 continue 字段为空,客户端可能会假设没有更多结果可用。如果 watch 为 true,则不支持此字段。

服务器保证,在使用 continue 时返回的对象与在没有限制的情况下发出单个列表调用时返回的对象将相同,即在发出第一个请求后没有创建、修改或删除的对象。这有时被称为一致的快照,并确保使用限制的客户端接收大量结果的较小的块可以确保它们可以看到所有可能的对象。如果在块列表列表期间更新对象,则返回第一个列表结果时存在的对象版本。

pretty

字符串

如果 'true',则输出会输出。

resourceVersion

字符串

resourceVersion 对可能给请求提供服务的资源版本设置一个约束。详情请查看 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions

默认为未设置

resourceVersionMatch

字符串

resourceVersionMatch 决定 resourceVersion 如何应用到列表调用。强烈建议您为设置 resourceVersion 的列表调用设置 resourceVersionMatch,详情请参阅 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions

默认为未设置

sendInitialEvents

布尔值

'sendInitialEvents=true' 可以与 'watch=true' 一起设置。在这种情况下,监视流将以 synthetic 事件开头,以生成集合中对象的当前状态。发送完所有此类事件后,将发送一个合成"Bookmark"事件。书签将报告与一组对象对应的 ResourceVersion (RV),并标有 '"k8s.io/initial-events-end": "true"' 注解。之后,监视流会照常进行,将与更改对应的监控事件(subsequent to the RV)发送到被监视的对象。

当设置了 'sendInitialEvents' 选项时,我们还需要设置 'resourceVersionMatch' 选项。监视请求的语义如下: - 'resourceVersionMatch' = NotOlderThan 解释为 "data at the provided as the provided as the provided 'resourceVersion'",当状态同步到 'resourceVersion' 时,书签事件至少作为 ListOptions 提供的 "resourceVersion" 提供。如果未设置 'resourceVersion',则会将其解释为 "consistent read",并且当状态在请求开始处理时至少同步时,会发送书签事件。- 'resourceVersionMatch' 设置为任何其他值或取消设置 Invalid 错误。

如果 'resourceVersion="" 或 'resourceVersion="0"' (用于向后兼容的原因)和 false,则默认为 true。

timeoutSeconds

整数

list/watch 调用的超时。这限制了调用的持续时间,而不考虑任何活动或不活跃。

watch

布尔值

观察对上述资源的更改,并将其恢复为添加、更新和删除通知的流。指定 resourceVersion。

HTTP 方法
GET
描述
观察单个对 HorizontalPodAutoscaler 列表的更改。已弃用:改为使用 'watch' 参数和 list 操作。
表 10.4. HTTP 响应
HTTP 代码响应正文

200 - OK

WatchEvent 模式

401 - Unauthorized

10.2.2.3. /apis/autoscaling/v2/namespaces/{namespace}/horizontalpodautoscalers

表 10.5. 全局路径参数
参数类型描述

namespace

字符串

对象名称和身份验证范围,如团队和项目

表 10.6. 全局查询参数
参数类型描述

pretty

字符串

如果 'true',则输出会输出。

HTTP 方法
DELETE
描述
删除 HorizontalPodAutoscaler 集合
表 10.7. 查询参数
参数类型描述

继续

字符串

从服务器检索更多结果时,应设置 continue 选项。由于这个值是定义的服务器,因此客户端只能使用之前查询结果中的 continue 值,并带有相同的查询参数(除 continue 值除外),因此服务器可能会拒绝它无法识别的值。如果指定的 continue 值不再有效,无论是因为过期时间(通常为 5 到十五分钟)还是服务器上的配置更改,服务器将会与继续令牌一起响应 410 ResourceExpired 错误。如果客户端需要一致的列表,则必须重启其列表,而无需 continue 字段。否则,客户端可能会发送另一个带有 410 错误的令牌的列表请求,服务器将使用从下一个密钥开始的列表进行响应,但从最新的快照开始,从上一个列表结果(创建、修改或删除)后,创建、修改或删除第一个列表请求将包含在响应中,只要它们的键位于"下一密钥"后。

当监视为 true 时,不支持此字段。客户端可以从服务器返回的最后一个 resourceVersion 值开始监视,而不错过任何修改。

dryRun

字符串

出现时,表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应,且请求不会被进一步处理。有效值为: - All: 所有预演阶段都将被处理

fieldSelector

字符串

用于按字段限制返回对象列表的选择器。默认为任何内容。

gracePeriodSeconds

整数

应该删除对象前的持续时间(以秒为单位)。值必须是非负整数。值零表示立即删除。如果这个值为 nil,则使用指定类型的默认宽限期。如果没有指定,则默认为每个对象值。零表示立即删除。

labelSelector

字符串

一个选择器,用于按标签限制返回的对象列表。默认为任何内容。

limit

整数

limit 是列表调用返回的最大响应数。如果存在更多项目,服务器会将列表元数据上的 'continue' 字段设置为可用于同一初始查询的值,以检索下一个结果集合。如果过滤了所有请求的对象,设置限制可能会小于请求的项目数量(最多零项),并且客户端应该只使用 continue 字段的存在来确定是否有可用的结果。服务器可能选择不支持 limit 参数,并将返回所有可用结果。如果指定了 limit,并且 continue 字段为空,客户端可能会假设没有更多结果可用。如果 watch 为 true,则不支持此字段。

服务器保证,在使用 continue 时返回的对象与在没有限制的情况下发出单个列表调用时返回的对象将相同,即在发出第一个请求后没有创建、修改或删除的对象。这有时被称为一致的快照,并确保使用限制的客户端接收大量结果的较小的块可以确保它们可以看到所有可能的对象。如果在块列表列表期间更新对象,则返回第一个列表结果时存在的对象版本。

orphanDependents

布尔值

deprecated :请使用 PropagationPolicy,此字段将在 1.7 中弃用。依赖的对象应该被孤立。如果为 true/false,则"orphan"终结器将从对象的终结器列表添加到/删除。可以设置此字段或 PropagationPolicy,但不能同时设置这两个字段。

propagationPolicy

字符串

是否以及如何执行垃圾回收。可以设置此字段或 OrphanDependents,但不能同时设置这两个字段。默认策略由 metadata.finalizers 和特定于资源的默认策略中设置的现有终结器决定。可接受值为:'Orphan' - 孤立依赖项; 'Background' - 允许垃圾收集器删除后台依赖的依赖项;'Foreground' - 一个级联策略,会删除前台所有依赖的级联策略。

resourceVersion

字符串

resourceVersion 对可能给请求提供服务的资源版本设置一个约束。详情请查看 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions

默认为未设置

resourceVersionMatch

字符串

resourceVersionMatch 决定 resourceVersion 如何应用到列表调用。强烈建议您为设置 resourceVersion 的列表调用设置 resourceVersionMatch,详情请参阅 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions

默认为未设置

sendInitialEvents

布尔值

'sendInitialEvents=true' 可以与 'watch=true' 一起设置。在这种情况下,监视流将以 synthetic 事件开头,以生成集合中对象的当前状态。发送完所有此类事件后,将发送一个合成"Bookmark"事件。书签将报告与一组对象对应的 ResourceVersion (RV),并标有 '"k8s.io/initial-events-end": "true"' 注解。之后,监视流会照常进行,将与更改对应的监控事件(subsequent to the RV)发送到被监视的对象。

当设置了 'sendInitialEvents' 选项时,我们还需要设置 'resourceVersionMatch' 选项。监视请求的语义如下: - 'resourceVersionMatch' = NotOlderThan 解释为 "data at the provided as the provided as the provided 'resourceVersion'",当状态同步到 'resourceVersion' 时,书签事件至少作为 ListOptions 提供的 "resourceVersion" 提供。如果未设置 'resourceVersion',则会将其解释为 "consistent read",并且当状态在请求开始处理时至少同步时,会发送书签事件。- 'resourceVersionMatch' 设置为任何其他值或取消设置 Invalid 错误。

如果 'resourceVersion="" 或 'resourceVersion="0"' (用于向后兼容的原因)和 false,则默认为 true。

timeoutSeconds

整数

list/watch 调用的超时。这限制了调用的持续时间,而不考虑任何活动或不活跃。

表 10.8. 主体参数
参数类型描述

正文(body)

DeleteOptions 模式

 
表 10.9. HTTP 响应
HTTP 代码响应正文

200 - OK

Status 模式

401 - Unauthorized

HTTP 方法
GET
描述
列出或监视 HorizontalPodAutoscaler 类型的对象
表 10.10. 查询参数
参数类型描述

allowWatchBookmarks

布尔值

allowWatchBookmarks请求类型为“BOOKMARK”的监视事件。没有实现书签的服务器可能会忽略这个标志和书签,由服务器自由裁量发送。客户端不应假设书签在任何特定间隔返回,也不会假定服务器在会话期间发送任何 BOOKMARK 事件。如果这不是监视,则忽略此字段。

继续

字符串

从服务器检索更多结果时,应设置 continue 选项。由于这个值是定义的服务器,因此客户端只能使用之前查询结果中的 continue 值,并带有相同的查询参数(除 continue 值除外),因此服务器可能会拒绝它无法识别的值。如果指定的 continue 值不再有效,无论是因为过期时间(通常为 5 到十五分钟)还是服务器上的配置更改,服务器将会与继续令牌一起响应 410 ResourceExpired 错误。如果客户端需要一致的列表,则必须重启其列表,而无需 continue 字段。否则,客户端可能会发送另一个带有 410 错误的令牌的列表请求,服务器将使用从下一个密钥开始的列表进行响应,但从最新的快照开始,从上一个列表结果(创建、修改或删除)后,创建、修改或删除第一个列表请求将包含在响应中,只要它们的键位于"下一密钥"后。

当监视为 true 时,不支持此字段。客户端可以从服务器返回的最后一个 resourceVersion 值开始监视,而不错过任何修改。

fieldSelector

字符串

用于按字段限制返回对象列表的选择器。默认为任何内容。

labelSelector

字符串

一个选择器,用于按标签限制返回的对象列表。默认为任何内容。

limit

整数

limit 是列表调用返回的最大响应数。如果存在更多项目,服务器会将列表元数据上的 'continue' 字段设置为可用于同一初始查询的值,以检索下一个结果集合。如果过滤了所有请求的对象,设置限制可能会小于请求的项目数量(最多零项),并且客户端应该只使用 continue 字段的存在来确定是否有可用的结果。服务器可能选择不支持 limit 参数,并将返回所有可用结果。如果指定了 limit,并且 continue 字段为空,客户端可能会假设没有更多结果可用。如果 watch 为 true,则不支持此字段。

服务器保证,在使用 continue 时返回的对象与在没有限制的情况下发出单个列表调用时返回的对象将相同,即在发出第一个请求后没有创建、修改或删除的对象。这有时被称为一致的快照,并确保使用限制的客户端接收大量结果的较小的块可以确保它们可以看到所有可能的对象。如果在块列表列表期间更新对象,则返回第一个列表结果时存在的对象版本。

resourceVersion

字符串

resourceVersion 对可能给请求提供服务的资源版本设置一个约束。详情请查看 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions

默认为未设置

resourceVersionMatch

字符串

resourceVersionMatch 决定 resourceVersion 如何应用到列表调用。强烈建议您为设置 resourceVersion 的列表调用设置 resourceVersionMatch,详情请参阅 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions

默认为未设置

sendInitialEvents

布尔值

'sendInitialEvents=true' 可以与 'watch=true' 一起设置。在这种情况下,监视流将以 synthetic 事件开头,以生成集合中对象的当前状态。发送完所有此类事件后,将发送一个合成"Bookmark"事件。书签将报告与一组对象对应的 ResourceVersion (RV),并标有 '"k8s.io/initial-events-end": "true"' 注解。之后,监视流会照常进行,将与更改对应的监控事件(subsequent to the RV)发送到被监视的对象。

当设置了 'sendInitialEvents' 选项时,我们还需要设置 'resourceVersionMatch' 选项。监视请求的语义如下: - 'resourceVersionMatch' = NotOlderThan 解释为 "data at the provided as the provided as the provided 'resourceVersion'",当状态同步到 'resourceVersion' 时,书签事件至少作为 ListOptions 提供的 "resourceVersion" 提供。如果未设置 'resourceVersion',则会将其解释为 "consistent read",并且当状态在请求开始处理时至少同步时,会发送书签事件。- 'resourceVersionMatch' 设置为任何其他值或取消设置 Invalid 错误。

如果 'resourceVersion="" 或 'resourceVersion="0"' (用于向后兼容的原因)和 false,则默认为 true。

timeoutSeconds

整数

list/watch 调用的超时。这限制了调用的持续时间,而不考虑任何活动或不活跃。

watch

布尔值

观察对上述资源的更改,并将其恢复为添加、更新和删除通知的流。指定 resourceVersion。

表 10.11. HTTP 响应
HTTP 代码响应正文

200 - OK

HorizontalPodAutoscalerList schema

401 - Unauthorized

HTTP 方法
POST
描述
create a HorizontalPodAutoscaler
表 10.12. 查询参数
参数类型描述

dryRun

字符串

出现时,表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应,且请求不会被进一步处理。有效值为: - All: 所有预演阶段都将被处理

fieldManager

字符串

fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长,且仅包含可打印的字符,如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。

fieldValidation

字符串

fieldValidation 指示服务器如何处理包含未知或重复字段的请求(POST/PUT/PATCH)中的对象。有效值为: - Ignore :这将忽略从对象静默丢弃的所有未知字段,并将忽略所有但解码器遇到的最后重复字段。这是 v1.23. - Warn: 在 v1.23 之前的默认行为:这会通过从对象丢弃的每个未知字段以及遇到的每个重复字段来发送警告。如果没有其他错误,请求仍会成功,且只保留任何重复字段的最后一个。这是 v1.23+ - Strict 的默认值:如果从对象中删除任何未知字段,或者存在任何重复字段,则会失败并显示 BadRequest 错误。从服务器返回的错误将包含遇到的所有未知和重复字段。

表 10.13. 主体参数
参数类型描述

正文(body)

HorizontalPodAutoscaler schema

 
表 10.14. HTTP 响应
HTTP 代码响应正文

200 - OK

HorizontalPodAutoscaler schema

201 - Created

HorizontalPodAutoscaler schema

202 - Accepted

HorizontalPodAutoscaler schema

401 - Unauthorized

10.2.2.4. /apis/autoscaling/v2/watch/namespaces/{namespace}/horizontalpodautoscalers

表 10.15. 全局路径参数
参数类型描述

namespace

字符串

对象名称和身份验证范围,如团队和项目

表 10.16. 全局查询参数
参数类型描述

allowWatchBookmarks

布尔值

allowWatchBookmarks请求类型为“BOOKMARK”的监视事件。没有实现书签的服务器可能会忽略这个标志和书签,由服务器自由裁量发送。客户端不应假设书签在任何特定间隔返回,也不会假定服务器在会话期间发送任何 BOOKMARK 事件。如果这不是监视,则忽略此字段。

继续

字符串

从服务器检索更多结果时,应设置 continue 选项。由于这个值是定义的服务器,因此客户端只能使用之前查询结果中的 continue 值,并带有相同的查询参数(除 continue 值除外),因此服务器可能会拒绝它无法识别的值。如果指定的 continue 值不再有效,无论是因为过期时间(通常为 5 到十五分钟)还是服务器上的配置更改,服务器将会与继续令牌一起响应 410 ResourceExpired 错误。如果客户端需要一致的列表,则必须重启其列表,而无需 continue 字段。否则,客户端可能会发送另一个带有 410 错误的令牌的列表请求,服务器将使用从下一个密钥开始的列表进行响应,但从最新的快照开始,从上一个列表结果(创建、修改或删除)后,创建、修改或删除第一个列表请求将包含在响应中,只要它们的键位于"下一密钥"后。

当监视为 true 时,不支持此字段。客户端可以从服务器返回的最后一个 resourceVersion 值开始监视,而不错过任何修改。

fieldSelector

字符串

用于按字段限制返回对象列表的选择器。默认为任何内容。

labelSelector

字符串

一个选择器,用于按标签限制返回的对象列表。默认为任何内容。

limit

整数

limit 是列表调用返回的最大响应数。如果存在更多项目,服务器会将列表元数据上的 'continue' 字段设置为可用于同一初始查询的值,以检索下一个结果集合。如果过滤了所有请求的对象,设置限制可能会小于请求的项目数量(最多零项),并且客户端应该只使用 continue 字段的存在来确定是否有可用的结果。服务器可能选择不支持 limit 参数,并将返回所有可用结果。如果指定了 limit,并且 continue 字段为空,客户端可能会假设没有更多结果可用。如果 watch 为 true,则不支持此字段。

服务器保证,在使用 continue 时返回的对象与在没有限制的情况下发出单个列表调用时返回的对象将相同,即在发出第一个请求后没有创建、修改或删除的对象。这有时被称为一致的快照,并确保使用限制的客户端接收大量结果的较小的块可以确保它们可以看到所有可能的对象。如果在块列表列表期间更新对象,则返回第一个列表结果时存在的对象版本。

pretty

字符串

如果 'true',则输出会输出。

resourceVersion

字符串

resourceVersion 对可能给请求提供服务的资源版本设置一个约束。详情请查看 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions

默认为未设置

resourceVersionMatch

字符串

resourceVersionMatch 决定 resourceVersion 如何应用到列表调用。强烈建议您为设置 resourceVersion 的列表调用设置 resourceVersionMatch,详情请参阅 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions

默认为未设置

sendInitialEvents

布尔值

'sendInitialEvents=true' 可以与 'watch=true' 一起设置。在这种情况下,监视流将以 synthetic 事件开头,以生成集合中对象的当前状态。发送完所有此类事件后,将发送一个合成"Bookmark"事件。书签将报告与一组对象对应的 ResourceVersion (RV),并标有 '"k8s.io/initial-events-end": "true"' 注解。之后,监视流会照常进行,将与更改对应的监控事件(subsequent to the RV)发送到被监视的对象。

当设置了 'sendInitialEvents' 选项时,我们还需要设置 'resourceVersionMatch' 选项。监视请求的语义如下: - 'resourceVersionMatch' = NotOlderThan 解释为 "data at the provided as the provided as the provided 'resourceVersion'",当状态同步到 'resourceVersion' 时,书签事件至少作为 ListOptions 提供的 "resourceVersion" 提供。如果未设置 'resourceVersion',则会将其解释为 "consistent read",并且当状态在请求开始处理时至少同步时,会发送书签事件。- 'resourceVersionMatch' 设置为任何其他值或取消设置 Invalid 错误。

如果 'resourceVersion="" 或 'resourceVersion="0"' (用于向后兼容的原因)和 false,则默认为 true。

timeoutSeconds

整数

list/watch 调用的超时。这限制了调用的持续时间,而不考虑任何活动或不活跃。

watch

布尔值

观察对上述资源的更改,并将其恢复为添加、更新和删除通知的流。指定 resourceVersion。

HTTP 方法
GET
描述
观察单个对 HorizontalPodAutoscaler 列表的更改。已弃用:改为使用 'watch' 参数和 list 操作。
表 10.17. HTTP 响应
HTTP 代码响应正文

200 - OK

WatchEvent 模式

401 - Unauthorized

10.2.2.5. /apis/autoscaling/v2/namespaces/{namespace}/horizontalpodautoscalers/{name}

表 10.18. 全局路径参数
参数类型描述

name

字符串

HorizontalPodAutoscaler 的名称

namespace

字符串

对象名称和身份验证范围,如团队和项目

表 10.19. 全局查询参数
参数类型描述

pretty

字符串

如果 'true',则输出会输出。

HTTP 方法
DELETE
描述
delete a HorizontalPodAutoscaler
表 10.20. 查询参数
参数类型描述

dryRun

字符串

出现时,表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应,且请求不会被进一步处理。有效值为: - All: 所有预演阶段都将被处理

gracePeriodSeconds

整数

应该删除对象前的持续时间(以秒为单位)。值必须是非负整数。值零表示立即删除。如果这个值为 nil,则使用指定类型的默认宽限期。如果没有指定,则默认为每个对象值。零表示立即删除。

orphanDependents

布尔值

deprecated :请使用 PropagationPolicy,此字段将在 1.7 中弃用。依赖的对象应该被孤立。如果为 true/false,则"orphan"终结器将从对象的终结器列表添加到/删除。可以设置此字段或 PropagationPolicy,但不能同时设置这两个字段。

propagationPolicy

字符串

是否以及如何执行垃圾回收。可以设置此字段或 OrphanDependents,但不能同时设置这两个字段。默认策略由 metadata.finalizers 和特定于资源的默认策略中设置的现有终结器决定。可接受值为:'Orphan' - 孤立依赖项; 'Background' - 允许垃圾收集器删除后台依赖的依赖项;'Foreground' - 一个级联策略,会删除前台所有依赖的级联策略。

表 10.21. 主体参数
参数类型描述

正文(body)

DeleteOptions 模式

 
表 10.22. HTTP 响应
HTTP 代码响应正文

200 - OK

Status 模式

202 - Accepted

Status 模式

401 - Unauthorized

HTTP 方法
GET
描述
阅读指定的 HorizontalPodAutoscaler
表 10.23. HTTP 响应
HTTP 代码响应正文

200 - OK

HorizontalPodAutoscaler schema

401 - Unauthorized

HTTP 方法
PATCH
描述
部分更新指定的 HorizontalPodAutoscaler
表 10.24. 查询参数
参数类型描述

dryRun

字符串

出现时,表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应,且请求不会被进一步处理。有效值为: - All: 所有预演阶段都将被处理

fieldManager

字符串

fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长,且仅包含可打印的字符,如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。应用请求需要此字段(application/apply-patch),但对于非应用补丁类型(JsonPatch、MergePatch、strategicMergePatch)是可选的。

fieldValidation

字符串

fieldValidation 指示服务器如何处理包含未知或重复字段的请求(POST/PUT/PATCH)中的对象。有效值为: - Ignore :这将忽略从对象静默丢弃的所有未知字段,并将忽略所有但解码器遇到的最后重复字段。这是 v1.23. - Warn: 在 v1.23 之前的默认行为:这会通过从对象丢弃的每个未知字段以及遇到的每个重复字段来发送警告。如果没有其他错误,请求仍会成功,且只保留任何重复字段的最后一个。这是 v1.23+ - Strict 的默认值:如果从对象中删除任何未知字段,或者存在任何重复字段,则会失败并显示 BadRequest 错误。从服务器返回的错误将包含遇到的所有未知和重复字段。

force

布尔值

强制尝试"强制"应用请求。这意味着用户将重新排序由其他人员拥有的冲突字段。对于非应用补丁请求,必须取消设置 force 标志。

表 10.25. 主体参数
参数类型描述

正文(body)

Patch 模式

 
表 10.26. HTTP 响应
HTTP 代码响应正文

200 - OK

HorizontalPodAutoscaler schema

201 - Created

HorizontalPodAutoscaler schema

401 - Unauthorized

HTTP 方法
PUT
描述
替换指定的 HorizontalPodAutoscaler
表 10.27. 查询参数
参数类型描述

dryRun

字符串

出现时,表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应,且请求不会被进一步处理。有效值为: - All: 所有预演阶段都将被处理

fieldManager

字符串

fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长,且仅包含可打印的字符,如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。

fieldValidation

字符串

fieldValidation 指示服务器如何处理包含未知或重复字段的请求(POST/PUT/PATCH)中的对象。有效值为: - Ignore :这将忽略从对象静默丢弃的所有未知字段,并将忽略所有但解码器遇到的最后重复字段。这是 v1.23. - Warn: 在 v1.23 之前的默认行为:这会通过从对象丢弃的每个未知字段以及遇到的每个重复字段来发送警告。如果没有其他错误,请求仍会成功,且只保留任何重复字段的最后一个。这是 v1.23+ - Strict 的默认值:如果从对象中删除任何未知字段,或者存在任何重复字段,则会失败并显示 BadRequest 错误。从服务器返回的错误将包含遇到的所有未知和重复字段。

表 10.28. 主体参数
参数类型描述

正文(body)

HorizontalPodAutoscaler schema

 
表 10.29. HTTP 响应
HTTP 代码响应正文

200 - OK

HorizontalPodAutoscaler schema

201 - Created

HorizontalPodAutoscaler schema

401 - Unauthorized

10.2.2.6. /apis/autoscaling/v2/watch/namespaces/{namespace}/horizontalpodautoscalers/{name}

表 10.30. 全局路径参数
参数类型描述

name

字符串

HorizontalPodAutoscaler 的名称

namespace

字符串

对象名称和身份验证范围,如团队和项目

表 10.31. 全局查询参数
参数类型描述

allowWatchBookmarks

布尔值

allowWatchBookmarks请求类型为“BOOKMARK”的监视事件。没有实现书签的服务器可能会忽略这个标志和书签,由服务器自由裁量发送。客户端不应假设书签在任何特定间隔返回,也不会假定服务器在会话期间发送任何 BOOKMARK 事件。如果这不是监视,则忽略此字段。

继续

字符串

从服务器检索更多结果时,应设置 continue 选项。由于这个值是定义的服务器,因此客户端只能使用之前查询结果中的 continue 值,并带有相同的查询参数(除 continue 值除外),因此服务器可能会拒绝它无法识别的值。如果指定的 continue 值不再有效,无论是因为过期时间(通常为 5 到十五分钟)还是服务器上的配置更改,服务器将会与继续令牌一起响应 410 ResourceExpired 错误。如果客户端需要一致的列表,则必须重启其列表,而无需 continue 字段。否则,客户端可能会发送另一个带有 410 错误的令牌的列表请求,服务器将使用从下一个密钥开始的列表进行响应,但从最新的快照开始,从上一个列表结果(创建、修改或删除)后,创建、修改或删除第一个列表请求将包含在响应中,只要它们的键位于"下一密钥"后。

当监视为 true 时,不支持此字段。客户端可以从服务器返回的最后一个 resourceVersion 值开始监视,而不错过任何修改。

fieldSelector

字符串

用于按字段限制返回对象列表的选择器。默认为任何内容。

labelSelector

字符串

一个选择器,用于按标签限制返回的对象列表。默认为任何内容。

limit

整数

limit 是列表调用返回的最大响应数。如果存在更多项目,服务器会将列表元数据上的 'continue' 字段设置为可用于同一初始查询的值,以检索下一个结果集合。如果过滤了所有请求的对象,设置限制可能会小于请求的项目数量(最多零项),并且客户端应该只使用 continue 字段的存在来确定是否有可用的结果。服务器可能选择不支持 limit 参数,并将返回所有可用结果。如果指定了 limit,并且 continue 字段为空,客户端可能会假设没有更多结果可用。如果 watch 为 true,则不支持此字段。

服务器保证,在使用 continue 时返回的对象与在没有限制的情况下发出单个列表调用时返回的对象将相同,即在发出第一个请求后没有创建、修改或删除的对象。这有时被称为一致的快照,并确保使用限制的客户端接收大量结果的较小的块可以确保它们可以看到所有可能的对象。如果在块列表列表期间更新对象,则返回第一个列表结果时存在的对象版本。

pretty

字符串

如果 'true',则输出会输出。

resourceVersion

字符串

resourceVersion 对可能给请求提供服务的资源版本设置一个约束。详情请查看 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions

默认为未设置

resourceVersionMatch

字符串

resourceVersionMatch 决定 resourceVersion 如何应用到列表调用。强烈建议您为设置 resourceVersion 的列表调用设置 resourceVersionMatch,详情请参阅 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions

默认为未设置

sendInitialEvents

布尔值

'sendInitialEvents=true' 可以与 'watch=true' 一起设置。在这种情况下,监视流将以 synthetic 事件开头,以生成集合中对象的当前状态。发送完所有此类事件后,将发送一个合成"Bookmark"事件。书签将报告与一组对象对应的 ResourceVersion (RV),并标有 '"k8s.io/initial-events-end": "true"' 注解。之后,监视流会照常进行,将与更改对应的监控事件(subsequent to the RV)发送到被监视的对象。

当设置了 'sendInitialEvents' 选项时,我们还需要设置 'resourceVersionMatch' 选项。监视请求的语义如下: - 'resourceVersionMatch' = NotOlderThan 解释为 "data at the provided as the provided as the provided 'resourceVersion'",当状态同步到 'resourceVersion' 时,书签事件至少作为 ListOptions 提供的 "resourceVersion" 提供。如果未设置 'resourceVersion',则会将其解释为 "consistent read",并且当状态在请求开始处理时至少同步时,会发送书签事件。- 'resourceVersionMatch' 设置为任何其他值或取消设置 Invalid 错误。

如果 'resourceVersion="" 或 'resourceVersion="0"' (用于向后兼容的原因)和 false,则默认为 true。

timeoutSeconds

整数

list/watch 调用的超时。这限制了调用的持续时间,而不考虑任何活动或不活跃。

watch

布尔值

观察对上述资源的更改,并将其恢复为添加、更新和删除通知的流。指定 resourceVersion。

HTTP 方法
GET
描述
观察对 kind HorizontalPodAutoscaler 的对象的更改。已弃用:使用带有列表操作的 'watch' 参数,而是过滤到带有 'fieldSelector' 参数的单个项目。
表 10.32. HTTP 响应
HTTP 代码响应正文

200 - OK

WatchEvent 模式

401 - Unauthorized

10.2.2.7. /apis/autoscaling/v2/namespaces/{namespace}/horizontalpodautoscalers/{name}/status

表 10.33. 全局路径参数
参数类型描述

name

字符串

HorizontalPodAutoscaler 的名称

namespace

字符串

对象名称和身份验证范围,如团队和项目

表 10.34. 全局查询参数
参数类型描述

pretty

字符串

如果 'true',则输出会输出。

HTTP 方法
GET
描述
指定 HorizontalPodAutoscaler 的读取状态
表 10.35. HTTP 响应
HTTP 代码响应正文

200 - OK

HorizontalPodAutoscaler schema

401 - Unauthorized

HTTP 方法
PATCH
描述
指定 HorizontalPodAutoscaler 的部分更新状态
表 10.36. 查询参数
参数类型描述

dryRun

字符串

出现时,表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应,且请求不会被进一步处理。有效值为: - All: 所有预演阶段都将被处理

fieldManager

字符串

fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长,且仅包含可打印的字符,如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。应用请求需要此字段(application/apply-patch),但对于非应用补丁类型(JsonPatch、MergePatch、strategicMergePatch)是可选的。

fieldValidation

字符串

fieldValidation 指示服务器如何处理包含未知或重复字段的请求(POST/PUT/PATCH)中的对象。有效值为: - Ignore :这将忽略从对象静默丢弃的所有未知字段,并将忽略所有但解码器遇到的最后重复字段。这是 v1.23. - Warn: 在 v1.23 之前的默认行为:这会通过从对象丢弃的每个未知字段以及遇到的每个重复字段来发送警告。如果没有其他错误,请求仍会成功,且只保留任何重复字段的最后一个。这是 v1.23+ - Strict 的默认值:如果从对象中删除任何未知字段,或者存在任何重复字段,则会失败并显示 BadRequest 错误。从服务器返回的错误将包含遇到的所有未知和重复字段。

force

布尔值

强制尝试"强制"应用请求。这意味着用户将重新排序由其他人员拥有的冲突字段。对于非应用补丁请求,必须取消设置 force 标志。

表 10.37. 主体参数
参数类型描述

正文(body)

Patch 模式

 
表 10.38. HTTP 响应
HTTP 代码响应正文

200 - OK

HorizontalPodAutoscaler schema

201 - Created

HorizontalPodAutoscaler schema

401 - Unauthorized

HTTP 方法
PUT
描述
替换指定 HorizontalPodAutoscaler 的状态
表 10.39. 查询参数
参数类型描述

dryRun

字符串

出现时,表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应,且请求不会被进一步处理。有效值为: - All: 所有预演阶段都将被处理

fieldManager

字符串

fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长,且仅包含可打印的字符,如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。

fieldValidation

字符串

fieldValidation 指示服务器如何处理包含未知或重复字段的请求(POST/PUT/PATCH)中的对象。有效值为: - Ignore :这将忽略从对象静默丢弃的所有未知字段,并将忽略所有但解码器遇到的最后重复字段。这是 v1.23. - Warn: 在 v1.23 之前的默认行为:这会通过从对象丢弃的每个未知字段以及遇到的每个重复字段来发送警告。如果没有其他错误,请求仍会成功,且只保留任何重复字段的最后一个。这是 v1.23+ - Strict 的默认值:如果从对象中删除任何未知字段,或者存在任何重复字段,则会失败并显示 BadRequest 错误。从服务器返回的错误将包含遇到的所有未知和重复字段。

表 10.40. 主体参数
参数类型描述

正文(body)

HorizontalPodAutoscaler schema

 
表 10.41. HTTP 响应
HTTP 代码响应正文

200 - OK

HorizontalPodAutoscaler schema

201 - Created

HorizontalPodAutoscaler schema

401 - Unauthorized

Red Hat logoGithubRedditYoutubeTwitter

学习

尝试、购买和销售

社区

关于红帽文档

通过我们的产品和服务,以及可以信赖的内容,帮助红帽用户创新并实现他们的目标。

让开源更具包容性

红帽致力于替换我们的代码、文档和 Web 属性中存在问题的语言。欲了解更多详情,请参阅红帽博客.

關於紅帽

我们提供强化的解决方案,使企业能够更轻松地跨平台和环境(从核心数据中心到网络边缘)工作。

© 2024 Red Hat, Inc.