You need to enable JavaScript to run this app.
缓存数据库 Redis 企业版

缓存数据库 Redis 企业版

请输入
  • 文档首页
    • 缓存数据库 Redis 企业版API 参考实例管理DeleteEnterpriseDBInstance
复制全文
我的收藏
实例管理
DeleteEnterpriseDBInstance
复制全文
我的收藏
DeleteEnterpriseDBInstance

调用 DeleteEnterpriseDBInstance 接口删除目标 Redis 企业版实例。

请求类型

异步请求。

调试

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

请求参数

参数
类型
是否必选
示例值
描述
InstanceId
String
是
redis-cn0212gzmh2xs****

实例 ID。

说明

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

CreateBackup
Boolean
否
true

是否在删除实例前创建全量备份。取值范围如下：

  • true（默认值）：创建备份。
  • false：不创建。

说明

  • 该参数仅对按量计费（即 ChargeType 为 PostPaid）的实例生效；包年包月（即 ChargeType 为 PrePaid）实例删除前必须创建一个最终备份，不支持设置该参数。
  • 您可以调用 DescribeEnterpriseDBInstanceDetail 接口查询指定实例的详情信息，包括实例类型和计费类型。
BackupPointName
String
否
testbackup

为待删除实例的最终备份设置备份名称。如需设置备份名称，名称需同时满足如下条件:

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

说明

  • 该参数仅当按量计费实例选择了在删除实例前创建全量备份（即 CreateBackup 为 true ）时生效；包年包月实例删除前创建的最终备份名称即为备份 ID。
  • 若不设置备份名称，默认使用备份 ID 作为名称。
ClientToken
String
否
WbiAlPqJM6tMoSOYhT****
用于保证请求的幂等性，防止重复提交请求。由客户端生成该参数值，要保证在不同请求间唯一，大小写敏感且不超过 127 个 ASCII 字符。

返回参数

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

示例

请求示例 

POST https://redis.cn-beijing.volcengineapi.com/?Action=DeleteEnterpriseDBInstance&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-cn0212gzmh2xs****",
    "CreateBackup": true,
    "BackupPointName": "testbackup"
}

返回示例 

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

错误码

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

最近更新时间：2025.08.14 15:34:20
这个页面对您有帮助吗？
有用
有用
无用
无用