Help Center/ ModelArts/ API Reference/ Node Management/ Locking Node Functions in Batches
Updated on 2025-08-20 GMT+08:00
View PDF
Share

Locking Node Functions in Batches

Function

This API is used to lock node functions in batches. Locked functions cannot be used on the console.

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

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 ID. The value is the metadata.name field in the resource pool details.

Request Parameters

Table 2 Request body parameters

Parameter

Mandatory

Type

Description

nodeNames

Yes

Array of strings

Names of nodes whose lock status needs to be changed.

actions

Yes

Array of strings

Changed function type. The value can be:

  • delete: Delete a lock.

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

nodes

Array of NodesResultMsg objects

Names and statuses of nodes whose lock status is updated
Table 4 NodesResultMsg

Parameter

Type

Description

name

String

Operation node name

status

String

Operation status

Status code: 404

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

Lock node functions in batches.

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

{
  "nodeNames" : [ "os-node-created-xzz78" ],
  "actions" : [ "delete" ]
}

Example Responses

Status code: 200

OK

{
  "nodes" : [ {
    "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

OK

404

Not found

Error Codes

See Error Codes.

Parent topic: Node Management