OpenShift 文档正在迁移，很快将只在 docs.redhat.com（所有 Red Hat 产品文档的中心）提供。立即体验 新的文档体验。
  1. 文档
    2. history bug_report picture_as_pdf
×

规模 [autoscaling/v1]

规范

属性 类型 描述

apiVersion

字符串

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

kind

字符串

Kind 是一个字符串值，表示此对象表示的 REST 资源。服务器可以从客户端提交请求的端点推断出这一点。无法更新。采用驼峰命名法。更多信息：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 描述了缩放子资源的属性。

status

对象

ScaleStatus 表示缩放子资源的当前状态。

.spec

描述

ScaleSpec 描述了缩放子资源的属性。

类型

对象

属性 类型 描述

replicas

整数

replicas 是缩放对象的所需实例数。

.status

描述

ScaleStatus 表示缩放子资源的当前状态。

类型

对象

必需

  • replicas

属性 类型 描述

replicas

整数

replicas 是缩放对象的实际观察到的实例数。

selector

字符串

selector 是应该匹配副本数的 Pod 的标签查询。这与标签选择器相同，但使用字符串格式以避免客户端自省。字符串的格式与查询参数语法相同。有关标签选择器的更多信息：https://kubernetes.ac.cn/docs/concepts/overview/working-with-objects/labels/

API 端点

提供以下 API 端点

  • /apis/apps/v1/namespaces/{namespace}/deployments/{name}/scale

    • GET：读取指定部署的缩放比例

    • PATCH：部分更新指定部署的缩放比例

    • PUT：替换指定部署的缩放比例

  • /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 的缩放比例

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

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

name

字符串

Scale 的名称
HTTP 方法

GET

描述

读取指定 Deployment 的 scale

表2. HTTP 响应
HTTP 代码 响应体

200 - OK

Scale 模式

401 - 未授权

空
HTTP 方法

PATCH

描述

部分更新指定 Deployment 的 scale

表3. 查询参数
参数 类型 描述

dryRun

字符串

如果存在，则表示不应持久化修改。无效或无法识别的 dryRun 指令将导致错误响应，并且不会进一步处理请求。有效值为：- All：将处理所有 dry run 阶段

fieldValidation

字符串

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

200 - OK

Scale 模式

201 - 已创建

Scale 模式

401 - 未授权

空
HTTP 方法

PUT

描述

替换指定 Deployment 的 scale

表5. 查询参数
参数 类型 描述

dryRun

字符串

如果存在，则表示不应持久化修改。无效或无法识别的 dryRun 指令将导致错误响应，并且不会进一步处理请求。有效值为：- All：将处理所有 dry run 阶段

fieldValidation

字符串

fieldValidation 指示服务器如何处理请求 (POST/PUT/PATCH) 中包含未知或重复字段的对象。有效值为：- Ignore：这将忽略从对象中静默删除的任何未知字段，并将忽略解码器遇到的最后一个重复字段之前的任何重复字段。这是 v1.23 之前的默认行为。- Warn：对于从对象中删除的每个未知字段以及遇到的每个重复字段，这将通过标准警告响应标头发送警告。如果没有任何其他错误，请求仍将成功，并且只会保留任何重复字段中的最后一个。这是 v1.23+ 的默认值 - Strict：如果从对象中删除任何未知字段，或者存在任何重复字段，这将使请求失败并返回 BadRequest 错误。服务器返回的错误将包含遇到的所有未知和重复字段。
表6. 请求体参数
参数 类型 描述

body

Scale 模式
表7. HTTP 响应
HTTP 代码 响应体

200 - OK

Scale 模式

201 - 已创建

Scale 模式

401 - 未授权

空

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

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

name

字符串

Scale 的名称
HTTP 方法

GET

描述

读取指定 ReplicaSet 的 scale

表9. HTTP 响应
HTTP 代码 响应体

200 - OK

Scale 模式

401 - 未授权

空
HTTP 方法

PATCH

描述

部分更新指定 ReplicaSet 的 scale

表10. 查询参数
参数 类型 描述

dryRun

字符串

如果存在，则表示不应持久化修改。无效或无法识别的 dryRun 指令将导致错误响应，并且不会进一步处理请求。有效值为：- All：将处理所有 dry run 阶段

fieldValidation

字符串

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

200 - OK

Scale 模式

201 - 已创建

Scale 模式

401 - 未授权

空
HTTP 方法

PUT

描述

替换指定 ReplicaSet 的 scale

表12. 查询参数
参数 类型 描述

dryRun

字符串

如果存在，则表示不应持久化修改。无效或无法识别的 dryRun 指令将导致错误响应，并且不会进一步处理请求。有效值为：- All：将处理所有 dry run 阶段

fieldValidation

字符串

fieldValidation 指示服务器如何处理请求 (POST/PUT/PATCH) 中包含未知或重复字段的对象。有效值为：- Ignore：这将忽略从对象中静默删除的任何未知字段，并将忽略解码器遇到的最后一个重复字段之前的任何重复字段。这是 v1.23 之前的默认行为。- Warn：对于从对象中删除的每个未知字段以及遇到的每个重复字段，这将通过标准警告响应标头发送警告。如果没有任何其他错误，请求仍将成功，并且只会保留任何重复字段中的最后一个。这是 v1.23+ 的默认值 - Strict：如果从对象中删除任何未知字段，或者存在任何重复字段，这将使请求失败并返回 BadRequest 错误。服务器返回的错误将包含遇到的所有未知和重复字段。
表13. 请求体参数
参数 类型 描述

body

Scale 模式
表14. HTTP 响应
HTTP 代码 响应体

200 - OK

Scale 模式

201 - 已创建

Scale 模式

401 - 未授权

空

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

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

name

字符串

Scale 的名称
HTTP 方法

GET

描述

读取指定 StatefulSet 的 scale

表16. HTTP 响应
HTTP 代码 响应体

200 - OK

Scale 模式

401 - 未授权

空
HTTP 方法

PATCH

描述

部分更新指定 StatefulSet 的 scale

表17. 查询参数
参数 类型 描述

dryRun

字符串

如果存在，则表示不应持久化修改。无效或无法识别的 dryRun 指令将导致错误响应，并且不会进一步处理请求。有效值为：- All：将处理所有 dry run 阶段

fieldValidation

字符串

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

200 - OK

Scale 模式

201 - 已创建

Scale 模式

401 - 未授权

空
HTTP 方法

PUT

描述

替换指定 StatefulSet 的 scale

表19. 查询参数
参数 类型 描述

dryRun

字符串

如果存在，则表示不应持久化修改。无效或无法识别的 dryRun 指令将导致错误响应，并且不会进一步处理请求。有效值为：- All：将处理所有 dry run 阶段

fieldValidation

字符串

fieldValidation 指示服务器如何处理请求 (POST/PUT/PATCH) 中包含未知或重复字段的对象。有效值为：- Ignore：这将忽略从对象中静默删除的任何未知字段，并将忽略解码器遇到的最后一个重复字段之前的任何重复字段。这是 v1.23 之前的默认行为。- Warn：对于从对象中删除的每个未知字段以及遇到的每个重复字段，这将通过标准警告响应标头发送警告。如果没有任何其他错误，请求仍将成功，并且只会保留任何重复字段中的最后一个。这是 v1.23+ 的默认值 - Strict：如果从对象中删除任何未知字段，或者存在任何重复字段，这将使请求失败并返回 BadRequest 错误。服务器返回的错误将包含遇到的所有未知和重复字段。
表20. 请求体参数
参数 类型 描述

body

Scale 模式
表21. HTTP 响应
HTTP 代码 响应体

200 - OK

Scale 模式

201 - 已创建

Scale 模式

401 - 未授权

空

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

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

name

字符串

Scale 的名称
HTTP 方法

GET

描述

读取指定 ReplicationController 的 scale

表23. HTTP 响应
HTTP 代码 响应体

200 - OK

Scale 模式

401 - 未授权

空
HTTP 方法

PATCH

描述

部分更新指定 ReplicationController 的 scale

表24. 查询参数
参数 类型 描述

dryRun

字符串

如果存在，则表示不应持久化修改。无效或无法识别的 dryRun 指令将导致错误响应，并且不会进一步处理请求。有效值为：- All：将处理所有 dry run 阶段

fieldValidation

字符串

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

200 - OK

Scale 模式

201 - 已创建

Scale 模式

401 - 未授权

空
HTTP 方法

PUT

描述

替换指定 ReplicationController 的 scale

表26. 查询参数
参数 类型 描述

dryRun

字符串

如果存在，则表示不应持久化修改。无效或无法识别的 dryRun 指令将导致错误响应，并且不会进一步处理请求。有效值为：- All：将处理所有 dry run 阶段

fieldValidation

字符串

fieldValidation 指示服务器如何处理请求 (POST/PUT/PATCH) 中包含未知或重复字段的对象。有效值为：- Ignore：这将忽略从对象中静默删除的任何未知字段，并将忽略解码器遇到的最后一个重复字段之前的任何重复字段。这是 v1.23 之前的默认行为。- Warn：对于从对象中删除的每个未知字段以及遇到的每个重复字段，这将通过标准警告响应标头发送警告。如果没有任何其他错误，请求仍将成功，并且只会保留任何重复字段中的最后一个。这是 v1.23+ 的默认值 - Strict：如果从对象中删除任何未知字段，或者存在任何重复字段，这将使请求失败并返回 BadRequest 错误。服务器返回的错误将包含遇到的所有未知和重复字段。
表27. 请求体参数
参数 类型 描述

body

Scale 模式
表28. HTTP 响应
HTTP 代码 响应体

200 - OK

Scale 模式

201 - 已创建

Scale 模式

401 - 未授权

空