Help Center/ ModelArts/ API Reference/ Node Pool Management/ Creating a Node Pool

Updated on 2025-08-20 GMT+08:00

View PDF

Creating a Node Pool

Function

This API is used to create a node pool.

Debugging

You can debug this API through automatic authentication in API Explorer or use the SDK sample code generated by API Explorer.

URI

POST /v2/{project_id}/pools/{pool_name}/nodepools

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID. For details, see Obtaining a Project ID and Name.
pool_name	Yes	String	Resource pool name.

Request Parameters

**Table 2** Request body parameters
Parameter	Mandatory	Type	Description
apiVersion	Yes	String	API version. The options are as follows: v2
kind	Yes	String	Node pool type. The options are as follows: NodePool: node pool
metadata	Yes	CreateNodePoolMetaVO object	Node pool metadata.
spec	No	NodePoolSpec object	Request body for creating a node pool.

**Table 3** CreateNodePoolMetaVO
Parameter	Mandatory	Type	Description
name	Yes	String	Node pool name.
annotations	No	CreateNodePoolAnnotations object	Node pool annotations.

**Table 4** CreateNodePoolAnnotations
Parameter	Mandatory	Type	Description
os.modelarts/billing.mode	No	String	Billing mode. The options are as follows: 0: pay-per-use
os.modelarts/period.num	No	String	Subscription period on a yearly/monthly basis, for example, 2. This parameter is mandatory when the billing mode is yearly/monthly.
os.modelarts/period.type	No	String	Yearly/Monthly subscription type. The options are as follows: 2: month 3: year 4: hour This parameter is mandatory when the billing mode is yearly/monthly.
os.modelarts/auto.renew	No	String	Whether to automatically renew the subscription. The options are as follows: 0: auto-renewal disabled (default value) 1: auto-renewal enabled
os.modelarts/promotion.info	No	String	Discount selected on the operations platform.
os.modelarts/service.console.url	No	String	URL of the page displayed after the subscription order is paid.
os.modelarts/order.id	No	String	Order ID, which is mandatory for creating a yearly/monthly resource or changing the billing mode.

**Table 5** NodePoolSpec
Parameter	Mandatory	Type	Description
resources	Yes	PoolResource object	List of resources in a node pool, including resource flavors, quantity, and custom configurations.

**Table 6** PoolResource
Parameter	Mandatory	Type	Description
flavor	Yes	String	Resource flavor name, for example, modelarts.vm.gpu.t4u8.
count	Yes	Integer	Minimum count for the flavors in a pool.
maxCount	Yes	Integer	Elastic usage of the resource flavor. This parameter value is the same as the count value in a physical pool.
azs	No	Array of PoolNodeAz objects	AZ where resource pool nodes are deployed.
nodePool	No	String	Node pool name, for example, nodePool-1.
taints	No	Array of Taint objects	Taints to be added to nodes to set anti-affinity. This parameter cannot be specified for a non-privileged pool.
labels	No	Map<String,String>	Kubernetes label, in the format of a key-value pair.
tags	No	Array of UserTag objects	Resource tag. This parameter cannot be specified for a non-privileged pool.
network	No	NodeNetwork object	Network configuration. This parameter cannot be specified for a non-privileged pool.
extendParams	No	Map<String,String>	Customize the parameter configurations. dockerBaseSize: Specify the container engine space size of a resource pool node. The value 0 indicates that the size is not limited.
creatingStep	No	CreatingStep object	Batch creation information.
os	No	Os object	OS image information.

**Table 7** PoolNodeAz
Parameter	Mandatory	Type	Description
az	Yes	String	Definition: AZ name. Constraints: N/A Range: N/A Default Value: N/A
count	Yes	Integer	Definition: Number of AZ resource instances. Constraints: N/A Range: N/A Default Value: N/A

**Table 8** Taint
Parameter	Mandatory	Type	Description
key	Yes	String	Key.
value	No	String	Value.
effect	Yes	String	Effect.

**Table 9** UserTag
Parameter	Mandatory	Type	Description
key	Yes	String	Key. The value cannot start with CCE- or __type_baremetal.
value	Yes	String	Value.

**Table 10** NodeNetwork
Parameter	Mandatory	Type	Description
vpc	No	String	VPC ID.
subnet	No	String	Subnet ID.
securityGroups	No	Array of strings	Security group IDs.

**Table 11** CreatingStep
Parameter	Mandatory	Type	Description
step	No	Integer	Creation step.
type	No	String	Batch creation type. The options are as follows: rack: entire cabinet

**Table 12** Os
Parameter	Mandatory	Type	Description
name	No	String	Definition: OS name. Constraints: N/A Range: N/A Default Value: N/A
imageId	No	String	Definition: OS image ID. Constraints: N/A Range: N/A Default Value: N/A
imageType	No	String	Definition: OS image type. Constraints: N/A Range: private: private image Default Value: N/A

Response Parameters

Status code: 200

**Table 13** Response body parameters
Parameter	Type	Description
apiVersion	String	API version. The options are as follows: v2
kind	String	Node pool type. The options are as follows: NodePool: node pool
metadata	CreateNodePoolMetaVO object	Node pool metadata.
spec	NodePoolSpec object	Request body for creating a node pool.

**Table 14** CreateNodePoolMetaVO
Parameter	Type	Description
name	String	Node pool name.
annotations	CreateNodePoolAnnotations object	Node pool annotations.

**Table 15** CreateNodePoolAnnotations
Parameter	Type	Description
os.modelarts/billing.mode	String	Billing mode. The options are as follows: 0: pay-per-use
os.modelarts/period.num	String	Subscription period on a yearly/monthly basis, for example, 2. This parameter is mandatory when the billing mode is yearly/monthly.
os.modelarts/period.type	String	Yearly/Monthly subscription type. The options are as follows: 2: month 3: year 4: hour This parameter is mandatory when the billing mode is yearly/monthly.
os.modelarts/auto.renew	String	Whether to automatically renew the subscription. The options are as follows: 0: auto-renewal disabled (default value) 1: auto-renewal enabled
os.modelarts/promotion.info	String	Discount selected on the operations platform.
os.modelarts/service.console.url	String	URL of the page displayed after the subscription order is paid.
os.modelarts/order.id	String	Order ID, which is mandatory for creating a yearly/monthly resource or changing the billing mode.

**Table 16** NodePoolSpec
Parameter	Type	Description
resources	PoolResource object	List of resources in a node pool, including resource flavors, quantity, and custom configurations.

**Table 17** PoolResource
Parameter	Type	Description
flavor	String	Resource flavor name, for example, modelarts.vm.gpu.t4u8.
count	Integer	Minimum count for the flavors in a pool.
maxCount	Integer	Elastic usage of the resource flavor. This parameter value is the same as the count value in a physical pool.
azs	Array of PoolNodeAz objects	AZ where resource pool nodes are deployed.
nodePool	String	Node pool name, for example, nodePool-1.
taints	Array of Taint objects	Taints to be added to nodes to set anti-affinity. This parameter cannot be specified for a non-privileged pool.
labels	Map<String,String>	Kubernetes label, in the format of a key-value pair.
tags	Array of UserTag objects	Resource tag. This parameter cannot be specified for a non-privileged pool.
network	NodeNetwork object	Network configuration. This parameter cannot be specified for a non-privileged pool.
extendParams	Map<String,String>	Customize the parameter configurations. dockerBaseSize: Specify the container engine space size of a resource pool node. The value 0 indicates that the size is not limited.
creatingStep	CreatingStep object	Batch creation information.
os	Os object	OS image information.

**Table 18** PoolNodeAz
Parameter	Type	Description
az	String	Definition: AZ name. Constraints: N/A Range: N/A Default Value: N/A
count	Integer	Definition: Number of AZ resource instances. Constraints: N/A Range: N/A Default Value: N/A

**Table 19** Taint
Parameter	Type	Description
key	String	Key.
value	String	Value.
effect	String	Effect.

**Table 20** UserTag
Parameter	Type	Description
key	String	Key. The value cannot start with CCE- or __type_baremetal.
value	String	Value.

**Table 21** NodeNetwork
Parameter	Type	Description
vpc	String	VPC ID.
subnet	String	Subnet ID.
securityGroups	Array of strings	Security group IDs.

**Table 22** CreatingStep
Parameter	Type	Description
step	Integer	Creation step.
type	String	Batch creation type. The options are as follows: rack: entire cabinet

**Table 23** Os
Parameter	Type	Description
name	String	Definition: OS name. Constraints: N/A Range: N/A Default Value: N/A
imageId	String	Definition: OS image ID. Constraints: N/A Range: N/A Default Value: N/A
imageType	String	Definition: OS image type. Constraints: N/A Range: private: private image Default Value: N/A

Status code: 400

**Table 24** Response body parameters
Parameter	Type	Description
error_code	String	Definition: ModelArts error code. Range: N/A
error_msg	String	Definition: Error message. Range: N/A

Example Requests

Create a node pool.

POST https://{endpoint}/v2/{project_id}/pools/{pool_name}/nodepools

{
  "kind" : "NodePool",
  "apiVersion" : "v2",
  "metadata" : {
    "name" : "nodepool-1",
    "annotations" : { }
  },
  "spec" : {
    "resources" : {
      "nodePool" : "nodepool-1",
      "flavor" : "modelarts.vm.2u4g.dcc",
      "count" : 1,
      "maxCount" : 1,
      "network" : {
        "vpc" : "277e9abc-0e6b-431a-9232-cfd25d5fc566",
        "subnet" : "03796378-c356-4c14-826b-e4913aa9c8b9",
        "securityGroups" : [ "0a15b48d-06f1-41e4-b782-ade90087bf59" ]
      }
    }
  }
}

Example Responses

Status code: 200

OK.

{
  "kind" : "NodePool",
  "apiVersion" : "v2",
  "metadata" : {
    "name" : "nodepool-1",
    "annotations" : { }
  },
  "spec" : {
    "resources" : {
      "nodePool" : "nodepool-1",
      "flavor" : "modelarts.vm.2u4g.dcc",
      "count" : 1,
      "maxCount" : 1,
      "network" : {
        "vpc" : "277e9abc-0e6b-431a-9232-cfd25d5fc566",
        "subnet" : "03796378-c356-4c14-826b-e4913aa9c8b9",
        "securityGroups" : [ "0a15b48d-06f1-41e4-b782-ade90087bf59" ]
      }
    }
  }
}

Status code: 400

Bad request

{
  "error_code" : "ModelArts.50004000",
  "error_msg" : "Bad request."
}

Status Codes

Status Code	Description
200	OK.
400	Bad request

Error Codes

See Error Codes.

Parent topic: Node Pool Management

Previous topic: Obtaining Node Pools

Next topic: Obtaining Details About a Specified Node Pool

Feedback

Was this page helpful?

Helpful Not helpful

Provide feedback

Thank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.

The system is busy. Please try again later.

Which of the following issues have you encountered?

Content is inconsistent with the product UI

Unclear descriptions

Lack of examples or code

Incorrect steps

Can't find what I need

Lack of best practices

Feedback (optional)

0/500

Select at least one type of issue, and enter your comments or suggestions.

Enter a maximum of 500 characters.

Submit Cancel

For any further questions, feel free to contact us through the chatbot.

Chatbot