节点移除
功能介绍
该API用于在指定集群下移除节点。
调用方法
请参见如何调用API。
URI
PUT /api/v3/projects/{project_id}/clusters/{cluster_id}/nodes/operation/remove
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| project_id | 是 | String | 参数解释: 项目ID,获取方式请参见如何获取接口URI中参数。 约束限制: 不涉及 取值范围: 账号的项目ID 默认取值: 不涉及 |
| cluster_id | 是 | String | 参数解释: 集群ID,获取方式请参见如何获取接口URI中参数。 约束限制: 不涉及 取值范围: 集群ID 默认取值: 不涉及 |
请求参数
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| Content-Type | 是 | String | 参数解释: 消息体的类型(格式),默认为application/json,有其他取值时会在具体接口中专门说明。 约束限制: GET方法不做校验 默认取值: 不涉及 |
| X-Auth-Token | 是 | String | 参数解释: 调用接口的认证方式分为Token和AK/SK两种,如果您使用的Token方式,此参数为必填,请填写Token的值,获取方式请参见获取token。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| apiVersion | 否 | String | 参数解释: API版本 约束限制: 固定值,不允许修改 取值范围: 不涉及 默认取值: v3 |
| kind | 否 | String | 参数解释: API类型 约束限制: 固定值,不允许修改 取值范围: 不涉及 默认取值: RemoveNodesTask |
| spec | 是 | RemoveNodesSpec object | 参数解释: 配置信息 约束限制: 不涉及 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| login | 否 | Login object | 参数解释: 节点的登录方式。不配置将保留所选择镜像的密码,为了保证您的正常使用,请确保所选择镜像中已经设置了密码。密钥对和密码登录方式二者必选其一。 约束限制: 不涉及 |
| nodes | 是 | Array of NodeItem objects | 参数解释: 待操作节点列表,当前最多支持同时移除200个节点。 约束限制: 不涉及 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| sshKey | 否 | String | 参数解释: 选择密钥对方式登录时的密钥对名称。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
| userPassword | 否 | UserPassword object | 参数解释: 选择密码方式登录时的账号密码信息,之后可通过此账号密码登录节点。 约束限制: 不涉及 |
| removeUserPassword | 否 | Boolean | 参数解释: 更新节点池时,移除当前节点池密码方式登录的配置 约束限制: 仅更新节点池场景支持该参数,设置为true时不允许设置userPassword 取值范围: 不涉及 默认取值: false |
| removeSSHKey | 否 | Boolean | 参数解释: 更新节点池时,移除当前节点池密钥对方式登录的配置 约束限制: 仅更新节点池场景支持该参数,设置为true时不允许设置sshKey 取值范围: 不涉及 默认取值: false |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| username | 否 | String | 参数解释: 登录账号,默认为“root”。 约束限制: 不涉及 取值范围: 不涉及 默认取值: root。 |
| password | 是 | String | 参数解释: 登录密码,若创建节点通过用户名密码方式,即使用该字段,则响应体中该字段作屏蔽展示。 约束限制: 创建节点时password字段需要加盐加密,具体方法请参见创建节点时password字段加盐加密。 取值范围: 密码复杂度要求: 默认取值: 不涉及 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| uid | 是 | String | 参数解释: 节点ID,节点ID获取方式请参见如何获取接口URI中参数。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
响应参数
状态码:200
| 参数 | 参数类型 | 描述 |
|---|---|---|
| apiVersion | String | 参数解释: API版本 约束限制: 固定值,不允许修改 取值范围: 不涉及 默认取值: v3 |
| kind | String | 参数解释: API类型 约束限制: 固定值,不允许修改 取值范围: 不涉及 默认取值: RemoveNodesTask |
| spec | RemoveNodesSpec object | 参数解释: 配置信息 约束限制: 不涉及 |
| status | TaskStatus object | 参数解释: 任务状态 约束限制: 不涉及 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| login | Login object | 参数解释: 节点的登录方式。不配置将保留所选择镜像的密码,为了保证您的正常使用,请确保所选择镜像中已经设置了密码。密钥对和密码登录方式二者必选其一。 约束限制: 不涉及 |
| nodes | Array of NodeItem objects | 参数解释: 待操作节点列表,当前最多支持同时移除200个节点。 约束限制: 不涉及 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| sshKey | String | 参数解释: 选择密钥对方式登录时的密钥对名称。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
| userPassword | UserPassword object | 参数解释: 选择密码方式登录时的账号密码信息,之后可通过此账号密码登录节点。 约束限制: 不涉及 |
| removeUserPassword | Boolean | 参数解释: 更新节点池时,移除当前节点池密码方式登录的配置 约束限制: 仅更新节点池场景支持该参数,设置为true时不允许设置userPassword 取值范围: 不涉及 默认取值: false |
| removeSSHKey | Boolean | 参数解释: 更新节点池时,移除当前节点池密钥对方式登录的配置 约束限制: 仅更新节点池场景支持该参数,设置为true时不允许设置sshKey 取值范围: 不涉及 默认取值: false |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| username | String | 参数解释: 登录账号,默认为“root”。 约束限制: 不涉及 取值范围: 不涉及 默认取值: root。 |
| password | String | 参数解释: 登录密码,若创建节点通过用户名密码方式,即使用该字段,则响应体中该字段作屏蔽展示。 约束限制: 创建节点时password字段需要加盐加密,具体方法请参见创建节点时password字段加盐加密。 取值范围: 密码复杂度要求: 默认取值: 不涉及 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| uid | String | 参数解释: 节点ID,节点ID获取方式请参见如何获取接口URI中参数。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| jobID | String | 参数解释: 任务ID,供调用者查询任务进度。获取方式请参见如何获取接口URI中参数。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
请求示例
移除节点
PUT /api/v3/projects/{project_id}/clusters/{cluster_id}/nodes/operation/remove
{
"spec" : {
"login" : {
"sshKey" : "KeyPair-001"
},
"nodes" : [ {
"uid" : "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
}, {
"uid" : "yyyyyyyy-yyyy-yyyy-yyyy-yyyyyyyyyyyy"
} ]
}
} 响应示例
状态码:200
表示在指定集群下移除节点的作业下发成功。
{
"spec" : {
"login" : {
"sshKey" : "KeyPair-001"
},
"nodes" : [ {
"uid" : "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
}, {
"uid" : "yyyyyyyy-yyyy-yyyy-yyyy-yyyyyyyyyyyy"
} ]
},
"status" : {
"jobID" : "2ec9b78d-9368-46f3-8f29-d1a95622a568"
}
} 状态码
| 状态码 | 描述 |
|---|---|
| 200 | 表示在指定集群下移除节点的作业下发成功。 |
错误码
请参见错误码。