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
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
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. |
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. |
Parameter | Mandatory | Type | Description |
---|---|---|---|
sshKey | No | String | Name of the key pair used for login. |
userPassword | No | UserPassword object | Password used for node login. |
Parameter | Mandatory | Type | Description |
---|---|---|---|
username | No | String | Login account. Defaults to root. |
password | Yes | String | If a username and a password are used to create a node, this field is shielded in the response body. A password must meet the following complexity requirements:
|
Parameter | Mandatory | Type | Description |
---|---|---|---|
uid | Yes | String | Node ID. |
Response Parameters
Status code: 200
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. |
Parameter | Type | Description |
---|---|---|
sshKey | String | Name of the key pair used for login. |
userPassword | UserPassword object | Password used for node login. |
Parameter | Type | Description |
---|---|---|
username | String | Login account. Defaults to root. |
password | String | If a username and a password are used to create a node, this field is shielded in the response body. A password must meet the following complexity requirements:
|
Parameter | Type | Description |
---|---|---|
uid | String | Node ID. |
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.
- Function
- URI
- Request Parameters
- Response Parameters
- Example Requests
- Example Responses
- Status Codes
- Error Codes