DescribeBackupConfig

最后更新时间：2023-07-06 16:46:11

1. API Description

Domain name for API request: cynosdb.tencentcloudapi.com.

This API is used to get the backup configuration information of the specified cluster, including the full backup time range and backup file retention period.

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: 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.
ClusterId	Yes	String	Cluster ID

3. Output Parameters

Parameter Name	Type	Description
BackupTimeBeg	Integer	Full backup start time. Value range: [0-24*3600]. For example, 0:00 AM, 1:00 AM, and 2:00 AM are represented by 0, 3600, and 7200, respectively
BackupTimeEnd	Integer	Full backup end time. Value range: [0-24*3600]. For example, 0:00 AM, 1:00 AM, and 2:00 AM are represented by 0, 3600, and 7200, respectively
ReserveDuration	Integer	Backup retention period in seconds. Backups will be cleared after this period elapses. 7 days is represented by 3600247 = 604800
BackupFreq	Array of String	Backup frequency. It is an array of 7 elements corresponding to Monday through Sunday. full: full backup; increment: incremental backup Note: this field may return null, indicating that no valid values can be obtained.
BackupType	String	Backup mode. logic: logic backup; snapshot: snapshot backup Note: this field may return null, indicating that no valid values can be obtained.
RequestId	String	The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Querying the backup configuration information

Input Example

https://cynosdb.tencentcloudapi.com/?Action=DescribeBackupConfig
&ClusterId=cynosdbmysql-45knmnra
&<Common request parameters>

Output Example

{
    "Response": {
        "BackupFreq": [
            "full",
            "increment",
            "increment",
            "increment",
            "increment",
            "increment",
            "increment"
        ],
        "BackupType": "",
        "BackupTimeEnd": 21600,
        "BackupTimeBeg": 7200,
        "RequestId": "180877",
        "ReserveDuration": 604800
    }
}

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
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.

tencent cloud

Recent Pages