10.3. scale [autoscaling/v1]


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

10.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

对象

ScaleSpec 描述 scale 子资源的属性。

status

对象

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

10.3.1.1. .spec

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

replicas

整数

replicas 是扩展对象的所需实例数量。

10.3.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/

10.3.2. API 端点

可用的 API 端点如下:

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

    • GET :指定 Deployment 的读取扩展
    • 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 的扩展

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

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

name

字符串

扩展的名称

namespace

字符串

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

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

pretty

字符串

如果为 'true',则输出会经过 pretty print 处理。

HTTP 方法
GET
描述
指定部署的读取扩展
表 10.44. HTTP 响应
HTTP 代码响应正文

200 - OK

scale 模式

401 - Unauthorized

HTTP 方法
PATCH
描述
指定部署的部分更新扩展
表 10.45. 查询参数
参数类型描述

dryRun

字符串

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

fieldManager

字符串

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

fieldValidation

string

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

force

布尔值

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

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

正文(body)

Patch 模式

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

200 - OK

scale 模式

201 - Created

scale 模式

401 - Unauthorized

HTTP 方法
PUT
描述
替换指定 Deployment 的扩展
表 10.48. 查询参数
参数类型描述

dryRun

字符串

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

fieldManager

字符串

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

fieldValidation

string

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

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

正文(body)

scale 模式

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

200 - OK

scale 模式

201 - Created

scale 模式

401 - Unauthorized

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

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

name

字符串

扩展的名称

namespace

字符串

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

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

pretty

字符串

如果为 'true',则输出会经过 pretty print 处理。

HTTP 方法
GET
描述
指定 ReplicaSet 的读取扩展
表 10.53. HTTP 响应
HTTP 代码响应正文

200 - OK

scale 模式

401 - Unauthorized

HTTP 方法
PATCH
描述
指定 ReplicaSet 的部分更新扩展
表 10.54. 查询参数
参数类型描述

dryRun

字符串

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

fieldManager

字符串

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

fieldValidation

string

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

force

布尔值

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

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

正文(body)

Patch 模式

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

200 - OK

scale 模式

201 - Created

scale 模式

401 - Unauthorized

HTTP 方法
PUT
描述
替换指定 ReplicaSet 的扩展
表 10.57. 查询参数
参数类型描述

dryRun

字符串

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

fieldManager

字符串

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

fieldValidation

string

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

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

正文(body)

scale 模式

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

200 - OK

scale 模式

201 - Created

scale 模式

401 - Unauthorized

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

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

name

字符串

扩展的名称

namespace

字符串

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

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

pretty

字符串

如果为 'true',则输出会经过 pretty print 处理。

HTTP 方法
GET
描述
指定 StatefulSet 的读取扩展
表 10.62. HTTP 响应
HTTP 代码响应正文

200 - OK

scale 模式

401 - Unauthorized

HTTP 方法
PATCH
描述
指定 StatefulSet 的部分更新扩展
表 10.63. 查询参数
参数类型描述

dryRun

字符串

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

fieldManager

字符串

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

fieldValidation

string

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

force

布尔值

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

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

正文(body)

Patch 模式

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

200 - OK

scale 模式

201 - Created

scale 模式

401 - Unauthorized

HTTP 方法
PUT
描述
替换指定 StatefulSet 的扩展
表 10.66. 查询参数
参数类型描述

dryRun

字符串

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

fieldManager

字符串

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

fieldValidation

string

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

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

正文(body)

scale 模式

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

200 - OK

scale 模式

201 - Created

scale 模式

401 - Unauthorized

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

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

name

字符串

扩展的名称

namespace

字符串

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

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

pretty

字符串

如果为 'true',则输出会经过 pretty print 处理。

HTTP 方法
GET
描述
读取指定的 ReplicationController 的扩展
表 10.71. HTTP 响应
HTTP 代码响应正文

200 - OK

scale 模式

401 - Unauthorized

HTTP 方法
PATCH
描述
部分更新指定 ReplicationController 的扩展
表 10.72. 查询参数
参数类型描述

dryRun

字符串

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

fieldManager

字符串

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

fieldValidation

string

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

force

布尔值

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

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

正文(body)

Patch 模式

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

200 - OK

scale 模式

201 - Created

scale 模式

401 - Unauthorized

HTTP 方法
PUT
描述
替换指定 ReplicationController 的规模
表 10.75. 查询参数
参数类型描述

dryRun

字符串

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

fieldManager

字符串

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

fieldValidation

string

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

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

正文(body)

scale 模式

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

200 - OK

scale 模式

201 - Created

scale 模式

401 - Unauthorized

Red Hat logoGithubRedditYoutubeTwitter

学习

尝试、购买和销售

社区

关于红帽文档

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

让开源更具包容性

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

關於紅帽

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

© 2024 Red Hat, Inc.