DescribeBackups--缓存数据库 Redis 企业版-火山引擎

文档中心

立即注册

导航

DescribeBackups

最近更新时间：2025.04.22 21:41:10首次发布时间：2024.12.13 17:25:37

调用 DescribeBackups 接口查询目标 Redis 企业版实例的备份集列表。

请求类型

同步请求。

请求参数

参数	类型	是否必选	示例值	描述
Scope	String	否	AccountInstances	备份查询范围。取值范围如下： `OneInstance`（默认值）：查询单个实例内的备份。 `AccountInstances`：查询当前账号下的备份。
InstanceId	String	否	redis-cn0212gzmh2xs****	实例 ID。说明当备份查询范围为单个实例（即 `Scope` 取值为`OneInstance`）时，该参数必填。您可以调用 DescribeDBInstances 接口查询目标地域下所有 Redis 实例的基本信息，包括实例 ID。若该参数留空，表示不使用实例 ID 筛选。
StartTime	String	否	2024-08-22T07:51:09Z	查询开始时间。格式为 `yyyy-MM-ddTHH:mm:ssZ`（UTC）。说明若设置了该参数，查询结束时间（即`EndTime`）参数也必填。若该参数留空，表示不使用时间范围筛选。
EndTime	String	否	2024-08-22T07:51:12Z	查询结束时间。格式为 `yyyy-MM-ddTHH:mm:ssZ`（UTC）。说明若设置了查询开始时间（即 `StartTime`），该参数必填。查询结束时间需晚于开始时间。若该参数留空，表示不使用时间范围筛选。
BackupStrategyList	String[]	否	[ "AutomatedBackup", "ManualBackup" ]	备份方式列表。取值范围如下： `ManualBackup`：手动备份。 `AutomatedBackup`：自动备份。说明支持同时传入多个备份方式，多个备份方式间用英文逗号（,）分隔。若该参数留空，表示不使用备份方式筛选。
BackupPointName	String	否	testbackup	备份名称，支持模糊查询。说明当备份查询范围为单个实例（即 `Scope` 取值为 `OneInstance`）时，该参数不生效。若该参数留空，表示不使用备份名称筛选。
ProjectName	String	否	default	备份所属的项目。说明仅当查询范围为当前账号（即 `Scope` 取值为 `AccountInstances`）时，该参数生效。若该参数留空，表示不使用项目名称筛选。
PageSize	Integer	否	10	每页记录数。取值为 1~100 间的整数。说明若设置了页码（即 `PageNumber`），该参数必填。若该参数留空，表示不使用每页记录数筛选。
PageNumber	Integer	否	1	备份集信息列表的页码，取值为不超过 Integer 数据类型的最大值，起始值为 1。说明若设置了该参数，每页记录数（即 `PageSize`）也必填。若该参数留空，表示不使用页码范围筛选。
BackupPointId	String	否	b-cn02xmmrp751i9cdzcphjmk4****	备份文件的备份 ID。支持模糊查询。说明仅当查询范围为当前账号（即 `Scope` 取值为 `AccountInstances`）时，该参数生效。若该参数留空，表示不使用备份 ID 筛选。

返回参数

参数	类型	示例值	描述
Total	Integer	1	符合查询条件的备份文件总数。
Backups	Object[]		备份文件信息详情。

示例

请求示例

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"
    ]
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "f3ffd83e-bef7-43b9-a803-e75b4f49****",
        "Action": "DescribeBackups",
        "Version": "2020-12-07",
        "Service": "Redis",
        "Region": "cn-beijing"
    },
    "Result": {
        "Backups": [
            {
                "BackupPointId": "b-cn02xmmrp751i9cdzcphjmk4****",
                "BackupPointName": "testbackup",
                "BackupStrategy": "ManualBackup",
                "BackupType": "Full",
                "EndTime": "2024-08-22T07:51:12Z",
                "InstanceId": "redis-cn0212gzmh2xs****",
                "InstanceInfo": {
                    "AccountId": 210000****,
                    "ArchType": "Cluster",
                    "ChargeType": "PostPaid",
                    "DeletionProtection": "disabled",
                    "EngineVersion": "7.4",
                    "ExpiredTime": "",
                    "InstanceId": "redis-cn0212gzmh2xs****",
                    "InstanceName": "test",
                    "MaintenanceTime": "02:00-02:59",
                    "NetworkType": "VPC",
                    "RegionId": "cn-beijing",
                    "Replicas": 2,
                    "ShardCapacity": 1024,
                    "ShardNumber": 2,
                    "TotalCapacity": 2048,
                    "VpcId": "3tf2ofnsmi3vj0wt****",
                    "ZoneIds": [
                        "cn-beijing-a"
                    ]
                },
                "ProjectName": "default",
                "Size": 486040,
                "StartTime": "2024-08-22T07:51:09Z",
                "Status": "Available",
                "TTL": 7
            }
        ],
        "Total": 1
    }
}

错误码

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