DescribeBackups - - 阿里雲

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.
RegionId	String	No	cn-hangzhou	The region ID of the instance. You can call the DescribeRegions operation to query the most recent region list.
DBInstanceId	String	Yes	dds-bp1a7009eb24****	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.
NodeId	String	No	d-bp128a003436****	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.
BackupId	String	No	2072**,2072,2072**	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.
PageNumber	Integer	No	1	The number of the page to return. The value must be an integer that is greater than 0. Default value: 1.
PageSize	Integer	No	30	The number of entries to return on each page. Valid values: 30, 50, and 100. Default value: 30.
StartTime	String	No	2022-01-13T13: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.
EndTime	String	No	2022-01-14T13:00Z	The end of the time range to query. Specify the time in the yyyy-MM-ddTHH:mmZ format. The time must be in UTC.

Response parameters


Parameter	Type	Example	Description
TotalCount	Integer	1	The total number of backup sets that were returned.
RequestId	String	275D43C3-F12F-5224-B375-0C6BF453BD56	The ID of the request.
PageSize	Integer	30	The number of entries to return on each page.
PageNumber	Integer	1	The number of the page to return.
Backups	Array of Backup		Details about backup sets.
Backup
BackupStatus	String	Success	The status of the backup. Valid values: Success: The backup task is successful. Failed: The backup task failed.
BackupType	String	FullBackup	The backup method. FullBackup: a full backup IncrementalBackup: an incremental backup
BackupStartTime	String	2022-01-14T03:56:17Z	The beginning of the backup time range. The time is in the yyyy-MM-ddTHH:mm:ssZ format and displayed in UTC.
BackupIntranetDownloadURL	String	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	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.
BackupSize	Long	6168576	The size of the backup set. Unit: bytes.
BackupDownloadURL	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	The Internet download URL of the backup set. If the download URL is unavailable, this parameter is an empty string.
BackupMode	String	Automated	The backup mode. Automated: automatic backup Manual: manual backup
BackupEndTime	String	2022-01-14T03:57:34Z	The end of the backup time range. The time is in the yyyy-MM-ddTHH:mm:ssZ format and displayed in UTC.
BackupId	Integer	32102****	The ID of the backup set.
BackupDBNames	String	config,myNewDB	The name of the database that has been backed up.
BackupMethod	String	Physical	The backup method. Valid values: Snapshot Physical Logical

Examples

Sample requests

http(s)://mongodb.aliyuncs.com/?Action=DescribeBackups
&DBInstanceId=dds-bp1a7009eb24****
&<Common request parameters>

Sample success responses

XML format

HTTP/1.1 200 OK
Content-Type:application/xml

<DescribeBackupsResponse>
    <TotalCount>1</TotalCount>
    <RequestId>275D43C3-F12F-5224-B375-0C6BF453BD56</RequestId>
    <PageSize>30</PageSize>
    <PageNumber>1</PageNumber>
    <Backups>
        <BackupStatus>Success</BackupStatus>
        <BackupType>FullBackup</BackupType>
        <BackupStartTime>2022-01-14T03:56:17Z</BackupStartTime>
        <BackupIntranetDownloadURL>http://rdsbak-hz-v3.oss-cn-hangzhou-internal.aliyuncs.com/custins5559*****/hins1936****_data_2022052504****_qp.xb?Expires=165361****&amp;OSSAccessKeyId=LTAI4G2wxd32KLGARfi****&amp;Signature=lkFPjOY%2F8adB18vnOCbtmT7ii****&amp;Region=cn-hangzhou</BackupIntranetDownloadURL>
        <BackupSize>6168576</BackupSize>
        <BackupDownloadURL>http://rdsbak-hz-v3.oss-cn-hangzhou.aliyuncs.com/custins5559****/hins1936****_data_2022052504****_qp.xb?Expires=165361****&amp;OSSAccessKeyId=LTAI4G2wxd32KLGARf****&amp;Signature=lkFPjOY%2F8adB18vnOCbtmT7****&amp;Region=cn-hangzhou</BackupDownloadURL>
        <BackupMode>Automated</BackupMode>
        <BackupEndTime>2022-01-14T03:57:34Z</BackupEndTime>
        <BackupDBNames>database</BackupDBNames>
        <BackupMethod>Physical</BackupMethod>
    </Backups>
</DescribeBackupsResponse>

JSON format

HTTP/1.1 200 OK
Content-Type:application/json

{
  "TotalCount" : 1,
  "RequestId" : "275D43C3-F12F-5224-B375-0C6BF453BD56",
  "PageSize" : 30,
  "PageNumber" : 1,
  "Backups" : {
    "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****&amp;OSSAccessKeyId=LTAI4G2wxd32KLGARfi****&amp;Signature=lkFPjOY%2F8adB18vnOCbtmT7ii****&amp;Region=cn-hangzhou",
    "BackupSize" : 6168576,
    "BackupDownloadURL" : "http://rdsbak-hz-v3.oss-cn-hangzhou.aliyuncs.com/custins5559****/hins1936****_data_2022052504****_qp.xb?Expires=165361****&amp;OSSAccessKeyId=LTAI4G2wxd32KLGARf****&amp;Signature=lkFPjOY%2F8adB18vnOCbtmT7****&amp;Region=cn-hangzhou",
    "BackupMode" : "Automated",
    "BackupEndTime" : "2022-01-14T03:57:34Z",
    "BackupDBNames" : "database",
    "BackupMethod" : "Physical"
  }
}

Error codes

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