实例分配 - AssignInstance
功能介绍
调用此api的前提条件是租户需要先购买实例。
将云机分配给租户指定的用户,需要指定用户userId。
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权,具体权限要求请参见权限和授权项。
- 如果使用身份策略授权,需具备如下身份策略权限。
授权项
访问级别
资源类型(*为必须)
条件键
别名
依赖的授权项
koophone:cloudphoneResource:instanceAssign
Write
cloudphoneResource *
-
-
-
URI
POST /v1/instances/assign
请求参数
参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
x-request-id | 是 | String | 消息跟踪唯一id |
X-Auth-Token | 是 | String | 租户级Token |
参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
user_instances | 是 | Array of user_instances objects | 用户实例绑定关系列表,列表最大长度100列 |
响应参数
状态码:200
参数 | 参数类型 | 描述 |
|---|---|---|
error_code | String | 0:成功 KOOPHONE.API.0000:租户不存在 KOOPHONE.API.1000:请求参数错误 KOOPHONE.API.1001:没有实例权限 KPAPI.2209:没有可分配的设备 KOOPHONE.API.9999:服务内部错误 |
error_msg | String | 响应描述 |
状态码:400
参数 | 参数类型 | 描述 |
|---|---|---|
error_code | String | 0:成功 KOOPHONE.API.0000:租户不存在 KOOPHONE.API.1000:请求参数错误 KOOPHONE.API.1001:没有实例权限 KPAPI.2209:没有可分配的设备 KOOPHONE.API.9999:服务内部错误 |
error_msg | String | 响应描述 |
状态码:500
参数 | 参数类型 | 描述 |
|---|---|---|
error_code | String | 0:成功 KOOPHONE.API.0000:租户不存在 KOOPHONE.API.1000:请求参数错误 KOOPHONE.API.1001:没有实例权限 KPAPI.2209:没有可分配的设备 KOOPHONE.API.9999:服务内部错误 |
error_msg | String | 响应描述 |
请求示例
/instances/assign
{
"user_instances" : [ {
"instance_id" : "a44uhlf7",
"user_id" : "1123422"
} ]
} 响应示例
无
状态码
状态码 | 描述 |
|---|---|
200 | 正常响应 |
400 | 请求错误 |
500 | 内部错误 |
错误码
请参见错误码。

