文档首页/ CloudDevice 服务/ API参考/ API/ 实例管理/ 实例取消分配 - UnassignInstance
更新时间：2025-10-30 GMT+08:00
查看PDF
分享

实例取消分配 - UnassignInstance

功能介绍

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

将云机取消分配给租户指定的用户，调用后会清除用户云机使用数据。

授权信息

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

URI

POST /v1/instances/unassign

请求参数

表1 请求Header参数

参数

是否必选

参数类型

描述

x-request-id

是

String

消息跟踪唯一id

X-Auth-Token

是

String

租户级Token
表2 请求Body参数

参数

是否必选

参数类型

描述

user_instances

是

Array of UserInstanceInfo objects

用户实例信息
表3 UserInstanceInfo

参数

是否必选

参数类型

描述

user_id

是

String

用户id，最大长度32个字符

instance_id

是

String

实例id，最大长度32个字符

响应参数

状态码：200

表4 响应Body参数

参数

参数类型

描述

error_code

String

0：成功

KOOPHONE.API.0000：租户不存在

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

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

KOOPHONE.API.2210：用户和实例绑定关系不存在

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

error_msg

String

错误信息

状态码：400

表5 响应Body参数

参数

参数类型

描述

error_code

String

0：成功

KOOPHONE.API.0000：租户不存在

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

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

KOOPHONE.API.2210：用户和实例绑定关系不存在

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

error_msg

String

错误信息

状态码：500

表6 响应Body参数

参数

参数类型

描述

error_code

String

0：成功

KOOPHONE.API.0000：租户不存在

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

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

KOOPHONE.API.2210：用户和实例绑定关系不存在

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

error_msg

String

错误信息

请求示例

/instances/unassign

{
  "user_instances" : [ {
    "instance_id" : "a44uhlf7",
    "user_id" : 1123422
  } ]
}

响应示例

无

状态码

状态码

描述

200

正常响应

400

请求错误

500

内部错误

错误码

请参见错误码。

父主题： 实例管理