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

缓存数据库 Redis 企业版

复制全文
备份恢复
DescribeBackupPlan
复制全文
DescribeBackupPlan

调用 DescribeBackupPlan 接口查询目标 Redis 企业版实例的自动备份策略,包括备份类型、备份周期、下一次执行备份的预期时间等信息。

请求类型

同步请求。

调试

请求参数

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

实例 ID。

说明

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

返回参数

参数
类型
示例值
描述
Active
Boolean
true

是否启用自动备份,取值范围如下:

  • true:已启用。
  • false:未启用。
BackupHour
Integer
5
开始执行备份的时间段(UTC+8)。取值范围为 0 到 23 间的任意整数,其中 0 表示系统会在 00:00~00:59 时段内执行备份,1 表示会在 01:00~01:59 时段内执行备份,以此类推。
BackupType
String
Full
备份类型。当前仅支持 Full,即全量备份。
ExpectNextBackupTime
String
2024-07-10T20:20:20Z
下一次执行备份的预期时间,格式为 yyyy-MM-ddTHH:mm:ssZ(UTC)。
InstanceId
String
redis-cn0212gzmh2xs****
实例 ID。
LastUpdateTime
String
2024-07-10T00:00:00Z
上一次修改备份策略的时间,格式为 yyyy-MM-ddTHH:mm:ssZ(UTC)。
Period
Integer[]
[1,2,3,4,5,6,7]
备份周期。取值范围为 1 到 7 之间的任意整数。其中,1 表示每周一进行备份,2 表示每周二进行备份,以此类推。
TTL
Integer
7
备份文件的保留天数,默认为 7 天。

示例

请求示例

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

返回示例

{
    "ResponseMetadata": {
        "RequestId": "202204151618440102121681030A63****",
        "Action": "DescribeBackupPlan",
        "Version": "2020-12-07",
        "Service": "Redis",
        "Region": "cn-beijing"
    },
    "Result": {
        "Active": true,
        "BackupHour": 5,
        "BackupType": "Full",
        "ExpectNextBackupTime": "2024-07-10T20:20:20Z",
        "InstanceId": "redis-cn0212gzmh2xs****",
        "LastUpdateTime": "2024-07-10T00:00:00Z",
        "Period": [
            1,
            2,
            3,
            4,
            5,
            6,
            7
        ],
        "TTL": 7
    }
}

错误码

更多详情,请参见错误码

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