文档首页/ CloudDevice 服务/ API参考/ API/ 实例使用/ 实例批量准备
更新时间：2025-08-12 GMT+08:00
查看PDF
分享

实例批量准备

功能介绍

实例批量准备。

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

调用该接口后，当前实例会被准备到可以串流的状态。

调试

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

URI

POST /v1/instances/prepare

请求参数

表1 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

租户级Token
表2 请求Body参数

参数

是否必选

参数类型

描述

user_id

是

String

用户id，最大长度32

instance_ids

是

Array of strings

实例列表，单个实例最大长度32，列表最大长度100

响应参数

状态码：200

表3 响应Body参数

参数

参数类型

描述

error_code

String

响应码，错误码规范KooPhone.API.1001，数字递增

error_msg

String

响应描述

data

InstanceStatusWrapper object

状态查询结果
表4 InstanceStatusWrapper

参数

参数类型

描述

status_list

Array of InstanceStatus objects

实例状态列表
表5 InstanceStatus

参数

参数类型

描述

instance_id

String

实例id

status

Integer

实例状态。0：正常，1：待还原，2：待分配，3：备份中

状态码：400

表6 响应Body参数

参数

参数类型

描述

error_code

String

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

error_msg

String

响应描述

状态码：500

表7 响应Body参数

参数

参数类型

描述

error_code

String

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

error_msg

String

响应描述

请求示例

/v1/instances/prepare

{
  "user_id" : "1008600000104285462",
  "instance_ids" : [ "iRJEVP96", "iRJEVP96" ]
}

响应示例

状态码：200

正常响应

{
  "data" : {
    "status_list" : [ {
      "instance_id" : "a44uhlf7",
      "status" : 0
    }, {
      "instance_id" : "efjy72gs",
      "status" : 1
    } ]
  },
  "error_code" : "0",
  "error_msg" : "ok"
}

状态码

状态码

描述

200

正常响应

400

请求错误

500

内部错误

错误码

请参见错误码。

父主题： 实例使用

相关文档