DescribeBackupSets - 查询备份集信息 - 云原生数据库 PolarDB

调用DescribeBackupSets接口查询备份集信息。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作	访问级别	资源类型	条件关键字	关联操作
drds:DescribeBackupSets	get	instance `acs:drds:{#regionId}:{#accountId}:instance/{#instanceId}/db/`	无	无

请求参数

名称	类型	必填	描述	示例值
DrdsInstanceId	string	是	DRDS 实例 ID。	drds***********
StartTime	string	是	查询开始时间，格式为时间戳（单位为毫秒）。	1591327800000
EndTime	string	是	查询结束时间，格式为时间戳（单位为毫秒）。说明查询结束时间需晚于查询开始时间	1591326000000

返回参数

名称	类型	描述	示例值
	object
Success	boolean	请求结果。	true
RequestId	string	请求 ID。	7103AEE3-9025-442F-B82B-BABD0A******
BackupSets	array<object>	备份集列表。
backupSet	object
EnableRecovery	boolean	该备份集是否可恢复。	false
Status	long	备份状态，取值范围如下： -1：失败 0：未开始 1：运行中 2：成功	2
BackupConsitentTime	string	备份恢复持续时间。	2020-06-05 11:31:38
BackupType	string	备份类型，取值范围如下： manual：手动备份 auto：自动备份	manual
BackupStartTime	long	备份开始时间，格式为时间戳（单位为毫秒）。	1591327754000
BackupLevel	string	备份级别，取值范围如下： db：数据库级别 instance：实例级别	instance
BackupMode	string	备份方式，取值范围如下： logic：逻辑备份 phy：快速备份	logic
BackupEndTime	long	备份结束时间，格式为时间戳（单位为毫秒）。说明 0 表示未结束。	1591327899000
Id	string	备份集 ID。	ba30d5c4-a6dc-11ea-bd40-************
BackupTotalSize	string	备份集大小，单位为 M。	93.24
BackupDbs	array
backupDb	string	备份的数据库列表。	["dts********"]

示例

正常返回示例

JSON格式

{
  "Success": true,
  "RequestId": "7103AEE3-9025-442F-B82B-BABD0A******",
  "BackupSets": {
    "backupSet": [
      {
        "EnableRecovery": false,
        "Status": 2,
        "BackupConsitentTime": "2020-06-05 11:31:38",
        "BackupType": "manual",
        "BackupStartTime": 1591327754000,
        "BackupLevel": "instance",
        "BackupMode": "logic",
        "BackupEndTime": 1591327899000,
        "Id": "ba30d5c4-a6dc-11ea-bd40-************",
        "BackupTotalSize": 93.24,
        "BackupDbs": {
          "backupDb": [
            [
              "dts********"
            ]
          ]
        }
      }
    ]
  }
}

错误码

HTTP status code	错误码	错误信息	描述
500	InternalError	The request processing has failed due to some unknown error.	请求失败，内部错误

访问错误中心查看更多错误码。

变更历史

变更时间	变更内容概要	操作

暂无变更历史