缩容集群-ShrinkCluster
功能介绍
对MRS集群进行缩容。
接口约束
无
调试
您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权,具体权限要求请参见权限和受限项。
- 如果使用身份策略授权,需具备如下身份策略权限。
URI
POST /v2/{project_id}/clusters/{cluster_id}/shrink
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| project_id | 是 | String | 参数解释: 项目编号。 约束限制: 不涉及 取值范围: 只能由英文字母和数字组成,且长度为[1-64]个字符。 默认取值: 不涉及 |
| cluster_id | 是 | String | 参数解释: 集群ID。 约束限制: 不涉及 取值范围: 只能由英文字母、数字以及“_”和“-”组成,且长度为[1-64]个字符。 默认取值: 不涉及 |
请求参数
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| node_group_name | 是 | String | 参数解释: 节点组名称。 约束限制: 不涉及 取值范围: 只能由英文字母、数字以及“_”和“-”组成,且长度为[1-64]个字符。 默认取值: 不涉及 |
| count | 否 | Integer | 参数解释: 缩容节点数量,如果是指定节点缩容,则该参数可以不填。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
| resource_ids | 否 | Array of strings | 参数解释: 缩容节点时指定待删除节点的资源ID列表。 resource_ids为空时,按照系统规则自动选择删除节点。仅支持删除状态异常的ecs节点。会针对指定节点进行强制删除。可通过查询主机接口获取resource_id。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
响应参数
状态码:200
| 参数 | 参数类型 | 描述 |
|---|---|---|
| result | String | 参数解释: 更新映射请求操作结果。 约束限制: 不涉及 取值范围:
默认取值: 不涉及 |
请求示例
- 在node_group_1节点组上缩容1个节点。
/v2/ff8080828997cb24018a1b2db3440b80/clusters/f7f45c04-4303-411c-9b71-d2cb730dd162/shrink { "node_group_name" : "node_group_1", "count" : 1 } - 在node_group_1节点组上强制缩容资源id为678050cd-ba1d-4550-942d-f2e396b1c6fb的节点。
/v2/ff8080828997cb24018a1b2db3440b80/clusters/f7f45c04-4303-411c-9b71-d2cb730dd162/shrink { "node_group_name" : "node_group_1", "resource_ids" : [ "678050cd-ba1d-4550-942d-f2e396b1c6fb" ] }
响应示例
状态码: 200
缩容成功
{
"result" : "succeeded"
} 状态码
状态码请参见状态码。
错误码
请参见错误码。