DeleteInstance - 删除实例--消息队列 RocketMQ版-火山引擎

文档中心

立即注册

导航

DeleteInstance - 删除实例

最近更新时间：2024.11.18 10:27:30首次发布时间：2023.07.12 16:22:34

调用 DeleteInstance 接口释放按量付费实例。

使用说明

对于不再使用的 RocketMQ 实例，建议及时删除以节约资源。

说明

待删除实例下的 Topic 和 Group 为空时才可删除。
删除实例不可恢复，请谨慎操作。
仅按量付费实例支持通过此接口删除。包年包月实例到期后自动删除，合同期内不支持删除。

注意事项

请求频率：该接口请求频率限制为 100 次/秒；单用户请求频率限制为 20 次/秒。

调试

API Explorer

您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。

去调试

请求参数

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

参数	类型	是否必填	示例值	描述
Action	String	是	DeleteInstance	要执行的操作，取值：DeleteInstance。
Version	String	是	2023-01-01	API的版本，取值：2023-01-01。
InstanceId	String	是	rocketmq-cnai1f0c29ca****	待查询详情的实例 ID。

返回参数

本接口无特有的返回参数。更多信息请见返回结构。

请求示例

POST /?Action=DeleteInstance&Version=2023-01-01 HTTP/1.1
Content-Type: application/json
Host: rocketmq.volcengineapi.com
X-Date: 20210328T100802Z
Authorization: HMAC-SHA256 Credential=AK********/20210328/cn-shanghai/rocketmq/request, SignedHeaders=x-date, Signature=********

{
  "InstanceId": "rocketmq-cnai1f0c29ca****"
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "2023022719153124D1D2D50917B7639137",
        "Action": "DeleteInstance",
        "Version": "2023-01-01",
        "Service": "RocketMQ",
        "Region": "cn-shanghai"
    },
    "Result": null
}

错误码

公共错误码请参见公共错误码文档。