自动扩展 API

OpenShift Container Platform 4.17

自动扩展 API 的参考指南

Red Hat OpenShift Documentation Team

法律通告

摘要

本文档描述了 OpenShift Container Platform autoscale API 对象及其详细规格。

第 1 章自动扩展 API

1.1. ClusterAutoscaler [autoscaling.openshift.io/v1]

描述: ClusterAutoscaler 是 clusterautoscalers API 的 Schema
类型: 对象

1.2. MachineAutoscaler [autoscaling.openshift.io/v1beta1]

描述: MachineAutoscaler 是 machineautoscalers API 的 Schema
类型: object

1.3. HorizontalPodAutoscaler [autoscaling/v2]

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

1.4. scale [autoscaling/v1]

描述: scale 代表资源的扩展请求。
类型: 对象

第 2 章 ClusterAutoscaler [autoscaling.openshift.io/v1]

描述: ClusterAutoscaler 是 clusterautoscalers API 的 Schema
类型: 对象

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
`metadata`	`ObjectMeta`	标准对象元数据。更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
`spec`	`对象`	ClusterAutoscaler 资源的所需状态
`status`	`对象`	最近观察到的 ClusterAutoscaler 资源状态

2.1.1. .spec

描述: ClusterAutoscaler 资源的所需状态
类型: object

属性	类型	描述
`balanceSimilarNodeGroups`	`布尔值`	balanceSimilarNodeGroups 启用/禁用 `-平衡-similar-node-groups` cluster-autoscaler 功能。此功能将自动识别具有相同实例类型和同一组标签的节点组，并尝试使这些节点组的相应大小保持平衡。
`balancingIgnoredLabels`	`数组（字符串）`	BalancingIgnoredLabels 为每个列出的标签在 cluster-autoscaler 上设置 "--balancing-ignore-label <label name>" 标记。这个选项指定在考虑节点组相似时，集群自动扩展应该忽略的标签。例如，如果您有具有 "topology.ebs.csi.aws.com/zone" 标签的节点，您可以添加此标签的名称，以防止集群自动扩展根据其值将节点分成不同的节点组。
`展开者`	`数组（字符串）`	设置在扩展操作过程中使用的扩展器的类型和顺序。这个选项指定一个排序列表，首先是集群自动扩展将使用的扩展器列表，以便在扩展时选择节点组进行扩展。Expanders 指示自动扩展在横向扩展集群时如何选择节点组。它们可以按顺序指定，以便第一个扩展器的结果被用作第二个的输入，以此类推。例如，如果将 `[LeastWaste, Random]` 设为 [LeastWaste, Random]，自动扩展将首先评估节点组，以确定哪个组具有最低资源，如果选择了多个组，那么自动扩展会随机选择这些组来确定要进行扩展的组。可用的扩展器如下：* LeastWaste - 选择在扩展后具有最小空闲 CPU （如果未关联、未使用的内存）的节点组。* priority - 选择具有用户分配最高优先级的节点组。详情请查看 https://github.com/openshift/kubernetes-autoscaler/blob/master/cluster-autoscaler/expander/priority/readme.md Random - 随机选择节点组。如果没有指定，则默认值是 `Random`，可用选项包括：Least `W` aste、`Priority`、`Random`。
`ignoreDaemonsetsUtilization`	`布尔值`	启用/Disables `--ignore-daemonsets-utilization` CA 功能标记。在计算缩减资源利用率时 CA 忽略 DaemonSet pod。默认为 false
`logVerbosity`	`整数`	设置自动扩展日志级别。默认值为 1，对于 DEBUGGING，建议使用级别 4，级别 6 将启用几乎所有值。这个选项的优先级高于 `CLUSTER_AUTOSCALER_VERBOSITY` 环境变量设置的日志级别。
`maxNodeProvisionTime`	`字符串`	最多时间 CA 等待置备节点
`maxPodGracePeriod`	`整数`	在缩减前为 pod 提供安全终止时间
`podPriorityThreshold`	`整数`	要允许用户调度 "best-effort" pod，它不应该触发 Cluster Autoscaler 操作，但仅在有备用资源可用时运行，更多信息：https://github.com/kubernetes/autoscaler/blob/master/cluster-autoscaler/FAQ.md#how-does-cluster-autoscaler-work-with-pod-priority-and-preemption
`resourceLimits`	`对象`	自动扩展资源的限制
`scaleDown`	`对象`	配置缩减操作
`skipNodesWithLocalStorage`	`布尔值`	启用/禁用 `--skip-nodes-with-local-storage` CA 功能标记。如果 true 集群自动扩展永远不会删除带有本地存储的 pod 的节点，如 EmptyDir 或 HostPath. true，在自动扩展时默认为 true

2.1.2. .spec.resourceLimits

描述: 自动扩展资源的限制
类型: object

属性	类型	描述
`内核`	`对象`	集群中的最小和最大内核数，格式为 <min>:<max>。集群自动扩展不会扩展集群超过这些数量。
`gpus`	`array`	集群中不同 GPU 的最小和最大数量，格式为 {p>:<min>:<max>。集群自动扩展不会扩展集群超过这些数量。可以多次传递。
`gpus[]`	`对象`
`maxNodesTotal`	`整数`	所有节点组中的节点数。集群自动扩展不会增加集群数量。
`内存`	`object`	集群中的最小和最大 GiB 内存量，格式为 <min>:<max>。集群自动扩展不会扩展集群超过这些数量。

2.1.3. .spec.resourceLimits.cores

描述

集群中的最小和最大内核数，格式为 <min>:<max>。集群自动扩展不会扩展集群超过这些数量。

类型

object

必填

max
分钟

属性	类型	描述
`max`	`整数`
`分钟`	`整数`

2.1.4. .spec.resourceLimits.gpus

描述: 集群中不同 GPU 的最小和最大数量，格式为 {p>:<min>:<max>。集群自动扩展不会扩展集群超过这些数量。可以多次传递。
类型: array

2.1.5. .spec.resourceLimits.gpus[]

描述

类型

object

必填

max
分钟
type

属性	类型	描述
`max`	`整数`
`分钟`	`整数`
`type`	`string`	与最小和最大限制关联的 GPU 类型。Cluster Autoscaler 使用这个值来标识具有 GPU 容量的节点，方法是将其作为 Node 对象上的标签值进行搜索。例如，具有与 Type 字段相同的标签键为 `cluster-api/accelerator` 的节点将计入 Cluster Autoscaler 的资源限值。

2.1.6. .spec.resourceLimits.memory

描述

集群中的最小和最大 GiB 内存量，格式为 <min>:<max>。集群自动扩展不会扩展集群超过这些数量。

类型

object

必填

max
分钟

属性	类型	描述
`max`	`整数`
`分钟`	`整数`

2.1.7. .spec.scaleDown

描述

配置缩减操作

类型

object

必填

enabled

属性	类型	描述
`delayAfterAdd`	`字符串`	扩展评估恢复的时长
`delayAfterDelete`	`字符串`	节点删除缩减评估恢复后的时长，默认为 scan-interval
`delayAfterFailure`	`字符串`	缩减评估恢复的缩减失败的时间
`enabled`	`布尔值`	应该 CA 缩减集群
`unneededTime`	`字符串`	在节点有资格缩减前应该不需要多久
`utilizationThreshold`	`string`	节点使用率级别，定义为请求资源的总和，按容量划分，如下所示，节点可以考虑缩减

2.1.8. .status

描述: 最近观察到的 ClusterAutoscaler 资源状态
类型: object

2.2. API 端点

可用的 API 端点如下：

/apis/autoscaling.openshift.io/v1/clusterautoscalers
- DELETE ：删除 ClusterAutoscaler 集合
- GET ：列出 ClusterAutoscaler 类型的对象
- POST ：创建 ClusterAutoscaler
/apis/autoscaling.openshift.io/v1/clusterautoscalers/{name}
- DELETE ：删除 ClusterAutoscaler
- GET ：读取指定的 ClusterAutoscaler
- PATCH: 部分更新指定的 ClusterAutoscaler
- PUT ：替换指定的 ClusterAutoscaler
/apis/autoscaling.openshift.io/v1/clusterautoscalers/{name}/status
- GET ：指定 ClusterAutoscaler 的读取状态
- PATCH: 部分更新指定 ClusterAutoscaler 的状态
- PUT ：替换指定 ClusterAutoscaler 的状态

2.2.1. /apis/autoscaling.openshift.io/v1/clusterautoscalers

HTTP 方法: DELETE
描述: 删除 ClusterAutoscaler 集合

表 2.1. HTTP 响应
HTTP 代码	响应正文
200 - OK	`Status` 模式
401 - Unauthorized	空

HTTP 方法: GET
描述: 列出 ClusterAutoscaler 类型的对象

表 2.2. HTTP 响应
HTTP 代码	响应正文
200 - OK	`ClusterAutoscalerList` 模式
401 - Unauthorized	空

HTTP 方法: POST
描述: 创建 ClusterAutoscaler

表 2.3. 查询参数
参数	类型	描述
`dryRun`	`字符串`	出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理
`fieldValidation`	`string`	fieldValidation 指示服务器如何处理包含了未知或重复字段的请求 (POST/PUT/PATCH) 中的对象。有效值为： - Ignore ：忽略从对象中静默丢弃的未知字段，并将忽略所有除最后一个重复字段以外的所有字段。这是 v1.23 版本之前的默认行为- Warn: 这会通过标准的警告响应头为从对象丢弃的每个未知字段以及遇到的每个重复字段，发送警告。如果没有其他错误，请求仍会成功，且只保留重复字段的最后一个。这是 v1.23+ 的的默认行为 - Strict: 如果从对象中删除了任何未知字段，或者存在任何重复字段，请求将失败并带有 BadRequest 错误。从服务器返回的错误将包含遇到的，以及重复的字段。

表 2.4. 主体参数
参数	类型	描述
`正文（body）`	`ClusterAutoscaler` 模式

表 2.5. HTTP 响应
HTTP 代码	响应正文
200 - OK	`ClusterAutoscaler` 模式
201 - Created	`ClusterAutoscaler` 模式
202 - Accepted	`ClusterAutoscaler` 模式
401 - Unauthorized	空

2.2.2. /apis/autoscaling.openshift.io/v1/clusterautoscalers/{name}

表 2.6. 全局路径参数
参数	类型	描述
`name`	`字符串`	ClusterAutoscaler 的名称

HTTP 方法: DELETE
描述: 删除 ClusterAutoscaler

表 2.7. 查询参数
参数	类型	描述
`dryRun`	`字符串`	出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理

表 2.8. HTTP 响应
HTTP 代码	响应正文
200 - OK	`Status` 模式
202 - Accepted	`Status` 模式
401 - Unauthorized	空

HTTP 方法: GET
描述: 阅读指定的 ClusterAutoscaler

表 2.9. HTTP 响应
HTTP 代码	响应正文
200 - OK	`ClusterAutoscaler` 模式
401 - Unauthorized	空

HTTP 方法: PATCH
描述: 部分更新指定的 ClusterAutoscaler

表 2.10. 查询参数
参数	类型	描述
`dryRun`	`字符串`	出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理
`fieldValidation`	`string`	fieldValidation 指示服务器如何处理包含了未知或重复字段的请求 (POST/PUT/PATCH) 中的对象。有效值为： - Ignore ：忽略从对象中静默丢弃的未知字段，并将忽略所有除最后一个重复字段以外的所有字段。这是 v1.23 版本之前的默认行为- Warn: 这会通过标准的警告响应头为从对象丢弃的每个未知字段以及遇到的每个重复字段，发送警告。如果没有其他错误，请求仍会成功，且只保留重复字段的最后一个。这是 v1.23+ 的的默认行为 - Strict: 如果从对象中删除了任何未知字段，或者存在任何重复字段，请求将失败并带有 BadRequest 错误。从服务器返回的错误将包含遇到的，以及重复的字段。

表 2.11. HTTP 响应
HTTP 代码	响应正文
200 - OK	`ClusterAutoscaler` 模式
401 - Unauthorized	空

HTTP 方法: PUT
描述: 替换指定的 ClusterAutoscaler

表 2.12. 查询参数
参数	类型	描述
`dryRun`	`字符串`	出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理
`fieldValidation`	`string`	fieldValidation 指示服务器如何处理包含了未知或重复字段的请求 (POST/PUT/PATCH) 中的对象。有效值为： - Ignore ：忽略从对象中静默丢弃的未知字段，并将忽略所有除最后一个重复字段以外的所有字段。这是 v1.23 版本之前的默认行为- Warn: 这会通过标准的警告响应头为从对象丢弃的每个未知字段以及遇到的每个重复字段，发送警告。如果没有其他错误，请求仍会成功，且只保留重复字段的最后一个。这是 v1.23+ 的的默认行为 - Strict: 如果从对象中删除了任何未知字段，或者存在任何重复字段，请求将失败并带有 BadRequest 错误。从服务器返回的错误将包含遇到的，以及重复的字段。

表 2.13. 主体参数
参数	类型	描述
`正文（body）`	`ClusterAutoscaler` 模式

表 2.14. HTTP 响应
HTTP 代码	响应正文
200 - OK	`ClusterAutoscaler` 模式
201 - Created	`ClusterAutoscaler` 模式
401 - Unauthorized	空

2.2.3. /apis/autoscaling.openshift.io/v1/clusterautoscalers/{name}/status

表 2.15. 全局路径参数
参数	类型	描述
`name`	`字符串`	ClusterAutoscaler 的名称

HTTP 方法: GET
描述: 指定 ClusterAutoscaler 的读取状态

表 2.16. HTTP 响应
HTTP 代码	响应正文
200 - OK	`ClusterAutoscaler` 模式
401 - Unauthorized	空

HTTP 方法: PATCH
描述: 部分更新指定 ClusterAutoscaler 的状态

表 2.17. 查询参数
参数	类型	描述
`dryRun`	`字符串`	出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理
`fieldValidation`	`string`	fieldValidation 指示服务器如何处理包含了未知或重复字段的请求 (POST/PUT/PATCH) 中的对象。有效值为： - Ignore ：忽略从对象中静默丢弃的未知字段，并将忽略所有除最后一个重复字段以外的所有字段。这是 v1.23 版本之前的默认行为- Warn: 这会通过标准的警告响应头为从对象丢弃的每个未知字段以及遇到的每个重复字段，发送警告。如果没有其他错误，请求仍会成功，且只保留重复字段的最后一个。这是 v1.23+ 的的默认行为 - Strict: 如果从对象中删除了任何未知字段，或者存在任何重复字段，请求将失败并带有 BadRequest 错误。从服务器返回的错误将包含遇到的，以及重复的字段。

表 2.18. HTTP 响应
HTTP 代码	响应正文
200 - OK	`ClusterAutoscaler` 模式
401 - Unauthorized	空

HTTP 方法: PUT
描述: 替换指定 ClusterAutoscaler 的状态

表 2.19. 查询参数
参数	类型	描述
`dryRun`	`字符串`	出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理
`fieldValidation`	`string`	fieldValidation 指示服务器如何处理包含了未知或重复字段的请求 (POST/PUT/PATCH) 中的对象。有效值为： - Ignore ：忽略从对象中静默丢弃的未知字段，并将忽略所有除最后一个重复字段以外的所有字段。这是 v1.23 版本之前的默认行为- Warn: 这会通过标准的警告响应头为从对象丢弃的每个未知字段以及遇到的每个重复字段，发送警告。如果没有其他错误，请求仍会成功，且只保留重复字段的最后一个。这是 v1.23+ 的的默认行为 - Strict: 如果从对象中删除了任何未知字段，或者存在任何重复字段，请求将失败并带有 BadRequest 错误。从服务器返回的错误将包含遇到的，以及重复的字段。

表 2.20. 主体参数
参数	类型	描述
`正文（body）`	`ClusterAutoscaler` 模式

表 2.21. HTTP 响应
HTTP 代码	响应正文
200 - OK	`ClusterAutoscaler` 模式
201 - Created	`ClusterAutoscaler` 模式
401 - Unauthorized	空

第 3 章 MachineAutoscaler [autoscaling.openshift.io/v1beta1]

描述: MachineAutoscaler 是 machineautoscalers API 的 Schema
类型: 对象

3.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
`metadata`	`ObjectMeta`	标准对象元数据。更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
`spec`	`对象`	可扩展资源的约束规格
`status`	`对象`	最近观察到的可扩展资源状态

3.1.1. .spec

描述

可扩展资源的约束规格

类型

object

必填

maxReplicas
minReplicas
scaleTargetRef

属性	类型	描述
`maxReplicas`	`整数`	maxReplicas 限制可扩展资源副本数
`minReplicas`	`整数`	minReplicas 限制可扩展资源副本数
`scaleTargetRef`	`对象`	scaleTargetRef 包含对可扩展资源的引用

3.1.2. .spec.scaleTargetRef

描述

scaleTargetRef 包含对可扩展资源的引用

类型

object

必填

kind
name

属性	类型	描述
`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
`name`	`字符串`	name 指定对象的名称，如 worker-us-east-1a。可扩展资源应该存在于单一命名空间中。

3.1.3. .status

描述: 最近观察到的可扩展资源状态
类型: object

属性	类型	描述
`lastTargetRef`	`对象`	lastTargetRef 包含对最近观察到的可扩展资源的引用

3.1.4. .status.lastTargetRef

描述

lastTargetRef 包含对最近观察到的可扩展资源的引用

类型

object

必填

kind
name

属性	类型	描述
`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
`name`	`字符串`	name 指定对象的名称，如 worker-us-east-1a。可扩展资源应该存在于单一命名空间中。

3.2. API 端点

可用的 API 端点如下：

/apis/autoscaling.openshift.io/v1beta1/machineautoscalers
- GET ：列出 MachineAutoscaler 类型的对象
/apis/autoscaling.openshift.io/v1beta1/namespaces/{namespace}/machineautoscalers
- DELETE ：删除 MachineAutoscaler 集合
- GET ：列出 MachineAutoscaler 类型的对象
- POST ：创建 MachineAutoscaler
/apis/autoscaling.openshift.io/v1beta1/namespaces/{namespace}/machineautoscalers/{name}
- DELETE ：删除 MachineAutoscaler
- GET ：读取指定的 MachineAutoscaler
- PATCH: 部分更新指定的 MachineAutoscaler
- PUT ：替换指定的 MachineAutoscaler
/apis/autoscaling.openshift.io/v1beta1/namespaces/{namespace}/machineautoscalers/{name}/status
- GET ：指定 MachineAutoscaler 的读取状态
- PATCH: 部分更新指定 MachineAutoscaler 的状态
- PUT ：替换指定 MachineAutoscaler 的状态

3.2.1. /apis/autoscaling.openshift.io/v1beta1/machineautoscalers

HTTP 方法: GET
描述: 列出 MachineAutoscaler 类型的对象

表 3.1. HTTP 响应
HTTP 代码	响应正文
200 - OK	`MachineAutoscalerList` 模式
401 - Unauthorized	空

3.2.2. /apis/autoscaling.openshift.io/v1beta1/namespaces/{namespace}/machineautoscalers

HTTP 方法: DELETE
描述: 删除 MachineAutoscaler 集合

表 3.2. HTTP 响应
HTTP 代码	响应正文
200 - OK	`Status` 模式
401 - Unauthorized	空

HTTP 方法: GET
描述: 列出 MachineAutoscaler 类型的对象

表 3.3. HTTP 响应
HTTP 代码	响应正文
200 - OK	`MachineAutoscalerList` 模式
401 - Unauthorized	空

HTTP 方法: POST
描述: 创建 MachineAutoscaler

表 3.4. 查询参数
参数	类型	描述
`dryRun`	`字符串`	出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理
`fieldValidation`	`string`	fieldValidation 指示服务器如何处理包含了未知或重复字段的请求 (POST/PUT/PATCH) 中的对象。有效值为： - Ignore ：忽略从对象中静默丢弃的未知字段，并将忽略所有除最后一个重复字段以外的所有字段。这是 v1.23 版本之前的默认行为- Warn: 这会通过标准的警告响应头为从对象丢弃的每个未知字段以及遇到的每个重复字段，发送警告。如果没有其他错误，请求仍会成功，且只保留重复字段的最后一个。这是 v1.23+ 的的默认行为 - Strict: 如果从对象中删除了任何未知字段，或者存在任何重复字段，请求将失败并带有 BadRequest 错误。从服务器返回的错误将包含遇到的，以及重复的字段。

表 3.5. 主体参数
参数	类型	描述
`正文（body）`	`MachineAutoscaler` 模式

表 3.6. HTTP 响应
HTTP 代码	响应正文
200 - OK	`MachineAutoscaler` 模式
201 - Created	`MachineAutoscaler` 模式
202 - Accepted	`MachineAutoscaler` 模式
401 - Unauthorized	空

3.2.3. /apis/autoscaling.openshift.io/v1beta1/namespaces/{namespace}/machineautoscalers/{name}

表 3.7. 全局路径参数
参数	类型	描述
`name`	`字符串`	MachineAutoscaler 的名称

HTTP 方法: DELETE
描述: 删除 MachineAutoscaler

表 3.8. 查询参数
参数	类型	描述
`dryRun`	`字符串`	出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理

表 3.9. HTTP 响应
HTTP 代码	响应正文
200 - OK	`Status` 模式
202 - Accepted	`Status` 模式
401 - Unauthorized	空

HTTP 方法: GET
描述: 阅读指定的 MachineAutoscaler

表 3.10. HTTP 响应
HTTP 代码	响应正文
200 - OK	`MachineAutoscaler` 模式
401 - Unauthorized	空

HTTP 方法: PATCH
描述: 部分更新指定的 MachineAutoscaler

表 3.11. 查询参数
参数	类型	描述
`dryRun`	`字符串`	出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理
`fieldValidation`	`string`	fieldValidation 指示服务器如何处理包含了未知或重复字段的请求 (POST/PUT/PATCH) 中的对象。有效值为： - Ignore ：忽略从对象中静默丢弃的未知字段，并将忽略所有除最后一个重复字段以外的所有字段。这是 v1.23 版本之前的默认行为- Warn: 这会通过标准的警告响应头为从对象丢弃的每个未知字段以及遇到的每个重复字段，发送警告。如果没有其他错误，请求仍会成功，且只保留重复字段的最后一个。这是 v1.23+ 的的默认行为 - Strict: 如果从对象中删除了任何未知字段，或者存在任何重复字段，请求将失败并带有 BadRequest 错误。从服务器返回的错误将包含遇到的，以及重复的字段。

表 3.12. HTTP 响应
HTTP 代码	响应正文
200 - OK	`MachineAutoscaler` 模式
401 - Unauthorized	空

HTTP 方法: PUT
描述: 替换指定的 MachineAutoscaler

表 3.13. 查询参数
参数	类型	描述
`dryRun`	`字符串`	出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理
`fieldValidation`	`string`	fieldValidation 指示服务器如何处理包含了未知或重复字段的请求 (POST/PUT/PATCH) 中的对象。有效值为： - Ignore ：忽略从对象中静默丢弃的未知字段，并将忽略所有除最后一个重复字段以外的所有字段。这是 v1.23 版本之前的默认行为- Warn: 这会通过标准的警告响应头为从对象丢弃的每个未知字段以及遇到的每个重复字段，发送警告。如果没有其他错误，请求仍会成功，且只保留重复字段的最后一个。这是 v1.23+ 的的默认行为 - Strict: 如果从对象中删除了任何未知字段，或者存在任何重复字段，请求将失败并带有 BadRequest 错误。从服务器返回的错误将包含遇到的，以及重复的字段。

表 3.14. 主体参数
参数	类型	描述
`正文（body）`	`MachineAutoscaler` 模式

表 3.15. HTTP 响应
HTTP 代码	响应正文
200 - OK	`MachineAutoscaler` 模式
201 - Created	`MachineAutoscaler` 模式
401 - Unauthorized	空

3.2.4. /apis/autoscaling.openshift.io/v1beta1/namespaces/{namespace}/machineautoscalers/{name}/status

表 3.16. 全局路径参数
参数	类型	描述
`name`	`字符串`	MachineAutoscaler 的名称

HTTP 方法: GET
描述: 指定 MachineAutoscaler 的读取状态

表 3.17. HTTP 响应
HTTP 代码	响应正文
200 - OK	`MachineAutoscaler` 模式
401 - Unauthorized	空

HTTP 方法: PATCH
描述: 部分更新指定 MachineAutoscaler 的状态

表 3.18. 查询参数
参数	类型	描述
`dryRun`	`字符串`	出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理
`fieldValidation`	`string`	fieldValidation 指示服务器如何处理包含了未知或重复字段的请求 (POST/PUT/PATCH) 中的对象。有效值为： - Ignore ：忽略从对象中静默丢弃的未知字段，并将忽略所有除最后一个重复字段以外的所有字段。这是 v1.23 版本之前的默认行为- Warn: 这会通过标准的警告响应头为从对象丢弃的每个未知字段以及遇到的每个重复字段，发送警告。如果没有其他错误，请求仍会成功，且只保留重复字段的最后一个。这是 v1.23+ 的的默认行为 - Strict: 如果从对象中删除了任何未知字段，或者存在任何重复字段，请求将失败并带有 BadRequest 错误。从服务器返回的错误将包含遇到的，以及重复的字段。

表 3.19. HTTP 响应
HTTP 代码	响应正文
200 - OK	`MachineAutoscaler` 模式
401 - Unauthorized	空

HTTP 方法: PUT
描述: 替换指定 MachineAutoscaler 的状态

表 3.20. 查询参数
参数	类型	描述
`dryRun`	`字符串`	出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理
`fieldValidation`	`string`	fieldValidation 指示服务器如何处理包含了未知或重复字段的请求 (POST/PUT/PATCH) 中的对象。有效值为： - Ignore ：忽略从对象中静默丢弃的未知字段，并将忽略所有除最后一个重复字段以外的所有字段。这是 v1.23 版本之前的默认行为- Warn: 这会通过标准的警告响应头为从对象丢弃的每个未知字段以及遇到的每个重复字段，发送警告。如果没有其他错误，请求仍会成功，且只保留重复字段的最后一个。这是 v1.23+ 的的默认行为 - Strict: 如果从对象中删除了任何未知字段，或者存在任何重复字段，请求将失败并带有 BadRequest 错误。从服务器返回的错误将包含遇到的，以及重复的字段。

表 3.21. 主体参数
参数	类型	描述
`正文（body）`	`MachineAutoscaler` 模式

表 3.22. HTTP 响应
HTTP 代码	响应正文
200 - OK	`MachineAutoscaler` 模式
201 - Created	`MachineAutoscaler` 模式
401 - Unauthorized	空

第 4 章 HorizontalPodAutoscaler [autoscaling/v2]

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

4.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
`metadata`	`ObjectMeta`	metadata 是标准对象元数据。更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
`spec`	`object`	HorizontalPodAutoscalerSpec 描述了 HorizontalPodAutoscaler 所需的功能。
`status`	`object`	HorizontalPodAutoscalerStatus 描述了 pod 横向自动扩展的当前状态。

4.1.1. .spec

描述

HorizontalPodAutoscalerSpec 描述了 HorizontalPodAutoscaler 所需的功能。

类型

object

必填

scaleTargetRef
maxReplicas

属性	类型	描述
`行为`	`object`	HorizontalPodAutoscalerBehavior 在 Up 和 Down directions (scaleUp 和 scaleDown 字段)中分别配置目标的扩展行为。
`maxReplicas`	`整数`	maxReplicas 是自动扩展可以向上扩展的副本数的上限。minReplicas 不能小于该 minReplicas。
`metrics`	`数组`	指标包含用于计算所需副本数的规格（将使用所有指标的最大副本数）。所需的副本数乘以 target 值与当前 pod 数量之间的比率。在增加 pod 数量时，使用的指标必须减少，反之亦然。如需有关每种指标类型如何响应的更多信息，请参阅单独的指标源类型。如果没有设置，则默认指标将设置为 80% 平均 CPU 使用率。
`metrics[]`	`object`	MetricSpec 根据单一指标指定如何缩放（仅应一次设置 `类型和` 另一个匹配字段）。
`minReplicas`	`整数`	minReplicas 是自动扩展可以缩减的副本数的下限。如果启用了 alpha 功能门 HPAScaleToZero，并且至少配置一个 Object 或 External 指标，则默认为 1 个 pod。minReplicas 允许为 0。只要至少有一个指标值可用，缩放就会激活。
`scaleTargetRef`	`对象`	CrossVersionObjectReference 包含足够信息，以便您识别引用的资源。

4.1.2. .spec.behavior

描述: HorizontalPodAutoscalerBehavior 在 Up 和 Down directions (scaleUp 和 scaleDown 字段)中分别配置目标的扩展行为。
类型: object

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

4.1.3. .spec.behavior.scaleDown

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

属性	类型	描述
`policies`	`数组`	策略是可以在扩展过程中使用的潜在缩放策略列表。必须至少指定一个策略，否则 HPAScalingRules 将被丢弃为无效
`policies[]`	`object`	HPAScalingPolicy 是一个单一策略，对于指定间隔，必须为 true。
`selectPolicy`	`string`	selectPolicy 用于指定要使用的策略。如果没有设置，则使用默认值 Max。
`stabilizationWindowSeconds`	`整数`	stabilizationWindowSeconds 是扩展或缩减时应考虑过去建议的秒数。stabilizationWindowSeconds 必须大于或等于 0，且小于或等于 3600 （一小时）。如果没有设置，请使用默认值： - 要扩展：0 （即没有稳定的静默功能）。- 要缩减 300 （例如，stabilization window 为 300 秒）。

4.1.4. .spec.behavior.scaleDown.policies

描述: 策略是可以在扩展过程中使用的潜在缩放策略列表。必须至少指定一个策略，否则 HPAScalingRules 将被丢弃为无效
类型: 数组

4.1.5. .spec.behavior.scaleDown.policies[]

描述

HPAScalingPolicy 是一个单一策略，对于指定间隔，必须为 true。

类型

object

必填

type
value
periodSeconds

属性	类型	描述
`periodSeconds`	`整数`	periodSeconds 指定策略应为 true 的时间窗口。periodSeconds 必须大于零，且小于或等于 1800 (30 分钟)。
`type`	`string`	type 用于指定扩展策略。
`value`	`整数`	值包含策略所允许的更改量。它必须大于零

4.1.6. .spec.behavior.scaleUp

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

属性	类型	描述
`policies`	`数组`	策略是可以在扩展过程中使用的潜在缩放策略列表。必须至少指定一个策略，否则 HPAScalingRules 将被丢弃为无效
`policies[]`	`object`	HPAScalingPolicy 是一个单一策略，对于指定间隔，必须为 true。
`selectPolicy`	`string`	selectPolicy 用于指定要使用的策略。如果没有设置，则使用默认值 Max。
`stabilizationWindowSeconds`	`整数`	stabilizationWindowSeconds 是扩展或缩减时应考虑过去建议的秒数。stabilizationWindowSeconds 必须大于或等于 0，且小于或等于 3600 （一小时）。如果没有设置，请使用默认值： - 要扩展：0 （即没有稳定的静默功能）。- 要缩减 300 （例如，stabilization window 为 300 秒）。

4.1.7. .spec.behavior.scaleUp.policies

描述: 策略是可以在扩展过程中使用的潜在缩放策略列表。必须至少指定一个策略，否则 HPAScalingRules 将被丢弃为无效
类型: 数组

4.1.8. .spec.behavior.scaleUp.policies[]

描述

HPAScalingPolicy 是一个单一策略，对于指定间隔，必须为 true。

类型

object

必填

type
value
periodSeconds

属性	类型	描述
`periodSeconds`	`整数`	periodSeconds 指定策略应为 true 的时间窗口。periodSeconds 必须大于零，且小于或等于 1800 (30 分钟)。
`type`	`string`	type 用于指定扩展策略。
`value`	`整数`	值包含策略所允许的更改量。它必须大于零

4.1.9. .spec.metrics

描述: 指标包含用于计算所需副本数的规格（将使用所有指标的最大副本数）。所需的副本数乘以 target 值与当前 pod 数量之间的比率。在增加 pod 数量时，使用的指标必须减少，反之亦然。如需有关每种指标类型如何响应的更多信息，请参阅单独的指标源类型。如果没有设置，则默认指标将设置为 80% 平均 CPU 使用率。
类型: 数组

4.1.10. .spec.metrics[]

描述

MetricSpec 根据单一指标指定如何缩放（仅应一次设置 类型和 另一个匹配字段）。

类型

object

必填

type

属性	类型	描述
`containerResource`	`object`	ContainerResourceMetricSource 指示如何扩展 Kubernetes 已知的资源指标，如请求和限值中指定的，描述当前 scale 目标中的每个 pod （如 CPU 或内存）。与目标相比，这些值将平均合上。此类指标内置在 Kubernetes 中，并且具有特殊的扩展选项，它们之上使用 "pods" 源的普通每个 pod 指标。应该只设置一个"目标"类型。
`external`	`object`	ExternalMetricSource 表示如何在不与任何 Kubernetes 对象关联的指标上扩展（例如，云消息传递服务中的队列长度，或从集群外运行的 loadbalancer 中的 QPS）。
`object`	`object`	ObjectMetricSource 指示如何在描述 kubernetes 对象的指标上缩放（例如，Ingress 对象上的 hits-per-second）。
`pods`	`object`	PodsMetricSource 表示如何在当前 scale 目标中描述每个 pod 的指标（例如，Transaction-processed-per-second）。这些值在与 target 值进行比较之前会平均在一起。
`resource`	`object`	ResourceMetricSource 指示如何缩放 Kubernetes 已知资源指标（如请求和限值中指定的），描述当前规模目标中的每个 pod （如 CPU 或内存）。与目标相比，这些值将平均合上。此类指标内置在 Kubernetes 中，并且具有特殊的扩展选项，它们之上使用 "pods" 源的普通每个 pod 指标。应该只设置一个"目标"类型。
`type`	`string`	type 是指标源的类型。它应该是 "ContainerResource", "External", "Object", "Pods" 或 "Resource" 之一，每个映射到对象中的匹配字段。注："ContainerResource" 类型在启用了 feature-gate HPAContainerMetrics 时可用

4.1.11. .spec.metrics[].containerResource

描述

ContainerResourceMetricSource 指示如何扩展 Kubernetes 已知的资源指标，如请求和限值中指定的，描述当前 scale 目标中的每个 pod （如 CPU 或内存）。与目标相比，这些值将平均合上。此类指标内置在 Kubernetes 中，并且具有特殊的扩展选项，它们之上使用 "pods" 源的普通每个 pod 指标。应该只设置一个"目标"类型。

类型

object

必填

名称
target
container

属性	类型	描述
`container`	`string`	container 是扩展目标 pod 中的容器名称
`名称`	`string`	name 是有问题的资源的名称。
`target`	`object`	MetricTarget 定义特定指标的目标值、平均值或平均利用率

4.1.12. .spec.metrics[].containerResource.target

描述

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

类型

object

必填

type

属性	类型	描述
`averageUtilization`	`整数`	averageUtilization 是所有相关 pod 中资源指标平均值的目标值，以 pod 资源请求的值的百分比表示。目前仅对 Resource 指标源类型有效
`averageValue`	`数量`	AverageValue 是所有相关 pod 间的指标平均值的目标值（作为数量）
`type`	`string`	type 代表指标类型是 Utilization、Value 或 AverageValue
`value`	`数量`	值是指标（作为一个数量）的目标值。

4.1.13. .spec.metrics[].external

描述

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

类型

object

必填

metric
target

属性	类型	描述
`metric`	`object`	MetricIdentifier 定义指标的名称和可选选择器
`target`	`object`	MetricTarget 定义特定指标的目标值、平均值或平均利用率

4.1.14. .spec.metrics[].external.metric

描述

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

类型

object

必填

name

属性	类型	描述
`name`	`string`	name 是给定指标的名称
`selector`	`LabelSelector`	选择器是在设置时给定指标的标准 kubernetes 标签选择器的字符串编码形式，它会作为额外参数传递给指标服务器，以进行更具体的指标范围。如果未设置，只有 metricName 将用于收集指标。

4.1.15. .spec.metrics[].external.target

描述

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

类型

object

必填

type

属性	类型	描述
`averageUtilization`	`整数`	averageUtilization 是所有相关 pod 中资源指标平均值的目标值，以 pod 资源请求的值的百分比表示。目前仅对 Resource 指标源类型有效
`averageValue`	`数量`	AverageValue 是所有相关 pod 间的指标平均值的目标值（作为数量）
`type`	`string`	type 代表指标类型是 Utilization、Value 或 AverageValue
`value`	`数量`	值是指标（作为一个数量）的目标值。

4.1.16. .spec.metrics[].object

描述

ObjectMetricSource 指示如何在描述 kubernetes 对象的指标上缩放（例如，Ingress 对象上的 hits-per-second）。

类型

object

必填

describedObject
target
metric

属性	类型	描述
`describedObject`	`object`	CrossVersionObjectReference 包含足够信息，以便您识别引用的资源。
`metric`	`object`	MetricIdentifier 定义指标的名称和可选选择器
`target`	`object`	MetricTarget 定义特定指标的目标值、平均值或平均利用率

4.1.17. .spec.metrics[].object.describedObject

描述

CrossVersionObjectReference 包含足够信息，以便您识别引用的资源。

类型

object

必填

kind
name

属性	类型	描述
`apiVersion`	`string`	apiVersion 是引用的 API 版本
`kind`	`string`	kind 是引用的类型；更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
`名称`	`string`	name 是引用的名称；更多信息： https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

4.1.18. .spec.metrics[].object.metric

描述

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

类型

object

必填

name

属性	类型	描述
`name`	`string`	name 是给定指标的名称
`selector`	`LabelSelector`	选择器是在设置时给定指标的标准 kubernetes 标签选择器的字符串编码形式，它会作为额外参数传递给指标服务器，以进行更具体的指标范围。如果未设置，只有 metricName 将用于收集指标。

4.1.19. .spec.metrics[].object.target

描述

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

类型

object

必填

type

属性	类型	描述
`averageUtilization`	`整数`	averageUtilization 是所有相关 pod 中资源指标平均值的目标值，以 pod 资源请求的值的百分比表示。目前仅对 Resource 指标源类型有效
`averageValue`	`数量`	AverageValue 是所有相关 pod 间的指标平均值的目标值（作为数量）
`type`	`string`	type 代表指标类型是 Utilization、Value 或 AverageValue
`value`	`数量`	值是指标（作为一个数量）的目标值。

4.1.20. .spec.metrics[].pods

描述

PodsMetricSource 表示如何在当前 scale 目标中描述每个 pod 的指标（例如，Transaction-processed-per-second）。这些值在与 target 值进行比较之前会平均在一起。

类型

object

必填

metric
target

属性	类型	描述
`metric`	`object`	MetricIdentifier 定义指标的名称和可选选择器
`target`	`object`	MetricTarget 定义特定指标的目标值、平均值或平均利用率

4.1.21. .spec.metrics[].pods.metric

描述

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

类型

object

必填

name

属性	类型	描述
`name`	`string`	name 是给定指标的名称
`selector`	`LabelSelector`	选择器是在设置时给定指标的标准 kubernetes 标签选择器的字符串编码形式，它会作为额外参数传递给指标服务器，以进行更具体的指标范围。如果未设置，只有 metricName 将用于收集指标。

4.1.22. .spec.metrics[].pods.target

描述

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

类型

object

必填

type

属性	类型	描述
`averageUtilization`	`整数`	averageUtilization 是所有相关 pod 中资源指标平均值的目标值，以 pod 资源请求的值的百分比表示。目前仅对 Resource 指标源类型有效
`averageValue`	`数量`	AverageValue 是所有相关 pod 间的指标平均值的目标值（作为数量）
`type`	`string`	type 代表指标类型是 Utilization、Value 或 AverageValue
`value`	`数量`	值是指标（作为一个数量）的目标值。

4.1.23. .spec.metrics[].resource

描述

ResourceMetricSource 指示如何缩放 Kubernetes 已知资源指标（如请求和限值中指定的），描述当前规模目标中的每个 pod （如 CPU 或内存）。与目标相比，这些值将平均合上。此类指标内置在 Kubernetes 中，并且具有特殊的扩展选项，它们之上使用 "pods" 源的普通每个 pod 指标。应该只设置一个"目标"类型。

类型

object

必填

名称
target

属性	类型	描述
`name`	`string`	name 是有问题的资源的名称。
`target`	`object`	MetricTarget 定义特定指标的目标值、平均值或平均利用率

4.1.24. .spec.metrics[].resource.target

描述

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

类型

object

必填

type

属性	类型	描述
`averageUtilization`	`整数`	averageUtilization 是所有相关 pod 中资源指标平均值的目标值，以 pod 资源请求的值的百分比表示。目前仅对 Resource 指标源类型有效
`averageValue`	`数量`	AverageValue 是所有相关 pod 间的指标平均值的目标值（作为数量）
`type`	`string`	type 代表指标类型是 Utilization、Value 或 AverageValue
`value`	`数量`	值是指标（作为一个数量）的目标值。

4.1.25. .spec.scaleTargetRef

描述

CrossVersionObjectReference 包含足够信息，以便您识别引用的资源。

类型

object

必填

kind
name

属性	类型	描述
`apiVersion`	`string`	apiVersion 是引用的 API 版本
`kind`	`string`	kind 是引用的类型；更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
`名称`	`string`	name 是引用的名称；更多信息： https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

4.1.26. .status

描述

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

类型

object

必填

desiredReplicas

属性	类型	描述
`conditions`	`数组`	条件是一组此自动扩展用来扩展其目标的条件，并指示是否满足这些条件。
`conditions[]`	`object`	HorizontalPodAutoscalerCondition 描述了特定点的 HorizontalPodAutoscaler 的状态。
`currentMetrics`	`数组`	currentMetrics 是此自动扩展使用的指标的最后一个读取状态。
`currentMetrics[]`	`object`	MetricStatus 描述了单个指标的最后读取状态。
`currentReplicas`	`整数`	currentReplicas 是此自动扩展管理的 pod 数量的当前数量，如自动扩展最后看到。
`desiredReplicas`	`整数`	desiredReplicas 是此自动扩展管理的 pod 数量所需的副本数，如自动扩展最后计算。
`lastScaleTime`	`时间`	lastScaleTime 是 HorizontalPodAutoscaler 最后一次扩展 pod 数量的时间，供自动扩展用来控制 pod 数量的变化频率。
`observedGeneration`	`整数`	observedGeneration 是此自动扩展观察到的最新生成。

4.1.27. .status.conditions

描述: 条件是一组此自动扩展用来扩展其目标的条件，并指示是否满足这些条件。
类型: array

4.1.28. .status.conditions[]

描述

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

类型

object

必填

type
status

属性	类型	描述
`lastTransitionTime`	`时间`	lastTransitionTime 是条件从一个状态转换到另一个状态最后一次的时间
`message`	`string`	Message 是人类可读的解释，其中包含有关转换的详细信息
`reason`	`字符串`	reason 是条件最后一次转换的原因。
`status`	`string`	status 是条件的状态(True, False, Unknown)
`type`	`string`	type 描述了当前的条件

4.1.29. .status.currentMetrics

描述: currentMetrics 是此自动扩展使用的指标的最后一个读取状态。
类型: 数组

4.1.30. .status.currentMetrics[]

描述

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

类型

object

必填

type

属性	类型	描述
`containerResource`	`object`	ContainerResourceMetricStatus 指示 Kubernetes 已知的资源指标的当前值，如请求和限值中指定的，描述当前 scale 目标（如 CPU 或内存）中的每个 pod 中的单个容器。此类指标内置在 Kubernetes 中，并且具有特殊的扩展选项，它们之上使用 "pods" 源的普通每个 pod 指标。
`external`	`object`	ExternalMetricStatus 表示没有与任何 Kubernetes 对象关联的全局指标的当前值。
`object`	`object`	ObjectMetricStatus 指示描述 kubernetes 对象的指标的当前值（例如，Ingress 对象上的 hits-per-second）。
`pods`	`object`	PodsMetricStatus 表示在当前 scale 目标中描述每个 pod 的指标的当前值（如 transactions-processed-per-second）。
`resource`	`object`	ResourceMetricStatus 指示 Kubernetes 已知的资源指标的当前值，如请求和限值中指定的，描述当前 scale 目标中的每个 pod （如 CPU 或内存）。此类指标内置在 Kubernetes 中，并且具有特殊的扩展选项，它们之上使用 "pods" 源的普通每个 pod 指标。
`type`	`string`	type 是指标源的类型。它将是 "ContainerResource", "External", "Object", "Pods" 或 "Resource" 之一，每个项对应于对象中的匹配字段。注："ContainerResource" 类型在启用了 feature-gate HPAContainerMetrics 时可用

4.1.31. .status.currentMetrics[].containerResource

描述

ContainerResourceMetricStatus 指示 Kubernetes 已知的资源指标的当前值，如请求和限值中指定的，描述当前 scale 目标（如 CPU 或内存）中的每个 pod 中的单个容器。此类指标内置在 Kubernetes 中，并且具有特殊的扩展选项，它们之上使用 "pods" 源的普通每个 pod 指标。

类型

object

必填

名称
current
container

属性	类型	描述
`container`	`string`	container 是扩展目标 pod 中的容器名称
`current`	`object`	MetricValueStatus 包含指标的当前值
`名称`	`string`	name 是有问题的资源的名称。

4.1.32. .status.currentMetrics[].containerResource.current

描述: MetricValueStatus 包含指标的当前值
类型: object

属性	类型	描述
`averageUtilization`	`整数`	currentAverageUtilization 是所有相关 pod 中资源指标平均值的当前值，以 pod 资源请求的值的百分比表示。
`averageValue`	`数量`	AverageValue 是所有相关 pod 间的指标平均值的当前值（作为数量）
`value`	`数量`	值是指标（作为一个数量）的当前值。

4.1.33. .status.currentMetrics[].external

描述

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

类型

object

必填

metric
current

属性	类型	描述
`current`	`object`	MetricValueStatus 包含指标的当前值
`metric`	`object`	MetricIdentifier 定义指标的名称和可选选择器

4.1.34. .status.currentMetrics[].external.current

描述: MetricValueStatus 包含指标的当前值
类型: object

属性	类型	描述
`averageUtilization`	`整数`	currentAverageUtilization 是所有相关 pod 中资源指标平均值的当前值，以 pod 资源请求的值的百分比表示。
`averageValue`	`数量`	AverageValue 是所有相关 pod 间的指标平均值的当前值（作为数量）
`value`	`数量`	值是指标（作为一个数量）的当前值。

4.1.35. .status.currentMetrics[].external.metric

描述

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

类型

object

必填

name

属性	类型	描述
`name`	`string`	name 是给定指标的名称
`selector`	`LabelSelector`	选择器是在设置时给定指标的标准 kubernetes 标签选择器的字符串编码形式，它会作为额外参数传递给指标服务器，以进行更具体的指标范围。如果未设置，只有 metricName 将用于收集指标。

4.1.36. .status.currentMetrics[].object

描述

ObjectMetricStatus 指示描述 kubernetes 对象的指标的当前值（例如，Ingress 对象上的 hits-per-second）。

类型

object

必填

metric
current
describedObject

属性	类型	描述
`current`	`object`	MetricValueStatus 包含指标的当前值
`describedObject`	`object`	CrossVersionObjectReference 包含足够信息，以便您识别引用的资源。
`metric`	`object`	MetricIdentifier 定义指标的名称和可选选择器

4.1.37. .status.currentMetrics[].object.current

描述: MetricValueStatus 包含指标的当前值
类型: object

属性	类型	描述
`averageUtilization`	`整数`	currentAverageUtilization 是所有相关 pod 中资源指标平均值的当前值，以 pod 资源请求的值的百分比表示。
`averageValue`	`数量`	AverageValue 是所有相关 pod 间的指标平均值的当前值（作为数量）
`value`	`数量`	值是指标（作为一个数量）的当前值。

4.1.38. .status.currentMetrics[].object.describedObject

描述

CrossVersionObjectReference 包含足够信息，以便您识别引用的资源。

类型

object

必填

kind
name

属性	类型	描述
`apiVersion`	`string`	apiVersion 是引用的 API 版本
`kind`	`string`	kind 是引用的类型；更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
`名称`	`string`	name 是引用的名称；更多信息： https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

4.1.39. .status.currentMetrics[].object.metric

描述

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

类型

object

必填

name

属性	类型	描述
`name`	`string`	name 是给定指标的名称
`selector`	`LabelSelector`	选择器是在设置时给定指标的标准 kubernetes 标签选择器的字符串编码形式，它会作为额外参数传递给指标服务器，以进行更具体的指标范围。如果未设置，只有 metricName 将用于收集指标。

4.1.40. .status.currentMetrics[].pods

描述

PodsMetricStatus 表示在当前 scale 目标中描述每个 pod 的指标的当前值（如 transactions-processed-per-second）。

类型

object

必填

metric
current

属性	类型	描述
`current`	`object`	MetricValueStatus 包含指标的当前值
`metric`	`object`	MetricIdentifier 定义指标的名称和可选选择器

4.1.41. .status.currentMetrics[].pods.current

描述: MetricValueStatus 包含指标的当前值
类型: object

属性	类型	描述
`averageUtilization`	`整数`	currentAverageUtilization 是所有相关 pod 中资源指标平均值的当前值，以 pod 资源请求的值的百分比表示。
`averageValue`	`数量`	AverageValue 是所有相关 pod 间的指标平均值的当前值（作为数量）
`value`	`数量`	值是指标（作为一个数量）的当前值。

4.1.42. .status.currentMetrics[].pods.metric

描述

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

类型

object

必填

name

属性	类型	描述
`name`	`string`	name 是给定指标的名称
`selector`	`LabelSelector`	选择器是在设置时给定指标的标准 kubernetes 标签选择器的字符串编码形式，它会作为额外参数传递给指标服务器，以进行更具体的指标范围。如果未设置，只有 metricName 将用于收集指标。

4.1.43. .status.currentMetrics[].resource

描述

ResourceMetricStatus 指示 Kubernetes 已知的资源指标的当前值，如请求和限值中指定的，描述当前 scale 目标中的每个 pod （如 CPU 或内存）。此类指标内置在 Kubernetes 中，并且具有特殊的扩展选项，它们之上使用 "pods" 源的普通每个 pod 指标。

类型

object

必填

名称
current

属性	类型	描述
`current`	`object`	MetricValueStatus 包含指标的当前值
`名称`	`string`	name 是有问题的资源的名称。

4.1.44. .status.currentMetrics[].resource.current

描述: MetricValueStatus 包含指标的当前值
类型: object

属性	类型	描述
`averageUtilization`	`整数`	currentAverageUtilization 是所有相关 pod 中资源指标平均值的当前值，以 pod 资源请求的值的百分比表示。
`averageValue`	`数量`	AverageValue 是所有相关 pod 间的指标平均值的当前值（作为数量）
`value`	`数量`	值是指标（作为一个数量）的当前值。

4.2. API 端点

可用的 API 端点如下：

/apis/autoscaling/v2/horizontalpodautoscalers
- GET: 列出或监视类型为 HorizontalPodAutoscaler 的对象
/apis/autoscaling/v2/watch/horizontalpodautoscalers
- GET: 观察对 HorizontalPodAutoscaler 列表的单独更改。已弃用：改为使用 'watch' 参数及列表操作。
/apis/autoscaling/v2/namespaces/{namespace}/horizontalpodautoscalers
- DELETE: delete collection of HorizontalPodAutoscaler
- GET: 列出或监视类型为 HorizontalPodAutoscaler 的对象
- POST ：创建一个 HorizontalPodAutoscaler
/apis/autoscaling/v2/watch/namespaces/{namespace}/horizontalpodautoscalers
- GET: 观察对 HorizontalPodAutoscaler 列表的单独更改。已弃用：改为使用 'watch' 参数及列表操作。
/apis/autoscaling/v2/namespaces/{namespace}/horizontalpodautoscalers/{name}
- DELETE: delete a 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 的状态

4.2.1. /apis/autoscaling/v2/horizontalpodautoscalers

HTTP 方法: GET
描述: 列出或监视类型为 HorizontalPodAutoscaler 的对象

表 4.1. HTTP 响应
HTTP 代码	响应正文
200 - OK	`HorizontalPodAutoscalerList` schema
401 - Unauthorized	空

4.2.2. /apis/autoscaling/v2/watch/horizontalpodautoscalers

HTTP 方法: GET
描述: 观察各个 HorizontalPodAutoscaler 列表的更改。已弃用：改为使用 'watch' 参数以及列表操作。

表 4.2. HTTP 响应
HTTP 代码	响应正文
200 - OK	`WatchEvent` 模式
401 - Unauthorized	空

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

HTTP 方法: DELETE
描述: delete collection of HorizontalPodAutoscaler

表 4.3. 查询参数
参数	类型	描述
`dryRun`	`字符串`	出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理

表 4.4. HTTP 响应
HTTP 代码	响应正文
200 - OK	`Status` 模式
401 - Unauthorized	空

HTTP 方法: GET
描述: 列出或监视类型为 HorizontalPodAutoscaler 的对象

表 4.5. HTTP 响应
HTTP 代码	响应正文
200 - OK	`HorizontalPodAutoscalerList` schema
401 - Unauthorized	空

HTTP 方法: POST
描述: create a HorizontalPodAutoscaler

表 4.6. 查询参数
参数	类型	描述
`dryRun`	`字符串`	出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理
`fieldValidation`	`string`	fieldValidation 指示服务器如何处理包含了未知或重复字段的请求 (POST/PUT/PATCH) 中的对象。有效值为： - Ignore ：忽略从对象中静默丢弃的未知字段，并将忽略所有除最后一个重复字段以外的所有字段。这是 v1.23 版本之前的默认行为- Warn: 这会通过标准的警告响应头为从对象丢弃的每个未知字段以及遇到的每个重复字段，发送警告。如果没有其他错误，请求仍会成功，且只保留重复字段的最后一个。这是 v1.23+ 的的默认行为 - Strict: 如果从对象中删除了任何未知字段，或者存在任何重复字段，请求将失败并带有 BadRequest 错误。从服务器返回的错误将包含遇到的，以及重复的字段。

表 4.7. 主体参数
参数	类型	描述
`正文（body）`	`HorizontalPodAutoscaler` schema

表 4.8. HTTP 响应
HTTP 代码	响应正文
200 - OK	`HorizontalPodAutoscaler` schema
201 - Created	`HorizontalPodAutoscaler` schema
202 - Accepted	`HorizontalPodAutoscaler` schema
401 - Unauthorized	空

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

HTTP 方法: GET
描述: 观察各个 HorizontalPodAutoscaler 列表的更改。已弃用：改为使用 'watch' 参数以及列表操作。

表 4.9. HTTP 响应
HTTP 代码	响应正文
200 - OK	`WatchEvent` 模式
401 - Unauthorized	空

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

表 4.10. 全局路径参数
参数	类型	描述
`name`	`字符串`	HorizontalPodAutoscaler 的名称

HTTP 方法: DELETE
描述: delete a HorizontalPodAutoscaler

表 4.11. 查询参数
参数	类型	描述
`dryRun`	`字符串`	出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理

表 4.12. HTTP 响应
HTTP 代码	响应正文
200 - OK	`Status` 模式
202 - Accepted	`Status` 模式
401 - Unauthorized	空

HTTP 方法: GET
描述: 阅读指定的 HorizontalPodAutoscaler

表 4.13. HTTP 响应
HTTP 代码	响应正文
200 - OK	`HorizontalPodAutoscaler` schema
401 - Unauthorized	空

HTTP 方法: PATCH
描述: 部分更新指定的 HorizontalPodAutoscaler

表 4.14. 查询参数
参数	类型	描述
`dryRun`	`字符串`	出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理
`fieldValidation`	`string`	fieldValidation 指示服务器如何处理包含了未知或重复字段的请求 (POST/PUT/PATCH) 中的对象。有效值为： - Ignore ：忽略从对象中静默丢弃的未知字段，并将忽略所有除最后一个重复字段以外的所有字段。这是 v1.23 版本之前的默认行为- Warn: 这会通过标准的警告响应头为从对象丢弃的每个未知字段以及遇到的每个重复字段，发送警告。如果没有其他错误，请求仍会成功，且只保留重复字段的最后一个。这是 v1.23+ 的的默认行为 - Strict: 如果从对象中删除了任何未知字段，或者存在任何重复字段，请求将失败并带有 BadRequest 错误。从服务器返回的错误将包含遇到的，以及重复的字段。

表 4.15. HTTP 响应
HTTP 代码	响应正文
200 - OK	`HorizontalPodAutoscaler` schema
201 - Created	`HorizontalPodAutoscaler` schema
401 - Unauthorized	空

HTTP 方法: PUT
描述: 替换指定的 HorizontalPodAutoscaler

表 4.16. 查询参数
参数	类型	描述
`dryRun`	`字符串`	出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理
`fieldValidation`	`string`	fieldValidation 指示服务器如何处理包含了未知或重复字段的请求 (POST/PUT/PATCH) 中的对象。有效值为： - Ignore ：忽略从对象中静默丢弃的未知字段，并将忽略所有除最后一个重复字段以外的所有字段。这是 v1.23 版本之前的默认行为- Warn: 这会通过标准的警告响应头为从对象丢弃的每个未知字段以及遇到的每个重复字段，发送警告。如果没有其他错误，请求仍会成功，且只保留重复字段的最后一个。这是 v1.23+ 的的默认行为 - Strict: 如果从对象中删除了任何未知字段，或者存在任何重复字段，请求将失败并带有 BadRequest 错误。从服务器返回的错误将包含遇到的，以及重复的字段。

表 4.17. 主体参数
参数	类型	描述
`正文（body）`	`HorizontalPodAutoscaler` schema

表 4.18. HTTP 响应
HTTP 代码	响应正文
200 - OK	`HorizontalPodAutoscaler` schema
201 - Created	`HorizontalPodAutoscaler` schema
401 - Unauthorized	空

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

表 4.19. 全局路径参数
参数	类型	描述
`name`	`字符串`	HorizontalPodAutoscaler 的名称

HTTP 方法: GET
描述: 观察对类型为 HorizontalPodAutoscaler 的对象的更改。已弃用：使用带列表操作的 'watch' 参数，而是过滤成一个带有 'fieldSelector' 参数的单个项目。

表 4.20. HTTP 响应
HTTP 代码	响应正文
200 - OK	`WatchEvent` 模式
401 - Unauthorized	空

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

表 4.21. 全局路径参数
参数	类型	描述
`name`	`字符串`	HorizontalPodAutoscaler 的名称

HTTP 方法: GET
描述: 指定 HorizontalPodAutoscaler 的读取状态

表 4.22. HTTP 响应
HTTP 代码	响应正文
200 - OK	`HorizontalPodAutoscaler` schema
401 - Unauthorized	空

HTTP 方法: PATCH
描述: 部分更新指定 HorizontalPodAutoscaler 的状态

表 4.23. 查询参数
参数	类型	描述
`dryRun`	`字符串`	出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理
`fieldValidation`	`string`	fieldValidation 指示服务器如何处理包含了未知或重复字段的请求 (POST/PUT/PATCH) 中的对象。有效值为： - Ignore ：忽略从对象中静默丢弃的未知字段，并将忽略所有除最后一个重复字段以外的所有字段。这是 v1.23 版本之前的默认行为- Warn: 这会通过标准的警告响应头为从对象丢弃的每个未知字段以及遇到的每个重复字段，发送警告。如果没有其他错误，请求仍会成功，且只保留重复字段的最后一个。这是 v1.23+ 的的默认行为 - Strict: 如果从对象中删除了任何未知字段，或者存在任何重复字段，请求将失败并带有 BadRequest 错误。从服务器返回的错误将包含遇到的，以及重复的字段。

表 4.24. HTTP 响应
HTTP 代码	响应正文
200 - OK	`HorizontalPodAutoscaler` schema
201 - Created	`HorizontalPodAutoscaler` schema
401 - Unauthorized	空

HTTP 方法: PUT
描述: 替换指定 HorizontalPodAutoscaler 的状态

表 4.25. 查询参数
参数	类型	描述
`dryRun`	`字符串`	出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理
`fieldValidation`	`string`	fieldValidation 指示服务器如何处理包含了未知或重复字段的请求 (POST/PUT/PATCH) 中的对象。有效值为： - Ignore ：忽略从对象中静默丢弃的未知字段，并将忽略所有除最后一个重复字段以外的所有字段。这是 v1.23 版本之前的默认行为- Warn: 这会通过标准的警告响应头为从对象丢弃的每个未知字段以及遇到的每个重复字段，发送警告。如果没有其他错误，请求仍会成功，且只保留重复字段的最后一个。这是 v1.23+ 的的默认行为 - Strict: 如果从对象中删除了任何未知字段，或者存在任何重复字段，请求将失败并带有 BadRequest 错误。从服务器返回的错误将包含遇到的，以及重复的字段。

表 4.26. 主体参数
参数	类型	描述
`正文（body）`	`HorizontalPodAutoscaler` schema

表 4.27. HTTP 响应
HTTP 代码	响应正文
200 - OK	`HorizontalPodAutoscaler` schema
201 - Created	`HorizontalPodAutoscaler` schema
401 - Unauthorized	空

第 5 章 scale [autoscaling/v1]

描述: scale 代表资源的扩展请求。
类型: 对象

5.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
`metadata`	`ObjectMeta`	标准对象元数据；更多信息：https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata。
`spec`	`对象`	ScaleSpec 描述 scale 子资源的属性。
`status`	`对象`	ScaleStatus 代表 scale 子资源的当前状态。

5.1.1. .spec

描述: ScaleSpec 描述 scale 子资源的属性。
类型: object

属性	类型	描述
`replicas`	`整数`	replicas 是扩展对象所需的实例数量。

5.1.2. .status

描述

ScaleStatus 代表 scale 子资源的当前状态。

类型

object

必填

replicas

属性	类型	描述
`replicas`	`整数`	replicas 是扩展对象观察到的实例的实际数量。
`selector`	`string`	selector 是 pod 的标签查询，它应当与副本数匹配。这与标签选择器相同，但采用字符串格式以避免由客户端内省。字符串的格式与 query-param 语法相同。有关标签选择器的更多信息： https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/

5.2. API 端点

可用的 API 端点如下：

/apis/apps/v1/namespaces/{namespace}/deployments/{name}/scale
- GET ：指定 Deployment 的读取扩展
- PATCH: 部分更新指定部署的扩展
- PUT ：替换指定 Deployment 的扩展
/apis/apps/v1/namespaces/{namespace}/replicasets/{name}/scale
- GET ：指定 ReplicaSet 的读取规模
- PATCH: 部分更新指定 ReplicaSet 的扩展
- PUT ：替换指定 ReplicaSet 的扩展
/apis/apps/v1/namespaces/{namespace}/statefulsets/{name}/scale
- GET ：指定 StatefulSet 的读取扩展
- PATCH: 部分更新指定 StatefulSet 的扩展
- PUT ：替换指定 StatefulSet 的扩展
/api/v1/namespaces/{namespace}/replicationcontrollers/{name}/scale
- GET ：指定 ReplicationController 的读取规模
- PATCH: 部分更新指定 ReplicationController 的扩展
- PUT ：替换指定 ReplicationController 的扩展

5.2.1. /apis/apps/v1/namespaces/{namespace}/deployments/{name}/scale

表 5.1. 全局路径参数
参数	类型	描述
`name`	`字符串`	Scale 的名称

HTTP 方法: GET
描述: 指定部署的读取规模

表 5.2. HTTP 响应
HTTP 代码	响应正文
200 - OK	`scale` 模式
401 - Unauthorized	空

HTTP 方法: PATCH
描述: 部分更新指定部署扩展

表 5.3. 查询参数
参数	类型	描述
`dryRun`	`字符串`	出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理
`fieldValidation`	`string`	fieldValidation 指示服务器如何处理包含了未知或重复字段的请求 (POST/PUT/PATCH) 中的对象。有效值为： - Ignore ：忽略从对象中静默丢弃的未知字段，并将忽略所有除最后一个重复字段以外的所有字段。这是 v1.23 版本之前的默认行为- Warn: 这会通过标准的警告响应头为从对象丢弃的每个未知字段以及遇到的每个重复字段，发送警告。如果没有其他错误，请求仍会成功，且只保留重复字段的最后一个。这是 v1.23+ 的的默认行为 - Strict: 如果从对象中删除了任何未知字段，或者存在任何重复字段，请求将失败并带有 BadRequest 错误。从服务器返回的错误将包含遇到的，以及重复的字段。

表 5.4. HTTP 响应
HTTP 代码	响应正文
200 - OK	`scale` 模式
201 - Created	`scale` 模式
401 - Unauthorized	空

HTTP 方法: PUT
描述: 替换指定 Deployment 的扩展

表 5.5. 查询参数
参数	类型	描述
`dryRun`	`字符串`	出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理
`fieldValidation`	`string`	fieldValidation 指示服务器如何处理包含了未知或重复字段的请求 (POST/PUT/PATCH) 中的对象。有效值为： - Ignore ：忽略从对象中静默丢弃的未知字段，并将忽略所有除最后一个重复字段以外的所有字段。这是 v1.23 版本之前的默认行为- Warn: 这会通过标准的警告响应头为从对象丢弃的每个未知字段以及遇到的每个重复字段，发送警告。如果没有其他错误，请求仍会成功，且只保留重复字段的最后一个。这是 v1.23+ 的的默认行为 - Strict: 如果从对象中删除了任何未知字段，或者存在任何重复字段，请求将失败并带有 BadRequest 错误。从服务器返回的错误将包含遇到的，以及重复的字段。

表 5.6. 主体参数
参数	类型	描述
`正文（body）`	`scale` 模式

表 5.7. HTTP 响应
HTTP 代码	响应正文
200 - OK	`scale` 模式
201 - Created	`scale` 模式
401 - Unauthorized	空

5.2.2. /apis/apps/v1/namespaces/{namespace}/replicasets/{name}/scale

表 5.8. 全局路径参数
参数	类型	描述
`name`	`字符串`	Scale 的名称

HTTP 方法: GET
描述: 指定 ReplicaSet 的读取规模

表 5.9. HTTP 响应
HTTP 代码	响应正文
200 - OK	`scale` 模式
401 - Unauthorized	空

HTTP 方法: PATCH
描述: 部分更新指定 ReplicaSet 扩展

表 5.10. 查询参数
参数	类型	描述
`dryRun`	`字符串`	出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理
`fieldValidation`	`string`	fieldValidation 指示服务器如何处理包含了未知或重复字段的请求 (POST/PUT/PATCH) 中的对象。有效值为： - Ignore ：忽略从对象中静默丢弃的未知字段，并将忽略所有除最后一个重复字段以外的所有字段。这是 v1.23 版本之前的默认行为- Warn: 这会通过标准的警告响应头为从对象丢弃的每个未知字段以及遇到的每个重复字段，发送警告。如果没有其他错误，请求仍会成功，且只保留重复字段的最后一个。这是 v1.23+ 的的默认行为 - Strict: 如果从对象中删除了任何未知字段，或者存在任何重复字段，请求将失败并带有 BadRequest 错误。从服务器返回的错误将包含遇到的，以及重复的字段。

表 5.11. HTTP 响应
HTTP 代码	响应正文
200 - OK	`scale` 模式
201 - Created	`scale` 模式
401 - Unauthorized	空

HTTP 方法: PUT
描述: 替换指定 ReplicaSet 的 scale

表 5.12. 查询参数
参数	类型	描述
`dryRun`	`字符串`	出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理
`fieldValidation`	`string`	fieldValidation 指示服务器如何处理包含了未知或重复字段的请求 (POST/PUT/PATCH) 中的对象。有效值为： - Ignore ：忽略从对象中静默丢弃的未知字段，并将忽略所有除最后一个重复字段以外的所有字段。这是 v1.23 版本之前的默认行为- Warn: 这会通过标准的警告响应头为从对象丢弃的每个未知字段以及遇到的每个重复字段，发送警告。如果没有其他错误，请求仍会成功，且只保留重复字段的最后一个。这是 v1.23+ 的的默认行为 - Strict: 如果从对象中删除了任何未知字段，或者存在任何重复字段，请求将失败并带有 BadRequest 错误。从服务器返回的错误将包含遇到的，以及重复的字段。

表 5.13. 主体参数
参数	类型	描述
`正文（body）`	`scale` 模式

表 5.14. HTTP 响应
HTTP 代码	响应正文
200 - OK	`scale` 模式
201 - Created	`scale` 模式
401 - Unauthorized	空

5.2.3. /apis/apps/v1/namespaces/{namespace}/statefulsets/{name}/scale

表 5.15. 全局路径参数
参数	类型	描述
`name`	`字符串`	Scale 的名称

HTTP 方法: GET
描述: 指定 StatefulSet 的读取扩展

表 5.16. HTTP 响应
HTTP 代码	响应正文
200 - OK	`scale` 模式
401 - Unauthorized	空

HTTP 方法: PATCH
描述: 部分更新指定 StatefulSet 的扩展

表 5.17. 查询参数
参数	类型	描述
`dryRun`	`字符串`	出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理
`fieldValidation`	`string`	fieldValidation 指示服务器如何处理包含了未知或重复字段的请求 (POST/PUT/PATCH) 中的对象。有效值为： - Ignore ：忽略从对象中静默丢弃的未知字段，并将忽略所有除最后一个重复字段以外的所有字段。这是 v1.23 版本之前的默认行为- Warn: 这会通过标准的警告响应头为从对象丢弃的每个未知字段以及遇到的每个重复字段，发送警告。如果没有其他错误，请求仍会成功，且只保留重复字段的最后一个。这是 v1.23+ 的的默认行为 - Strict: 如果从对象中删除了任何未知字段，或者存在任何重复字段，请求将失败并带有 BadRequest 错误。从服务器返回的错误将包含遇到的，以及重复的字段。

表 5.18. HTTP 响应
HTTP 代码	响应正文
200 - OK	`scale` 模式
201 - Created	`scale` 模式
401 - Unauthorized	空

HTTP 方法: PUT
描述: 替换指定 StatefulSet 的扩展

表 5.19. 查询参数
参数	类型	描述
`dryRun`	`字符串`	出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理
`fieldValidation`	`string`	fieldValidation 指示服务器如何处理包含了未知或重复字段的请求 (POST/PUT/PATCH) 中的对象。有效值为： - Ignore ：忽略从对象中静默丢弃的未知字段，并将忽略所有除最后一个重复字段以外的所有字段。这是 v1.23 版本之前的默认行为- Warn: 这会通过标准的警告响应头为从对象丢弃的每个未知字段以及遇到的每个重复字段，发送警告。如果没有其他错误，请求仍会成功，且只保留重复字段的最后一个。这是 v1.23+ 的的默认行为 - Strict: 如果从对象中删除了任何未知字段，或者存在任何重复字段，请求将失败并带有 BadRequest 错误。从服务器返回的错误将包含遇到的，以及重复的字段。

表 5.20. 主体参数
参数	类型	描述
`正文（body）`	`scale` 模式

表 5.21. HTTP 响应
HTTP 代码	响应正文
200 - OK	`scale` 模式
201 - Created	`scale` 模式
401 - Unauthorized	空

5.2.4. /api/v1/namespaces/{namespace}/replicationcontrollers/{name}/scale

表 5.22. 全局路径参数
参数	类型	描述
`name`	`字符串`	Scale 的名称

HTTP 方法: GET
描述: 指定 ReplicationController 的读取扩展

表 5.23. HTTP 响应
HTTP 代码	响应正文
200 - OK	`scale` 模式
401 - Unauthorized	空

HTTP 方法: PATCH
描述: 部分更新指定 ReplicationController 的扩展

表 5.24. 查询参数
参数	类型	描述
`dryRun`	`字符串`	出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理
`fieldValidation`	`string`	fieldValidation 指示服务器如何处理包含了未知或重复字段的请求 (POST/PUT/PATCH) 中的对象。有效值为： - Ignore ：忽略从对象中静默丢弃的未知字段，并将忽略所有除最后一个重复字段以外的所有字段。这是 v1.23 版本之前的默认行为- Warn: 这会通过标准的警告响应头为从对象丢弃的每个未知字段以及遇到的每个重复字段，发送警告。如果没有其他错误，请求仍会成功，且只保留重复字段的最后一个。这是 v1.23+ 的的默认行为 - Strict: 如果从对象中删除了任何未知字段，或者存在任何重复字段，请求将失败并带有 BadRequest 错误。从服务器返回的错误将包含遇到的，以及重复的字段。

表 5.25. HTTP 响应
HTTP 代码	响应正文
200 - OK	`scale` 模式
201 - Created	`scale` 模式
401 - Unauthorized	空

HTTP 方法: PUT
描述: 替换指定 ReplicationController 的扩展

表 5.26. 查询参数
参数	类型	描述
`dryRun`	`字符串`	出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理
`fieldValidation`	`string`	fieldValidation 指示服务器如何处理包含了未知或重复字段的请求 (POST/PUT/PATCH) 中的对象。有效值为： - Ignore ：忽略从对象中静默丢弃的未知字段，并将忽略所有除最后一个重复字段以外的所有字段。这是 v1.23 版本之前的默认行为- Warn: 这会通过标准的警告响应头为从对象丢弃的每个未知字段以及遇到的每个重复字段，发送警告。如果没有其他错误，请求仍会成功，且只保留重复字段的最后一个。这是 v1.23+ 的的默认行为 - Strict: 如果从对象中删除了任何未知字段，或者存在任何重复字段，请求将失败并带有 BadRequest 错误。从服务器返回的错误将包含遇到的，以及重复的字段。

表 5.27. 主体参数
参数	类型	描述
`正文（body）`	`scale` 模式

表 5.28. HTTP 响应
HTTP 代码	响应正文
200 - OK	`scale` 模式
201 - Created	`scale` 模式
401 - Unauthorized	空

Legal Notice

OpenShift documentation is licensed under the Apache License 2.0 (https://www.apache.org/licenses/LICENSE-2.0).

Modified versions must remove all Red Hat trademarks.

Portions adapted from https://github.com/kubernetes-incubator/service-catalog/ with modifications by Red Hat.

Red Hat, Red Hat Enterprise Linux, the Red Hat logo, the Shadowman logo, JBoss, OpenShift, Fedora, the Infinity logo, and RHCE are trademarks of Red Hat, Inc., registered in the United States and other countries.

Linux® is the registered trademark of Linus Torvalds in the United States and other countries.

Java® is a registered trademark of Oracle and/or its affiliates.

XFS® is a trademark of Silicon Graphics International Corp. or its subsidiaries in the United States and/or other countries.

MySQL® is a registered trademark of MySQL AB in the United States, the European Union and other countries.

Node.js® is an official trademark of Joyent. Red Hat Software Collections is not formally related to or endorsed by the official Joyent Node.js open source or commercial project.

The OpenStack® Word Mark and OpenStack logo are either registered trademarks/service marks or trademarks/service marks of the OpenStack Foundation, in the United States and other countries and are used with the OpenStack Foundation’s permission. We are not affiliated with, endorsed or sponsored by the OpenStack Foundation, or the OpenStack community.

All other trademarks are the property of their respective owners.

自动扩展 API