You need to enable JavaScript to run this app.
导航
DeleteDBInstance
最近更新时间:2024.02.07 12:41:54首次发布时间:2022.03.01 10:51:03

调用 DeleteDBInstance 接口删除指定的 Redis 实例。

请求类型

异步请求。

注意事项

调用 DeleteDBInstance 接口删除实例时,系统会根据实例类型自动选择对应的默认备份策略,其中:

  • 主备实例:删除实例前会默认创建一个最终备份,备份创建成功后保留期为 7 天。建议您及时下载保存到本地。您可以在备份列表页查看或下载已删除实例的备份,并根据备份恢复实例。更多详情,请参见恢复已删除实例
  • 单节点实例:单节点实例不支持持久性和备份功能,删除时默认不会创建任何备份,删除后实例数据将被彻底清除,请谨慎操作。关于单节点实例的更多详情,请参见产品架构

请求参数

名称类型是否必选示例值描述

InstanceId

String

redis-cn0212gzmh2xs****

实例 ID。

说明

您可以调用 DescribeDBInstances 接口查询目标地域下所有 Redis 实例的基本信息,包括实例 ID。

BackupPointName

String

b-cq01wp9k2wlw9z9gzl76n2vd****

为待删除实例的最终备份设置备份名称。若不设置备份名称,默认使用备份 ID 作为名称。
如需设置备份名称,名称需同时满足如下条件:

  • 以中文、字母、下划线(_)开头。
  • 长度为 1-128 个字符。
  • 由中文、字母、数字、下划线(_)和中划线(-)组成。

说明

  • 该参数仅对按量计费主备实例生效,即实例的 InstanceClassPrimarySecondaryChargeTypePostPaid
  • 您可以调用 DescribeDBInstanceDetail 接口查询指定实例的详情信息,包括实例类型和计费类型。
ClientTokenStringWbiAlPqJM6tMoSOYhT****用于保证请求的幂等性,防止重复提交请求。由客户端生成该参数值,要保证在不同请求间唯一,大小写敏感且不超过 127 个 ASCII 字符。

返回数据

null

请求示例

POST https://redis.volcengineapi.com/?Action=DeleteDBInstance&Version=2020-12-07 HTTP/1.1
Host: redis.volcengineapi.com
Content-Type: application/json; charset=utf-8
X-Date: 20201103T104027Z
Authorization: HMAC-SHA256 Credential=AK****/20201103/cn-beijing/Redis/request,SignedHeaders=content-type;host;x-date,Signature=****
{
	"InstanceId": "redis-cn0212gzmh2xs****",
	"CreateBackup": true
}

返回示例

正常返回示例

{
     "ResponseMetadata": {
          "RequestId": "2022012421383201022509900805A7****",
          "Action": "DeleteDBInstance",
          "Version": "2020-12-07",
          "Service": "Redis",
          "Region": "cn-beijing"
     },
     "Result": null
}

错误码

更多详情,请参见错误码