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.
URI
POST /api/v3/projects/{project_id}/clusters/{cluster_id}/nodepools/{nodepool_id}/nodes/add
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. |
nodepool_id |
Yes |
String |
Node pool ID. |
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 |
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. |
Response Parameters
Status code: 200
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" }
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.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.