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.
Calling Method
For details, see Calling APIs.
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. |
status |
No |
TaskStatus object |
Job status. |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
login |
Yes |
Login object |
Node login mode. Either the key pair or password must be used for login. |
nodes |
Yes |
Array of NodeItem objects |
List of nodes to be removed. A maximum of 200 nodes can be removed at a time. |
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. The default value is 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:
|
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 |
---|---|---|
login |
Login object |
Node login mode. Either the key pair or password must be used for login. |
nodes |
Array of NodeItem objects |
List of nodes to be removed. A maximum of 200 nodes can be removed at a time. |
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. The default value is 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:
|
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" } }
SDK Sample Code
The SDK sample code is as follows.
Removing a Node
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 |
package com.huaweicloud.sdk.test; import com.huaweicloud.sdk.core.auth.ICredential; import com.huaweicloud.sdk.core.auth.BasicCredentials; import com.huaweicloud.sdk.core.exception.ConnectionException; import com.huaweicloud.sdk.core.exception.RequestTimeoutException; import com.huaweicloud.sdk.core.exception.ServiceResponseException; import com.huaweicloud.sdk.cce.v3.region.CceRegion; import com.huaweicloud.sdk.cce.v3.*; import com.huaweicloud.sdk.cce.v3.model.*; import java.util.List; import java.util.ArrayList; public class RemoveNodeSolution { public static void main(String[] args) { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment String ak = System.getenv("CLOUD_SDK_AK"); String sk = System.getenv("CLOUD_SDK_SK"); String projectId = "{project_id}"; ICredential auth = new BasicCredentials() .withProjectId(projectId) .withAk(ak) .withSk(sk); CceClient client = CceClient.newBuilder() .withCredential(auth) .withRegion(CceRegion.valueOf("<YOUR REGION>")) .build(); RemoveNodeRequest request = new RemoveNodeRequest(); request.withClusterId("{cluster_id}"); RemoveNodesTask body = new RemoveNodesTask(); List<NodeItem> listSpecNodes = new ArrayList<>(); listSpecNodes.add( new NodeItem() .withUid("xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx") ); listSpecNodes.add( new NodeItem() .withUid("yyyyyyyy-yyyy-yyyy-yyyy-yyyyyyyyyyyy") ); Login loginSpec = new Login(); loginSpec.withSshKey("KeyPair-001"); RemoveNodesSpec specbody = new RemoveNodesSpec(); specbody.withLogin(loginSpec) .withNodes(listSpecNodes); body.withSpec(specbody); request.withBody(body); try { RemoveNodeResponse response = client.removeNode(request); System.out.println(response.toString()); } catch (ConnectionException e) { e.printStackTrace(); } catch (RequestTimeoutException e) { e.printStackTrace(); } catch (ServiceResponseException e) { e.printStackTrace(); System.out.println(e.getHttpStatusCode()); System.out.println(e.getRequestId()); System.out.println(e.getErrorCode()); System.out.println(e.getErrorMsg()); } } } |
Removing a Node
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 |
# coding: utf-8 import os from huaweicloudsdkcore.auth.credentials import BasicCredentials from huaweicloudsdkcce.v3.region.cce_region import CceRegion from huaweicloudsdkcore.exceptions import exceptions from huaweicloudsdkcce.v3 import * if __name__ == "__main__": # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak = os.environ["CLOUD_SDK_AK"] sk = os.environ["CLOUD_SDK_SK"] projectId = "{project_id}" credentials = BasicCredentials(ak, sk, projectId) client = CceClient.new_builder() \ .with_credentials(credentials) \ .with_region(CceRegion.value_of("<YOUR REGION>")) \ .build() try: request = RemoveNodeRequest() request.cluster_id = "{cluster_id}" listNodesSpec = [ NodeItem( uid="xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" ), NodeItem( uid="yyyyyyyy-yyyy-yyyy-yyyy-yyyyyyyyyyyy" ) ] loginSpec = Login( ssh_key="KeyPair-001" ) specbody = RemoveNodesSpec( login=loginSpec, nodes=listNodesSpec ) request.body = RemoveNodesTask( spec=specbody ) response = client.remove_node(request) print(response) except exceptions.ClientRequestException as e: print(e.status_code) print(e.request_id) print(e.error_code) print(e.error_msg) |
Removing a Node
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 |
package main import ( "fmt" "github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic" cce "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/cce/v3" "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/cce/v3/model" region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/cce/v3/region" ) func main() { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak := os.Getenv("CLOUD_SDK_AK") sk := os.Getenv("CLOUD_SDK_SK") projectId := "{project_id}" auth := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). WithProjectId(projectId). Build() client := cce.NewCceClient( cce.CceClientBuilder(). WithRegion(region.ValueOf("<YOUR REGION>")). WithCredential(auth). Build()) request := &model.RemoveNodeRequest{} request.ClusterId = "{cluster_id}" var listNodesSpec = []model.NodeItem{ { Uid: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", }, { Uid: "yyyyyyyy-yyyy-yyyy-yyyy-yyyyyyyyyyyy", }, } sshKeyLogin:= "KeyPair-001" loginSpec := &model.Login{ SshKey: &sshKeyLogin, } specbody := &model.RemoveNodesSpec{ Login: loginSpec, Nodes: listNodesSpec, } request.Body = &model.RemoveNodesTask{ Spec: specbody, } response, err := client.RemoveNode(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
For SDK sample code of more programming languages, see the Sample Code tab in API Explorer. SDK sample code can be automatically generated.
Status Codes
Status Code |
Description |
---|---|
200 |
The job for removing a node in a specified cluster is successfully delivered. |
Error Codes
See Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot