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

实例批量准备 - BatchPrepareInstances

功能介绍

实例批量准备。

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

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

授权信息

账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。

  • 如果使用角色与策略授权，具体权限要求请参见权限和授权项。
  • 如果使用身份策略授权，需具备如下身份策略权限。

    授权项

    访问级别

    资源类型（*为必须）

    条件键

    别名

    依赖的授权项

    koophone:cloudphoneResource:instancePrepare

    Write

    cloudphoneResource *

    -

    -

    -

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：备份中，4：重置中，5：重启中，6：正常离线，7：换机中，8：到期备份恢复中，9：到期备份恢复失败，10：设备维护中）

状态码：400

表6 响应Body参数

参数

参数类型

描述

error_code

String

0：成功

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

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

KOOPHONE.API.4001：实例不存在

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

error_msg

String

错误信息

状态码：500

表7 响应Body参数

参数

参数类型

描述

error_code

String

0：成功

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

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

KOOPHONE.API.4001：实例不存在

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

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

内部错误

错误码

请参见错误码。

父主题：实例使用