DescribeBackupSetList - PolarDB - Alibaba Cloud Documentation Center

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter	Type	Required	Example	Description
Action	String	Yes	DescribeBackupSetList	The operation that you want to perform. Set the value to DescribeBackupSetList.
RegionId	String	Yes	cn-hangzhou	The region ID of the instance.
DBInstanceName	String	Yes	pxc-xxxxxx	The instance name.
StartTime	Long	No	1635707845000	The beginning of the time range to query. Unit: milliseconds.
EndTime	Long	No	1635707845000	The end of the time range to query. Unit: milliseconds.
PageSize	Integer	No	30	The number of entries per page.
PageNumber	Integer	No	1	The page number. Pages start from page 1.
DestCrossRegion	String	No	cn-hangzhou	The region ID of the backup sets. To return the backup sets from a specific region, specify this parameter. You can specify only one region at a time.

Response parameters

Parameter	Type	Example	Description
Message	String	success	The returned message. If the request was successful, a success message is returned. If the request failed, an error message is returned.
RequestId	String	1A6D328C-84B8-40DC-BF49-6C73984D7494	The request ID.
Success	Boolean	true	Indicates whether the request was successful.
Data	Array of BackupSet		The data structure.
EndTime	Long	1635706960956	The end time of the backup.
Status	Integer	1	The status of the backup set. Valid values: 0: The backup is in progress. 1: The backup succeeded. 2: The backup failed.
BackupSetSize	Long	88803195	The size of the backup set. Unit: bytes.
BackupSetId	Long	111	The backup set ID.
BackupType	Integer	1	The backup type. Valid values: 0: fast backup 1: consistent backup
BeginTime	Long	1635706960956	The start time of the backup.
BackupModel	Integer	0	The backup method. Valid values: 0: automatic backup 1: manual backup

Examples

Sample requests

http(s)://[Endpoint]/?Action=DescribeBackupSetList
&RegionId=cn-hangzhou
&DBInstanceName=pxc-xxxxxx
&StartTime=1635707845000
&EndTime=1635707845000
&PageSize=30
&PageNumber=1
&DestCrossRegion=cn-hangzhou
&<Common request parameters>

Sample success responses

XML format

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 format

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

Error codes

For a list of error codes, see Service error codes.