Product Overview
Benefits
Use Cases
Architecture
Regions
Domain name for API request: tcaplusdb.intl.tencentcloudapi.com.
This API is used to query backup records.
When querying the cluster level, set TableGroupId to -1 and TableName to -1.
When querying the cluster and table group levels, set TableName to -1.
When querying the cluster, table group, and table levels, both TableGroupId and TableName cannot be set to -1.
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: DescribeBackupRecords. |
| Version | Yes | String | Common Params. The value used for this API: 2019-08-23. |
| Region | Yes | String | Common Params. For more information, please see the list of regions supported by the product. |
| ClusterId | No | String | Cluster ID, which is used to query a specified cluster |
| Limit | No | Integer | Number of results per page |
| Offset | No | Integer | Page offset |
| TableGroupId | No | String | Table group ID used as a filter condition |
| TableName | No | String | Table name used as a filter condition |
| Parameter Name | Type | Description |
|---|---|---|
| BackupRecords | Array of BackupRecords | Backup record details |
| TotalCount | Integer | Number of returned entries |
| 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: tcaplusdb.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeBackupRecords
<Common request parameters>
{
"Limit": 1,
"ClusterId": "xx",
"TableGroupId": "xx",
"TableName": "xx",
"Offset": 1
}{
"Response": {
"TotalCount": 92,
"BackupRecords": [
{
"BackupBatchTime": "xx",
"AppId": 1,
"TableName": "xx",
"ZoneId": 1,
"BackupType": "xx",
"FileTag": "xx",
"ShardCount": 1,
"BackupExpireTime": "xx",
"BackupSuccRate": "xx",
"BackupFileSize": 1
}
],
"RequestId": "xx"
}
}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 |
|---|---|
| AuthFailure.UnauthorizedOperation | API operation authentication error. |
| FailedOperation.RegionMismatch | The requested region does not match. |
| InternalError | Internal error. |
| InvalidParameter | Invalid parameter. |
| InvalidParameterValue | Incorrect parameter value. |
| ResourceNotFound | The resource does not exist. |
피드백