You need to enable JavaScript to run this app.
导航
ReleaseInstance - 释放目标实例
最近更新时间:2024.10.21 17:11:13首次发布时间:2023.11.30 14:19:27

调用 ReleaseInstance 接口,删除(释放)目标实例。

注意事项

  • 调用 ReleaseInstance 接口,成功发送请求后会立即释放实例,不会经过二次确认。操作一旦执行,则无法暂停或撤销。删除后,实例配置和数据都将被完全销毁,无法恢复,请谨慎操作。
  • 如果需要释放的是包年包月实例,将根据退订退款规则进行退款。详情请参见退订管理
  • 如果您的实例开启了删除保护功能,将无法通过此接口删除。您可以调用 ModifyDeletionProtection 接口,关闭实例删除保护功能后,再删除实例。

请求说明

  • 请求方式:POST
  • 请求地址:/?Action=ReleaseInstance&Version=2023-01-01 HTTP/1.1

调试

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数

参数
类型
是否必填
示例值
描述
Action
String

ReleaseInstance

要执行的操作,取值:ReleaseInstance。

Version
String

2023-01-01

API的版本,取值:2023-01-01。

InstanceId
String

o-00k***o718

需要释放的实例 ID。

返回参数

下表仅列出本接口特有的返回参数。更多信息请参见返回结构

参数
类型
示例值
描述
Status
String

SUCCESSFUL

返回的操作状态。

Message
String

--

返回的提示信息。

请求示例

POST https://open.volcengineapi.com/?Action=ReleaseInstance&Version=2023-01-01
Content-Type: application/json
X-Date: 20231003T104027Z
Authorization: HMAC-SHA256 
Credential=AKLTMjI2ODVlYzI3ZGY1NGU4ZjhjYWRjMTlmNTM5OTZ****/20231003/cn-beijing/ESCloud/request, SignedHeaders=content-type;host;x-date, Signature=88dd0a9ea555d8609ec83eb46054b52f6cd4f79b8d5094fa784c66fa3f2b****
{
    "InstanceId": "o-00k***o718"
}

返回示例

{
    "ResponseMetadata": {
        "Action": "ReleaseInstance",
        "Region": "cn-beijing",
        "RequestId": "2023060411042001001***",
        "Service": "ESCloud",
        "Version": "2023-01-01"
    },
    "Result": {
        "Status": "SUCCESSFUL",
        "Message": ""
    }
}

错误码

下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。

状态码
错误码
错误信息
说明
200
Unauthorized
unauthorized error

用户无权限调用接口

200
IllegalParameter
illegal parameter

非法参数。可能是参数缺失,也可能是参数不符合接口要求

200
InternalServerError
服务器内部异常

服务由于异常退出,无法完成接口请求操作