文档首页/KooPhone 云服务/API参考/API/实例订购/实例删除 - DeleteInstance
更新时间：2025-11-24 GMT+08:00
查看PDF
分享

实例删除 - DeleteInstance

功能介绍

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

租户可以调用该openapi退订已经订购的包周期实例，不可以退订按需的实例。

授权信息

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

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

    授权项

    访问级别

    资源类型（*为必须）

    条件键

    别名

    依赖的授权项

    koophone:cloudphoneResource:instanceDelete

    Write

    cloudphoneResource *

    -

    -

    -

URI

POST /v1/instances/delete

请求参数

表1 请求Header参数

参数

是否必选

参数类型

描述

x-auth-token

是

String

租户token

Content-Type

是

String

默认填写“application/json”，表示请求体是JSON格式

表2 请求Body参数

参数

是否必选

参数类型

描述

instanceIdList

是

Array of strings

退订实例ID列表，单个实例最长32个字符，列表最长100列

响应参数

状态码：200

表3 响应Body参数

参数

参数类型

描述

data

String

返回信息

error_code

String

错误码，0表示成功

error_msg

String

错误信息，OK表示成功

状态码：400

表4 响应Body参数

参数

参数类型

描述

error_code

String

0：成功

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

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

KOOPHONE.API.5001：不能删除按需实例

KOOPHONE.API.1012：实例不属于同一租户

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

error_msg

String

错误信息

请求示例

/instances/delete

{
  "instanceIdList" : [ "XvH39QVW" ]
}

响应示例

状态码：200

实例删除返回

{
  "data" : null,
  "error_code" : "0",
  "error_msg" : "OK"
}

状态码

状态码

描述

200

实例删除返回

400

错误情况异常

错误码

请参见错误码。

父主题：实例订购