文档首页/ CloudDevice 服务/ API参考/ API/ 实例管理/ 实例批量重置 - BatchReset
更新时间:2025-10-30 GMT+08:00

实例批量重置 - BatchReset

功能介绍

实例批量重置。

调用此api的前提条件是租户需要先购买实例。

调用该接口后,当前实例会被初始化。

授权信息

账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限,具体权限要求请参见权限和授权项

URI

POST /v1/instances/batch-reset

请求参数

表1 请求Header参数

参数

是否必选

参数类型

描述

x-request-id

String

消息跟踪唯一id

X-Auth-Token

String

租户级Token

表2 请求Body参数

参数

是否必选

参数类型

描述

instance_ids

Array of strings

实例列表,单个实例最长32个字符,列表最长100列

响应参数

状态码:200

表3 响应Body参数

参数

参数类型

描述

error_code

String

0:成功

KOOPHONE.API.0000:租户不存在

KOOPHONE.API.1000:请求参数错误

KOOPHONE.API.1001:没有实例权限

KPAPI.2209:没有可分配的设备

KOOPHONE.API.9999:服务内部错误

error_msg

String

响应描述

状态码:400

表4 响应Body参数

参数

参数类型

描述

error_code

String

0:成功

KOOPHONE.API.1000:请求参数错误

KOOPHONE.API.1001:没有实例权限

KOOPHONE.API.9999:服务内部报错

error_msg

String

错误信息

请求示例

/v1/instances/batch-reset 

{
  "instance_ids" : [ "a44uhlf7", "efjy72gs" ]
}

响应示例

状态码:200

正常响应

{
  "error_code" : "0",
  "error_msg" : "ok"
}

状态码

状态码

描述

200

正常响应

400

请求错误

错误码

请参见错误码