You need to enable JavaScript to run this app.
文档中心
缓存数据库 Redis 版

缓存数据库 Redis 版

复制全文
下载 pdf
实例管理
DeleteDBInstance
复制全文
下载 pdf
DeleteDBInstance
调用 DeleteDBInstance 接口删除目标 Redis 实例。​
请求类型​
异步请求。​
注意事项​
调用 DeleteDBInstance 接口删除实例时,系统会根据实例类型自动选择对应的默认备份策略,其中:​
  • 主备实例:删除实例前会默认创建一个最终备份,建议您及时下载保存到本地。实例删除后,实例数据将被彻底清除且不可恢复,请谨慎操作。您可以在备份列表页查看并下载已删除实例的备份。更多详情,请参见查看备份。​
  • 单节点实例:单节点实例不支持持久性和备份功能,删除时默认不会创建任何备份,删除后实例数据将被彻底清除,请谨慎操作。关于单节点实例的更多详情,请参见产品架构。​
调试​
API Explorer
您可以通过 API Explorer 在线发起调用,无需关注签名生成过程,快速获取调用结果。
​
请求参数​
​
参数​
类型​
是否必选​
示例值​
描述​
InstanceId​
String​
是​
redis-cn0212gzmh2xs1111​
实例 ID。​
说明​
您可以调用 DescribeDBInstances接口查询目标地域下所有 Redis 实例的基本信息,包括实例 ID。​
BackupPointName​
String​
否​
testbackup​
为待删除实例的最终备份设置备份名称。若不设置备份名称,默认使用备份 ID 作为名称。​
如需设置备份名称,名称需同时满足如下条件:​
  • 以中文、字母、下划线(_)开头。​
  • 长度为 1-128 个字符。​
  • 由中文、字母、数字、下划线(_)和中划线(-)组成。​
说明​
  • 该参数仅对按量计费的主备实例生效,即实例的 InstanceClass 为 PrimarySecondary 且 ChargeType 为 PostPaid。​
  • 您可以调用 DescribeDBInstanceDetail接口查询指定实例的详情信息,包括实例类型和计费类型。​
ClientToken​
String​
否​
WbiAlPqJM6tMoSOYhT****​
用于保证请求的幂等性,防止重复提交请求。由客户端生成该参数值,要保证在不同请求间唯一,大小写敏感且不超过 127 个 ASCII 字符。​
​
返回参数​
本接口无特有的返回参数。更多信息请见返回结构。​
示例​
请求示例​
​
POST https://redis.cn-beijing.volcengineapi.com/?Action=DeleteDBInstance&Version=2020-12-07 HTTP/1.1​
Host: redis.cn-beijing.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-cn0212gzmh2xs1111",​
"BackupPointName": "testbackup"​
}​
​
返回示例​
​
{​
"ResponseMetadata": {​
"RequestId": "2022012421383201022509900805A71111",​
"Action": "DeleteDBInstance",​
"Version": "2020-12-07",​
"Service": "Redis",​
"Region": "cn-beijing"​
},​
"Result": null​
}​
​
错误码​
更多详情,请参见错误码。​
最近更新时间:2026.09.21 14:23:31
这个页面对您有帮助吗?
有用
有用
无用
无用