You can call this operation to query the backup information of a specified ApsaraDB for PolarDB cluster.

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
DBClusterId String Yes pc-bpxxxxxxx

The ID of the ApsaraDB for PolarDB cluster.

EndTime String Yes 2019-07-27T15:00Z

The end of the time range where the backup data is queried. The end time must be later than the start time. Specify the time in the YYYY-MM-DDThh:mmZ format. The time must be in UTC.

StartTime String Yes 2019-07-26T15:00Z

The beginning of the time range where the backup data is queried. Specify the time in the YYYY-MM-DDThh:mmZ format. The time must be in UTC.

AccessKeyId String No key-test

The AccessKey ID provided to you by Alibaba Cloud.

Action String No DescribeBackups

The operation that you want to perform. Set the value to DescribeBackups.

BackupId String No 42395xxxx

The ID of the backup set.

BackupMode String No Manual

The type of the backup. Valid values:

  • Automated: automatic backup
  • Manual: manual backup
BackupStatus String No Success

The status of the backup task. Valid values:

  • Success: The backup task is completed.
  • Failed: The backup task failed.
PageNumber Integer No 1

The number of the page to return. Valid values: any non-zero positive integer.

Default value: 1

PageSize Integer No 30

The number of entries to return on each page. Valid values:

  • 30
  • 50
  • 100

Default value: 30

Response parameters

Parameter Type Example Description
Items

The list of backups.

Backup

The details of a backup.

BackupEndTime String 2019-07-27T07:31:23Z

The time when this backup task ended. The time is displayed in UTC.

BackupId String 42395xxxx

The ID of the backup set.

BackupMethod String Snapshot

The method of the backup. Only snapshot backup is supported. The value is Snapshot.

BackupMode String Manual

The type of the backup. Valid values:

Automated: automatic backup

Manual: manual backup

BackupSetSize String 3572498432

The size of the backup file. Unit: bytes.

Note The space released after the snapshot file is deleted is much smaller than the size of this file due to the blocks shared between snapshots.
BackupStartTime String 2019-07-27T07:31:13Z

The time when this backup task started. The time is displayed in UTC.

BackupStatus String Success

The status of the backup task. Valid values:

  • Success: The backup task is completed.
  • Failed: The backup task failed.
BackupType String FullBackup

The type of the backup. Only full backup is supported. The value is FullBackup.

DBClusterId String pc-bpxxxxxxx

The ID of the ApsaraDB for PolarDB cluster.

PageNumber String 1

The page number of the returned page.

PageRecordCount String 2

The number of entries returned per page.

RequestId String E22FB172-F0AB-42FF-A6D0-115065D64971

The ID of the request.

TotalRecordCount String 2

The total number of entries returned.

Examples

Sample requests


http(s)://[Endpoint]/? Action=DescribeBackups
&DBClusterId=pc-bpxxxxxxx
&EndTime=2019-07-27T15:00Z
&StartTime=2019-07-26T15:00Z
&<Common request parameters>

Sample success responses

XML format

<DescribeBackupsResponse>
  <Items>
        <Backup>
              <StoreStatus>Enabled</StoreStatus>
              <BackupType>FullBackup</BackupType>
              <BackupSetSize>3572498432</BackupSetSize>
              <BackupEndTime>2019-07-27T07:31:23Z</BackupEndTime>
              <BackupMethod>Snapshot</BackupMethod>
              <BackupMode>Manual</BackupMode>
              <BackupStatus>Success</BackupStatus>
              <DBClusterId>pc-bpxxxxxxx</DBClusterId>
              <BackupStartTime>2019-07-27T07:31:13Z</BackupStartTime>
              <BackupId>423957113</BackupId>
        </Backup>
        <Backup>
              <StoreStatus>Enabled</StoreStatus>
              <BackupType>FullBackup</BackupType>
              <BackupSetSize>3572498432</BackupSetSize>
              <BackupEndTime>2019-07-27T07:27:18Z</BackupEndTime>
              <BackupMethod>Snapshot</BackupMethod>
              <BackupMode>Manual</BackupMode>
              <BackupStatus>Success</BackupStatus>
              <DBClusterId>pc-bpxxxxxxx</DBClusterId>
              <BackupStartTime>2019-07-27T07:27:08Z</BackupStartTime>
              <BackupId>423955591</BackupId>
        </Backup>
  </Items>
  <PageNumber>1</PageNumber>
  <TotalRecordCount>2</TotalRecordCount>
  <RequestId>E22FB172-F0AB-42FF-A6D0-115065D64971</RequestId>
  <PageRecordCount>2</PageRecordCount>
</DescribeBackupsResponse>

JSON format

{
	"Items":{
		"Backup":[
			{
				"StoreStatus":"Enabled",
				"BackupType":"FullBackup",
				"BackupEndTime":"2019-07-27T07:31:23Z",
				"BackupSetSize":3572498432,
				"BackupMode":"Manual",
				"BackupMethod":"Snapshot",
				"DBClusterId":"pc-bpxxxxxxx",
				"BackupStatus":"Success",
				"BackupId":423957113,
				"BackupStartTime":"2019-07-27T07:31:13Z"
			},
			{
				"StoreStatus":"Enabled",
				"BackupType":"FullBackup",
				"BackupEndTime":"2019-07-27T07:27:18Z",
				"BackupSetSize":3572498432,
				"BackupMode":"Manual",
				"BackupMethod":"Snapshot",
				"DBClusterId":"pc-bpxxxxxxx",
				"BackupStatus":"Success",
				"BackupId":423955591,
				"BackupStartTime":"2019-07-27T07:27:08Z"
			}
		]
	},
	"TotalRecordCount":2,
	"PageNumber":1,
	"RequestId":"E22FB172-F0AB-42FF-A6D0-115065D64971",
	"PageRecordCount":2
}

Error codes

For a list of error codes, visit the API Error Center.