更新时间:2024-11-06 GMT+08:00

节点开启缩容保护

功能介绍

该API用于节点开启缩容保护,开启缩容保护的节点无法通过修改节点池个数的方式被缩容。

调用方法

请参见如何调用API

URI

POST /api/v3/projects/{project_id}/clusters/{cluster_id}/nodes/locknodescaledown

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

参数解释:

项目ID,获取方式请参见如何获取接口URI中参数

约束限制:

不涉及

取值范围:

账号的项目ID

默认取值:

不涉及

cluster_id

String

参数解释:

集群ID,获取方式请参见如何获取接口URI中参数

约束限制:

不涉及

取值范围:

集群ID

默认取值:

不涉及

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

Content-Type

String

参数解释:

消息体的类型(格式)

约束限制:

GET方法不做校验

取值范围:

  • application/json

  • application/json;charset=utf-8

  • application/x-pem-file

默认取值:

不涉及

X-Auth-Token

String

参数解释:

调用接口的认证方式分为Token和AK/SK两种,如果您使用的Token方式,此参数为必填,请填写Token的值,获取方式请参见获取token

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

表3 请求Body参数

参数

是否必选

参数类型

描述

apiVersion

String

API版本,固定值“v3”。

kind

String

API类型,固定值“List”。

nodeList

Array of strings

需要开启缩容保护的节点ID列表,节点ID获取方式请参见如何获取接口URI中参数

响应参数

请求示例

锁定节点不可缩容

POST /api/v3/projects/{project_id}/clusters/{cluster_id}/nodes/locknodescaledown

{
  "kind" : "List",
  "apiVersion" : "v3",
  "nodeList" : [ "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" ]
}

响应示例

状态码

状态码

描述

200

表示节点开启缩容保护成功。

错误码

请参见错误码