Help Center/ Cloud Container Engine/ API Reference (Kuala Lumpur Region)/ APIs/ Node Management/ Managing a Node in a Customized Node Pool
Updated on 2025-12-08 GMT+08:00
View PDF
Share

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:

The request body type or format

Constraints:

The GET method is not verified.

Options:

  • application/json

  • application/json;charset=utf-8

  • application/x-pem-file

  • multipart/form-data (used when the FormData parameter is present)

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

Definition

API version

Constraints

The value is fixed and cannot be changed.

Range

N/A

Default Value

v3

kind

Yes

String

Definition

API type

Constraints

The value is fixed and cannot be changed.

Range

N/A

Default Value

List

nodeList

Yes

Array of AddNodesToNodePool objects

Definition

List of nodes to be managed. A maximum of 200 nodes can be managed at a time.

Constraints

N/A

Range

N/A

Default Value

N/A
Table 4 AddNodesToNodePool

Parameter

Mandatory

Type

Description

serverID

Yes

String

Definition

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

NOTE:
To obtain the server ID, log in to the management console, choose Service List > Compute > Elastic Cloud Server or Bare Metal Server, click the server name, and copy the server ID on the server details page.

Constraints

N/A

Range

N/A

Default Value

N/A

Response Parameters

Status code: 200

Table 5 Response body parameters

Parameter

Type

Description

jobid

String

Definition

ID returned after a job is submitted. This ID can be used to query the execution of the job.

Range

N/A

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

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.

Parent topic: Node Management