---
api_metadata:
apiVersion: "autoscaling/v2"
import: "k8s.io/api/autoscaling/v2"
kind: "HorizontalPodAutoscaler"
content_type: "api_reference"
description: "HorizontalPodAutoscaler 是水平 Pod 自动扩缩器的配置，它根据指定的指标自动管理实现 scale 子资源的任何资源的副本数。"
title: "HorizontalPodAutoscaler"
weight: 14
---
`apiVersion: autoscaling/v2`
`import "k8s.io/api/autoscaling/v2"`
## HorizontalPodAutoscaler {#HorizontalPodAutoscaler}
HorizontalPodAutoscaler 是水平 Pod 自动扩缩器的配置，
它根据指定的指标自动管理实现 scale 子资源的任何资源的副本数。
- **apiVersion**: autoscaling/v2
- **kind**: HorizontalPodAutoscaler
- **metadata** (}}">ObjectMeta)
`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.
- **status** (}}">HorizontalPodAutoscalerStatus)
`status` 是自动扩缩器的当前信息。
## HorizontalPodAutoscalerSpec {#HorizontalPodAutoscalerSpec}
HorizontalPodAutoscalerSpec 描述了 HorizontalPodAutoscaler 预期的功能。
- **maxReplicas** (int32)，必需
`maxReplicas` 是自动扩缩器可以扩容的副本数的上限。不能小于 `minReplicas`。
- **scaleTargetRef** (CrossVersionObjectReference)，必需
`scaleTargetRef` 指向要扩缩的目标资源，用于收集 Pod 的相关指标信息以及实际更改的副本数。
**CrossVersionObjectReference 包含足够的信息来让你识别出所引用的资源。**
- **scaleTargetRef.kind** (string)，必需
`kind` 是被引用对象的类别；更多信息：
https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
- **scaleTargetRef.name** (string)，必需
`name` 是被引用对象的名称；更多信息：
https://kubernetes.io/zh-cn/docs/concepts/overview/working-with-objects/names/#names
- **scaleTargetRef.apiVersion** (string)
`apiVersion` 是被引用对象的 API 版本。
- **minReplicas** (int32)
`minReplicas` 是自动扩缩器可以缩减的副本数的下限。它默认为 1 个 Pod。
如果启用了 Alpha 特性门控 HPAScaleToZero 并且配置了至少一个 Object 或 External 度量指标，
则 `minReplicas` 允许为 0。只要至少有一个度量值可用，扩缩就处于活动状态。
- **behavior** (HorizontalPodAutoscalerBehavior)
`behavior` 配置目标在扩容（Up）和缩容（Down）两个方向的扩缩行为（分别用 `scaleUp` 和 `scaleDown` 字段）。
如果未设置，则会使用默认的 HPAScalingRules 进行扩缩容。
**HorizontalPodAutoscalerBehavior 配置目标在扩容（Up）和缩容（Down）两个方向的扩缩行为
（分别用 `scaleUp` 和 `scaleDown` 字段）。**
- **behavior.scaleDown** (HPAScalingRules)
`scaleDown` 是缩容策略。如果未设置，则默认值允许缩减到 `minReplicas` 数量的 Pod，
具有 300 秒的稳定窗口（使用最近 300 秒的最高推荐值）。
**HPAScalingRules** 配置一个方向上的扩缩行为，通过扩缩策略规则和可配置的对度量值的容差。
扩缩策略规则在根据 HPA 的度量值计算出期望的副本数后应用。它们可以通过指定扩缩策略来限制扩缩速度。
它们可以通过指定稳定窗口防止波动，这样不会立即设置副本数量，而是从稳定窗口中选择最安全的值。
容忍度应用于度量值，防止因度量的微小变化而过于急切地扩缩。
（注意，设置容忍度需要启用 Beta **特性门控** HPAConfigurableTolerance。）
- **behavior.scaleDown.policies** ([]HPAScalingPolicy)
*Atomic: will be replaced during a merge*
policies is a list of potential scaling polices which can be used during scaling. If not set, use the default values: - For scale up: allow doubling the number of pods, or an absolute change of 4 pods in a 15s window. - For scale down: allow all pods to be removed in a 15s window.
-->
HPAScalingRules 为一个方向配置扩缩行为。在根据 HPA 的指标计算 `desiredReplicas` 后应用这些规则。
可以通过指定扩缩策略来限制扩缩速度。可以通过指定稳定窗口来防止抖动，
因此不会立即设置副本数，而是选择稳定窗口中最安全的值。
- **behavior.scaleDown.policies** ([]HPAScalingPolicy)
**原子性：将在合并时被替换**
`policies` 是可在扩缩容过程中使用的潜在扩缩策略的列表。
如果未设置，使用默认值：
- 对于扩容：允许将 Pod 数量翻倍，或在 15 秒窗口内绝对增加 4 个 Pod。
- 对于缩容：允许在 15 秒窗口内移除所有 Pod。
**HPAScalingPolicy 是一个单一的策略，它必须在指定的过去时间间隔内保持为 true。**
- **behavior.scaleDown.policies.type** (string)，必需
type 用于指定扩缩策略。
- **behavior.scaleDown.policies.value** (int32)，必需
`value` 包含策略允许的更改量。它必须大于零。
- **behavior.scaleDown.policies.periodSeconds** (int32)，必需
`periodSeconds` 表示策略应该保持为 true 的时间窗口长度。
`periodSeconds` 必须大于零且小于或等于 1800（30 分钟）。
- **behavior.scaleDown.selectPolicy** (string)
`selectPolicy` 用于指定应该使用哪个策略。如果未设置，则使用默认值 Max。
- **behavior.scaleDown.stabilizationWindowSeconds** (int32)
`stabilizationWindowSeconds` 是在扩缩容时应考虑的之前建议的秒数。`stabilizationWindowSeconds`
必须大于或等于零且小于或等于 3600（一小时）。如果未设置，则使用默认值：
- 扩容：0（不设置稳定窗口）。
- 缩容：300（即稳定窗口为 300 秒）。
- **behavior.scaleDown.tolerance** (}}">Quantity)
`tolerance` 是当前的度量值和期望的指标值之间比率的容差，在此容差范围内，系统不会更新期望的副本数量
（例如，0.01 为 1%）。必须大于或等于零。如果未设置，则应用默认的集群范围容差
（默认为 10%）。
例如，如果配置了以 100Mi 的内存消耗为目标的自动扩缩容，
并且扩缩容的容差分别为 5% 和 1%，那么当实际消耗低于 95Mi
或超过 101Mi 时，将触发扩缩容。
这是一个 Beta 字段，需要启用 **HPAConfigurableTolerance** 特性门控。
- **behavior.scaleUp** (HPAScalingRules)
`scaleUp` 是用于扩容的扩缩策略。如果未设置，则默认值为以下值中的较高者：
* 每 60 秒增加不超过 4 个 Pod
* 每 60 秒 Pod 数量翻倍
不使用稳定窗口。
**HPAScalingRules** 配置了一个方向上的扩缩行为，通过扩缩策略规则和可配置的指标容忍度。
扩缩策略规则在根据 HPA 的指标计算出期望的副本数后应用。它们可以通过指定扩缩策略来限制扩缩速度。
它们可以通过指定稳定窗口防止波动，这样不会立即设置副本数量，而是从稳定窗口中选择最安全的值。
容忍度应用于指标值，防止因小的指标变化而过于急切地扩缩。
（注意，设置容忍度需要启用 Beta 特性门控 **HPAConfigurableTolerance**。）
- **behavior.scaleUp.policies** ([]HPAScalingPolicy)
**原子性：将在合并时被替换**
`policies` 是一个潜在的扩缩策略列表，可以在扩缩期间使用。如果未设置，则使用默认值：
- 对于扩容：允许将 Pod 数量翻倍，或在 15 秒窗口内绝对增加 4 个 Pod。
- 对于缩容：允许在 15 秒窗口内移除所有 Pod。
**HPAScalingPolicy 是一个单一的策略，它必须在指定的过去时间间隔内保持为 true。**
- **behavior.scaleUp.policies.type** (string)，必需
`type` 用于指定扩缩策略。
- **behavior.scaleUp.policies.value** (int32)，必需
`value` 包含策略允许的更改量。它必须大于零。
- **behavior.scaleUp.policies.periodSeconds** (int32)，必需
`periodSeconds` 表示策略应该保持为 true 的时间窗口长度。
`periodSeconds` 必须大于零且小于或等于 1800（30 分钟）。
- **behavior.scaleUp.selectPolicy** (string)
`selectPolicy` 用于指定应该使用哪个策略。如果未设置，则使用默认值 Max。
- **behavior.scaleUp.stabilizationWindowSeconds** (int32)
`stabilizationWindowSeconds` 是在扩缩容时应考虑的之前建议的秒数。`stabilizationWindowSeconds`
必须大于或等于零且小于或等于 3600（一小时）。如果未设置，则使用默认值：
- 扩容：0（不设置稳定窗口）。
- 缩容：300（即稳定窗口为 300 秒）。
- **behavior.scaleUp.tolerance** (}}">Quantity)
`tolerance` 是当前和期望的指标值之间比率的容差，
在此容差下不会更新期望的副本数量（例如，1% 为 0.01）。
必须大于或等于零。如果未设置，则应用默认的集群范围容差（默认为 10%）。
例如，如果配置了以 100Mi 的内存消耗为目标的自动扩缩容，
并且扩缩容的容差分别为 5% 和 1%，那么当实际消耗低于 95Mi
或超过 101Mi 时，将触发扩缩容。
这是一个 Beta 字段，需要启用 **HPAConfigurableTolerance** 特性门控。
- **metrics** ([]MetricSpec)
**原子性：将在合并时被替换**
`metrics` 包含用于计算预期副本数的规约（将使用所有指标的最大副本数）。
预期副本数是通过将目标值与当前值之间的比率乘以当前 Pod 数来计算的。
因此，使用的指标必须随着 Pod 数量的增加而减少，反之亦然。
有关每种类别的指标必须如何响应的更多信息，请参阅各个指标源类别。
如果未设置，默认指标将设置为 80% 的平均 CPU 利用率。
**MetricSpec 指定如何基于单个指标进行扩缩容（一次只能设置 `type` 和一个其他匹配字段）**
- **metrics.type** (string)，必需
`type` 是指标源的类别。它取值是 “ContainerResource”、“External”、“Object”、“Pods” 或 “Resource” 之一，
每个类别映射到对象中的一个对应的字段。
- **metrics.containerResource** (ContainerResourceMetricSource)
`containerResource` 是指 Kubernetes 已知的资源指标（例如在请求和限制中指定的那些），
描述当前扩缩目标中每个 Pod 中的单个容器（例如 CPU 或内存）。
此类指标内置于 Kubernetes 中，在使用 “pods” 源的、按 Pod 计算的普通指标之外，还具有一些特殊的扩缩选项。
ContainerResourceMetricSource 指示如何根据请求和限制中指定的 Kubernetes 已知的资源指标进行扩缩容，
此结构描述当前扩缩目标中的每个 Pod（例如 CPU 或内存）。在与目标值比较之前，这些值先计算平均值。
此类指标内置于 Kubernetes 中，并且在使用 “Pods” 源的、按 Pod 统计的普通指标之外支持一些特殊的扩缩选项。
只应设置一种 “target” 类别。
- **metrics.containerResource.container** (string)，必需
`container` 是扩缩目标的 Pod 中容器的名称。
- **metrics.containerResource.name** (string)，必需
`name` 是相关资源的名称。
- **metrics.containerResource.target** (MetricTarget)，必需
`target` 指定给定指标的目标值。
**MetricTarget 定义特定指标的目标值、平均值或平均利用率**
- **metrics.containerResource.target.type** (string)，必需
`type` 表示指标类别是 `Utilization`、`Value` 或 `AverageValue`。
- **metrics.containerResource.target.averageUtilization** (int32)
`averageUtilization` 是跨所有相关 Pod 的资源指标均值的目标值，
表示为 Pod 资源请求值的百分比。目前仅对 “Resource” 指标源类别有效。
- **metrics.containerResource.target.averageValue** (}}">Quantity)
是跨所有相关 Pod 的指标均值的目标值（以数量形式给出）。
- **metrics.containerResource.target.value** (}}">Quantity)
`value` 是指标的目标值（以数量形式给出）。
- **metrics.external** (ExternalMetricSource)
`external` 指的是不与任何 Kubernetes 对象关联的全局指标。
这一字段允许基于来自集群外部运行的组件（例如云消息服务中的队列长度，或来自运行在集群外部的负载均衡器的 QPS）的信息进行自动扩缩容。
ExternalMetricSource 指示如何基于 Kubernetes 对象无关的指标
（例如云消息传递服务中的队列长度，或来自集群外部运行的负载均衡器的 QPS）执行扩缩操作。
- **metrics.external.metric** (MetricIdentifier)，必需
`metric` 通过名称和选择算符识别目标指标。
**MetricIdentifier 定义指标的名称和可选的选择算符**
- **metrics.external.metric.name** (string)，必需
`name` 是给定指标的名称。
- **metrics.external.metric.selector** (}}">LabelSelector)
`selector` 是给定指标的标准 Kubernetes 标签选择算符的字符串编码形式。
设置后，它作为附加参数传递给指标服务器，以获取更具体的指标范围。
未设置时，仅 `metricName` 参数将用于收集指标。
- **metrics.external.target** (MetricTarget)，必需
`target` 指定给定指标的目标值。
**MetricTarget 定义特定指标的目标值、平均值或平均利用率**
- **metrics.external.target.type** (string)，必需
`type` 表示指标类别是 `Utilization`、`Value` 或 `AverageValue`。
- **metrics.external.target.averageUtilization** (int32)
`averageUtilization` 是跨所有相关 Pod 得到的资源指标均值的目标值，
表示为 Pod 资源请求值的百分比。目前仅对 “Resource” 指标源类别有效。
- **metrics.external.target.averageValue** (}}">Quantity)
`averageValue` 是跨所有相关 Pod 得到的指标均值的目标值（以数量形式给出）。
- **metrics.external.target.value** (}}">Quantity)
`value` 是指标的目标值（以数量形式给出）。
- **metrics.object** (ObjectMetricSource)
`object` 是指描述单个 Kubernetes 对象的指标（例如，Ingress 对象上的 `hits-per-second`）。
**ObjectMetricSource 表示如何根据描述 Kubernetes 对象的指标进行扩缩容（例如，Ingress 对象的 `hits-per-second`）**
- **metrics.object.describedObject** (CrossVersionObjectReference)，必需
`describeObject` 表示对象的描述，如对象的 `kind`、`name`、`apiVersion`。
**CrossVersionObjectReference 包含足够的信息来让你识别所引用的资源。**
- **metrics.object.describedObject.kind** (string)，必需
被引用对象的类别；更多信息：
https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
- **metrics.object.describedObject.name** (string)，必需
被引用对象的名称；更多信息： https://kubernetes.io/zh-cn/docs/concepts/overview/working-with-objects/names/#names
- **metrics.object.describedObject.apiVersion** (string)
被引用对象的 API 版本。
- **metrics.object.metric** (MetricIdentifier)，必需
metric 通过名称和选择算符识别目标指标。
**MetricIdentifier 定义指标的名称和可选的选择算符**
- **metrics.object.metric.name** (string)，必需
`name` 是给定指标的名称。
- **metrics.object.metric.selector** (}}">LabelSelector)
`selector` 是给定指标的标准 Kubernetes 标签选择算符的字符串编码形式。
设置后，它作为附加参数传递给指标服务器，以获取更具体的指标范围。
未设置时，仅 `metricName` 参数将用于收集指标。
- **metrics.object.target** (MetricTarget)，必需
`target` 表示给定指标的目标值。
**MetricTarget 定义特定指标的目标值、平均值或平均利用率**
- **metrics.object.target.type** (string)，必需
`type` 表示指标类别是 `Utilization`、`Value` 或 `AverageValue`。
- **metrics.object.target.averageUtilization** (int32)
`averageUtilization` 是跨所有相关 Pod 得出的资源指标均值的目标值，
表示为 Pod 资源请求值的百分比。目前仅对 “Resource” 指标源类别有效。
- **metrics.object.target.averageValue** (}}">Quantity)
`averageValue` 是跨所有 Pod 得出的指标均值的目标值（以数量形式给出）。
- **metrics.object.target.value** (}}">Quantity)
`value` 是指标的目标值（以数量形式给出）。
- **metrics.pods** (PodsMetricSource)
`pods` 是指描述当前扩缩目标中每个 Pod 的指标（例如，`transactions-processed-per-second`）。
在与目标值进行比较之前，这些指标值将被平均。
PodsMetricSource 表示如何根据描述当前扩缩目标中每个 Pod 的指标进行扩缩容（例如，`transactions-processed-per-second`）。
在与目标值进行比较之前，这些指标值将被平均。
- **metrics.pods.metric** (MetricIdentifier)，必需
`metric` 通过名称和选择算符识别目标指标。
**MetricIdentifier 定义指标的名称和可选的选择算符**
- **metrics.pods.metric.name** (string)，必需
`name` 是给定指标的名称。
- **metrics.pods.metric.selector** (}}">LabelSelector)
`selector` 是给定指标的标准 Kubernetes 标签选择算符的字符串编码形式。
设置后，它作为附加参数传递给指标服务器，以获取更具体的指标范围。
未设置时，仅 `metricName` 参数将用于收集指标。
- **metrics.pods.target** (MetricTarget)，必需
`target` 表示给定指标的目标值。
**MetricTarget 定义特定指标的目标值、平均值或平均利用率**
- **metrics.pods.target.type** (string)，必需
`type` 表示指标类别是 `Utilization`、`Value` 或 `AverageValue`。
- **metrics.pods.target.averageUtilization** (int32)
`averageUtilization` 是跨所有相关 Pod 得出的资源指标均值的目标值，
表示为 Pod 资源请求值的百分比。目前仅对 “Resource” 指标源类别有效。
- **metrics.pods.target.averageValue** (}}">Quantity)
averageValue 是跨所有 Pod 得出的指标均值的目标值（以数量形式给出）。
- **metrics.pods.target.value** (}}">Quantity)
value 是指标的目标值（以数量形式给出）。
- **metrics.resource** (ResourceMetricSource)
resource 是指 Kubernetes 已知的资源指标（例如在请求和限制中指定的那些），
此结构描述当前扩缩目标中的每个 Pod（例如 CPU 或内存）。此类指标内置于 Kubernetes 中，
并且在使用 “Pods” 源的、按 Pod 统计的普通指标之外支持一些特殊的扩缩选项。
ResourceMetricSource 指示如何根据请求和限制中指定的 Kubernetes 已知的资源指标进行扩缩容，
此结构描述当前扩缩目标中的每个 Pod（例如 CPU 或内存）。在与目标值比较之前，这些指标值将被平均。
此类指标内置于 Kubernetes 中，并且在使用 “Pods” 源的、按 Pod 统计的普通指标之外支持一些特殊的扩缩选项。
只应设置一种 “target” 类别。
- **metrics.resource.name** (string)，必需
name 是相关资源的名称。
- **metrics.resource.target** (MetricTarget)，必需
target 指定给定指标的目标值。
**MetricTarget 定义特定指标的目标值、平均值或平均利用率**
- **metrics.resource.target.type** (string)，必需
type 表示指标类别是 `Utilization`、`Value` 或 `AverageValue`。
- **metrics.resource.target.averageUtilization** (int32)
averageUtilization 是跨所有相关 Pod 得出的资源指标均值的目标值，
表示为 Pod 资源请求值的百分比。目前仅对 “Resource” 指标源类别有效。
- **metrics.resource.target.averageValue** (}}">Quantity)
averageValue 是跨所有 Pod 得出的指标均值的目标值（以数量形式给出）。
- **metrics.resource.target.value** (}}">Quantity)
value 是指标的目标值（以数量形式给出）。
## HorizontalPodAutoscalerStatus {#HorizontalPodAutoscalerStatus}
HorizontalPodAutoscalerStatus 描述了水平 Pod 自动扩缩器的当前状态。
- **desiredReplicas** (int32)，必需
desiredReplicas 是此自动扩缩器管理的 Pod 的所期望的副本数，由自动扩缩器最后计算。
- **conditions** ([]HorizontalPodAutoscalerCondition)
**补丁策略：基于键 `type` 合并**
**Map：合并时将保留 type 键的唯一值**
conditions 是此自动扩缩器扩缩其目标所需的一组条件，并指示是否满足这些条件。
**HorizontalPodAutoscalerCondition 描述 HorizontalPodAutoscaler 在某一时间点的状态。**
- **conditions.status** (string)，必需
status 是状况的状态（True、False、Unknown）。
- **conditions.type** (string)，必需
type 描述当前状况。
- **conditions.lastTransitionTime** (Time)
lastTransitionTime 是状况最近一次从一种状态转换到另一种状态的时间。
**Time 是对 time.Time 的封装。Time 支持对 YAML 和 JSON 进行正确封包。为 time 包的许多函数方法提供了封装器。**
- **conditions.message** (string)
message 是一个包含有关转换的可读的详细信息。
- **conditions.reason** (string)
reason 是状况最后一次转换的原因。
- **currentMetrics** ([]MetricStatus)
**原子性：将在合并期间被替换**
currentMetrics 是此自动扩缩器使用的指标的最后读取状态。
**MetricStatus 描述了单个指标的最后读取状态。**
- **currentMetrics.type** (string)，必需
type 是指标源的类别。它取值是 “ContainerResource”、“External”、“Object”、“Pods” 或 “Resource” 之一，
每个类别映射到对象中的一个对应的字段。
- **currentMetrics.containerResource** (ContainerResourceMetricStatus)
containerResource 是指 Kubernetes 已知的一种资源指标（例如在请求和限制中指定的那些），
描述当前扩缩目标中每个 Pod 中的单个容器（例如 CPU 或内存）。
此类指标内置于 Kubernetes 中，并且在使用 "Pods" 源的、按 Pod 统计的普通指标之外支持一些特殊的扩缩选项。
ContainerResourceMetricStatus 指示如何根据请求和限制中指定的 Kubernetes 已知的资源指标进行扩缩容，
此结构描述当前扩缩目标中的每个 Pod（例如 CPU 或内存）。此类指标内置于 Kubernetes 中，
并且在使用 “Pods” 源的、按 Pod 统计的普通指标之外支持一些特殊的扩缩选项。
- **currentMetrics.containerResource.container** (string)，必需
container 是扩缩目标的 Pod 中的容器名称。
- **currentMetrics.containerResource.current** (MetricValueStatus)，必需
current 包含给定指标的当前值。
**MetricValueStatus 保存指标的当前值**
- **currentMetrics.containerResource.current.averageUtilization** (int32)
averageUtilization 是跨所有相关 Pod 得出的资源指标均值的当前值，表示为 Pod 资源请求值的百分比。
- **currentMetrics.containerResource.current.averageValue** (}}">Quantity)
averageValue 是跨所有相关 Pod 的指标均值的当前值（以数量形式给出）。
- **currentMetrics.containerResource.current.value** (}}">Quantity)
value 是指标的当前值（以数量形式给出）。
- **currentMetrics.containerResource.name** (string)，必需
name 是相关资源的名称。
- **currentMetrics.external** (ExternalMetricStatus)
external 指的是不与任何 Kubernetes 对象关联的全局指标。这一字段允许基于来自集群外部运行的组件
（例如云消息服务中的队列长度，或来自集群外部运行的负载均衡器的 QPS）的信息进行自动扩缩。
**ExternalMetricStatus 表示与任何 Kubernetes 对象无关的全局指标的当前值。**
- **currentMetrics.external.current** (MetricValueStatus)，必需
current 包含给定指标的当前值。
**MetricValueStatus 保存指标的当前值**
- **currentMetrics.external.current.averageUtilization** (int32)
averageUtilization 是跨所有相关 Pod 得出的资源指标均值的当前值，表示为 Pod 资源请求值的百分比。
- **currentMetrics.external.current.averageValue** (}}">Quantity)
averageValue 是跨所有相关 Pod 的指标均值的当前值（以数量形式给出）。
- **currentMetrics.external.current.value** (}}">Quantity)
value 是指标的当前值（以数量形式给出）。
- **currentMetrics.external.metric** (MetricIdentifier)，必需
metric 通过名称和选择算符识别目标指标。
**MetricIdentifier 定义指标的名称和可选的选择算符**
- **currentMetrics.external.metric.name** (string)，必需
name 是给定指标的名称。
- **currentMetrics.external.metric.selector** (}}">LabelSelector)
selector 是给定指标的标准 Kubernetes 标签选择算符的字符串编码形式。
设置后，它作为附加参数传递给指标服务器，以获取更具体的指标范围。
未设置时，仅 metricName 参数将用于收集指标。
- **currentMetrics.object** (ObjectMetricStatus)
object 是指描述单个 Kubernetes 对象的指标（例如，Ingress 对象的 `hits-per-second`）。
**ObjectMetricStatus 表示描述 Kubernetes 对象的指标的当前值（例如，Ingress 对象的 `hits-per-second`）。**
- **currentMetrics.object.current** (MetricValueStatus)，必需
current 包含给定指标的当前值。
**MetricValueStatus 保存指标的当前值**
- **currentMetrics.object.current.averageUtilization** (int32)
averageUtilization 是跨所有相关 Pod 得出的资源指标均值的当前值，表示为 Pod 资源请求值的百分比。
- **currentMetrics.object.current.averageValue** (}}">Quantity)
averageValue 是跨所有相关 Pod 的指标均值的当前值（以数量形式给出）。
- **currentMetrics.object.current.value** (}}">Quantity)
value 是指标的当前值（以数量形式给出）。
- **currentMetrics.object.describedObject** (CrossVersionObjectReference)，必需
describeObject 表示对象的描述，如对象的 `kind`、`name`、`apiVersion`。
**CrossVersionObjectReference 包含足够的信息来让你识别所引用的资源。**
- **currentMetrics.object.describedObject.kind** (string)，必需
`kind` 是被引用对象的类别；更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
- **currentMetrics.object.describedObject.name** (string)，必需
被引用对象的名称；更多信息： https://kubernetes.io/zh-cn/docs/concepts/overview/working-with-objects/names/#names
- **currentMetrics.object.describedObject.apiVersion** (string)
被引用对象的 API 版本。
- **currentMetrics.object.metric** (MetricIdentifier)，必需
metric 通过名称和选择算符识别目标指标。
**MetricIdentifier 定义指标的名称和可选的选择算符**
- **currentMetrics.object.metric.name** (string)，必需
name 是给定指标的名称。
- **currentMetrics.object.metric.selector** (}}">LabelSelector)
selector 是给定指标的标准 Kubernetes 标签选择算符的字符串编码形式。
设置后，它作为附加参数传递给指标服务器，以获取更具体的指标范围。
未设置时，仅 metricName 参数将用于收集指标。
- **currentMetrics.pods** (PodsMetricStatus)
pods 是指描述当前扩缩目标中每个 Pod 的指标（例如，`transactions-processed-per-second`）。
在与目标值进行比较之前，这些指标值将被平均。
**PodsMetricStatus 表示描述当前扩缩目标中每个 Pod 的指标的当前值（例如，`transactions-processed-per-second`）。**
- **currentMetrics.pods.current** (MetricValueStatus)，必需
current 包含给定指标的当前值。
**MetricValueStatus 保存指标的当前值**
- **currentMetrics.pods.current.averageUtilization** (int32)
averageUtilization 是跨所有相关 Pod 得出的资源指标均值的当前值，表示为 Pod 资源请求值的百分比。
- **currentMetrics.pods.current.averageValue** (}}">Quantity)
averageValue 是跨所有相关 Pod 的指标均值的当前值（以数量形式给出）。
- **currentMetrics.pods.current.value** (}}">Quantity)
value 是指标的当前值（以数量形式给出）。
- **currentMetrics.pods.metric** (MetricIdentifier)，必需
metric 通过名称和选择算符识别目标指标。
**MetricIdentifier 定义指标的名称和可选的选择算符**
- **currentMetrics.pods.metric.name** (string)，必需
name 是给定指标的名称。
- **currentMetrics.pods.metric.selector** (}}">LabelSelector)
selector 是给定指标的标准 Kubernetes 标签选择算符的字符串编码形式。
设置后，它作为附加参数传递给指标服务器，以获取更具体的指标范围。
未设置时，仅 metricName 参数将用于收集指标。
- **currentMetrics.resource** (ResourceMetricStatus)
resource 是指 Kubernetes 已知的资源指标（例如在请求和限制中指定的那些），
此结构描述当前扩缩目标中的每个 Pod（例如 CPU 或内存）。此类指标内置于 Kubernetes 中，
并且在使用 “Pods” 源的、按 Pod 统计的普通指标之外支持一些特殊的扩缩选项。
ResourceMetricSource 指示如何根据请求和限制中指定的 Kubernetes 已知的资源指标进行扩缩容，
此结构描述当前扩缩目标中的每个 Pod（例如 CPU 或内存）。在与目标值比较之前，这些指标值将被平均。
此类指标内置于 Kubernetes 中，并且在使用 “Pods” 源的、按 Pod 统计的普通指标之外支持一些特殊的扩缩选项。
- **currentMetrics.resource.current** (MetricValueStatus)，必需
current 包含给定指标的当前值。
**MetricValueStatus 保存指标的当前值**
- **currentMetrics.resource.current.averageUtilization** (int32)
averageUtilization 是跨所有相关 Pod 得出的资源指标均值的当前值，
表示为 Pod 资源请求值的百分比。
- **currentMetrics.resource.current.averageValue** (}}">Quantity)
averageValue 是跨所有相关 Pod 的指标均值的当前值（以数量形式给出）。
- **currentMetrics.resource.current.value** (}}">Quantity)
value 是指标的当前值（以数量形式给出）。
- **currentMetrics.resource.name** (string)，必需
name 是相关资源的名称。
- **currentReplicas** (int32)
currentReplicas 是此自动扩缩器管理的 Pod 的当前副本数，如自动扩缩器最后一次看到的那样。
- **lastScaleTime** (Time)
lastScaleTime 是 HorizontalPodAutoscaler 上次扩缩 Pod 数量的时间，自动扩缩器使用它来控制更改 Pod 数量的频率。
**Time 是对 time.Time 的封装。Time 支持对 YAML 和 JSON 进行正确封包。为 time 包的许多函数方法提供了封装器。**
- **observedGeneration** (int64)
observedGeneration 是此自动扩缩器观察到的最新一代。
## HorizontalPodAutoscalerList {#HorizontalPodAutoscalerList}
HorizontalPodAutoscalerList 是水平 Pod 自动扩缩器对象列表。
- **apiVersion**: autoscaling/v2
- **kind**: HorizontalPodAutoscalerList
- **metadata** (}}">ListMeta)
metadata 是标准的列表元数据。
- **items** ([]}}">HorizontalPodAutoscaler)，必需
items 是水平 Pod 自动扩缩器对象的列表。
## Operations {#Operations}
### `get` 读取指定的 HorizontalPodAutoscaler
#### HTTP 请求
GET /apis/autoscaling/v2/namespaces/{namespace}/horizontalpodautoscalers/{name}
#### 参数
- **name** （**路径参数**）: string，必需
HorizontalPodAutoscaler 的名称。
- **namespace** （**路径参数**）: string，必需
}}">namespace
- **pretty** （**查询参数**）: string
}}">pretty
#### 响应
200 (}}">HorizontalPodAutoscaler): OK
401: Unauthorized
### `get` 读取指定 HorizontalPodAutoscaler 的状态
#### HTTP 请求
GET /apis/autoscaling/v2/namespaces/{namespace}/horizontalpodautoscalers/{name}/status
#### 参数
- **name** （**路径参数**）: string，必需
HorizontalPodAutoscaler 的名称。
- **namespace** （**路径参数**）: string，必需
}}">namespace
- **pretty** （**查询参数**）: string
}}">pretty
#### 响应
200 (}}">HorizontalPodAutoscaler): OK
401: Unauthorized
### `list` 列出或观察 HorizontalPodAutoscaler 类别的对象
#### HTTP 请求
GET /apis/autoscaling/v2/namespaces/{namespace}/horizontalpodautoscalers
#### 参数
- **namespace** （**路径参数**）: string，必需
}}">namespace
- **allowWatchBookmarks** （**查询参数**）: boolean
}}">allowWatchBookmarks
- **continue** （**查询参数**）: string
}}">continue
- **fieldSelector** （**查询参数**）: string
}}">fieldSelector
- **labelSelector** （**查询参数**）: string
}}">labelSelector
- **limit** （**查询参数**）: integer
}}">limit
- **pretty** （**查询参数**）: string
}}">pretty
- **resourceVersion** （**查询参数**）: string
}}">resourceVersion
- **resourceVersionMatch** （**查询参数**）: string
}}">resourceVersionMatch
- **sendInitialEvents** （**查询参数**）: boolean
}}">sendInitialEvents
- **shardSelector** （**查询参数**）: string
}}">shardSelector
- **timeoutSeconds** （**查询参数**）: integer
}}">timeoutSeconds
- **watch** （**查询参数**）: boolean
}}">watch
#### 响应
200 (}}">HorizontalPodAutoscalerList): OK
401: Unauthorized
### `list` 列出或观察 HorizontalPodAutoscaler 类别的对象
#### HTTP 请求
GET /apis/autoscaling/v2/horizontalpodautoscalers
#### 参数
- **allowWatchBookmarks** （**查询参数**）: boolean
}}">allowWatchBookmarks
- **continue** （**查询参数**）: string
}}">continue
- **fieldSelector** （**查询参数**）: string
}}">fieldSelector
- **labelSelector** （**查询参数**）: string
}}">labelSelector
- **limit** （**查询参数**）: integer
}}">limit
- **pretty** （**查询参数**）: string
}}">pretty
- **resourceVersion** （**查询参数**）: string
}}">resourceVersion
- **resourceVersionMatch** （**查询参数**）: string
}}">resourceVersionMatch
- **sendInitialEvents** （**查询参数**）: boolean
}}">sendInitialEvents
- **shardSelector** （**查询参数**）: string
}}">shardSelector
- **timeoutSeconds** （**查询参数**）: integer
}}">timeoutSeconds
- **watch** （**查询参数**）: boolean
}}">watch
#### 响应
200 (}}">HorizontalPodAutoscalerList): OK
401: Unauthorized
### `create` 创建一个 HorizontalPodAutoscaler
#### HTTP 请求
POST /apis/autoscaling/v2/namespaces/{namespace}/horizontalpodautoscalers
#### 参数
- **namespace** （**路径参数**）: string，必需
}}">namespace
- **body**：}}">HorizontalPodAutoscaler，必需
- **dryRun** （**查询参数**）: string
}}">dryRun
- **fieldManager** （**查询参数**）: string
}}">fieldManager
- **fieldValidation** （**查询参数**）: string
}}">fieldValidation
- **pretty** （**查询参数**）: string
}}">pretty
#### 响应
200 (}}">HorizontalPodAutoscaler): OK
201 (}}">HorizontalPodAutoscaler): Created
202 (}}">HorizontalPodAutoscaler): Accepted
401: Unauthorized
### `update` 替换指定的 HorizontalPodAutoscaler
#### HTTP 请求
PUT /apis/autoscaling/v2/namespaces/{namespace}/horizontalpodautoscalers/{name}
#### 参数
- **name** （**路径参数**）: string，必需
HorizontalPodAutoscaler 的名称。
- **namespace** （**路径参数**）: string，必需
}}">namespace
- **body**：}}">HorizontalPodAutoscaler，必需
- **dryRun** （**查询参数**）: string
}}">dryRun
- **fieldManager** （**查询参数**）: string
}}">fieldManager
- **fieldValidation** （**查询参数**）: string
}}">fieldValidation
- **pretty** （**查询参数**）: string
}}">pretty
#### 响应
200 (}}">HorizontalPodAutoscaler): OK
201 (}}">HorizontalPodAutoscaler): Created
401: Unauthorized
### `update` 替换指定 HorizontalPodAutoscaler 的状态
#### HTTP 请求
PUT /apis/autoscaling/v2/namespaces/{namespace}/horizontalpodautoscalers/{name}/status
#### 参数
- **name** （**路径参数**）: string，必需
HorizontalPodAutoscaler 的名称。
- **namespace** （**路径参数**）: string，必需
}}">namespace
- **body**：}}">HorizontalPodAutoscaler，必需
- **dryRun** （**查询参数**）: string
}}">dryRun
- **fieldManager** （**查询参数**）: string
}}">fieldManager
- **fieldValidation** （**查询参数**）: string
}}">fieldValidation
- **pretty** （**查询参数**）: string
}}">pretty
#### 响应
200 (}}">HorizontalPodAutoscaler): OK
201 (}}">HorizontalPodAutoscaler): Created
401: Unauthorized
### `patch` 部分更新指定的 HorizontalPodAutoscaler
#### HTTP 请求
PATCH /apis/autoscaling/v2/namespaces/{namespace}/horizontalpodautoscalers/{name}
#### 参数
- **name** （**路径参数**）: string，必需
HorizontalPodAutoscaler 的名称。
- **namespace** （**路径参数**）: string，必需
}}">namespace
- **body**：}}">Patch，必需
- **dryRun** （**查询参数**）: string
}}">dryRun
- **fieldManager** （**查询参数**）: string
}}">fieldManager
- **fieldValidation** （**查询参数**）: string
}}">fieldValidation
- **force** （**查询参数**）: boolean
}}">force
- **pretty** （**查询参数**）: string
}}">pretty
#### 响应
200 (}}">HorizontalPodAutoscaler): OK
201 (}}">HorizontalPodAutoscaler): Created
401: Unauthorized
### `patch` 部分更新指定 HorizontalPodAutoscaler 的状态
#### HTTP 请求
PATCH /apis/autoscaling/v2/namespaces/{namespace}/horizontalpodautoscalers/{name}/status
#### 参数
- **name** （**路径参数**）: string，必需
HorizontalPodAutoscaler 的名称。
- **namespace** （**路径参数**）: string，必需
}}">namespace
- **body**：}}">Patch，必需
- **dryRun** （**查询参数**）: string
}}">dryRun
- **fieldManager** （**查询参数**）: string
}}">fieldManager
- **fieldValidation** （**查询参数**）: string
}}">fieldValidation
- **force** （**查询参数**）: boolean
}}">force
- **pretty** （**查询参数**）: string
}}">pretty
#### 响应
200 (}}">HorizontalPodAutoscaler): OK
201 (}}">HorizontalPodAutoscaler): Created
401: Unauthorized
### `delete` 删除一个 HorizontalPodAutoscaler
#### HTTP 请求
DELETE /apis/autoscaling/v2/namespaces/{namespace}/horizontalpodautoscalers/{name}
#### 参数
- **name** （**路径参数**）: string，必需
HorizontalPodAutoscaler 的名称。
- **namespace** （**路径参数**）: string，必需
}}">namespace
- **body**: }}">DeleteOptions
- **dryRun** （**查询参数**）: string
}}">dryRun
- **gracePeriodSeconds** （**查询参数**）: integer
}}">gracePeriodSeconds
- **ignoreStoreReadErrorWithClusterBreakingPotential** （**查询参数**）: boolean
}}">ignoreStoreReadErrorWithClusterBreakingPotential
- **pretty** （**查询参数**）: string
}}">pretty
- **propagationPolicy** （**查询参数**）: string
}}">propagationPolicy
#### 响应
200 (}}">Status): OK
202 (}}">Status): Accepted
401: Unauthorized
### `deletecollection` 删除 HorizontalPodAutoscaler 的集合
#### HTTP 请求
DELETE /apis/autoscaling/v2/namespaces/{namespace}/horizontalpodautoscalers
#### 参数
- **namespace** （**路径参数**）: string，必需
}}">namespace
- **body**: }}">DeleteOptions
- **continue** （**查询参数**）: string
}}">continue
- **dryRun** （**查询参数**）: string
}}">dryRun
- **fieldSelector** （**查询参数**）: string
}}">fieldSelector
- **gracePeriodSeconds** （**查询参数**）: integer
}}">gracePeriodSeconds
- **ignoreStoreReadErrorWithClusterBreakingPotential** （**查询参数**）: boolean
}}">ignoreStoreReadErrorWithClusterBreakingPotential
- **labelSelector** （**查询参数**）: string
}}">labelSelector
- **limit** （**查询参数**）: integer
}}">limit
- **pretty** （**查询参数**）: string
}}">pretty
- **propagationPolicy** （**查询参数**）: string
}}">propagationPolicy
- **resourceVersion** （**查询参数**）: string
}}">resourceVersion
- **resourceVersionMatch** （**查询参数**）: string
}}">resourceVersionMatch
- **sendInitialEvents** （**查询参数**）: boolean
}}">sendInitialEvents
- **shardSelector** （**查询参数**）: string
}}">shardSelector
- **timeoutSeconds** （**查询参数**）: integer
}}">timeoutSeconds
#### 响应
200 (}}">Status): OK
401: Unauthorized