DescribeBackupSetList - 查看备份集列表 - 云原生数据库 PolarDB

调用DescribeBackupSetList接口查看备份集列表。

调试

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

调试

授权信息

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

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

操作

访问级别

资源类型

条件关键字

关联操作

polardbx:DescribeBackupSetList

none

*全部资源

*

无

请求参数

名称	类型	必填	描述	示例值
RegionId	string	是	实例所属地域的 ID。	cn-hangzhou
DBInstanceName	string	是	实例名称。	pxc-xxxxxx
StartTime	integer	否	开始时间的时间戳，单位为毫秒。	1635707845000
EndTime	integer	否	结束时间的时间戳，单位为毫秒。	1635707845000
PageSize	integer	否	每页的数据大小。	30
PageNumber	integer	否	分页下标，从 1 开始。	1
DestCrossRegion	string	否	备份集所在的地域，指定后可返回某个具体地域的备份集，一次仅支持指定一个地域。	cn-hangzhou

返回参数

名称	类型	描述	示例值
	object
Message	string	返回信息，成功为 success，错误返回错误码。	success
RequestId	string	请求 ID。	1A6D328C-84B8-40DC-BF49-6C73984D7494
Success	boolean	请求是否成功。	true
Data	array<object>	数据结构体。
	object
EndTime	integer	备份结束时间。	1635706960956
Status	integer	备份集状态： 0：备份中； 1：备份成功； 2：备份失败。	1
BackupSetSize	integer	备份集大小，单位为 byte。	88803195
BackupSetId	string	备份集 ID。	111
BackupType	integer	备份类型： 0：快速备份； 1：一致性备份。	1
BeginTime	integer	备份开始时间。	1635706960956
BackupModel	integer	备份模式： 0：自动备份； 1：手动备份。	0

示例

正常返回示例

JSON格式

{
  "Message": "success",
  "RequestId": "1A6D328C-84B8-40DC-BF49-6C73984D7494",
  "Success": true,
  "Data": [
    {
      "EndTime": 1635706960956,
      "Status": 1,
      "BackupSetSize": 88803195,
      "BackupSetId": "111",
      "BackupType": 1,
      "BeginTime": 1635706960956,
      "BackupModel": 0
    }
  ]
}

错误码

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

变更历史

更多信息，参考变更详情。