You can call this operation to query the backup sets of an AnalyticDB for MySQL 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
Action String Yes DescribeBackups

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

DescribeBackups.

DBClusterId String Yes am-bp1xxxxxxxx47

The ID of the cluster.

EndTime String Yes 2011-06-15T16:00Z

The end of the time range to query. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mmZ format. The end time must be later than the start time. The time must be in UTC.

StartTime String Yes 2011-06-01T16:00Z

The beginning of the time range to query. Specify the time in the yyyy-MM-ddTHH:mmZ format. The time must be in UTC.

BackupId String No 327329803

The ID of the backup set.

PageSize Integer No 30

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

  • 30
  • 50
  • 100

Default value: 30.

PageNumber Integer No 1

The number of the page to return. Valid values: positive integers.

Default value: 1.

Response parameters

Parameter Type Example Description
Items Array of Backup

Details about the list of backup sets.

Backup
BackupEndTime String 2011-05-30T03:29:00Z

The time at which the backup ends. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.

BackupId String 327329803

The ID of the backup set.

BackupMethod String Snapshot

The backup method.

Snapshot: the snapshot backup method.

BackupSize Integer 2167808

The size of the backup file. Unit: bytes.

BackupStartTime String 2011-05-30T03:29:00Z

The time at which the backup starts. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.

BackupType String FullBackup

The backup type. Valid values:

  • FullBackup
  • IncrementalBackup
DBClusterId String am-bp1xxxxxxxx47

The ID of the cluster.

PageNumber String 10

The number of the page.

PageSize String 30

The number of backup sets on the page.

RequestId String 1AD222E9-E606-4A42-BF6D-8A4442913CEF

The ID of the request.

TotalCount String 300

The total number of entries returned.

Examples

Sample requests

http(s)://[Endpoint]/? Action=DescribeBackups
&DBClusterId=am-bp1xxxxxxxx47
&EndTime=2011-06-15T16:00Z
&StartTime=2011-06-01T16:00Z
&<Common request parameters>

Sample success responses

XML format

<TotalCount>300</TotalCount>
<RequestId>1AD222E9-E606-4A42-BF6D-8A4442913CEF</RequestId>
<PageSize>30</PageSize>
<PageNumber>10</PageNumber>
<Items>
    <Backup>
        <BackupMethod>Snapshot</BackupMethod>
        <BackupEndTime>2011-05-30T03:29:00Z</BackupEndTime>
        <BackupSize>2167808</BackupSize>
        <DBClusterId>am-bp1xxxxxxxx47    </DBClusterId>
        <BackupStartTime>2011-05-30T03:29:00Z</BackupStartTime>
        <BackupId>327329803</BackupId>
        <BackupType>FullBackup</BackupType>
    </Backup>
</Items>

JSON format

{
    "TotalCount": 300,
    "RequestId": "1AD222E9-E606-4A42-BF6D-8A4442913CEF",
    "PageSize": 30,
    "PageNumber": 10,
    "Items": {
        "Backup": {
            "BackupMethod": "Snapshot",
            "BackupEndTime": "2011-05-30T03:29:00Z",
            "BackupSize": 2167808,
            "DBClusterId": "am-bp1xxxxxxxx47",
            "BackupStartTime": "2011-05-30T03:29:00Z",
            "BackupId": 327329803,
            "BackupType": "FullBackup"
        }
    }
}

Error codes

HttpCode Error code Error message Description
404 InvalidDBCluster.NotFound The DBClusterId provided does not exist in our records. The error message returned because the specified cluster ID does not exist. Check whether you specify the cluster ID value correctly.

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