重置节点 - BatchResetPoolNodes
功能介绍
重置节点接口用于将指定节点恢复至初始状态或重新配置其运行参数,支持批量操作时多个节点独立执行重置流程。该接口适用于以下场景:当节点因配置错误、服务异常或需恢复默认设置时,用户可通过此接口批量重置目标节点,确保每个节点的重置过程互不影响。使用该接口的前提条件包括:目标节点已存在且用户具备管理员权限,节点需处于可操作状态(如非锁定或维护中),批量操作时需提供有效的节点列表作为输入参数。操作完成后,指定节点将被重置(如清除临时数据、重启服务或恢复默认配置),其状态将更新为可用状态。若节点不存在、用户权限不足、节点状态异常或输入参数缺失,接口将返回对应错误信息(如404未找到节点、403权限拒绝、400参数校验失败等)。
调试
您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权,具体权限要求请参见权限和授权项。
- 如果使用身份策略授权,需具备如下身份策略权限。
URI
POST /v2/{project_id}/pools/{pool_name}/nodes/batch-reset
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| project_id | 是 | String | 参数解释:用户项目ID。获取方法请参见获取项目ID和名称。 约束限制:1 - 64字符,字母、数字和中划线。 取值范围:不涉及。 默认取值:不涉及。 |
| pool_name | 是 | String | 参数解释:资源池ID。取值资源池详情的metadata.name字段。 约束限制:不涉及。 取值范围:不涉及。 默认取值:不涉及。 |
请求参数
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| nodeNames | 是 | Array of strings | 参数解释:需要重置的节点名称列表。 约束限制:不涉及。 |
| rollingConfig | 是 | rollingConfig object | 参数解释:节点重置是滚动配置。 约束限制:不涉及。 |
| nodeConfig | 否 | nodeConfig object | 参数解释:节点配置参数。 约束限制:该参数待下线。超节点禁传此参数,非超节点亦不推荐传递此参数。重置配置参数会从节点所在的nodepool自动取值, 若需要重置时修改某参数, 可先修改nodepool相关参数, 再进行重置。 |
响应参数
状态码:200
| 参数 | 参数类型 | 描述 |
|---|---|---|
| job_id | String | 参数解释:异步任务的ID。 取值范围:不涉及。 |
状态码:404
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 参数解释:ModelArts错误码。 取值范围:不涉及。 |
| error_msg | String | 参数解释:具体错误信息。 取值范围:不涉及。 |
请求示例
POST /v2/{project_id}/pools/{pool_name}/nodes/batch-reset
{
"nodeNames" : [ "os-node-created-lv29s" ],
"rollingConfig" : {
"strategy" : "RollingByPercent",
"maxUnavailable" : 25
},
"nodeConfig" : {
"imageId" : "3f2ee6e8-b19b-4683-8c9d-c10b197d51d6",
"imageType" : "private"
}
} 响应示例
状态码:200
{
"job_id" : "f234a869-f8ee-4b51-8255-3cbede368aba"
} 状态码:404
{
"error_code" : "ModelArts.50015001",
"error_msg" : "pool not found"
} 状态码
| 状态码 | 描述 |
|---|---|
| 200 | OK。 |
| 404 | Not Found。 |
错误码
请参见错误码。