更新时间:2025-08-12 GMT+08:00
分享

实例批量重置

功能介绍

实例批量重置。

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

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

调试

您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。

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

响应码,KOOPHONE.API.xxxx或者common.00000xxx

error_msg

String

响应描述

状态码:400

表4 响应Body参数

参数

参数类型

描述

error_code

String

响应码,KOOPHONE.API.xxxx或者common.00000xxx

error_msg

String

响应描述

状态码:500

表5 响应Body参数

参数

参数类型

描述

error_code

String

响应码,KOOPHONE.API.xxxx或者common.00000xxx

error_msg

String

响应描述

请求示例

/v1/instances/batch-reset 

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

响应示例

状态码:200

正常响应

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

状态码

状态码

描述

200

正常响应

400

请求错误

500

内部错误

错误码

请参见错误码

相关文档