Help Center/ Cloud Container Engine/ API Reference/ APIs/ Node Management/ Managing a Node in a Customized Node Pool
Updated on 2024-11-06 GMT+08:00

Managing a Node in a Customized Node Pool

Function

This API is used to manage a node in a customized node pool of a cluster. Spot instances are not supported.

  • ECSs, DeHs, and BMSs can be managed.

  • The URL for cluster management is in the format of https://Endpoint/uri, where uri specifies the resource path for API access.

Calling Method

For details, see Calling APIs.

URI

POST /api/v3/projects/{project_id}/clusters/{cluster_id}/nodepools/{nodepool_id}/nodes/add

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Details:

Project ID. For details about how to obtain the value, see How to Obtain Parameters in the API URI.

Constraints:

None

Options:

Project IDs of the account

Default value:

N/A

cluster_id

Yes

String

Details:

Cluster ID. For details about how to obtain the value, see How to Obtain Parameters in the API URI.

Constraints:

None

Options:

Cluster IDs

Default value:

N/A

nodepool_id

Yes

String

Details:

Node pool ID. For details about how to obtain the ID, see How to Obtain Parameters in the API URI.

Constraints:

None

Options:

Cluster IDs

Default value:

N/A

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

Content-Type

Yes

String

Details:

Request body type or format

Constraints:

The GET method is not verified.

Options:

  • application/json

  • application/json;charset=utf-8

  • application/x-pem-file

Default value:

N/A

X-Auth-Token

Yes

String

Details:

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.

Constraints:

None

Options:

N/A

Default value:

N/A

Table 3 Request body parameters

Parameter

Mandatory

Type

Description

apiVersion

Yes

String

API version. The value is fixed at v3.

kind

Yes

String

API type. The value is fixed at List.

nodeList

Yes

Array of AddNodesToNodePool objects

List of nodes to be managed. A maximum of 200 nodes can be managed simultaneously.

Table 4 AddNodesToNodePool

Parameter

Mandatory

Type

Description

serverID

Yes

String

Server ID, which can be obtained from the ECS or BMS console

Response Parameters

Status code: 200

Table 5 Response body parameters

Parameter

Type

Description

jobid

String

Job ID returned after the job is delivered. The job ID can be used to query the job execution status.

Example Requests

Manage a node in a customized node pool.

POST /api/v3/projects/{project_id}/clusters/{cluster_id}/nodepool/{nodepool_id}/nodes/add

{
  "kind" : "List",
  "apiVersion" : "v3",
  "nodeList" : [ {
    "serverID" : "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxx1"
  }, {
    "serverID" : "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxx2"
  } ]
}

Example Responses

Status code: 200

The job for managing a node in the customized node pool in the cluster delivered.

{
  "jobid" : "2ec9b78d-9368-46f3-8f29-d1a95622a568"
}

SDK Sample Code

The SDK sample code is as follows.

Manage a node in a customized node pool.

 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
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.UUID;
import java.util.List;
import java.util.ArrayList;

public class AddNodesToNodePoolSolution {

    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();
        AddNodesToNodePoolRequest request = new AddNodesToNodePoolRequest();
        request.withClusterId("{cluster_id}");
        request.withNodepoolId("{nodepool_id}");
        AddNodesToNodePoolList body = new AddNodesToNodePoolList();
        List<AddNodesToNodePool> listbodyNodeList = new ArrayList<>();
        listbodyNodeList.add(
            new AddNodesToNodePool()
                .withServerID(UUID.fromString("xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxx1"))
        );
        listbodyNodeList.add(
            new AddNodesToNodePool()
                .withServerID(UUID.fromString("xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxx2"))
        );
        body.withNodeList(listbodyNodeList);
        body.withKind("List");
        body.withApiVersion("v3");
        request.withBody(body);
        try {
            AddNodesToNodePoolResponse response = client.addNodesToNodePool(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());
        }
    }
}

Manage a node in a customized node pool.

 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
# 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 = AddNodesToNodePoolRequest()
        request.cluster_id = "{cluster_id}"
        request.nodepool_id = "{nodepool_id}"
        listNodeListbody = [
            AddNodesToNodePool(
                server_id="xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxx1"
            ),
            AddNodesToNodePool(
                server_id="xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxx2"
            )
        ]
        request.body = AddNodesToNodePoolList(
            node_list=listNodeListbody,
            kind="List",
            api_version="v3"
        )
        response = client.add_nodes_to_node_pool(request)
        print(response)
    except exceptions.ClientRequestException as e:
        print(e.status_code)
        print(e.request_id)
        print(e.error_code)
        print(e.error_msg)

Manage a node in a customized node pool.

 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
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.AddNodesToNodePoolRequest{}
	request.ClusterId = "{cluster_id}"
	request.NodepoolId = "{nodepool_id}"
	var listNodeListbody = []model.AddNodesToNodePool{
        {
            ServerID: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxx1",
        },
        {
            ServerID: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxx2",
        },
    }
	request.Body = &model.AddNodesToNodePoolList{
		NodeList: listNodeListbody,
		Kind: "List",
		ApiVersion: "v3",
	}
	response, err := client.AddNodesToNodePool(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 managing a node in the customized node pool in the cluster delivered.

Error Codes

See Error Codes.