批量对节点功能上锁
功能介绍
批量对节点功能上锁接口用于批量对指定节点的功能进行上锁操作,被上锁的功能在控制台将无法正常使用。该接口适用于以下场景:当需要临时禁用某些节点的功能以防止误操作、进行系统维护或测试时,用户可通过此接口批量对节点功能进行上锁。使用该接口的前提条件是节点功能已存在且用户具有管理员权限。上锁操作完成后,指定节点的功能将在控制台被禁用,无法进行相关操作。若节点功能不存在、用户无权限操作或请求参数无效,接口将返回相应的错误信息。
调试
您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。
URI
POST /v2/{project_id}/pools/{pool_name}/nodes/batch-lock
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
参数解释:用户项目ID。获取方法请参见获取项目ID和名称。 约束限制:1 - 64字符,字母、数字和中划线。 取值范围:不涉及。 默认取值:不涉及。 |
pool_name |
是 |
String |
参数解释:资源池ID。取值资源池详情的metadata.name字段。 约束限制:不涉及。 取值范围:不涉及。 默认取值:不涉及。 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
nodeNames |
是 |
Array of strings |
参数解释:需要变更锁状态的节点名称列表。 约束限制:不涉及。 |
actions |
是 |
Array of strings |
参数解释:变更的功能类型。 约束限制:不涉及。 |
响应参数
状态码:200
参数 |
参数类型 |
描述 |
---|---|---|
nodes |
Array of NodesResultMsg objects |
参数解释:批量操作的资源池节点ID列表及状态。 |
参数 |
参数类型 |
描述 |
---|---|---|
name |
String |
参数解释:解锁的资源池节点ID,取值自节点详情metadata.name字段的值。 取值范围:不涉及。 |
status |
String |
参数解释:资源池节点批量操作结果。 取值范围:可选值如下:
|
状态码:404
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
参数解释:ModelArts错误码。 取值范围:不涉及。 |
error_msg |
String |
参数解释:具体错误信息。 取值范围:不涉及。 |
请求示例
批量对节点功能上锁。
POST /v2/{project_id}/pools/{pool_name}/nodes/batch-lock { "nodeNames" : [ "os-node-created-xzz78" ], "actions" : [ "delete" ] }
响应示例
状态码:200
OK。
{ "nodes" : [ { "name" : "os-node-created-xzz78", "status" : "success" } ] }
状态码:404
Not Found。
{ "error_code" : "ModelArts.50015001", "error_msg" : "pool not found" }
状态码
状态码 |
描述 |
---|---|
200 |
OK。 |
404 |
Not Found。 |
错误码
请参见错误码。