Domain name for API request: cynosdb.intl.tencentcloudapi.com.
This API is used to obtain the backup configuration information of a specified cluster, including the full backup time period and the backup file retention time.
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: DescribeBackupConfig. |
| Version | Yes | String | Common Params. The value used for this API: 2019-01-07. |
| Region | Yes | String | Common Params. For more information, please see the list of regions supported by the product. This API only supports: ap-bangkok, ap-beijing, ap-chengdu, ap-chongqing, ap-guangzhou, ap-hongkong, ap-jakarta, ap-nanjing, ap-seoul, ap-shanghai, ap-shenzhen-fsi, ap-singapore, ap-tokyo, eu-frankfurt, na-ashburn, na-siliconvalley, sa-saopaulo. |
| ClusterId | Yes | String | Cluster ID. |
| Parameter Name | Type | Description |
|---|---|---|
| BackupTimeBeg | Integer | Indicates the full backup start time, [0-24*3600]. For example, 0:00, 1:00, and 2:00 are 0, 3600, and 7200 respectively. |
| BackupTimeEnd | Integer | Indicates the full backup start time, [0-24*3600]. For example, 0:00, 1:00, and 2:00 are 0, 3600, and 7200 respectively. |
| ReserveDuration | Integer | Indicates the backup retention period in seconds. Backups longer than this time will be cleaned up. 7 days is represented as 3600247=604800. |
| BackupFreq | Array of String | Backup frequency, an array of length 7, corresponding to Monday to Sunday backup method, full-full backup, increment-incremental backup |
| BackupType | String | Backup method, logic-logical backup, snapshot-snapshot backup |
| LogicCrossRegionsConfigUpdateTime | String | Cross-regional logical backup configuration modification time |
| LogicBackupConfig | LogicBackupConfigInfo | Automatic logical backup configuration |
| SnapshotSecondaryBackupConfig | BackupConfigInfo | Second-level snapshot backup configuration information Note: This field may return null, indicating that no valid values can be obtained. |
| SparseBackupConfig | SparseBackupConfigRsp | Sparse backup configuration |
| 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. |
Describe Backup Config
POST / HTTP/1.1
Host: cynosdb.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeBackupConfig
<Common request parameters>
{
"ClusterId": "cynosdbmysql-aws1kpv6"
}
{
"Response": {
"BackupFreq": [
"full",
"full",
"full",
"full",
"full",
"full",
"full"
],
"BackupTimeBeg": 7200,
"BackupTimeEnd": 21600,
"BackupType": "snapshot",
"LogicBackupConfig": {
"LogicBackupEnable": "OFF",
"LogicBackupTimeBeg": 0,
"LogicBackupTimeEnd": 0,
"LogicCrossRegions": null,
"LogicCrossRegionsEnable": "",
"LogicReserveDuration": 0
},
"LogicCrossRegionsConfigUpdateTime": "",
"RequestId": "e0127059-bb40-4308-a67d-c3bcddba372e",
"ReserveDuration": 604800,
"SnapshotSecondaryBackupConfig": {
"BackupCustomAutoTime": false,
"BackupIntervalTime": 0,
"BackupTimeBeg": 0,
"BackupTimeEnd": 0,
"BackupTriggerStrategy": "",
"BackupWeekDays": null,
"CrossRegions": null,
"CrossRegionsEnable": "",
"ReserveDuration": 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 |
|---|---|
| FailedOperation.DatabaseAccessError | Failed to access the database. Please try again later. If the problem persists, please contact customer service. |
| FailedOperation.GetBackupStrategyError | Failed to query the backup policy. Please try again later. If the problem persists, please contact customer service. |
| FailedOperation.OperationFailedError | Operation failed. Try again later. If the problem persists, contact customer service. |
| InternalError.SystemError | Internal system error. |
| InvalidParameterValue.ParamError | Incorrect parameter. |
| InvalidParameterValue.StoragePoolNotFound | No related storage pool found. |
| ResourceNotFound.ClusterNotFoundError | The cluster does not exist. |
| UnauthorizedOperation.PermissionDenied | CAM authentication failed. |
フィードバック