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.
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. |
| Parameter Name | Type | Description |
|---|---|---|
| BackupSaveTime | Integer | Retention period for backup data, in days. |
| BackupFrequency | Integer | Backup frequency. Backup interval in hours. Value: 12, 24. |
| BackupTime | Integer | Automatic backup start time. |
| BackupMethod | Integer | Backup mode. - 0: logical backup. - 1: physical backup. -3: Snapshot backup. Description: 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. |
| ActiveWeekdays | String | Day of week for backup, 0-6, separated by commas |
| LongTermInterval | String | Long-term backup period. weekly - by week, monthly - by month, empty means not enabled. |
| LongTermActiveDays | String | Date of long-term backup, week 0-6, month 1-31 |
| LongTermExpiredDays | Integer | Long-term backup retention period |
| OplogExpiredDays | Integer | Incremental backup retention period |
| BackupVersion | Integer | Backup version. 0 - Old backup method, 1 - Advanced backup. |
| BackupTotalSize | BackupTotalSize | Backup size |
| AlertThreshold | Integer | alarm limit |
| 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. |
POST / HTTP/1.1
Host: mongodb.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeBackupRules
<Common request parameters>
{
"InstanceId": "cmgo-xxxxx"
}
{
"Response": {
"ActiveWeekdays": "0,1,2,3,4,5,6",
"AlertThreshold": 0,
"BackupFrequency": 12,
"BackupMethod": 0,
"BackupSaveTime": 7,
"BackupTime": 0,
"BackupTotalSize": {
"FreeQuota": 10737418240,
"OplogSize": 602372,
"SnapshotSize": 28916
},
"BackupVersion": 1,
"LongTermActiveDays": "",
"LongTermExpiredDays": 0,
"LongTermInterval": "",
"OplogExpiredDays": 0,
"RequestId": "b544304c-e8eb-4819-8715-05a005c010ca"
}
}
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
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. |
文档反馈