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

Updated on 2026-01-30 GMT+08:00

View PDF

Creating a Node Pool

Function

This API is used to create a node pool. This API is used when you need to create a node pool with specified configurations when you need to expand compute resources, optimize resource allocation, or deploy new services. Before using this API, ensure that you have the administrator permission and the node pool parameters (such as the number of nodes, specifications, and network configurations) are correctly set. After the creation, the node pool will be created and be available, and the related node information will be recorded. If you do not have the required permission, the parameter settings are incorrect, or system resources are insufficient, the API will return an error message.

Debugging

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

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.

If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.
If you are using identity policy-based authorization, no identity policy-based permission required for calling this API.

URI

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

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Definition: User project ID. For details, see Obtaining a Project ID and Name. Constraints: N/A Range: N/A Default Value: N/A
pool_name	Yes	String	Definition: Resource pool name. Constraints: N/A Range: N/A Default Value: N/A

Request Parameters

**Table 2** Request body parameters
Parameter	Mandatory	Type	Description
apiVersion	Yes	String	Definition: API version. Range: v2
kind	Yes	String	Definition: Node pool type. Range: NodePool: node pool
metadata	Yes	CreateNodePoolMetaVO object	Definition: Node pool metadata.
spec	No	NodePoolSpec object	Definition: Node pool expectation.

**Table 3** CreateNodePoolMetaVO
Parameter	Mandatory	Type	Description
name	Yes	String	Definition: Node pool name. Constraints: N/A Range: N/A Default Value: N/A
annotations	No	CreateNodePoolAnnotations object	Definition: Node pool annotations. Constraints: N/A Range: N/A Default Value: N/A

**Table 4** CreateNodePoolAnnotations
Parameter	Mandatory	Type	Description
os.modelarts/billing.mode	No	String	Definition: Billing mode. Constraints: N/A Range: 0: pay-per-use 1: yearly/monthly Default Value: N/A
os.modelarts/period.num	No	String	Definition: Subscription period on a yearly/monthly basis, for example, 2. This parameter is mandatory when the billing mode is yearly/monthly. Constraints: N/A Range: N/A Default Value: N/A
os.modelarts/period.type	No	String	Definition: Subscription type on a yearly/monthly basis. This parameter is mandatory when the billing mode is yearly/monthly. Constraints: N/A Range: 2: month 3: year 4: hour Default Value: N/A
os.modelarts/auto.renew	No	String	Definition: Specifies whether to automatically renew the subscription. Constraints: N/A Range: 0: auto-renewal disabled 1: auto-renewal enabled Default Value: 0
os.modelarts/promotion.info	No	String	Definition: Discount selected on the operations platform. Constraints: N/A Range: N/A Default Value: N/A
os.modelarts/service.console.url	No	String	Definition: URL of the page displayed after the subscription order is paid. Constraints: N/A Range: N/A Default Value: N/A
os.modelarts/order.id	No	String	Definition: Order ID, which is mandatory for creating a yearly/monthly resource or changing the billing mode. Constraints: N/A Range: N/A Default Value: N/A

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

**Table 6** PoolResource
Parameter	Mandatory	Type	Description
flavor	Yes	String	Definition: Resource flavor name, for example, modelarts.vm.gpu.t4u8. Range: N/A.
count	Yes	Integer	Definition: Committed specifications. Range: N/A.
maxCount	Yes	Integer	Definition: Elastic usage of the resource flavor. This parameter value is the same the count value in a physical pool. Range: N/A.
azs	No	Array of PoolNodeAz objects	Definition: AZ information of nodes in the resource pool.
nodePool	No	String	Definition: Node pool name, for example, nodePool-1. Range: N/A.
taints	No	Array of Taints objects	Definition: 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>	Definition: Kubernetes label, in key-value pair format.
tags	No	Array of UserTags objects	Definition: Resource tag. This parameter cannot be specified for a non-privileged pool.
network	No	NodeNetwork object	Definition: Network configuration. This parameter cannot be specified for a non-privileged pool.
extendParams	No	ResourceExtendParams object	Definition: Custom configuration.
creatingStep	No	CreatingStep object	Definition: Information about batch creation.
rootVolume	No	RootVolume object	Definition: Information about the custom system disk (cloud hard disk).
dataVolumes	No	Array of DataVolumeItem objects	Definition: List of custom data disks (cloud hard disks).
volumeGroupConfigs	No	Array of VolumeGroupConfig objects	Definition: Advanced disk configuration. This parameter is mandatory when a custom data disk exists.
os	No	Os object	Definition: OS image information.

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

**Table 8** Taints
Parameter	Mandatory	Type	Description
key	Yes	String	Definition: Key. Range: N/A
value	No	String	Value.
effect	Yes	String	Effect.

**Table 9** UserTags
Parameter	Mandatory	Type	Description
key	Yes	String	Definition: Key. The value cannot start with CCE- or __type_baremetal. Range: N/A
value	Yes	String	Value.

**Table 10** NodeNetwork
Parameter	Mandatory	Type	Description
vpc	No	String	Definition: VPC ID. Range: N/A.
subnet	No	String	Definition: Subnet ID. Range: N/A.
securityGroups	No	Array of strings	Definition: Security group ID set.

**Table 11** ResourceExtendParams
Parameter	Mandatory	Type	Description
dockerBaseSize	No	String	Definition: Container image space of a node. Range: Specified: The default value of dockerBaseSize ranges from 50 to 500. However, the actual value is restricted by the container data disk size of the node. Unlimited: *dockerBaseSize="0, indicating that the container image space is not limited.
postInstall	No	String	Definition: Post-installation script. The entered value must be encoded using Base64. Range: N/A.
runtime	No	String	Definition: Container runtime. Range: docker: Container runtime. It is the most commonly used container engine, which is used to create and manage container instances based on container images. containerd: Industrial-grade container runtime. It focuses on container lifecycle management and is one of the core components at the bottom layer of Docker. It can also be deployed independently.
labelPolicyOnExistingNodes	No	String	Definition: Kubernetes label update policy of existing nodes. If the value is empty, the existing nodes are updated by default. Range: refresh: Update. ignore: Do not update.
taintPolicyOnExistingNodes	No	String	Definition: Kubernetes taint update policy of existing nodes. If the value is empty, the existing nodes are updated by default. Range: refresh: Update. ignore: Do not update.
tagPolicyOnExistingNodes	No	String	Definition: Resource tag update policy of existing nodes. If the value is empty, the existing nodes are updated by default. Range: refresh: Update. ignore: Do not update.
XParameterPlaneSubnet	No	String	Definition: Subnet ID used for data transmission on the parameter plane between physical clusters. The value cannot be the same as the node subnet or container subnet. Range: N/A.
nodePoolName	No	String	Definition: Name of the node pool specified by you. The value is a string of 2 to 50 characters, consisting of lowercase letters, hyphens (-), and digits. It must start with a lowercase letter and cannot end with a hyphen (-) or -default. Range: N/A.

**Table 12** CreatingStep
Parameter	Mandatory	Type	Description
step	No	Integer	Definition: Step of a supernode. Constraints: N/A Range: Only the step contained in the resource specification details is supported. Default Value: N/A
type	No	String	Definition: Batch creation type. Constraints: N/A Range: hyperinstance: supernode Default Value: N/A

**Table 13** RootVolume
Parameter	Mandatory	Type	Description
volumeType	Yes	String	Definition: Disk type.. Range: SSD: Ultra-high I/O disk GPSSD: General-purpose SSD SAS: High I/O disk
size	Yes	String	Definition: Disk size, in GiB. Range: N/A.

**Table 14** DataVolumeItem
Parameter	Mandatory	Type	Description
volumeType	Yes	String	Definition: Disk type.. Range: SSD: Ultra-high I/O disk GPSSD: General-purpose SSD SAS: High I/O disk
size	Yes	String	Definition: Disk size, in GiB. Range: N/A.
count	No	Integer	Definition: Number of disks. Range: N/A.
extendParams	Yes	VolumeExtendParams object	Definition: Custom disk configuration.

**Table 15** VolumeExtendParams
Parameter	Mandatory	Type	Description
volumeGroup	Yes	String	Definition: Name of a disk group, which is used to divide storage space. Range: vgpaas: container disk. default: common data disk, which is mounted in default mode. vguser: common data disk, which is mounted to a specified path. The group name varies depending on the path, for example, vguser1 and vguser2. vg-everest-localvolume-persistent: common data disk, which is used as the persistent storage volume. vg-everest-localvolume-ephemeral: common data disk, which is used as a temporary storage volume.

**Table 16** VolumeGroupConfig
Parameter	Mandatory	Type	Description
volumeGroup	Yes	String	Definition: Disk group name. Index of the volume group in the dataVolumes. Range: N/A.
dockerThinPool	No	Integer	Definition: Percentage of data disks designated as container disks. This parameter can be specified only when volumeGroup is vgpaas (container disk). Range: N/A.
lvmConfig	No	LvmConfig object	Definition: LVM configuration management.
types	No	Array of strings	Definition: Storage type. Options: volume: Cloud hard disk. When dataVolumes is specified, the default value is used. local: Local disk. This parameter must be specified when a local disk is used.

**Table 17** LvmConfig
Parameter	Mandatory	Type	Description
lvType	Yes	String	Definition: LVM write mode. Range: linear: Linear mode. striped: Striped mode in which multiple disks are used to form a strip to improve disk performance.
path	No	String	Definition: Disk mount path. This parameter takes effect only in user configuration. The value is an absolute path. Digits, letters, periods (.), hyphens (-), and underscores (_) are allowed. Range: N/A.

**Table 18** Os
Parameter	Mandatory	Type	Description
name	No	String	Definition: OS name and version, for example, EulorOS 2.5. This parameter can be left blank when a private image is specified. Range: N/A.
imageId	No	String	Definition: OS image ID. Range: N/A.
imageType	No	String	Definition: OS image type. This parameter must be specified when a private image is set. By default, the preset image is used. You do not need to specify this field. Range: private: private images "": The preset image is used.
autoMatch	No	String	Definition: Automatic OS image matching configuration. If this parameter is set, the optimal image is automatically selected, and this parameter is automatically cleared. Range: OS name and version, for example, EulorOS 2.5.

Response Parameters

Status code: 200

**Table 19** Response body parameters
Parameter	Type	Description
apiVersion	String	Definition: API version. Range: v2
kind	String	Definition: Node pool type. Range: NodePool: node pool
metadata	CreateNodePoolMetaVO object	Definition: Node pool metadata.
spec	NodePoolSpec object	Definition: Node pool expectation.

**Table 20** CreateNodePoolMetaVO
Parameter	Type	Description
name	String	Definition: Node pool name. Constraints: N/A Range: N/A Default Value: N/A
annotations	CreateNodePoolAnnotations object	Definition: Node pool annotations. Constraints: N/A Range: N/A Default Value: N/A

**Table 21** CreateNodePoolAnnotations
Parameter	Type	Description
os.modelarts/billing.mode	String	Definition: Billing mode. Constraints: N/A Range: 0: pay-per-use 1: yearly/monthly Default Value: N/A
os.modelarts/period.num	String	Definition: Subscription period on a yearly/monthly basis, for example, 2. This parameter is mandatory when the billing mode is yearly/monthly. Constraints: N/A Range: N/A Default Value: N/A
os.modelarts/period.type	String	Definition: Subscription type on a yearly/monthly basis. This parameter is mandatory when the billing mode is yearly/monthly. Constraints: N/A Range: 2: month 3: year 4: hour Default Value: N/A
os.modelarts/auto.renew	String	Definition: Specifies whether to automatically renew the subscription. Constraints: N/A Range: 0: auto-renewal disabled 1: auto-renewal enabled Default Value: 0
os.modelarts/promotion.info	String	Definition: Discount selected on the operations platform. Constraints: N/A Range: N/A Default Value: N/A
os.modelarts/service.console.url	String	Definition: URL of the page displayed after the subscription order is paid. Constraints: N/A Range: N/A Default Value: N/A
os.modelarts/order.id	String	Definition: Order ID, which is mandatory for creating a yearly/monthly resource or changing the billing mode. Constraints: N/A Range: N/A Default Value: N/A

**Table 22** NodePoolSpec
Parameter	Type	Description
resources	PoolResource object	Definition: List of resources in a node pool, including resource flavors, quantity, and custom configurations. Range: N/A

**Table 23** PoolResource
Parameter	Type	Description
flavor	String	Definition: Resource flavor name, for example, modelarts.vm.gpu.t4u8. Range: N/A.
count	Integer	Definition: Committed specifications. Range: N/A.
maxCount	Integer	Definition: Elastic usage of the resource flavor. This parameter value is the same the count value in a physical pool. Range: N/A.
azs	Array of PoolNodeAz objects	Definition: AZ information of nodes in the resource pool.
nodePool	String	Definition: Node pool name, for example, nodePool-1. Range: N/A.
taints	Array of Taints objects	Definition: Taints to be added to nodes to set anti-affinity. This parameter cannot be specified for a non-privileged pool.
labels	Map<String,String>	Definition: Kubernetes label, in key-value pair format.
tags	Array of UserTags objects	Definition: Resource tag. This parameter cannot be specified for a non-privileged pool.
network	NodeNetwork object	Definition: Network configuration. This parameter cannot be specified for a non-privileged pool.
extendParams	ResourceExtendParams object	Definition: Custom configuration.
creatingStep	CreatingStep object	Definition: Information about batch creation.
rootVolume	RootVolume object	Definition: Information about the custom system disk (cloud hard disk).
dataVolumes	Array of DataVolumeItem objects	Definition: List of custom data disks (cloud hard disks).
volumeGroupConfigs	Array of VolumeGroupConfig objects	Definition: Advanced disk configuration. This parameter is mandatory when a custom data disk exists.
os	Os object	Definition: OS image information.

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

**Table 25** Taints
Parameter	Type	Description
key	String	Definition: Key. Range: N/A
value	String	Value.
effect	String	Effect.

**Table 26** UserTags
Parameter	Type	Description
key	String	Definition: Key. The value cannot start with CCE- or __type_baremetal. Range: N/A
value	String	Value.

**Table 27** NodeNetwork
Parameter	Type	Description
vpc	String	Definition: VPC ID. Range: N/A.
subnet	String	Definition: Subnet ID. Range: N/A.
securityGroups	Array of strings	Definition: Security group ID set.

**Table 28** ResourceExtendParams
Parameter	Type	Description
dockerBaseSize	String	Definition: Container image space of a node. Range: Specified: The default value of dockerBaseSize ranges from 50 to 500. However, the actual value is restricted by the container data disk size of the node. Unlimited: *dockerBaseSize="0, indicating that the container image space is not limited.
postInstall	String	Definition: Post-installation script. The entered value must be encoded using Base64. Range: N/A.
runtime	String	Definition: Container runtime. Range: docker: Container runtime. It is the most commonly used container engine, which is used to create and manage container instances based on container images. containerd: Industrial-grade container runtime. It focuses on container lifecycle management and is one of the core components at the bottom layer of Docker. It can also be deployed independently.
labelPolicyOnExistingNodes	String	Definition: Kubernetes label update policy of existing nodes. If the value is empty, the existing nodes are updated by default. Range: refresh: Update. ignore: Do not update.
taintPolicyOnExistingNodes	String	Definition: Kubernetes taint update policy of existing nodes. If the value is empty, the existing nodes are updated by default. Range: refresh: Update. ignore: Do not update.
tagPolicyOnExistingNodes	String	Definition: Resource tag update policy of existing nodes. If the value is empty, the existing nodes are updated by default. Range: refresh: Update. ignore: Do not update.
XParameterPlaneSubnet	String	Definition: Subnet ID used for data transmission on the parameter plane between physical clusters. The value cannot be the same as the node subnet or container subnet. Range: N/A.
nodePoolName	String	Definition: Name of the node pool specified by you. The value is a string of 2 to 50 characters, consisting of lowercase letters, hyphens (-), and digits. It must start with a lowercase letter and cannot end with a hyphen (-) or -default. Range: N/A.

**Table 29** CreatingStep
Parameter	Type	Description
step	Integer	Definition: Step of a supernode. Constraints: N/A Range: Only the step contained in the resource specification details is supported. Default Value: N/A
type	String	Definition: Batch creation type. Constraints: N/A Range: hyperinstance: supernode Default Value: N/A

**Table 30** RootVolume
Parameter	Type	Description
volumeType	String	Definition: Disk type.. Range: SSD: Ultra-high I/O disk GPSSD: General-purpose SSD SAS: High I/O disk
size	String	Definition: Disk size, in GiB. Range: N/A.

**Table 31** DataVolumeItem
Parameter	Type	Description
volumeType	String	Definition: Disk type.. Range: SSD: Ultra-high I/O disk GPSSD: General-purpose SSD SAS: High I/O disk
size	String	Definition: Disk size, in GiB. Range: N/A.
count	Integer	Definition: Number of disks. Range: N/A.
extendParams	VolumeExtendParams object	Definition: Custom disk configuration.

**Table 32** VolumeExtendParams
Parameter	Type	Description
volumeGroup	String	Definition: Name of a disk group, which is used to divide storage space. Range: vgpaas: container disk. default: common data disk, which is mounted in default mode. vguser: common data disk, which is mounted to a specified path. The group name varies depending on the path, for example, vguser1 and vguser2. vg-everest-localvolume-persistent: common data disk, which is used as the persistent storage volume. vg-everest-localvolume-ephemeral: common data disk, which is used as a temporary storage volume.

**Table 33** VolumeGroupConfig
Parameter	Type	Description
volumeGroup	String	Definition: Disk group name. Index of the volume group in the dataVolumes. Range: N/A.
dockerThinPool	Integer	Definition: Percentage of data disks designated as container disks. This parameter can be specified only when volumeGroup is vgpaas (container disk). Range: N/A.
lvmConfig	LvmConfig object	Definition: LVM configuration management.
types	Array of strings	Definition: Storage type. Options: volume: Cloud hard disk. When dataVolumes is specified, the default value is used. local: Local disk. This parameter must be specified when a local disk is used.

**Table 34** LvmConfig
Parameter	Type	Description
lvType	String	Definition: LVM write mode. Range: linear: Linear mode. striped: Striped mode in which multiple disks are used to form a strip to improve disk performance.
path	String	Definition: Disk mount path. This parameter takes effect only in user configuration. The value is an absolute path. Digits, letters, periods (.), hyphens (-), and underscores (_) are allowed. Range: N/A.

**Table 35** Os
Parameter	Type	Description
name	String	Definition: OS name and version, for example, EulorOS 2.5. This parameter can be left blank when a private image is specified. Range: N/A.
imageId	String	Definition: OS image ID. Range: N/A.
imageType	String	Definition: OS image type. This parameter must be specified when a private image is set. By default, the preset image is used. You do not need to specify this field. Range: private: private images "": The preset image is used.
autoMatch	String	Definition: Automatic OS image matching configuration. If this parameter is set, the optimal image is automatically selected, and this parameter is automatically cleared. Range: OS name and version, for example, EulorOS 2.5.

Status code: 400

**Table 36** 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