Queries the snapshots of an instance.
Operation description
Before you call this operation, you must enable the sandbox feature for the database instance. For more information, see Use the emergency recovery feature of an ApsaraDB RDS for MySQL instance or Create a sandbox instance for emergency disaster recovery of a self-managed MySQL database. This operation is available only for the Database Backup (DBS) API of the 2021-01-01 version.
Debugging
Authorization information
Request parameters
Parameter | Type | Required | Description | Example |
---|---|---|---|---|
BackupPlanId | string | Yes | The ID of the backup schedule. You can call the DescribeBackupPlanList operation to query the ID of the backup schedule. Note
If your instance is an ApsaraDB RDS for MySQL instance, you can configure automatic access to a data source to automatically add the instance to DBS and obtain the ID of the backup schedule.
| 1hxxxx8xxxxxa |
BackupSetId | string | No | The ID of the backup set. If this parameter is specified, only the snapshot of the specified backup set is returned. If this parameter is not specified, all the snapshots of the backup schedule are returned. | 1xxxx2xxxxx1e |
PageSize | string | No | The number of entries to return on each page. Valid values:
| 30 |
PageNumber | string | No | The number of the page to return. Pages start from page 1. Default value: 1. | 1 |
Response parameters
Examples
Sample success responses
JSON
format
{
"Data": " \"Data\": { \"number\": 2, \"size\": 2, \"content\": [ { \"backupSetTime\": \"2021-08-28T23:12:31Z\", \"backupSetId\": \"Inc_1hxxxx8xxxxxa_20210801064200_mysql-bin.000134\", \"backupSetType\": \"Inc\", \"backupPlanId\": \"1hxxxx8xxxxxa\" }, { \"backupSetTime\": \"2021-08-28T22:42:28Z\", \"backupSetId\": \"1hxxxx8xxxxxa_20210829064228\", \"backupSetType\": \"FULL\", \"backupPlanId\": \"1hxxxx8xxxxxa\" } ], \"totalElements\": 2 },",
"RequestId": "4F1888AC-1138-4995-B9FE-D2734F61C058",
"ErrCode": "Param.NotFound",
"Success": "true",
"ErrMessage": "The specified parameter %s value is not valid.",
"Code": "Param.NotFound",
"Message": "The specified parameter %s value is not valid."
}
Error codes
For a list of error codes, visit the Service error codes.
Change history
Change time | Summary of changes | Operation |
---|