Removing a Node

Function

This API is used to remove a node from a specified cluster.

The URL for cluster management is in the format of https://Endpoint/uri. In the URL, uri indicates the resource path, that is, the path for API access.

URI

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

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID. For details about how to obtain the value, see How to Obtain Parameters in the API URI.
cluster_id	Yes	String	Cluster ID. For details about how to obtain the value, see How to Obtain Parameters in the API URI.

Request Parameters

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
Content-Type	Yes	String	Message body type (format).
X-Auth-Token	Yes	String	Requests for calling an API can be authenticated using either a token or AK/SK. If token-based authentication is used, this parameter is mandatory and must be set to a user token. For details, see Obtaining a User Token.

**Table 3** Request body parameters
Parameter	Mandatory	Type	Description
apiVersion	No	String	API version. The value is fixed at v3.
kind	No	String	API type. The value is fixed at RemoveNodesTask.
spec	Yes	RemoveNodesSpec object	Configuration information.
status	No	TaskStatus object	Job status.

**Table 4** RemoveNodesSpec
Parameter	Mandatory	Type	Description
login	Yes	Login object	Node login mode. Either the key pair or password must be used for login. NOTE: This parameter cannot be modified when a node pool is being updated.
nodes	Yes	Array of NodeItem objects	List of nodes to be removed. A maximum of 200 nodes can be removed at a time.

**Table 5** Login
Parameter	Mandatory	Type	Description
sshKey	No	String	Name of the key pair used for login.

**Table 6** UserPassword
Parameter	Mandatory	Type	Description
username	No	String	Login account. The default value is root.
password	Yes	String	Login password. If a username and password are used to create a node, this field is shielded in the response body. A password must meet the following complexity requirements: Contains 8 to 26 characters. Contains at least three of the following character types: uppercase letters, lowercase letters, digits, and special characters !@$%^-_=+[{}]:,./? Cannot contain the username or the username spelled backwards. The password field must be salted during node creation. For details, see Adding a Salt in the password Field When Creating a Node.

**Table 7** NodeItem
Parameter	Mandatory	Type	Description
uid	Yes	String	Node ID.

**Table 8** TaskStatus
Parameter	Mandatory	Type	Description
jobID	No	String	Job ID, which is used by the caller to query the job progress.

Response Parameters

Status code: 200

**Table 9** Response body parameters
Parameter	Type	Description
apiVersion	String	API version. The value is fixed at v3.
kind	String	API type. The value is fixed at RemoveNodesTask.
spec	RemoveNodesSpec object	Configuration information.
status	TaskStatus object	Job status.

**Table 10** RemoveNodesSpec
Parameter	Type	Description
login	Login object	Node login mode. Either the key pair or password must be used for login. NOTE: This parameter cannot be modified when a node pool is being updated.
nodes	Array of NodeItem objects	List of nodes to be removed. A maximum of 200 nodes can be removed at a time.

**Table 11** Login
Parameter	Type	Description
sshKey	String	Name of the key pair used for login.

**Table 12** UserPassword
Parameter	Type	Description
username	String	Login account. The default value is root.
password	String	Login password. If a username and password are used to create a node, this field is shielded in the response body. A password must meet the following complexity requirements: Contains 8 to 26 characters. Contains at least three of the following character types: uppercase letters, lowercase letters, digits, and special characters !@$%^-_=+[{}]:,./? Cannot contain the username or the username spelled backwards. The password field must be salted during node creation. For details, see Adding a Salt in the password Field When Creating a Node.

**Table 13** NodeItem
Parameter	Type	Description
uid	String	Node ID.

**Table 14** TaskStatus
Parameter	Type	Description
jobID	String	Job ID, which is used by the caller to query the job progress.

Example Requests

Removing a Node

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"
    } ]
  }
}

Example Responses

Status code: 200

The job for removing a node in a specified cluster is successfully delivered.

{
  "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"
  }
}

Status Codes

Status Code	Description
200	The job for removing a node in a specified cluster is successfully delivered.

Error Codes

See Error Codes.

Parent topic: Node Management

Previous topic: Resetting a Node

Next topic: Migrating a Node

Feedback

Was this page helpful?

Helpful Not helpful

Provide feedback

Thank you very much for your feedback. We will continue working to improve the documentation.

The system is busy. Please try again later.