文档首页> 云容器引擎 CCE> API参考（吉隆坡区域）> API> 节点管理> 节点移除
更新时间：2023-06-26 GMT+08:00
查看PDF

节点移除

功能介绍

该API用于在指定集群下移除节点。

集群管理的URL格式为：https://Endpoint/uri。其中uri为资源路径，也即API访问的路径。

URI

PUT /api/v3/projects/{project_id}/clusters/{cluster_id}/nodes/operation/remove

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

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

cluster_id

是

String

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

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

Content-Type

是

String

消息体的类型（格式）

X-Auth-Token

是

String

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

参数

是否必选

参数类型

描述

apiVersion

否

String

API版本，固定值“v3”。

kind

否

String

API类型，固定值“RemoveNodesTask”。

spec

是

RemoveNodesSpec object

配置信息

status

否

TaskStatus object

任务状态
表4 RemoveNodesSpec

参数

是否必选

参数类型

描述

login

是

Login object

节点的登录方式。密钥对和密码登录方式二者必选其一。

nodes

是

Array of NodeItem objects

待操作节点列表
表5 Login

参数

是否必选

参数类型

描述

sshKey

否

String

选择密钥对方式登录时的密钥对名称。

userPassword

否

UserPassword object

选择密码方式登录时的帐号密码信息，之后可通过此帐号密码登录节点。
表6 UserPassword

参数

是否必选

参数类型

描述

username

否

String

登录帐号，默认为“root”

password

是

String

登录密码，若创建节点通过用户名密码方式，即使用该字段，则响应体中该字段作屏蔽展示。 密码复杂度要求：

  • 长度为8-26位。

  • 密码至少必须包含大写字母、小写字母、数字和特殊字符（!@$%^-_=+[{}]:,./?~#*）中的三种。

  • 密码不能包含用户名或用户名的逆序。 创建节点时password字段需要加盐加密，具体方法请参见创建节点时password字段加盐加密。
表7 NodeItem

参数

是否必选

参数类型

描述

uid

是

String

节点ID
表8 TaskStatus

参数

是否必选

参数类型

描述

jobID

否

String

任务ID，供调用者查询任务进度。

响应参数

状态码： 200

表9 响应Body参数

参数

参数类型

描述

apiVersion

String

API版本，固定值“v3”。

kind

String

API类型，固定值“RemoveNodesTask”。

spec

RemoveNodesSpec object

配置信息

status

TaskStatus object

任务状态
表10 RemoveNodesSpec

参数

参数类型

描述

login

Login object

节点的登录方式。密钥对和密码登录方式二者必选其一。

nodes

Array of NodeItem objects

待操作节点列表
表11 Login

参数

参数类型

描述

sshKey

String

选择密钥对方式登录时的密钥对名称。

userPassword

UserPassword object

选择密码方式登录时的帐号密码信息，之后可通过此帐号密码登录节点。
表12 UserPassword

参数

参数类型

描述

username

String

登录帐号，默认为“root”

password

String

登录密码，若创建节点通过用户名密码方式，即使用该字段，则响应体中该字段作屏蔽展示。 密码复杂度要求：

  • 长度为8-26位。

  • 密码至少必须包含大写字母、小写字母、数字和特殊字符（!@$%^-_=+[{}]:,./?~#*）中的三种。

  • 密码不能包含用户名或用户名的逆序。 创建节点时password字段需要加盐加密，具体方法请参见创建节点时password字段加盐加密。
表13 NodeItem

参数

参数类型

描述

uid

String

节点ID
表14 TaskStatus

参数

参数类型

描述

jobID

String

任务ID，供调用者查询任务进度。

请求示例

移除节点

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

表示在指定集群下移除节点的作业下发成功。

错误码

请参见错误码。

父主题： 节点管理