Migrating a Node to a Custom Node Pool

Function

This API is used to migrate a node to a custom node pool. Only nodes in the default node pool can be migrated. Throughout the migration process, the node will remain unaffected and will not require resetting or restarting. Additionally, the original password will be preserved.

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

Constraints

Only nodes with the same VPC, subnet, enterprise project, ECS group, flavor, AZ, resource reservation settings, container engine, and OS as the node pool can be migrated to the pool.
Only running nodes in the default node pool (DefaultPool) can be migrated to other node pools.
After a node is migrated to a node pool, the pool's resource tags, Kubernetes labels, and Kubernetes taints will be synchronized to the node. If there is a conflict, the node pool's configurations will take precedence.
After a node is migrated to a node pool, the pool's security group will take over the node's original security group.
After a node is migrated to a node pool, its acceptance tag will be removed. If it is scaled in from the pool, it will be deleted.
After a node is migrated to a node pool, its login mode will remain the same.

Calling Method

For details, see Calling APIs.

URI

PUT /api/v3/projects/{project_id}/clusters/{cluster_id}/nodepools/{nodepool_id}/nodes/migrate

**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 MigrateNodesToNodePool objects	Definition List of nodes to be migrated. A maximum of 50 nodes can be migrated at a time. Constraints N/A

**Table 4** MigrateNodesToNodePool
Parameter	Mandatory	Type	Description
nodeID	Yes	String	Definition Node ID. For details about how to obtain the value, see How to Obtain Parameters in the API URI. Constraints N/A Range N/A Default Value N/A

Response Parameters

Status code: 200

The node has been migrated to the custom node pool.

None

Example Requests

Migrate a node from the default node pool to a custom node pool.

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

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