You need to enable JavaScript to run this app.
导航
FlushDBInstance
最近更新时间:2024.09.13 11:12:18首次发布时间:2023.11.29 10:25:26

调用 FlushDBInstance 接口清除目标 Redis 实例中的所有业务数据。

请求类型

同步请求。

注意事项

  • 执行清除数据操作后,实例中的已有业务数据都会被清除且无法找回,请谨慎操作。
  • 建议清除数据前,先手动备份 Redis 实例的数据。手动备份的方法,请参见手动备份和 CreateBackup
  • 单节点实例(即 InstanceClass 取值为 Standalone)不支持持久性和备份功能,因此数据被清除后无法再恢复,请谨慎操作。关于单节点实例的更多详情,请参见产品架构
  • 参数配置中禁用 flushall 命令(即 disabled-commands 参数中加入 flushall 命令),不会影响 Redis 控制台上清除数据功能的正常执行和 FlushDBInstance 接口的正常调用。参数设置方法,请参见设置实例参数
  • 成功调用 FlushDBInstance 接口后,Redis 会立即开始执行 flushall async 操作,操作执行时长会受待清除的数据量大小影响。
  • 清除数据操作不会影响新写入的数据,即调用 FlushDBInstance 接口才写入的数据不会被清除。

请求参数

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

实例 ID。

说明

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

ClientToken
String
WbiAlPqJM6tMoSOYhT****
用于保证请求的幂等性,防止重复提交请求。由客户端生成该参数值,要保证在不同请求间唯一,大小写敏感且不超过 127 个 ASCII 字符。

返回参数

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

示例

请求示例

POST https://redis.volcengineapi.com/?Action=FlushDBInstance&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****"
}

返回示例

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

错误码

更多详情,请参见错误码