DescribeDBBackups

Last updated: 2025-12-03 10:42:15

DescribeDBBackups

Last updated: 2025-12-03 10:42:15

1. API Description

Domain name for API request: mongodb.intl.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 150 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	Yes	String	Common Params. For more information, please see the list of regions supported by the product.
InstanceId	Yes	String	Instance ID. Log in to the TencentDB for MongoDB console, and copy the instance ID from the instance list.
BackupMethod	No	Integer	Backup method. - 0: logical backup. - 1: physical backup. - 3: snapshot backup. Note: 1. The General Edition instance supports logical and physical backup. The Cloud Disk Edition instance supports physical and snapshot backup, but does not support logical backup currently. 2. Physical backup is not supported when storage encryption is enabled for the instance.
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	Number of backups.
RequestId	String	The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.

4. Example

Example1 Querying the Backup File Information on a TencentDB for MongoDB Instance

Input Example

POST / HTTP/1.1
Host: mongodb.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeDBBackups
<Common request parameters>

{
    "InstanceId": "cmgo-fdzf****",
    "BackupMethod": 0
}

Output Example

{
    "Response": {
        "BackupList": [
            {
                "BackId": 10657020,
                "BackupDesc": "Set daily scheduled automatic backup in the system background.",
                "BackupMethod": 0,
                "BackupName": "cmgo-fdzf****_2025-09-17 22:01",
                "BackupRegion": "",
                "BackupSize": 5747379,
                "BackupType": 0,
                "DeleteTime": "2025-09-24 22:01:58",
                "EndTime": "2025-09-17 22:01:58",
                "InstanceId": "cmgo-fdzf****",
                "RestoreTime": "",
                "StartTime": "2025-09-17 22:01:52",
                "Status": 2
            },
            {
                "BackId": 10688339,
                "BackupDesc": "Set daily scheduled automatic backup in the system background.",
                "BackupMethod": 0,
                "BackupName": "cmgo-fdzf****_2025-09-18 22:03",
                "BackupRegion": "ap-shanghai",
                "BackupSize": 5747378,
                "BackupType": 0,
                "DeleteTime": "2025-09-20 22:03:37",
                "EndTime": "2025-09-18 22:03:44",
                "InstanceId": "cmgo-fdzf****",
                "RestoreTime": "",
                "StartTime": "2025-09-18 22:03:42",
                "Status": 2
            }
        ],
        "RequestId": "0e2eb0e1-f775-4ba8-af9f-e5650a55dce1",
        "TotalCount": 2
    }
}

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

Tencent Cloud CLI 3.0

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 sub-account 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

Feedback

tencent cloud