DescribeBackups - ApsaraDB for MongoDB - Alibaba Cloud Documentation Center

Queries the backup sets of an ApsaraDB for MongoDB instance.

debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

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:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level, All Resources is 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	READ	dbinstance acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}	none	none

Request parameters

Parameter	Type	Required	Description	Example
DBInstanceId	string	Yes	The ID of the instance. 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 is valid only when DBInstanceId is set 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 obtain the value of this parameter. 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 shards. Multiple , with commas (,) in the middle.	2072**,2072,2072**
PageNumber	integer	No	The number of the page to return. The value must be an integer that is greater than 0. Default value: 1.	1
PageSize	integer	No	The number of entries to return on each page. Valid values: 30, 50, and 100. Default value: 30.	30
StartTime	string	No	The beginning of the time range to query. Specify the time 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 yyyy-MM-ddTHH:mmZ format. The time must be in UTC.	2022-01-14T13:00Z

Response parameters

Parameter	Type	Description	Example
	object
TotalCount	integer	The total number of backup sets that were returned.	1
RequestId	string	The ID of the request.	275D43C3-F12F-5224-B375-0C6BF453BD56
PageSize	integer	The number of entries to return on each page.	30
PageNumber	integer	The number of the page to return.	1
Backups	object []	Details about backup sets.
BackupStatus	string	The status of the backup. Valid values: Success: The backup task is successful. Failed: The backup task failed.	Success
BackupType	string	The backup method. FullBackup: a full backup IncrementalBackup: an incremental backup	FullBackup
BackupStartTime	string	The beginning of the backup time range. The time is in the yyyy-MM-ddTHH:mm:ssZ format and displayed in UTC.	2022-01-14T03:56:17Z
BackupIntranetDownloadURL	string	The internal download URL of the backup set. Note You can use this URL to download the backup set from on the ECS instance which is on the same network as the ApsaraDB for MongoDB instance.	http://rdsbak-hz-v3.oss-cn-hangzhou-internal.aliyuncs.com/custins5559***/hins1936_data_2022052504_qp.xb?Expires=165361&OSSAccessKeyId=LTAI4G2wxd32KLGARfi&Signature=lkFPjOY%2F8adB18vnOCbtmT7ii**&Region=cn-hangzhou
BackupSize	long	The size of the backup set. Unit: bytes.	6168576
BackupDownloadURL	string	The Internet download URL of the backup set. If the download URL is unavailable, this parameter is an empty string.	http://rdsbak-hz-v3.oss-cn-hangzhou.aliyuncs.com/custins5559**/hins1936_data_2022052504_qp.xb?Expires=165361&OSSAccessKeyId=LTAI4G2wxd32KLGARf&Signature=lkFPjOY%2F8adB18vnOCbtmT7**&Region=cn-hangzhou
BackupMode	string	The backup mode. Automated: automatic backup Manual: manual backup	Automated
BackupEndTime	string	The end of the backup time range. The time is in the yyyy-MM-ddTHH:mm:ssZ format and displayed in UTC.	2022-01-14T03:57:34Z
BackupId	integer	The ID of the backup set.	32102****
BackupDBNames	string	The name of the database that has been backed up.	database
BackupMethod	string	The backup method. Valid values: Snapshot Physical Logical	Physical

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=LTAI4G2wxd32KLGARfi****&Signature=lkFPjOY%2F8adB18vnOCbtmT7ii****&Region=cn-hangzhou",
        "BackupSize": 6168576,
        "BackupDownloadURL": "http://rdsbak-hz-v3.oss-cn-hangzhou.aliyuncs.com/custins5559****/hins1936****_data_2022052504****_qp.xb?Expires=165361****&OSSAccessKeyId=LTAI4G2wxd32KLGARf****&Signature=lkFPjOY%2F8adB18vnOCbtmT7****&Region=cn-hangzhou",
        "BackupMode": "Automated",
        "BackupEndTime": "2022-01-14T03:57:34Z",
        "BackupId": 0,
        "BackupDBNames": "database",
        "BackupMethod": "Physical"
      }
    ]
  }
}

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.