Queries backup sets of a PolarDB-X instance.
Debugging
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 ID of the region where the PolarDB-X instance is deployed. |
DBInstanceName | String | Yes | pxc-xxxxxx |
The name of the PolarDB-X instance. |
StartTime | Long | No | 1635707845000 |
The start time of the backup. Unit: millisecond. |
EndTime | Long | No | 1635707845000 |
The end time of the backup. Unit: millisecond. |
PageSize | Integer | No | 30 |
The number of entries to return on each page. |
PageNumber | Integer | No | 1 |
The number of the page to return. Pages start from page 1. |
Response parameters
Parameter | Type | Example | Description |
---|---|---|---|
Message | String | success |
The message that is returned. If the request is successful, "success" is returned. If the request fails, an error code is returned. |
RequestId | String | 1A6D328C-84B8-40DC-BF49-6C73984D7494 |
The ID of the request. |
Success | Boolean | true |
Indicates whether the request is successful. |
Data | Array of BackupSet |
The data that is returned. |
|
EndTime | Long | 1635706960956 |
The end time of the backup. |
Status | Integer | 1 |
The status of the backup set.
|
BackupSetSize | Long | 88803195 |
The size of the backup set. Unit: byte. |
BackupSetId | Long | 111 |
The ID of the backup set. |
BackupType | Integer | 1 |
The type of the backup.
|
BeginTime | Long | 1635706960956 |
The start time of the backup. |
BackupModel | Integer | 0 |
The backup method.
|
Examples
Sample requests
http(s)://[Endpoint]/?Action=DescribeBackupSetList
&RegionId=cn-hangzhou
&DBInstanceName=pxc-xxxxxx
&StartTime=1635707845000
&EndTime=1635707845000
&PageSize=30
&PageNumber=1
&<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, visit the API Error Center.