DeleteDBInstance --云数据库 veDB MySQL 版-火山引擎

文档中心

立即注册

导航

DeleteDBInstance

最近更新时间：2024.11.08 10:14:35首次发布时间：2022.04.12 19:05:15

调用 DeleteDBInstance 接口删除 veDB MySQL 实例。

请求类型

异步请求。

调试

API Explorer

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

去调试

注意事项

仅实例状态处于运行中或错误的实例支持删除操作，即调用 DescribeDBInstanceDetail 接口时，返回的 InstanceStatus 应为 Running 或 Error。
仅按量计费的 veDB MySQL 实例支持调用 DeleteDBInstance 接口删除。包年包月实例仅支持通过控制台退订，具体操作步骤请参见退订包年包月实例。

请求参数

名称	类型	是否必选	示例值	描述
InstanceId	String	是	vedbm-r3xq0zdl****	实例 ID。说明您可以调用 DescribeDBInstances 接口查询实例 ID。
DataKeepPolicy	String	否	Last	删除实例时的备份保留策略。仅支持取值为 `Last`，表示创建并保留一个最终备份文件。说明若未传入该参数，则不保留备份。删除时，即便此参数传入了 `All`，系统也会将其转换为 `Last`。

返回参数

null

请求示例

POST /?Action=DeleteDBInstance&Version=2022-01-01 HTTP/1.1
Content-Type: application/json
Host: vedbm.volcengineapi.com
X-Date: 20220101T101010Z
Authorization: HMAC-SHA256 Credential=AKLTN2I0MmFiNzMxNWE5NDgzMzk4MmVjMTVkODlkZTZ****/20211202/cn-beijing/vedbm/request,SignedHeaders=x-date, Signature=6a593bf5f59e7c1109fb205c739d1cff4c672fe2d251963f4d48c8701d16***

```json
{
    "InstanceId": "vedbm-r3xq0zdl****",
    "DataKeepPolicy": "Last"
}

返回示例

正常返回示例

{
    "ResponseMetadata": {
        "RequestId": "202204102303580102111952291A4E84AB",
        "Action": "DeleteDBInstance",
        "Version": "2022-01-01",
        "Service": "vedbm",
        "Region": "cn-beijing"
    },
    "Result": null
}

错误码

更多详情，请参见错误码。