DescribeBackupRules

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

DescribeBackupRules

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

1. API Description

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

This API is used to obtain the automatic backup configuration information of an instance.

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: DescribeBackupRules.
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	Specifies the instance ID. For example, cmgo-p8vn****. Log in to the TencentDB for MongoDB console, and copy the instance ID from the instance list.

3. Output Parameters

Parameter Name	Type	Description
BackupSaveTime	Integer	Retention period for backup data, in days.
BackupTime	Integer	Automatic backup start time.
BackupMethod	Integer	Backup method. - 0: logical backup. - 1: physical backup.
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 Automatic Backup Rule Information of an Instance

This example shows you how to query the automatic backup rule information of an instance.

Input Example

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

{
    "InstanceId": "cmgo-9d0p****"
}

Output Example

{
    "Response": {
        "BackupMethod": 0,
        "BackupSaveTime": 7,
        "BackupTime": 1,
        "RequestId": "07ec4290-d682-11ed-aa06-f56fb86dae78"
    }
}

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
InternalError	Internal error
InternalError.CheckAppIdFailed	`appId` verification failed.

Was this page helpful?

You can also Contact Sales or Submit a Ticket for help.

Yes

Feedback

tencent cloud