使用DescribeBackupSetList获取备份集列表-云原生数据库 PolarDB-阿里云

调试

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

请求参数

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

返回数据

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

示例

请求示例

http(s)://[Endpoint]/?Action=DescribeBackupSetList
&RegionId=cn-hangzhou
&DBInstanceName=pxc-xxxxxx
&StartTime=1635707845000
&EndTime=1635707845000
&PageSize=30
&PageNumber=1
&DestCrossRegion=cn-hangzhou
&公共请求参数

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<DescribeBackupSetListResponse>
    <Message>success</Message>
    <RequestId>1A6D328C-84B8-40DC-BF49-6C73984D7494</RequestId>
    <Success>true</Success>
    <Data>
        <EndTime>1635706960956</EndTime>
        <Status>1</Status>
        <BackupSetSize>88803195</BackupSetSize>
        <BackupSetId>111</BackupSetId>
        <BackupType>1</BackupType>
        <BeginTime>1635706960956</BeginTime>
        <BackupModel>0</BackupModel>
    </Data>
</DescribeBackupSetListResponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/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
  } ]
}

错误码

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