tencent cloud

All product documents
APIs
DocumentationAPIsTencentDB for MongoDBBackup APIsDescribeDBBackups
DescribeDBBackups
Last updated: 2023-03-20 10:55:18
DescribeDBBackups
Last updated: 2023-03-20 10:55:18

1. API Description

Domain name for API request: mongodb.tencentcloudapi.com.

This API is used to query the list of instance backups. Currently, only backups created in the last seven days can be queried.

A maximum of 20 requests can be initiated per second for this API.

We recommend you to use API Explorer
Try it
API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters

The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.

Parameter Name Required Type Description
Action Yes String Common Params. The value used for this API: DescribeDBBackups.
Version Yes String Common Params. The value used for this API: 2019-07-25.
Region No String Common Params. This parameter is not required for this API.
InstanceId Yes String Instance ID in the format of cmgo-p8vnipr5. It is the same as the instance ID displayed on the TencentDB Console page
BackupMethod No Integer Backup mode. Valid values: 0 (logical backup), 1 (physical backup), 2 (both modes). Default value: 0.
Limit No Integer Number of entries per page. Maximum value: 100. If this parameter is left empty, all entries will be returned.
Offset No Integer Pagination offset, starting from 0. Default value: 0.

3. Output Parameters

Parameter Name Type Description
BackupList Array of BackupInfo Backup list
TotalCount Integer Total number of backups
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Querying the backup file information of a TencentDB instance

Input Example

https://mongodb.tencentcloudapi.com/?Action=DescribeDBBackups
&InstanceId=cmgo-f555zzzz
&BackupMethod=1
&<Common request parameters>

Output Example

{
    "Response": {
        "RequestId": "6EF60BEC-0242-43AF-BB20-270359FB54A7",
        "BackupList": [],
        "TotalCount": 0
    }
}

5. Developer Resources

SDK

TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

Command Line Interface

6. Error Code

The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.

Error Code Description
InvalidParameter Parameter error
InvalidParameter.PermissionDenied The current subaccount has no permission to perform this operation.
InvalidParameterValue.NotFoundInstance The instance was not found.
Was this page helpful?
You can also Contact Sales or Submit a Ticket for help.
Yes
No

Feedback

Contact Us

Contact our sales team or business advisors to help your business.

Contact Us
Technical Support

Open a ticket if you're looking for further assistance. Our Ticket is 7x24 avaliable.

Submit a Ticket
7x24 Phone Support
Hong Kong, China
+852 800 906 020 (Toll Free)
United States
+1 844 606 0804 (Toll Free)
United Kingdom
+44 808 196 4551 (Toll Free)
Canada
+1 888 605 7930 (Toll Free)
Australia
+61 1300 986 386 (Toll Free)
EdgeOne hotline
+852 300 80699
More local hotlines coming soon