Help Center/ ModelArts/ API Reference/ Node Management/ Batch Updating Nodes
Updated on 2026-01-30 GMT+08:00
Online Debugging
CLI Examples
View PDF
Share

Batch Updating Nodes

Function

This API is used to modify the configuration or attributes of multiple nodes at the same time. Each node can execute the update process independently during batch operations. Use this API when you need to upgrade node software versions, manage resource tags, adjust resource allocation policies, apply security fixes, or synchronize configuration changes. To use it, ensure the target nodes exist, have administrator rights, and are operational (not locked or under maintenance). Provide a valid node list and update parameters like configurations or version numbers. After the update, nodes adopt the new settings and become available, replacing old configurations. If issues arise, like missing nodes, insufficient permissions, incorrect node states (like under maintenance), invalid parameters, or incomplete data, the system returns errors such as 404 node not found, 403 permission denied, or 400 parameter validation failed.

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}/nodes/batch-update

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: The value can contain 1 to 64 characters. Letters, digits, and hyphens (-) are allowed.

Range: N/A.

Default Value: N/A.

pool_name

Yes

String

Definition: Resource pool ID. The value is the metadata.name field in the resource pool details.

Constraints: N/A.

Range: N/A.

Default Value: N/A.

Request Parameters

Table 2 Request body parameters

Parameter

Mandatory

Type

Description

nodeNames

Yes

Array of strings

Definition: List of nodes to be updated.

Constraints: N/A.

action

Yes

String

Definition: Node update type.

Constraints: N/A.

Range:

  • openHaRedundant: Enable HA redundancy.

  • closeHaRedundant: Disable HA redundancy.

  • createTags: Batch add node resource tags.

  • deleteTags: Batch delete node resource tags.

Default Value: N/A.

haRedundantEnable

No

Boolean

Definition: HA redundancy tag. If the value is true, HA redundancy is enabled for the node.

Constraints: N/A.

Range: N/A.

Default Value: N/A.

haRedundantEffect

No

String

Definition: HA redundancy tag effect.

Constraints: N/A.

Range:

  • NoSchedule: No scheduling is allowed.

  • NoExecute: No execution is allowed.

Default Value: N/A.

driver

No

NodeDriver object

Definition: Driver version and status of a node.

Constraints: N/A.

tags

No

Array of NodeTag objects

Definition: List of resource tags to be operated in batches.

Constraints: N/A.
Table 3 NodeDriver

Parameter

Mandatory

Type

Description

version

No

String

Definition: Driver version on the node.

Constraints: N/A.

Range: N/A.

Default Value: N/A.

updateStrategy

No

String

Definition: Node driver upgrade policy.

Constraints: N/A.

Range: N/A.

Default Value: N/A.
Table 4 NodeTag

Parameter

Mandatory

Type

Description

key

Yes

String

Definition: Tag key. It can contain letters, digits, spaces, and special characters (_.:=+-@), but cannot start or end with a space or start with sys.

Constraints: N/A.

Range: N/A.

Default Value: N/A.

value

Yes

String

Definition: Tag value. Can contain letters, digits, spaces, and special characters _.:=+-@ but cannot start or end with a space.

Constraints: N/A.

Range: N/A.

Default Value: N/A.

Response Parameters

Status code: 200

Table 5 Response body parameters

Parameter

Type

Description

successNodeNames

Array of strings

Definition: List of nodes that are successfully updated.

failNodeNames

Array of strings

Definition: List of nodes that fail to be updated.

Status code: 404

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

Enable node HA redundancy.

POST /v2/{project_id}/pools/{pool_name}/nodes/batch-update

{
  "nodeNames" : [ "os-node-created-xzz78" ],
  "action" : "openHaRedundant"
}

Example Responses

Status code: 200

Request succeeded.

{
  "successNodeNames" : [ {
    "name" : "os-node-created-xzz78",
    "status" : "success"
  } ]
}

Status code: 404

Not found.

{
  "error_code" : "ModelArts.50015001",
  "error_msg" : "pool not found"
}

Status Codes

Status Code

Description

200

Request succeeded.

404

Not found.

Error Codes

See Error Codes.

Parent topic: Node Management