You need to enable JavaScript to run this app.
导航
DeleteInstance - 删除实例
最近更新时间:2024.10.17 15:24:39首次发布时间:2023.03.30 19:59:24

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

注意事项

  • 实例被删除后无法恢复,请谨慎调用。
  • 仅按量付费实例支持通过此接口删除。包年包月实例到期后自动删除,合同期内不支持删除。
  • 删除实例前,需要确保实例中没有 Topic 和 Group;没有执行中的后台任务。

调试

请求参数

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

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

DeleteInstance

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

Version
String

2022-05-01

API的版本,取值:2022-05-01。

InstanceId
String

kafka-cnngqkfgdudt****

实例 ID。

返回参数

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

请求示例

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

{
  "InstanceId": "kafka-cnng3s31v076****"
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "2023022719153124D1D2D50917B7639137",
        "Action": "DeleteInstance",
        "Version": "2022-05-01",
        "Service": "Kafka",
        "Region": "cn-beijing"
    },
    "Result": null
}

错误码

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

状态码
错误码
错误信息
说明
400
OperationDenied.ChargeTypeIsPrepaid
It's forbidden to release a prepaid instance within validity period.

不支持在合同期内删除实例。

400
OperationDenied.InstancePrepaid
The operation is not permitted due to the instance charge type is prepaid.

当前实例计费类型是预付费,无法执行该操作。

403
OperationDenied.InstanceNotEmpty
The instance that you tried to delete is not empty.

期望删除的实例不为空。

404
InvalidInstance.NotFound
The specified instance does not exist.

实例不存在。