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.
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 . |
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. |
https://mongodb.tencentcloudapi.com/?Action=DescribeDBBackups
&InstanceId=cmgo-f555zzzz
&BackupMethod=1
&<Common request parameters>
{
"Response": {
"RequestId": "6EF60BEC-0242-43AF-BB20-270359FB54A7",
"BackupList": [],
"TotalCount": 0
}
}
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 |
---|---|
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?