10.2. HorizontalPodAutoscaler [autoscaling/v2]
- 描述
- HorizontalPodAutoscaler 是 pod 横向自动扩展的配置,它根据指定的指标自动管理任何资源的副本数。
- 类型
-
对象
10.2.1. 规格
属性 | 类型 | 描述 |
---|---|---|
|
| APIVersion 定义对象的这个表示法的版本化的 schema。服务器应该将识别的模式转换为最新的内部值,并可拒绝未识别的值。更多信息: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources |
|
| kind 是一个字符串值,代表此对象所代表的 REST 资源。服务器可以从客户端向其提交请求的端点推断。无法更新。采用驼峰拼写法 (CamelCase)。更多信息: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
| metadata 是标准对象元数据。更多信息: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata | |
|
| HorizontalPodAutoscalerSpec 描述了 HorizontalPodAutoscaler 所需的功能。 |
|
| HorizontalPodAutoscalerStatus 描述了 pod 横向自动扩展的当前状态。 |
10.2.1.1. .spec
- 描述
- HorizontalPodAutoscalerSpec 描述了 HorizontalPodAutoscaler 所需的功能。
- 类型
-
object
- 必填
-
scaleTargetRef
-
maxReplicas
-
属性 | 类型 | 描述 |
---|---|---|
|
| HorizontalPodAutoscalerBehavior 在 Up 和 Down directions (scaleUp 和 scaleDown 字段)中分别配置目标的扩展行为。 |
|
| maxReplicas 是自动扩展可以向上扩展的副本数的上限。minReplicas 不能小于该 minReplicas。 |
|
| 指标包含用于计算所需副本数的规格(将使用所有指标的最大副本数)。所需的副本数乘以 target 值与当前 pod 数量之间的比率。在增加 pod 数量时,使用的指标必须减少,反之亦然。如需有关每种指标类型如何响应的更多信息,请参阅单独的指标源类型。如果没有设置,则默认指标将设置为 80% 平均 CPU 使用率。 |
|
|
MetricSpec 根据单一指标指定如何缩放(仅应一次设置 |
|
| minReplicas 是自动扩展可以缩减的副本数的下限。如果启用了 alpha 功能门 HPAScaleToZero,并且至少配置一个 Object 或 External 指标,则默认为 1 个 pod。minReplicas 允许为 0。只要至少有一个指标值可用,缩放就会激活。 |
|
| CrossVersionObjectReference 包含足够信息,以便您识别引用的资源。 |
10.2.1.2. .spec.behavior
- 描述
- HorizontalPodAutoscalerBehavior 在 Up 和 Down directions (scaleUp 和 scaleDown 字段)中分别配置目标的扩展行为。
- 类型
-
object
属性 | 类型 | 描述 |
---|---|---|
|
| HPAScalingRules 为一个方向配置扩展行为。这些规则在从 HPA 的指标计算 DesiredReplicas 后应用。它们可以通过指定扩展策略来限制扩展速度。它们可以通过指定 stabilization 窗口来防止阻塞,因此不会立即设置副本数,而是从 stabilization 窗口中选择安全的值。 |
|
| HPAScalingRules 为一个方向配置扩展行为。这些规则在从 HPA 的指标计算 DesiredReplicas 后应用。它们可以通过指定扩展策略来限制扩展速度。它们可以通过指定 stabilization 窗口来防止阻塞,因此不会立即设置副本数,而是从 stabilization 窗口中选择安全的值。 |
10.2.1.3. .spec.behavior.scaleDown
- 描述
- HPAScalingRules 为一个方向配置扩展行为。这些规则在从 HPA 的指标计算 DesiredReplicas 后应用。它们可以通过指定扩展策略来限制扩展速度。它们可以通过指定 stabilization 窗口来防止阻塞,因此不会立即设置副本数,而是从 stabilization 窗口中选择安全的值。
- 类型
-
object
属性 | 类型 | 描述 |
---|---|---|
|
| 策略是可以在扩展过程中使用的潜在缩放策略列表。必须至少指定一个策略,否则 HPAScalingRules 将被丢弃为无效 |
|
| HPAScalingPolicy 是一个单一策略,对于指定间隔,必须为 true。 |
|
| selectPolicy 用于指定要使用的策略。如果没有设置,则使用默认值 Max。 |
|
| stabilizationWindowSeconds 是扩展或缩减时应考虑过去建议的秒数。stabilizationWindowSeconds 必须大于或等于 0,且小于或等于 3600 (一小时)。如果没有设置,请使用默认值: - 要扩展:0 (即没有稳定的静默功能)。- 要缩减 300 (例如,stabilization window 为 300 秒)。 |
10.2.1.4. .spec.behavior.scaleDown.policies
- 描述
- 策略是可以在扩展过程中使用的潜在缩放策略列表。必须至少指定一个策略,否则 HPAScalingRules 将被丢弃为无效
- 类型
-
数组
10.2.1.5. .spec.behavior.scaleDown.policies[]
- 描述
- HPAScalingPolicy 是一个单一策略,对于指定间隔,必须为 true。
- 类型
-
object
- 必填
-
type
-
value
-
periodSeconds
-
属性 | 类型 | 描述 |
---|---|---|
|
| periodSeconds 指定策略应为 true 的时间窗口。periodSeconds 必须大于零,且小于或等于 1800 (30 分钟)。 |
|
| type 用于指定扩展策略。 |
|
| 值包含策略所允许的更改量。它必须大于零 |
10.2.1.6. .spec.behavior.scaleUp
- 描述
- HPAScalingRules 为一个方向配置扩展行为。这些规则在从 HPA 的指标计算 DesiredReplicas 后应用。它们可以通过指定扩展策略来限制扩展速度。它们可以通过指定 stabilization 窗口来防止阻塞,因此不会立即设置副本数,而是从 stabilization 窗口中选择安全的值。
- 类型
-
object
属性 | 类型 | 描述 |
---|---|---|
|
| 策略是可以在扩展过程中使用的潜在缩放策略列表。必须至少指定一个策略,否则 HPAScalingRules 将被丢弃为无效 |
|
| HPAScalingPolicy 是一个单一策略,对于指定间隔,必须为 true。 |
|
| selectPolicy 用于指定要使用的策略。如果没有设置,则使用默认值 Max。 |
|
| stabilizationWindowSeconds 是扩展或缩减时应考虑过去建议的秒数。stabilizationWindowSeconds 必须大于或等于 0,且小于或等于 3600 (一小时)。如果没有设置,请使用默认值: - 要扩展:0 (即没有稳定的静默功能)。- 要缩减 300 (例如,stabilization window 为 300 秒)。 |
10.2.1.7. .spec.behavior.scaleUp.policies
- 描述
- 策略是可以在扩展过程中使用的潜在缩放策略列表。必须至少指定一个策略,否则 HPAScalingRules 将被丢弃为无效
- 类型
-
数组
10.2.1.8. .spec.behavior.scaleUp.policies[]
- 描述
- HPAScalingPolicy 是一个单一策略,对于指定间隔,必须为 true。
- 类型
-
object
- 必填
-
type
-
value
-
periodSeconds
-
属性 | 类型 | 描述 |
---|---|---|
|
| periodSeconds 指定策略应为 true 的时间窗口。periodSeconds 必须大于零,且小于或等于 1800 (30 分钟)。 |
|
| type 用于指定扩展策略。 |
|
| 值包含策略所允许的更改量。它必须大于零 |
10.2.1.9. .spec.metrics
- 描述
- 指标包含用于计算所需副本数的规格(将使用所有指标的最大副本数)。所需的副本数乘以 target 值与当前 pod 数量之间的比率。在增加 pod 数量时,使用的指标必须减少,反之亦然。如需有关每种指标类型如何响应的更多信息,请参阅单独的指标源类型。如果没有设置,则默认指标将设置为 80% 平均 CPU 使用率。
- 类型
-
数组
10.2.1.10. .spec.metrics[]
- 描述
-
MetricSpec 根据单一指标指定如何缩放(仅应一次设置
类型和
另一个匹配字段)。 - 类型
-
object
- 必填
-
type
-
属性 | 类型 | 描述 |
---|---|---|
|
| ContainerResourceMetricSource 指示如何扩展 Kubernetes 已知的资源指标,如请求和限值中指定的,描述当前 scale 目标中的每个 pod (如 CPU 或内存)。与目标相比,这些值将平均合上。此类指标内置在 Kubernetes 中,并且具有特殊的扩展选项,它们之上使用 "pods" 源的普通每个 pod 指标。应该只设置一个"目标"类型。 |
|
| ExternalMetricSource 表示如何在不与任何 Kubernetes 对象关联的指标上扩展(例如,云消息传递服务中的队列长度,或从集群外运行的 loadbalancer 中的 QPS)。 |
|
| ObjectMetricSource 指示如何在描述 kubernetes 对象的指标上缩放(例如,Ingress 对象上的 hits-per-second)。 |
|
| PodsMetricSource 表示如何在当前 scale 目标中描述每个 pod 的指标(例如,Transaction-processed-per-second)。这些值在与 target 值进行比较之前会平均在一起。 |
|
| ResourceMetricSource 指示如何缩放 Kubernetes 已知资源指标(如请求和限值中指定的),描述当前规模目标中的每个 pod (如 CPU 或内存)。与目标相比,这些值将平均合上。此类指标内置在 Kubernetes 中,并且具有特殊的扩展选项,它们之上使用 "pods" 源的普通每个 pod 指标。应该只设置一个"目标"类型。 |
|
| type 是指标源的类型。它应该是 "ContainerResource", "External", "Object", "Pods" 或 "Resource" 之一,每个映射到对象中的匹配字段。注:"ContainerResource" 类型在启用了 feature-gate HPAContainerMetrics 时可用 |
10.2.1.11. .spec.metrics[].containerResource
- 描述
- ContainerResourceMetricSource 指示如何扩展 Kubernetes 已知的资源指标,如请求和限值中指定的,描述当前 scale 目标中的每个 pod (如 CPU 或内存)。与目标相比,这些值将平均合上。此类指标内置在 Kubernetes 中,并且具有特殊的扩展选项,它们之上使用 "pods" 源的普通每个 pod 指标。应该只设置一个"目标"类型。
- 类型
-
object
- 必填
-
name
-
target
-
container
-
属性 | 类型 | 描述 |
---|---|---|
|
| container 是扩展目标 pod 中的容器名称 |
|
| name 是有问题的资源的名称。 |
|
| MetricTarget 定义特定指标的目标值、平均值或平均利用率 |
10.2.1.12. .spec.metrics[].containerResource.target
- 描述
- MetricTarget 定义特定指标的目标值、平均值或平均利用率
- 类型
-
object
- 必填
-
type
-
属性 | 类型 | 描述 |
---|---|---|
|
| averageUtilization 是所有相关 pod 中资源指标平均值的目标值,以 pod 资源请求的值的百分比表示。目前仅对 Resource 指标源类型有效 |
| AverageValue 是所有相关 pod 间的指标平均值的目标值(作为数量) | |
|
| type 代表指标类型是 Utilization、Value 或 AverageValue |
| 值是指标(作为一个数量)的目标值。 |
10.2.1.13. .spec.metrics[].external
- 描述
- ExternalMetricSource 表示如何在不与任何 Kubernetes 对象关联的指标上扩展(例如,云消息传递服务中的队列长度,或从集群外运行的 loadbalancer 中的 QPS)。
- 类型
-
object
- 必填
-
metric
-
target
-
属性 | 类型 | 描述 |
---|---|---|
|
| MetricIdentifier 定义指标的名称和可选选择器 |
|
| MetricTarget 定义特定指标的目标值、平均值或平均利用率 |
10.2.1.14. .spec.metrics[].external.metric
- 描述
- MetricIdentifier 定义指标的名称和可选选择器
- 类型
-
object
- 必填
-
name
-
属性 | 类型 | 描述 |
---|---|---|
|
| name 是给定指标的名称 |
| 选择器是在设置时给定指标的标准 kubernetes 标签选择器的字符串编码形式,它会作为额外参数传递给指标服务器,以进行更具体的指标范围。如果未设置,只有 metricName 将用于收集指标。 |
10.2.1.15. .spec.metrics[].external.target
- 描述
- MetricTarget 定义特定指标的目标值、平均值或平均利用率
- 类型
-
object
- 必填
-
type
-
属性 | 类型 | 描述 |
---|---|---|
|
| averageUtilization 是所有相关 pod 中资源指标平均值的目标值,以 pod 资源请求的值的百分比表示。目前仅对 Resource 指标源类型有效 |
| AverageValue 是所有相关 pod 间的指标平均值的目标值(作为数量) | |
|
| type 代表指标类型是 Utilization、Value 或 AverageValue |
| 值是指标(作为一个数量)的目标值。 |
10.2.1.16. .spec.metrics[].object
- 描述
- ObjectMetricSource 指示如何在描述 kubernetes 对象的指标上缩放(例如,Ingress 对象上的 hits-per-second)。
- 类型
-
object
- 必填
-
describedObject
-
target
-
metric
-
属性 | 类型 | 描述 |
---|---|---|
|
| CrossVersionObjectReference 包含足够信息,以便您识别引用的资源。 |
|
| MetricIdentifier 定义指标的名称和可选选择器 |
|
| MetricTarget 定义特定指标的目标值、平均值或平均利用率 |
10.2.1.17. .spec.metrics[].object.describedObject
- 描述
- CrossVersionObjectReference 包含足够信息,以便您识别引用的资源。
- 类型
-
object
- 必填
-
kind
-
name
-
属性 | 类型 | 描述 |
---|---|---|
|
| apiVersion 是引用的 API 版本 |
|
| kind 是引用的类型;更多信息: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
|
| name 是引用的名称;更多信息: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
10.2.1.18. .spec.metrics[].object.metric
- 描述
- MetricIdentifier 定义指标的名称和可选选择器
- 类型
-
object
- 必填
-
name
-
属性 | 类型 | 描述 |
---|---|---|
|
| name 是给定指标的名称 |
| 选择器是在设置时给定指标的标准 kubernetes 标签选择器的字符串编码形式,它会作为额外参数传递给指标服务器,以进行更具体的指标范围。如果未设置,只有 metricName 将用于收集指标。 |
10.2.1.19. .spec.metrics[].object.target
- 描述
- MetricTarget 定义特定指标的目标值、平均值或平均利用率
- 类型
-
object
- 必填
-
type
-
属性 | 类型 | 描述 |
---|---|---|
|
| averageUtilization 是所有相关 pod 中资源指标平均值的目标值,以 pod 资源请求的值的百分比表示。目前仅对 Resource 指标源类型有效 |
| AverageValue 是所有相关 pod 间的指标平均值的目标值(作为数量) | |
|
| type 代表指标类型是 Utilization、Value 或 AverageValue |
| 值是指标(作为一个数量)的目标值。 |
10.2.1.20. .spec.metrics[].pods
- 描述
- PodsMetricSource 表示如何在当前 scale 目标中描述每个 pod 的指标(例如,Transaction-processed-per-second)。这些值在与 target 值进行比较之前会平均在一起。
- 类型
-
object
- 必填
-
metric
-
target
-
属性 | 类型 | 描述 |
---|---|---|
|
| MetricIdentifier 定义指标的名称和可选选择器 |
|
| MetricTarget 定义特定指标的目标值、平均值或平均利用率 |
10.2.1.21. .spec.metrics[].pods.metric
- 描述
- MetricIdentifier 定义指标的名称和可选选择器
- 类型
-
object
- 必填
-
name
-
属性 | 类型 | 描述 |
---|---|---|
|
| name 是给定指标的名称 |
| 选择器是在设置时给定指标的标准 kubernetes 标签选择器的字符串编码形式,它会作为额外参数传递给指标服务器,以进行更具体的指标范围。如果未设置,只有 metricName 将用于收集指标。 |
10.2.1.22. .spec.metrics[].pods.target
- 描述
- MetricTarget 定义特定指标的目标值、平均值或平均利用率
- 类型
-
object
- 必填
-
type
-
属性 | 类型 | 描述 |
---|---|---|
|
| averageUtilization 是所有相关 pod 中资源指标平均值的目标值,以 pod 资源请求的值的百分比表示。目前仅对 Resource 指标源类型有效 |
| AverageValue 是所有相关 pod 间的指标平均值的目标值(作为数量) | |
|
| type 代表指标类型是 Utilization、Value 或 AverageValue |
| 值是指标(作为一个数量)的目标值。 |
10.2.1.23. .spec.metrics[].resource
- 描述
- ResourceMetricSource 指示如何缩放 Kubernetes 已知资源指标(如请求和限值中指定的),描述当前规模目标中的每个 pod (如 CPU 或内存)。与目标相比,这些值将平均合上。此类指标内置在 Kubernetes 中,并且具有特殊的扩展选项,它们之上使用 "pods" 源的普通每个 pod 指标。应该只设置一个"目标"类型。
- 类型
-
object
- 必填
-
name
-
target
-
属性 | 类型 | 描述 |
---|---|---|
|
| name 是有问题的资源的名称。 |
|
| MetricTarget 定义特定指标的目标值、平均值或平均利用率 |
10.2.1.24. .spec.metrics[].resource.target
- 描述
- MetricTarget 定义特定指标的目标值、平均值或平均利用率
- 类型
-
object
- 必填
-
type
-
属性 | 类型 | 描述 |
---|---|---|
|
| averageUtilization 是所有相关 pod 中资源指标平均值的目标值,以 pod 资源请求的值的百分比表示。目前仅对 Resource 指标源类型有效 |
| AverageValue 是所有相关 pod 间的指标平均值的目标值(作为数量) | |
|
| type 代表指标类型是 Utilization、Value 或 AverageValue |
| 值是指标(作为一个数量)的目标值。 |
10.2.1.25. .spec.scaleTargetRef
- 描述
- CrossVersionObjectReference 包含足够信息,以便您识别引用的资源。
- 类型
-
object
- 必填
-
kind
-
name
-
属性 | 类型 | 描述 |
---|---|---|
|
| apiVersion 是引用的 API 版本 |
|
| kind 是引用的类型;更多信息: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
|
| name 是引用的名称;更多信息: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
10.2.1.26. .status
- 描述
- HorizontalPodAutoscalerStatus 描述了 pod 横向自动扩展的当前状态。
- 类型
-
object
- 必填
-
desiredReplicas
-
属性 | 类型 | 描述 |
---|---|---|
|
| 条件是一组此自动扩展用来扩展其目标的条件,并指示是否满足这些条件。 |
|
| HorizontalPodAutoscalerCondition 描述了特定点的 HorizontalPodAutoscaler 的状态。 |
|
| currentMetrics 是此自动扩展使用的指标的最后一个读取状态。 |
|
| MetricStatus 描述了单个指标的最后读取状态。 |
|
| currentReplicas 是此自动扩展管理的 pod 数量的当前数量,如自动扩展最后看到。 |
|
| desiredReplicas 是此自动扩展管理的 pod 数量所需的副本数,如自动扩展最后计算。 |
| lastScaleTime 是 HorizontalPodAutoscaler 最后一次扩展 pod 数量的时间,供自动扩展用来控制 pod 数量的变化频率。 | |
|
| observedGeneration 是此自动扩展观察到的最新生成。 |
10.2.1.27. .status.conditions
- 描述
- 条件是一组此自动扩展用来扩展其目标的条件,并指示是否满足这些条件。
- 类型
-
array
10.2.1.28. .status.conditions[]
- 描述
- HorizontalPodAutoscalerCondition 描述了特定点的 HorizontalPodAutoscaler 的状态。
- 类型
-
object
- 必填
-
type
-
status
-
属性 | 类型 | 描述 |
---|---|---|
| lastTransitionTime 是条件从一个状态转换到另一个状态最后一次的时间 | |
|
| Message 是人类可读的解释,其中包含有关转换的详细信息 |
|
| reason 是条件最后一次转换的原因。 |
|
| status 是条件的状态(True, False, Unknown) |
|
| type 描述了当前的条件 |
10.2.1.29. .status.currentMetrics
- 描述
- currentMetrics 是此自动扩展使用的指标的最后一个读取状态。
- 类型
-
数组
10.2.1.30. .status.currentMetrics[]
- 描述
- MetricStatus 描述了单个指标的最后读取状态。
- 类型
-
object
- 必填
-
type
-
属性 | 类型 | 描述 |
---|---|---|
|
| ContainerResourceMetricStatus 指示 Kubernetes 已知的资源指标的当前值,如请求和限值中指定的,描述当前 scale 目标(如 CPU 或内存)中的每个 pod 中的单个容器。此类指标内置在 Kubernetes 中,并且具有特殊的扩展选项,它们之上使用 "pods" 源的普通每个 pod 指标。 |
|
| ExternalMetricStatus 表示没有与任何 Kubernetes 对象关联的全局指标的当前值。 |
|
| ObjectMetricStatus 指示描述 kubernetes 对象的指标的当前值(例如,Ingress 对象上的 hits-per-second)。 |
|
| PodsMetricStatus 表示在当前 scale 目标中描述每个 pod 的指标的当前值(如 transactions-processed-per-second)。 |
|
| ResourceMetricStatus 指示 Kubernetes 已知的资源指标的当前值,如请求和限值中指定的,描述当前 scale 目标中的每个 pod (如 CPU 或内存)。此类指标内置在 Kubernetes 中,并且具有特殊的扩展选项,它们之上使用 "pods" 源的普通每个 pod 指标。 |
|
| type 是指标源的类型。它将是 "ContainerResource", "External", "Object", "Pods" 或 "Resource" 之一,每个项对应于对象中的匹配字段。注:"ContainerResource" 类型在启用了 feature-gate HPAContainerMetrics 时可用 |
10.2.1.31. .status.currentMetrics[].containerResource
- 描述
- ContainerResourceMetricStatus 指示 Kubernetes 已知的资源指标的当前值,如请求和限值中指定的,描述当前 scale 目标(如 CPU 或内存)中的每个 pod 中的单个容器。此类指标内置在 Kubernetes 中,并且具有特殊的扩展选项,它们之上使用 "pods" 源的普通每个 pod 指标。
- 类型
-
object
- 必填
-
name
-
current
-
container
-
属性 | 类型 | 描述 |
---|---|---|
|
| container 是扩展目标 pod 中的容器名称 |
|
| MetricValueStatus 包含指标的当前值 |
|
| name 是有问题的资源的名称。 |
10.2.1.32. .status.currentMetrics[].containerResource.current
- 描述
- MetricValueStatus 包含指标的当前值
- 类型
-
object
属性 | 类型 | 描述 |
---|---|---|
|
| currentAverageUtilization 是所有相关 pod 中资源指标平均值的当前值,以 pod 资源请求的值的百分比表示。 |
| AverageValue 是所有相关 pod 间的指标平均值的当前值(作为数量) | |
| 值是指标(作为一个数量)的当前值。 |
10.2.1.33. .status.currentMetrics[].external
- 描述
- ExternalMetricStatus 表示没有与任何 Kubernetes 对象关联的全局指标的当前值。
- 类型
-
object
- 必填
-
metric
-
current
-
属性 | 类型 | 描述 |
---|---|---|
|
| MetricValueStatus 包含指标的当前值 |
|
| MetricIdentifier 定义指标的名称和可选选择器 |
10.2.1.34. .status.currentMetrics[].external.current
- 描述
- MetricValueStatus 包含指标的当前值
- 类型
-
object
属性 | 类型 | 描述 |
---|---|---|
|
| currentAverageUtilization 是所有相关 pod 中资源指标平均值的当前值,以 pod 资源请求的值的百分比表示。 |
| AverageValue 是所有相关 pod 间的指标平均值的当前值(作为数量) | |
| 值是指标(作为一个数量)的当前值。 |
10.2.1.35. .status.currentMetrics[].external.metric
- 描述
- MetricIdentifier 定义指标的名称和可选选择器
- 类型
-
object
- 必填
-
name
-
属性 | 类型 | 描述 |
---|---|---|
|
| name 是给定指标的名称 |
| 选择器是在设置时给定指标的标准 kubernetes 标签选择器的字符串编码形式,它会作为额外参数传递给指标服务器,以进行更具体的指标范围。如果未设置,只有 metricName 将用于收集指标。 |
10.2.1.36. .status.currentMetrics[].object
- 描述
- ObjectMetricStatus 指示描述 kubernetes 对象的指标的当前值(例如,Ingress 对象上的 hits-per-second)。
- 类型
-
object
- 必填
-
metric
-
current
-
describedObject
-
属性 | 类型 | 描述 |
---|---|---|
|
| MetricValueStatus 包含指标的当前值 |
|
| CrossVersionObjectReference 包含足够信息,以便您识别引用的资源。 |
|
| MetricIdentifier 定义指标的名称和可选选择器 |
10.2.1.37. .status.currentMetrics[].object.current
- 描述
- MetricValueStatus 包含指标的当前值
- 类型
-
object
属性 | 类型 | 描述 |
---|---|---|
|
| currentAverageUtilization 是所有相关 pod 中资源指标平均值的当前值,以 pod 资源请求的值的百分比表示。 |
| AverageValue 是所有相关 pod 间的指标平均值的当前值(作为数量) | |
| 值是指标(作为一个数量)的当前值。 |
10.2.1.38. .status.currentMetrics[].object.describedObject
- 描述
- CrossVersionObjectReference 包含足够信息,以便您识别引用的资源。
- 类型
-
object
- 必填
-
kind
-
name
-
属性 | 类型 | 描述 |
---|---|---|
|
| apiVersion 是引用的 API 版本 |
|
| kind 是引用的类型;更多信息: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
|
| name 是引用的名称;更多信息: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
10.2.1.39. .status.currentMetrics[].object.metric
- 描述
- MetricIdentifier 定义指标的名称和可选选择器
- 类型
-
object
- 必填
-
name
-
属性 | 类型 | 描述 |
---|---|---|
|
| name 是给定指标的名称 |
| 选择器是在设置时给定指标的标准 kubernetes 标签选择器的字符串编码形式,它会作为额外参数传递给指标服务器,以进行更具体的指标范围。如果未设置,只有 metricName 将用于收集指标。 |
10.2.1.40. .status.currentMetrics[].pods
- 描述
- PodsMetricStatus 表示在当前 scale 目标中描述每个 pod 的指标的当前值(如 transactions-processed-per-second)。
- 类型
-
object
- 必填
-
metric
-
current
-
属性 | 类型 | 描述 |
---|---|---|
|
| MetricValueStatus 包含指标的当前值 |
|
| MetricIdentifier 定义指标的名称和可选选择器 |
10.2.1.41. .status.currentMetrics[].pods.current
- 描述
- MetricValueStatus 包含指标的当前值
- 类型
-
object
属性 | 类型 | 描述 |
---|---|---|
|
| currentAverageUtilization 是所有相关 pod 中资源指标平均值的当前值,以 pod 资源请求的值的百分比表示。 |
| AverageValue 是所有相关 pod 间的指标平均值的当前值(作为数量) | |
| 值是指标(作为一个数量)的当前值。 |
10.2.1.42. .status.currentMetrics[].pods.metric
- 描述
- MetricIdentifier 定义指标的名称和可选选择器
- 类型
-
object
- 必填
-
name
-
属性 | 类型 | 描述 |
---|---|---|
|
| name 是给定指标的名称 |
| 选择器是在设置时给定指标的标准 kubernetes 标签选择器的字符串编码形式,它会作为额外参数传递给指标服务器,以进行更具体的指标范围。如果未设置,只有 metricName 将用于收集指标。 |
10.2.1.43. .status.currentMetrics[].resource
- 描述
- ResourceMetricStatus 指示 Kubernetes 已知的资源指标的当前值,如请求和限值中指定的,描述当前 scale 目标中的每个 pod (如 CPU 或内存)。此类指标内置在 Kubernetes 中,并且具有特殊的扩展选项,它们之上使用 "pods" 源的普通每个 pod 指标。
- 类型
-
object
- 必填
-
name
-
current
-
属性 | 类型 | 描述 |
---|---|---|
|
| MetricValueStatus 包含指标的当前值 |
|
| name 是有问题的资源的名称。 |
10.2.1.44. .status.currentMetrics[].resource.current
- 描述
- MetricValueStatus 包含指标的当前值
- 类型
-
object
属性 | 类型 | 描述 |
---|---|---|
|
| currentAverageUtilization 是所有相关 pod 中资源指标平均值的当前值,以 pod 资源请求的值的百分比表示。 |
| AverageValue 是所有相关 pod 间的指标平均值的当前值(作为数量) | |
| 值是指标(作为一个数量)的当前值。 |
10.2.2. API 端点
可用的 API 端点如下:
/apis/autoscaling/v2/horizontalpodautoscalers
-
GET
: 列出或监视类型为 HorizontalPodAutoscaler 的对象
-
/apis/autoscaling/v2/watch/horizontalpodautoscalers
-
GET
: 观察对 HorizontalPodAutoscaler 列表的单独更改。已弃用:改为使用 'watch' 参数及列表操作。
-
/apis/autoscaling/v2/namespaces/{namespace}/horizontalpodautoscalers
-
DELETE
: 删除 HorizontalPodAutoscaler 的集合 -
GET
: 列出或监视类型为 HorizontalPodAutoscaler 的对象 -
POST
:创建一个 HorizontalPodAutoscaler
-
/apis/autoscaling/v2/watch/namespaces/{namespace}/horizontalpodautoscalers
-
GET
: 观察对 HorizontalPodAutoscaler 列表的单独更改。已弃用:改为使用 'watch' 参数及列表操作。
-
/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 的对象的更改。已弃用:使用带有 list 操作的 'watch' 参数,而是过滤为带有 'fieldSelector' 参数的单个项目。
-
/apis/autoscaling/v2/namespaces/{namespace}/horizontalpodautoscalers/{name}/status
-
GET
:指定 HorizontalPodAutoscaler 的读取状态 -
PATCH
: 部分更新指定 HorizontalPodAutoscaler 的状态 -
PUT
:替换指定 HorizontalPodAutoscaler 的状态
-
10.2.2.1. /apis/autoscaling/v2/horizontalpodautoscalers
参数 | 类型 | 描述 |
---|---|---|
|
| allowWatchBookmarks请求类型为“BOOKMARK”的监视事件。没有实现书签的服务器可能会忽略这个标志和书签,由服务器自由裁量发送。客户端不应假设书签在任何特定间隔返回,也不会假定服务器在会话期间发送任何 BOOKMARK 事件。如果这不是监视,则忽略此字段。 |
|
| 从服务器检索更多结果时,应设置 continue 选项。由于这个值是定义的服务器,因此客户端只能使用之前查询结果中的 continue 值,并带有相同的查询参数(除 continue 值除外),因此服务器可能会拒绝它无法识别的值。如果指定的 continue 值不再有效,无论是因为过期时间(通常为 5 到十五分钟)还是服务器上的配置更改,服务器将会与继续令牌一起响应 410 ResourceExpired 错误。如果客户端需要一致的列表,它必须重启其列表,而无需 continue 字段。否则,客户端可能会发送另一个带有 410 错误接收的令牌的列表请求,服务器将以从下一个密钥开始开始的列表响应,但从最新的快照开始,这与上一个列表结果中不一致 - 在第一个列表请求后将包含在响应中,只要它们的密钥位于 "next key" 后。 当 watch 为 true 时不支持此字段。客户端可以从服务器返回的最后一个 resourceVersion 值开始监视,而不丢失任何修改。 |
|
| 一个选择器,用于限制其字段返回的对象列表。默认为任何内容。 |
|
| 一个选择器,用于限制其标签返回的对象列表。默认为任何内容。 |
|
| limit 是列表调用返回的最大响应数。如果存在更多项目,服务器会将列表元数据上的"continue"字段设为可用于同一初始查询的值,以检索下一组结果。如果过滤所有请求的对象,则设置限制可能会返回少于请求项目数量(最多为零项),并且客户端只应使用 continue 字段的存在,以确定是否有更多结果可用。服务器可能会选择不支持 limit 参数,并返回所有可用的结果。如果指定了 limit,并且 continue 字段为空,客户端可能会假定没有更多结果可用。如果 watch 为 true,则不支持此字段。 服务器保证,在使用时返回的对象将与在没有限制限制的情况下发出单个列表调用相同 - 也就是说,在发出第一个请求后没有创建、修改或删除对象。这有时被称为一致的快照,并确保使用限制来接收非常大结果的较小的块的客户端可确保它们看到所有可能的对象。如果在块列表中更新对象,则返回第一个列表结果时存在的对象版本。 |
|
| 如果为 'true',则输出会经过 pretty print 处理。 |
|
| resourceVersion 对可能给请求提供服务的资源版本设置一个约束。详情请查看 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions 默认为未设置 |
|
| resourceVersionMatch 决定如何将 resourceVersion 应用到列表调用。强烈建议您为设置 resourceVersion 的 list 调用设置 resourceVersionMatch。详情请参阅 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions。 默认为未设置 |
|
| 'sendInitialEvents=true' 可以与 'watch=true' 一起设置。在这种情况下,观察流将以复合事件开头,以生成集合中对象的当前状态。发送完所有这些事件后,将发送合成"Bookmark"事件。书签将报告与对象集合对应的 ResourceVersion (RV),并使用 '"k8s.io/initial-events-end": "true" 注解进行标记。之后,监视流将照常进行,从而向监视的对象发送与更改对应的监视事件(按 RV 排序)。 当设置 'sendInitialEvents' 选项时,我们还需要设置 'resourceVersionMatch' 选项。watch 请求的语义如下: - 'resourceVersionMatch' = NotOlderThan 被解释为"data"作为提供的 'resourceVersion'",当状态同步到 'resourceVersion' 时,书签 事件至少作为 ListOptions 提供的 "resourceVersion'。如果未设置 'resourceVersion',这会被解释为 "consistent read",当请求开始处理时至少会发送书签事件。- 'resourceVersionMatch' 设置为任何其他值或未设置 Invalid 错误。 如果 'resourceVersion=""' 或 'resourceVersion="0"' (出于向后兼容原因)和 false,则默认为 true。 |
|
| 列表/watch 调用的超时。这限制了调用的持续时间,无论任何活动或不活跃。 |
|
| 观察对所描述资源的更改,并将它们作为添加、更新和删除通知的流返回。指定 resourceVersion。 |
- HTTP 方法
-
GET
- 描述
- 列出或监视类型为 HorizontalPodAutoscaler 的对象
HTTP 代码 | 响应正文 |
---|---|
200 - OK |
|
401 - Unauthorized | 空 |
10.2.2.2. /apis/autoscaling/v2/watch/horizontalpodautoscalers
参数 | 类型 | 描述 |
---|---|---|
|
| allowWatchBookmarks请求类型为“BOOKMARK”的监视事件。没有实现书签的服务器可能会忽略这个标志和书签,由服务器自由裁量发送。客户端不应假设书签在任何特定间隔返回,也不会假定服务器在会话期间发送任何 BOOKMARK 事件。如果这不是监视,则忽略此字段。 |
|
| 从服务器检索更多结果时,应设置 continue 选项。由于这个值是定义的服务器,因此客户端只能使用之前查询结果中的 continue 值,并带有相同的查询参数(除 continue 值除外),因此服务器可能会拒绝它无法识别的值。如果指定的 continue 值不再有效,无论是因为过期时间(通常为 5 到十五分钟)还是服务器上的配置更改,服务器将会与继续令牌一起响应 410 ResourceExpired 错误。如果客户端需要一致的列表,它必须重启其列表,而无需 continue 字段。否则,客户端可能会发送另一个带有 410 错误接收的令牌的列表请求,服务器将以从下一个密钥开始开始的列表响应,但从最新的快照开始,这与上一个列表结果中不一致 - 在第一个列表请求后将包含在响应中,只要它们的密钥位于 "next key" 后。 当 watch 为 true 时不支持此字段。客户端可以从服务器返回的最后一个 resourceVersion 值开始监视,而不丢失任何修改。 |
|
| 一个选择器,用于限制其字段返回的对象列表。默认为任何内容。 |
|
| 一个选择器,用于限制其标签返回的对象列表。默认为任何内容。 |
|
| limit 是列表调用返回的最大响应数。如果存在更多项目,服务器会将列表元数据上的"continue"字段设为可用于同一初始查询的值,以检索下一组结果。如果过滤所有请求的对象,则设置限制可能会返回少于请求项目数量(最多为零项),并且客户端只应使用 continue 字段的存在,以确定是否有更多结果可用。服务器可能会选择不支持 limit 参数,并返回所有可用的结果。如果指定了 limit,并且 continue 字段为空,客户端可能会假定没有更多结果可用。如果 watch 为 true,则不支持此字段。 服务器保证,在使用时返回的对象将与在没有限制限制的情况下发出单个列表调用相同 - 也就是说,在发出第一个请求后没有创建、修改或删除对象。这有时被称为一致的快照,并确保使用限制来接收非常大结果的较小的块的客户端可确保它们看到所有可能的对象。如果在块列表中更新对象,则返回第一个列表结果时存在的对象版本。 |
|
| 如果为 'true',则输出会经过 pretty print 处理。 |
|
| resourceVersion 对可能给请求提供服务的资源版本设置一个约束。详情请查看 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions 默认为未设置 |
|
| resourceVersionMatch 决定如何将 resourceVersion 应用到列表调用。强烈建议您为设置 resourceVersion 的 list 调用设置 resourceVersionMatch。详情请参阅 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions。 默认为未设置 |
|
| 'sendInitialEvents=true' 可以与 'watch=true' 一起设置。在这种情况下,观察流将以复合事件开头,以生成集合中对象的当前状态。发送完所有这些事件后,将发送合成"Bookmark"事件。书签将报告与对象集合对应的 ResourceVersion (RV),并使用 '"k8s.io/initial-events-end": "true" 注解进行标记。之后,监视流将照常进行,从而向监视的对象发送与更改对应的监视事件(按 RV 排序)。 当设置 'sendInitialEvents' 选项时,我们还需要设置 'resourceVersionMatch' 选项。watch 请求的语义如下: - 'resourceVersionMatch' = NotOlderThan 被解释为"data"作为提供的 'resourceVersion'",当状态同步到 'resourceVersion' 时,书签 事件至少作为 ListOptions 提供的 "resourceVersion'。如果未设置 'resourceVersion',这会被解释为 "consistent read",当请求开始处理时至少会发送书签事件。- 'resourceVersionMatch' 设置为任何其他值或未设置 Invalid 错误。 如果 'resourceVersion=""' 或 'resourceVersion="0"' (出于向后兼容原因)和 false,则默认为 true。 |
|
| 列表/watch 调用的超时。这限制了调用的持续时间,无论任何活动或不活跃。 |
|
| 观察对所描述资源的更改,并将它们作为添加、更新和删除通知的流返回。指定 resourceVersion。 |
- HTTP 方法
-
GET
- 描述
- 观察各个 HorizontalPodAutoscaler 列表的更改。已弃用:改为使用 'watch' 参数以及列表操作。
HTTP 代码 | 响应正文 |
---|---|
200 - OK |
|
401 - Unauthorized | 空 |
10.2.2.3. /apis/autoscaling/v2/namespaces/{namespace}/horizontalpodautoscalers
参数 | 类型 | 描述 |
---|---|---|
|
| 对象名称和身份验证范围,如团队(team)和项目(project) |
参数 | 类型 | 描述 |
---|---|---|
|
| 如果为 'true',则输出会经过 pretty print 处理。 |
- HTTP 方法
-
DELETE
- 描述
- 删除 HorizontalPodAutoscaler 的集合
参数 | 类型 | 描述 |
---|---|---|
|
| 从服务器检索更多结果时,应设置 continue 选项。由于这个值是定义的服务器,因此客户端只能使用之前查询结果中的 continue 值,并带有相同的查询参数(除 continue 值除外),因此服务器可能会拒绝它无法识别的值。如果指定的 continue 值不再有效,无论是因为过期时间(通常为 5 到十五分钟)还是服务器上的配置更改,服务器将会与继续令牌一起响应 410 ResourceExpired 错误。如果客户端需要一致的列表,它必须重启其列表,而无需 continue 字段。否则,客户端可能会发送另一个带有 410 错误接收的令牌的列表请求,服务器将以从下一个密钥开始开始的列表响应,但从最新的快照开始,这与上一个列表结果中不一致 - 在第一个列表请求后将包含在响应中,只要它们的密钥位于 "next key" 后。 当 watch 为 true 时不支持此字段。客户端可以从服务器返回的最后一个 resourceVersion 值开始监视,而不丢失任何修改。 |
|
| 出现时,表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应,且请求不会被进一步处理。有效值为: - All: 所有预演阶段都将被处理 |
|
| 一个选择器,用于限制其字段返回的对象列表。默认为任何内容。 |
|
| 应该删除对象前的持续时间(以秒为单位)。值必须是非负整数。值为零表示立即删除。如果这个值是 nil,则会使用指定类型的默认宽限期。如果没有指定,则默认为每个对象值。零表示立即删除。 |
|
| 一个选择器,用于限制其标签返回的对象列表。默认为任何内容。 |
|
| limit 是列表调用返回的最大响应数。如果存在更多项目,服务器会将列表元数据上的"continue"字段设为可用于同一初始查询的值,以检索下一组结果。如果过滤所有请求的对象,则设置限制可能会返回少于请求项目数量(最多为零项),并且客户端只应使用 continue 字段的存在,以确定是否有更多结果可用。服务器可能会选择不支持 limit 参数,并返回所有可用的结果。如果指定了 limit,并且 continue 字段为空,客户端可能会假定没有更多结果可用。如果 watch 为 true,则不支持此字段。 服务器保证,在使用时返回的对象将与在没有限制限制的情况下发出单个列表调用相同 - 也就是说,在发出第一个请求后没有创建、修改或删除对象。这有时被称为一致的快照,并确保使用限制来接收非常大结果的较小的块的客户端可确保它们看到所有可能的对象。如果在块列表中更新对象,则返回第一个列表结果时存在的对象版本。 |
|
| 弃用:请使用 PropagationPolicy,此字段将在 1.7 中弃用。如果依赖对象是孤立的。如果为 true/false,则 "orphan" finalizer 将添加到对象的终结器列表中。可以设置此字段或 PropagationPolicy,但不能同时设置。 |
|
| 是否执行垃圾回收。可以设置此字段或 OrphanDependents,但不能同时设置两者。默认策略由 metadata.finalizers 和特定于资源的默认策略中设置的现有终结器决定。可接受的值有: 'Orphan' - 孤立的依赖项; 'Background' - 允许垃圾收集器删除依赖项,"Foreground' - 删除前台所有依赖的级联策略。 |
|
| resourceVersion 对可能给请求提供服务的资源版本设置一个约束。详情请查看 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions 默认为未设置 |
|
| resourceVersionMatch 决定如何将 resourceVersion 应用到列表调用。强烈建议您为设置 resourceVersion 的 list 调用设置 resourceVersionMatch。详情请参阅 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions。 默认为未设置 |
|
| 'sendInitialEvents=true' 可以与 'watch=true' 一起设置。在这种情况下,观察流将以复合事件开头,以生成集合中对象的当前状态。发送完所有这些事件后,将发送合成"Bookmark"事件。书签将报告与对象集合对应的 ResourceVersion (RV),并使用 '"k8s.io/initial-events-end": "true" 注解进行标记。之后,监视流将照常进行,从而向监视的对象发送与更改对应的监视事件(按 RV 排序)。 当设置 'sendInitialEvents' 选项时,我们还需要设置 'resourceVersionMatch' 选项。watch 请求的语义如下: - 'resourceVersionMatch' = NotOlderThan 被解释为"data"作为提供的 'resourceVersion'",当状态同步到 'resourceVersion' 时,书签 事件至少作为 ListOptions 提供的 "resourceVersion'。如果未设置 'resourceVersion',这会被解释为 "consistent read",当请求开始处理时至少会发送书签事件。- 'resourceVersionMatch' 设置为任何其他值或未设置 Invalid 错误。 如果 'resourceVersion=""' 或 'resourceVersion="0"' (出于向后兼容原因)和 false,则默认为 true。 |
|
| 列表/watch 调用的超时。这限制了调用的持续时间,无论任何活动或不活跃。 |
参数 | 类型 | 描述 |
---|---|---|
|
HTTP 代码 | 响应正文 |
---|---|
200 - OK |
|
401 - Unauthorized | 空 |
- HTTP 方法
-
GET
- 描述
- 列出或监视类型为 HorizontalPodAutoscaler 的对象
参数 | 类型 | 描述 |
---|---|---|
|
| allowWatchBookmarks请求类型为“BOOKMARK”的监视事件。没有实现书签的服务器可能会忽略这个标志和书签,由服务器自由裁量发送。客户端不应假设书签在任何特定间隔返回,也不会假定服务器在会话期间发送任何 BOOKMARK 事件。如果这不是监视,则忽略此字段。 |
|
| 从服务器检索更多结果时,应设置 continue 选项。由于这个值是定义的服务器,因此客户端只能使用之前查询结果中的 continue 值,并带有相同的查询参数(除 continue 值除外),因此服务器可能会拒绝它无法识别的值。如果指定的 continue 值不再有效,无论是因为过期时间(通常为 5 到十五分钟)还是服务器上的配置更改,服务器将会与继续令牌一起响应 410 ResourceExpired 错误。如果客户端需要一致的列表,它必须重启其列表,而无需 continue 字段。否则,客户端可能会发送另一个带有 410 错误接收的令牌的列表请求,服务器将以从下一个密钥开始开始的列表响应,但从最新的快照开始,这与上一个列表结果中不一致 - 在第一个列表请求后将包含在响应中,只要它们的密钥位于 "next key" 后。 当 watch 为 true 时不支持此字段。客户端可以从服务器返回的最后一个 resourceVersion 值开始监视,而不丢失任何修改。 |
|
| 一个选择器,用于限制其字段返回的对象列表。默认为任何内容。 |
|
| 一个选择器,用于限制其标签返回的对象列表。默认为任何内容。 |
|
| limit 是列表调用返回的最大响应数。如果存在更多项目,服务器会将列表元数据上的"continue"字段设为可用于同一初始查询的值,以检索下一组结果。如果过滤所有请求的对象,则设置限制可能会返回少于请求项目数量(最多为零项),并且客户端只应使用 continue 字段的存在,以确定是否有更多结果可用。服务器可能会选择不支持 limit 参数,并返回所有可用的结果。如果指定了 limit,并且 continue 字段为空,客户端可能会假定没有更多结果可用。如果 watch 为 true,则不支持此字段。 服务器保证,在使用时返回的对象将与在没有限制限制的情况下发出单个列表调用相同 - 也就是说,在发出第一个请求后没有创建、修改或删除对象。这有时被称为一致的快照,并确保使用限制来接收非常大结果的较小的块的客户端可确保它们看到所有可能的对象。如果在块列表中更新对象,则返回第一个列表结果时存在的对象版本。 |
|
| resourceVersion 对可能给请求提供服务的资源版本设置一个约束。详情请查看 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions 默认为未设置 |
|
| resourceVersionMatch 决定如何将 resourceVersion 应用到列表调用。强烈建议您为设置 resourceVersion 的 list 调用设置 resourceVersionMatch。详情请参阅 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions。 默认为未设置 |
|
| 'sendInitialEvents=true' 可以与 'watch=true' 一起设置。在这种情况下,观察流将以复合事件开头,以生成集合中对象的当前状态。发送完所有这些事件后,将发送合成"Bookmark"事件。书签将报告与对象集合对应的 ResourceVersion (RV),并使用 '"k8s.io/initial-events-end": "true" 注解进行标记。之后,监视流将照常进行,从而向监视的对象发送与更改对应的监视事件(按 RV 排序)。 当设置 'sendInitialEvents' 选项时,我们还需要设置 'resourceVersionMatch' 选项。watch 请求的语义如下: - 'resourceVersionMatch' = NotOlderThan 被解释为"data"作为提供的 'resourceVersion'",当状态同步到 'resourceVersion' 时,书签 事件至少作为 ListOptions 提供的 "resourceVersion'。如果未设置 'resourceVersion',这会被解释为 "consistent read",当请求开始处理时至少会发送书签事件。- 'resourceVersionMatch' 设置为任何其他值或未设置 Invalid 错误。 如果 'resourceVersion=""' 或 'resourceVersion="0"' (出于向后兼容原因)和 false,则默认为 true。 |
|
| 列表/watch 调用的超时。这限制了调用的持续时间,无论任何活动或不活跃。 |
|
| 观察对所描述资源的更改,并将它们作为添加、更新和删除通知的流返回。指定 resourceVersion。 |
HTTP 代码 | 响应正文 |
---|---|
200 - OK |
|
401 - Unauthorized | 空 |
- HTTP 方法
-
POST
- 描述
- 创建 HorizontalPodAutoscaler
参数 | 类型 | 描述 |
---|---|---|
|
| 出现时,表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应,且请求不会被进一步处理。有效值为: - All: 所有预演阶段都将被处理 |
|
| fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长,且仅包含可打印的字符,如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。 |
|
| fieldValidation 指示服务器如何处理包含了未知或重复字段的请求 (POST/PUT/PATCH) 中的对象。有效值为: - Ignore :忽略从对象中静默丢弃的未知字段,并将忽略所有除最后一个重复字段以外的所有字段。这是 v1.23 版本之前的默认行为- Warn: 这会通过标准的警告响应头为从对象丢弃的每个未知字段以及遇到的每个重复字段,发送警告。如果没有其他错误,请求仍会成功,且只保留重复字段的最后一个。这是 v1.23+ 的的默认行为 - Strict: 如果从对象中删除了任何未知字段,或者存在任何重复字段,请求将失败并带有 BadRequest 错误。从服务器返回的错误将包含遇到的,以及重复的字段。 |
参数 | 类型 | 描述 |
---|---|---|
|
HTTP 代码 | 响应正文 |
---|---|
200 - OK | |
201 - Created | |
202 - Accepted | |
401 - Unauthorized | 空 |
10.2.2.4. /apis/autoscaling/v2/watch/namespaces/{namespace}/horizontalpodautoscalers
参数 | 类型 | 描述 |
---|---|---|
|
| 对象名称和身份验证范围,如团队(team)和项目(project) |
参数 | 类型 | 描述 |
---|---|---|
|
| allowWatchBookmarks请求类型为“BOOKMARK”的监视事件。没有实现书签的服务器可能会忽略这个标志和书签,由服务器自由裁量发送。客户端不应假设书签在任何特定间隔返回,也不会假定服务器在会话期间发送任何 BOOKMARK 事件。如果这不是监视,则忽略此字段。 |
|
| 从服务器检索更多结果时,应设置 continue 选项。由于这个值是定义的服务器,因此客户端只能使用之前查询结果中的 continue 值,并带有相同的查询参数(除 continue 值除外),因此服务器可能会拒绝它无法识别的值。如果指定的 continue 值不再有效,无论是因为过期时间(通常为 5 到十五分钟)还是服务器上的配置更改,服务器将会与继续令牌一起响应 410 ResourceExpired 错误。如果客户端需要一致的列表,它必须重启其列表,而无需 continue 字段。否则,客户端可能会发送另一个带有 410 错误接收的令牌的列表请求,服务器将以从下一个密钥开始开始的列表响应,但从最新的快照开始,这与上一个列表结果中不一致 - 在第一个列表请求后将包含在响应中,只要它们的密钥位于 "next key" 后。 当 watch 为 true 时不支持此字段。客户端可以从服务器返回的最后一个 resourceVersion 值开始监视,而不丢失任何修改。 |
|
| 一个选择器,用于限制其字段返回的对象列表。默认为任何内容。 |
|
| 一个选择器,用于限制其标签返回的对象列表。默认为任何内容。 |
|
| limit 是列表调用返回的最大响应数。如果存在更多项目,服务器会将列表元数据上的"continue"字段设为可用于同一初始查询的值,以检索下一组结果。如果过滤所有请求的对象,则设置限制可能会返回少于请求项目数量(最多为零项),并且客户端只应使用 continue 字段的存在,以确定是否有更多结果可用。服务器可能会选择不支持 limit 参数,并返回所有可用的结果。如果指定了 limit,并且 continue 字段为空,客户端可能会假定没有更多结果可用。如果 watch 为 true,则不支持此字段。 服务器保证,在使用时返回的对象将与在没有限制限制的情况下发出单个列表调用相同 - 也就是说,在发出第一个请求后没有创建、修改或删除对象。这有时被称为一致的快照,并确保使用限制来接收非常大结果的较小的块的客户端可确保它们看到所有可能的对象。如果在块列表中更新对象,则返回第一个列表结果时存在的对象版本。 |
|
| 如果为 'true',则输出会经过 pretty print 处理。 |
|
| resourceVersion 对可能给请求提供服务的资源版本设置一个约束。详情请查看 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions 默认为未设置 |
|
| resourceVersionMatch 决定如何将 resourceVersion 应用到列表调用。强烈建议您为设置 resourceVersion 的 list 调用设置 resourceVersionMatch。详情请参阅 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions。 默认为未设置 |
|
| 'sendInitialEvents=true' 可以与 'watch=true' 一起设置。在这种情况下,观察流将以复合事件开头,以生成集合中对象的当前状态。发送完所有这些事件后,将发送合成"Bookmark"事件。书签将报告与对象集合对应的 ResourceVersion (RV),并使用 '"k8s.io/initial-events-end": "true" 注解进行标记。之后,监视流将照常进行,从而向监视的对象发送与更改对应的监视事件(按 RV 排序)。 当设置 'sendInitialEvents' 选项时,我们还需要设置 'resourceVersionMatch' 选项。watch 请求的语义如下: - 'resourceVersionMatch' = NotOlderThan 被解释为"data"作为提供的 'resourceVersion'",当状态同步到 'resourceVersion' 时,书签 事件至少作为 ListOptions 提供的 "resourceVersion'。如果未设置 'resourceVersion',这会被解释为 "consistent read",当请求开始处理时至少会发送书签事件。- 'resourceVersionMatch' 设置为任何其他值或未设置 Invalid 错误。 如果 'resourceVersion=""' 或 'resourceVersion="0"' (出于向后兼容原因)和 false,则默认为 true。 |
|
| 列表/watch 调用的超时。这限制了调用的持续时间,无论任何活动或不活跃。 |
|
| 观察对所描述资源的更改,并将它们作为添加、更新和删除通知的流返回。指定 resourceVersion。 |
- HTTP 方法
-
GET
- 描述
- 观察各个 HorizontalPodAutoscaler 列表的更改。已弃用:改为使用 'watch' 参数以及列表操作。
HTTP 代码 | 响应正文 |
---|---|
200 - OK |
|
401 - Unauthorized | 空 |
10.2.2.5. /apis/autoscaling/v2/namespaces/{namespace}/horizontalpodautoscalers/{name}
参数 | 类型 | 描述 |
---|---|---|
|
| HorizontalPodAutoscaler 的名称 |
|
| 对象名称和身份验证范围,如团队(team)和项目(project) |
参数 | 类型 | 描述 |
---|---|---|
|
| 如果为 'true',则输出会经过 pretty print 处理。 |
- HTTP 方法
-
DELETE
- 描述
- delete a HorizontalPodAutoscaler
参数 | 类型 | 描述 |
---|---|---|
|
| 出现时,表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应,且请求不会被进一步处理。有效值为: - All: 所有预演阶段都将被处理 |
|
| 应该删除对象前的持续时间(以秒为单位)。值必须是非负整数。值为零表示立即删除。如果这个值是 nil,则会使用指定类型的默认宽限期。如果没有指定,则默认为每个对象值。零表示立即删除。 |
|
| 弃用:请使用 PropagationPolicy,此字段将在 1.7 中弃用。如果依赖对象是孤立的。如果为 true/false,则 "orphan" finalizer 将添加到对象的终结器列表中。可以设置此字段或 PropagationPolicy,但不能同时设置。 |
|
| 是否执行垃圾回收。可以设置此字段或 OrphanDependents,但不能同时设置两者。默认策略由 metadata.finalizers 和特定于资源的默认策略中设置的现有终结器决定。可接受的值有: 'Orphan' - 孤立的依赖项; 'Background' - 允许垃圾收集器删除依赖项,"Foreground' - 删除前台所有依赖的级联策略。 |
参数 | 类型 | 描述 |
---|---|---|
|
HTTP 代码 | 响应正文 |
---|---|
200 - OK |
|
202 - Accepted |
|
401 - Unauthorized | 空 |
- HTTP 方法
-
GET
- 描述
- 阅读指定的 HorizontalPodAutoscaler
HTTP 代码 | 响应正文 |
---|---|
200 - OK | |
401 - Unauthorized | 空 |
- HTTP 方法
-
PATCH
- 描述
- 部分更新指定的 HorizontalPodAutoscaler
参数 | 类型 | 描述 |
---|---|---|
|
| 出现时,表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应,且请求不会被进一步处理。有效值为: - All: 所有预演阶段都将被处理 |
|
| fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长,且仅包含可打印的字符,如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。应用请求(application/apply-patch)需要此字段,但对非应用补丁类型(JsonPatch、MergePatch、MergePatch)是可选的。 |
|
| fieldValidation 指示服务器如何处理包含了未知或重复字段的请求 (POST/PUT/PATCH) 中的对象。有效值为: - Ignore :忽略从对象中静默丢弃的未知字段,并将忽略所有除最后一个重复字段以外的所有字段。这是 v1.23 版本之前的默认行为- Warn: 这会通过标准的警告响应头为从对象丢弃的每个未知字段以及遇到的每个重复字段,发送警告。如果没有其他错误,请求仍会成功,且只保留重复字段的最后一个。这是 v1.23+ 的的默认行为 - Strict: 如果从对象中删除了任何未知字段,或者存在任何重复字段,请求将失败并带有 BadRequest 错误。从服务器返回的错误将包含遇到的,以及重复的字段。 |
|
| 强制要"强制"应用请求。这意味着用户将重新分配由其他人员拥有的冲突字段。对于非应用补丁请求,必须取消设置 force 标志。 |
参数 | 类型 | 描述 |
---|---|---|
|
|
HTTP 代码 | 响应正文 |
---|---|
200 - OK | |
201 - Created | |
401 - Unauthorized | 空 |
- HTTP 方法
-
PUT
- 描述
- 替换指定的 HorizontalPodAutoscaler
参数 | 类型 | 描述 |
---|---|---|
|
| 出现时,表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应,且请求不会被进一步处理。有效值为: - All: 所有预演阶段都将被处理 |
|
| fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长,且仅包含可打印的字符,如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。 |
|
| fieldValidation 指示服务器如何处理包含了未知或重复字段的请求 (POST/PUT/PATCH) 中的对象。有效值为: - Ignore :忽略从对象中静默丢弃的未知字段,并将忽略所有除最后一个重复字段以外的所有字段。这是 v1.23 版本之前的默认行为- Warn: 这会通过标准的警告响应头为从对象丢弃的每个未知字段以及遇到的每个重复字段,发送警告。如果没有其他错误,请求仍会成功,且只保留重复字段的最后一个。这是 v1.23+ 的的默认行为 - Strict: 如果从对象中删除了任何未知字段,或者存在任何重复字段,请求将失败并带有 BadRequest 错误。从服务器返回的错误将包含遇到的,以及重复的字段。 |
参数 | 类型 | 描述 |
---|---|---|
|
HTTP 代码 | 响应正文 |
---|---|
200 - OK | |
201 - Created | |
401 - Unauthorized | 空 |
10.2.2.6. /apis/autoscaling/v2/watch/namespaces/{namespace}/horizontalpodautoscalers/{name}
参数 | 类型 | 描述 |
---|---|---|
|
| HorizontalPodAutoscaler 的名称 |
|
| 对象名称和身份验证范围,如团队(team)和项目(project) |
参数 | 类型 | 描述 |
---|---|---|
|
| allowWatchBookmarks请求类型为“BOOKMARK”的监视事件。没有实现书签的服务器可能会忽略这个标志和书签,由服务器自由裁量发送。客户端不应假设书签在任何特定间隔返回,也不会假定服务器在会话期间发送任何 BOOKMARK 事件。如果这不是监视,则忽略此字段。 |
|
| 从服务器检索更多结果时,应设置 continue 选项。由于这个值是定义的服务器,因此客户端只能使用之前查询结果中的 continue 值,并带有相同的查询参数(除 continue 值除外),因此服务器可能会拒绝它无法识别的值。如果指定的 continue 值不再有效,无论是因为过期时间(通常为 5 到十五分钟)还是服务器上的配置更改,服务器将会与继续令牌一起响应 410 ResourceExpired 错误。如果客户端需要一致的列表,它必须重启其列表,而无需 continue 字段。否则,客户端可能会发送另一个带有 410 错误接收的令牌的列表请求,服务器将以从下一个密钥开始开始的列表响应,但从最新的快照开始,这与上一个列表结果中不一致 - 在第一个列表请求后将包含在响应中,只要它们的密钥位于 "next key" 后。 当 watch 为 true 时不支持此字段。客户端可以从服务器返回的最后一个 resourceVersion 值开始监视,而不丢失任何修改。 |
|
| 一个选择器,用于限制其字段返回的对象列表。默认为任何内容。 |
|
| 一个选择器,用于限制其标签返回的对象列表。默认为任何内容。 |
|
| limit 是列表调用返回的最大响应数。如果存在更多项目,服务器会将列表元数据上的"continue"字段设为可用于同一初始查询的值,以检索下一组结果。如果过滤所有请求的对象,则设置限制可能会返回少于请求项目数量(最多为零项),并且客户端只应使用 continue 字段的存在,以确定是否有更多结果可用。服务器可能会选择不支持 limit 参数,并返回所有可用的结果。如果指定了 limit,并且 continue 字段为空,客户端可能会假定没有更多结果可用。如果 watch 为 true,则不支持此字段。 服务器保证,在使用时返回的对象将与在没有限制限制的情况下发出单个列表调用相同 - 也就是说,在发出第一个请求后没有创建、修改或删除对象。这有时被称为一致的快照,并确保使用限制来接收非常大结果的较小的块的客户端可确保它们看到所有可能的对象。如果在块列表中更新对象,则返回第一个列表结果时存在的对象版本。 |
|
| 如果为 'true',则输出会经过 pretty print 处理。 |
|
| resourceVersion 对可能给请求提供服务的资源版本设置一个约束。详情请查看 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions 默认为未设置 |
|
| resourceVersionMatch 决定如何将 resourceVersion 应用到列表调用。强烈建议您为设置 resourceVersion 的 list 调用设置 resourceVersionMatch。详情请参阅 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions。 默认为未设置 |
|
| 'sendInitialEvents=true' 可以与 'watch=true' 一起设置。在这种情况下,观察流将以复合事件开头,以生成集合中对象的当前状态。发送完所有这些事件后,将发送合成"Bookmark"事件。书签将报告与对象集合对应的 ResourceVersion (RV),并使用 '"k8s.io/initial-events-end": "true" 注解进行标记。之后,监视流将照常进行,从而向监视的对象发送与更改对应的监视事件(按 RV 排序)。 当设置 'sendInitialEvents' 选项时,我们还需要设置 'resourceVersionMatch' 选项。watch 请求的语义如下: - 'resourceVersionMatch' = NotOlderThan 被解释为"data"作为提供的 'resourceVersion'",当状态同步到 'resourceVersion' 时,书签 事件至少作为 ListOptions 提供的 "resourceVersion'。如果未设置 'resourceVersion',这会被解释为 "consistent read",当请求开始处理时至少会发送书签事件。- 'resourceVersionMatch' 设置为任何其他值或未设置 Invalid 错误。 如果 'resourceVersion=""' 或 'resourceVersion="0"' (出于向后兼容原因)和 false,则默认为 true。 |
|
| 列表/watch 调用的超时。这限制了调用的持续时间,无论任何活动或不活跃。 |
|
| 观察对所描述资源的更改,并将它们作为添加、更新和删除通知的流返回。指定 resourceVersion。 |
- HTTP 方法
-
GET
- 描述
- 观察对类型为 HorizontalPodAutoscaler 的对象的更改。已弃用:使用带列表操作的 'watch' 参数,而是过滤成一个带有 'fieldSelector' 参数的单个项目。
HTTP 代码 | 响应正文 |
---|---|
200 - OK |
|
401 - Unauthorized | 空 |
10.2.2.7. /apis/autoscaling/v2/namespaces/{namespace}/horizontalpodautoscalers/{name}/status
参数 | 类型 | 描述 |
---|---|---|
|
| HorizontalPodAutoscaler 的名称 |
|
| 对象名称和身份验证范围,如团队(team)和项目(project) |
参数 | 类型 | 描述 |
---|---|---|
|
| 如果为 'true',则输出会经过 pretty print 处理。 |
- HTTP 方法
-
GET
- 描述
- 指定 HorizontalPodAutoscaler 的读取状态
HTTP 代码 | 响应正文 |
---|---|
200 - OK | |
401 - Unauthorized | 空 |
- HTTP 方法
-
PATCH
- 描述
- 部分更新指定 HorizontalPodAutoscaler 的状态
参数 | 类型 | 描述 |
---|---|---|
|
| 出现时,表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应,且请求不会被进一步处理。有效值为: - All: 所有预演阶段都将被处理 |
|
| fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长,且仅包含可打印的字符,如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。应用请求(application/apply-patch)需要此字段,但对非应用补丁类型(JsonPatch、MergePatch、MergePatch)是可选的。 |
|
| fieldValidation 指示服务器如何处理包含了未知或重复字段的请求 (POST/PUT/PATCH) 中的对象。有效值为: - Ignore :忽略从对象中静默丢弃的未知字段,并将忽略所有除最后一个重复字段以外的所有字段。这是 v1.23 版本之前的默认行为- Warn: 这会通过标准的警告响应头为从对象丢弃的每个未知字段以及遇到的每个重复字段,发送警告。如果没有其他错误,请求仍会成功,且只保留重复字段的最后一个。这是 v1.23+ 的的默认行为 - Strict: 如果从对象中删除了任何未知字段,或者存在任何重复字段,请求将失败并带有 BadRequest 错误。从服务器返回的错误将包含遇到的,以及重复的字段。 |
|
| 强制要"强制"应用请求。这意味着用户将重新分配由其他人员拥有的冲突字段。对于非应用补丁请求,必须取消设置 force 标志。 |
参数 | 类型 | 描述 |
---|---|---|
|
|
HTTP 代码 | 响应正文 |
---|---|
200 - OK | |
201 - Created | |
401 - Unauthorized | 空 |
- HTTP 方法
-
PUT
- 描述
- 替换指定 HorizontalPodAutoscaler 的状态
参数 | 类型 | 描述 |
---|---|---|
|
| 出现时,表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应,且请求不会被进一步处理。有效值为: - All: 所有预演阶段都将被处理 |
|
| fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长,且仅包含可打印的字符,如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。 |
|
| fieldValidation 指示服务器如何处理包含了未知或重复字段的请求 (POST/PUT/PATCH) 中的对象。有效值为: - Ignore :忽略从对象中静默丢弃的未知字段,并将忽略所有除最后一个重复字段以外的所有字段。这是 v1.23 版本之前的默认行为- Warn: 这会通过标准的警告响应头为从对象丢弃的每个未知字段以及遇到的每个重复字段,发送警告。如果没有其他错误,请求仍会成功,且只保留重复字段的最后一个。这是 v1.23+ 的的默认行为 - Strict: 如果从对象中删除了任何未知字段,或者存在任何重复字段,请求将失败并带有 BadRequest 错误。从服务器返回的错误将包含遇到的,以及重复的字段。 |
参数 | 类型 | 描述 |
---|---|---|
|
HTTP 代码 | 响应正文 |
---|---|
200 - OK | |
201 - Created | |
401 - Unauthorized | 空 |