You need to enable JavaScript to run this app.
导航
缓存数据库 Redis 版
  • 文档首页
    • /
  • 缓存数据库 Redis 版

DescribeBackups

最近更新时间：2024.02.07 12:41:51

首次发布时间：2021.11.15 16:07:16

我的收藏

调用 DescribeBackups 接口查询指定 Redis 实例的备份集信息列表。

请求类型

同步请求。

注意事项

仅主备实例支持调用该接口，单节点实例不支持备份恢复相关操作，不支持调用该接口。关于两种类型实例的功能特性差异详情，请参见功能特性差异。

请求参数

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

Scope

String

否

AccountInstances

备份查询范围。取值范围如下：

  • OneInstance （默认值）：查询单个实例内的备份。
  • AccountInstances：查询当前账号下的备份。

InstanceId

String

否

redis-cn0212gzmh2xs****

实例 ID。

说明

  • 当备份查询范围为单个实例（即 Scope 取值为 OneInstance）时，该参数必填。
  • 您可以调用 DescribeDBInstances 接口查询目标地域下所有 Redis 实例的基本信息，包括实例 ID。

StartTime

String

否

2021-11-01T06:00:00Z

查询开始时间。格式为 yyyy-MM-ddTHH:mmZ（UTC 时间）。

说明

  • 若设置了该参数，查询结束时间（即 EndTime）参数也必填。
  • 若该参数留空，表示不使用时间筛选。

EndTime

String

否

2021-11-11T07:00:00Z

查询结束时间。格式为 yyyy-MM-ddTHH:mmZ（UTC 时间）。

说明

  • 若设置了查询开始时间（即 StartTime），该参数必填。
  • 查询结束时间需晚于开始时间。

PageNumber

Integer

否

1

备份集信息列表的页码，取值为不超过 Integer 数据类型的最大值，起始值为 1。

说明

  • 若设置了该参数，每页记录数（即 PageSize）也必填。
  • 若该参数留空，表示不使用页码范围筛选。

PageSize

Integer

否

10

每页记录数。取值为 1~100 间的整数。

说明

  • 若设置了页码（即 PageNumber），该参数必填。
  • 若该参数留空，表示不使用每页记录数筛选。

BackupStrategyList

Array of String

否

[
"AutomatedBackup",
"ManualBackup"
]

备份方式列表。取值范围如下：

  • ManualBackup：手动备份。
  • AutomatedBackup：自动备份。

说明

若该参数留空，表示不使用备份方式筛选。

BackupPointName

String

否

b-cn02xmmrp751i9cdzcphjmk4****

备份名称，支持模糊查询。

说明

  • 当备份查询范围为单个实例（即 Scope 取值为 OneInstance）时，该参数不生效。
  • 若该参数留空，表示不使用备份名称筛选。

ProjectName

String

否

default

备份所属的项目。

说明

  • 当备份查询范围为单个实例（即 Scope 取值为 OneInstance）时，该参数不生效。
  • 若该参数留空，表示不使用项目名称筛选。

返回数据

名称类型示例值描述
BackupsArray of BackupInfo请参见返回示例。备份集信息列表详情。关于 BackupInfo 的详细说明，请参见数据结构。
TotalInteger1总的备份集信息条目数。

请求示例

  • 查询指定实例下备份信息
    POST https://redis.volcengineapi.com/?Action=DescribeBackups&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****",
    "PageNumber": 1,
    "PageSize": 10,
    "BackupStrategyList": [
        "AutomatedBackup",
        "ManualBackup"
    ]
}
  • 查询当前账号下的备份信息
    POST https://redis.volcengineapi.com/?Action=DescribeBackups&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=****
{
    "Scope": "AccountInstances",
    "PageNumber": 1,
    "PageSize": 10,
    "ProjectName": "default"
}

返回示例

正常返回示例

{
    "ResponseMetadata": {
        "RequestId": "f3ffd83e-bef7-43b9-a803-e75b4f49043d",
        "Action": "DescribeBackups",
        "Version": "2020-12-07",
        "Service": "Redis",
        "Region": "cn-beijing"
    },
    "Result": {
        "Backups": [
           {
            "BackupPointId": "b-cn02xmmrp751i9cdzcphjmk4****",
            "BackupPointName": "b-cn02xmmrp751i9cdzcphjmk4****",
            "BackupStrategy":"ManualBackup",
            "BackupType": "Full",
            "EndTime": "2022-01-30T03:16:15Z",
            "InstanceDetail": {
               "AccountId": 2100xxxxxx,
               "ArchType": "Cluster",
               "ChargeType": "PrePaid",
               "EngineVersion": "5.0",
               "ExpiredTime": "2022-02-28 23:59:59",
               "InstanceId": "redis-cn0212gzmh2xs****",
               "InstanceName": "test",
               "MaintenanceTime": "02:00-03:00",
               "NetworkType": "VPC",
               "RegionId": "cn-beijing",
               "Replicas": 2,
               "ShardCapacity": 256,
               "ShardCount": 1,
               "TotalCapacity": 256,
               "UsedCapacity": 0,
               "VpcInfo": {
                 "ID": "vpc-3tf2ofnsmi3vj0wt****",
                 "Name": "vpc_test"
               },
               "ZoneIds":[
                 "cn-beijing-a"
               ]
             },
            "InstanceId": "redis-cn0212gzmh2xs****",
            "ProjectName": "default",
            "Size": 0,
            "StartTime": "2022-01-30T03:16:11Z",
            "Status": "Available",
            "TTL": 7
            }
        ]
        "Total": 1
    }
}

错误码

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