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

Updating a Node Pool

Function

This API is used to update 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

PATCH /v2/{project_id}/pools/{pool_name}/nodepools/{nodepool_name}

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.

nodepool_name

Yes

String

Node pool name.

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

Content-Type

Yes

String

application/merge-patch+json.

Table 3 Request body parameters

Parameter

Mandatory

Type

Description

spec

Yes

NodePoolSpec object

Request body for updating a node pool.

Table 4 NodePoolSpec

Parameter

Mandatory

Type

Description

resources

Yes

PoolResource object

List of resources in a node pool, including resource flavors, quantity, and custom configurations.

Table 5 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 6 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 7 Taint

Parameter

Mandatory

Type

Description

key

Yes

String

Key.

value

No

String

Value.

effect

Yes

String

Effect.

Table 8 UserTag

Parameter

Mandatory

Type

Description

key

Yes

String

Key. The value cannot start with CCE- or __type_baremetal.

value

Yes

String

Value.

Table 9 NodeNetwork

Parameter

Mandatory

Type

Description

vpc

No

String

VPC ID.

subnet

No

String

Subnet ID.

securityGroups

No

Array of strings

Security group IDs.

Table 10 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 11 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 12 Response body parameters

Parameter

Type

Description

spec

NodePoolSpec object

Request body for updating a node pool.

Table 13 NodePoolSpec

Parameter

Type

Description

resources

PoolResource object

List of resources in a node pool, including resource flavors, quantity, and custom configurations.

Table 14 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 15 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 16 Taint

Parameter

Type

Description

key

String

Key.

value

String

Value.

effect

String

Effect.

Table 17 UserTag

Parameter

Type

Description

key

String

Key. The value cannot start with CCE- or __type_baremetal.

value

String

Value.

Table 18 NodeNetwork

Parameter

Type

Description

vpc

String

VPC ID.

subnet

String

Subnet ID.

securityGroups

Array of strings

Security group IDs.

Table 19 CreatingStep

Parameter

Type

Description

step

Integer

Creation step.

type

String

Batch creation type. The options are as follows:

  • rack: entire cabinet

Table 20 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 21 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

Update a node pool.

PATCH https://{endpoint}/v2/{project_id}/pools/{pool_name}/nodepools/{nodepool_name}

{
  "spec" : {
    "resources" : {
      "nodePool" : "modelarts.vm.2u4g.dcc-Default",
      "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.

{
  "spec" : {
    "resources" : {
      "nodePool" : "modelarts.vm.2u4g.dcc-Default",
      "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.