Queries the backup sets of an ApsaraDB for MongoDB instance.
Debugging
Authorization information
The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:
- Operation: the value that you can use in the Action element to specify the operation on a resource.
- Access level: the access level of each operation. The levels are read, write, and list.
- Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- For mandatory resource types, indicate with a prefix of * .
- If the permissions cannot be granted at the resource level,
All Resourcesis used in the Resource type column of the operation.
- Condition Key: the condition key that is defined by the cloud service.
- Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
| Operation | Access level | Resource type | Condition key | Associated operation |
|---|---|---|---|---|
| dds:DescribeBackups | get | *Instance acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId} |
| none |
Request parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| DBInstanceId | string | Yes | The instance ID. Note
If you set this parameter to the ID of a sharded cluster instance, you must also specify the NodeId parameter.
| dds-bp1a7009eb24**** |
| NodeId | string | No | The ID of the shard node in the sharded cluster instance. Note
This parameter takes effect only when you set the DBInstanceId parameter to the ID of a sharded cluster instance.
| d-bp128a003436**** |
| BackupId | string | No | The ID of the backup set. You can call the CreateBackup operation to query the backup set ID. If you set the DBInstanceId parameter to the ID of a sharded cluster instance, the number of backup IDs is the same as the number of shard nodes. Multiple backup IDs are separated with commas (,). | 2072****,2072****,2072**** |
| PageNumber | integer | No | The page number. Pages start from page 1. Default value: 1. | 1 |
| PageSize | integer | No | The number of entries to return per page. Valid values:
| 30 |
| StartTime | string | No | The beginning of the time range to query. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mmZ format. The time must be in UTC. | 2022-01-13T13:00Z |
| EndTime | string | No | The end of the time range to query. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mmZ format. The time must be in UTC. The end time must be later than the start time. | 2022-01-14T13:00Z |
| SrcRegion | string | No | The region ID of the instance. Note
| cn-beijing |
| DestRegion | string | No | The region ID of the Cross-regional backup. Note
This parameter is required for the Cross-regional backup.
| cn-hangzhou |
Response parameters
Examples
Sample success responses
JSONformat
{
"TotalCount": 1,
"RequestId": "275D43C3-F12F-5224-B375-0C6BF453BD56",
"PageSize": 30,
"PageNumber": 1,
"Backups": {
"Backup": [
{
"BackupStatus": "Success",
"BackupType": "FullBackup",
"BackupStartTime": "2022-01-14T03:56:17Z",
"BackupIntranetDownloadURL": "http://rdsbak-hz-v3.oss-cn-hangzhou-internal.aliyuncs.com/custins5559*****/hins1936****_data_2022052504****_qp.xb?Expires=165361****&OSSAccessKeyId=***********************&Signature=****************************&Region=cn-hangzhou",
"BackupSize": 6168576,
"BackupDownloadURL": "http://rdsbak-hz-v3.oss-cn-hangzhou.aliyuncs.com/custins5559****/hins1936****_data_2022052504****_qp.xb?Expires=165361****&OSSAccessKeyId=***********************&Signature=****************************&Region=cn-hangzhou",
"BackupMode": "Automated",
"BackupEndTime": "2022-01-14T03:57:34Z",
"BackupId": 0,
"BackupDBNames": "database",
"BackupMethod": "Physical",
"BackupJobId": "1123xxxx",
"BackupName": "12345678.tar.gz",
"BackupScale": "DBInstance",
"IsAvail": true,
"EngineVersion": "4.2"
}
]
}
}Error codes
| HTTP status code | Error code | Error message |
|---|---|---|
| 400 | InvalidStartTime.Malformed | The Specified parameter StartTime is not valid. |
| 400 | InvalidEndTime.Malformed | The Specified parameter EndTime is not valid. |
| 400 | InvalidStartTimeAndEndTime.Malformed | The Specified parameter StartTime or EndTime is not valid. |
| 400 | InvalidPageSize.Malformed | The specified parameter PageSize is not valid. |
For a list of error codes, visit the Service error codes.
Change history
| Change time | Summary of changes | Operation |
|---|---|---|
| 2024-10-29 | The Error code has changed. The response structure of the API has changed | View Change Details |
| 2024-04-12 | The Error code has changed. The response structure of the API has changed | View Change Details |
| 2024-03-25 | The Error code has changed. The response structure of the API has changed | View Change Details |
| 2024-02-22 | The Error code has changed. The response structure of the API has changed | View Change Details |
| 2023-12-07 | The Error code has changed | View Change Details |