DescribeBackupConfig

Last updated: 2025-11-13 20:51:48

DescribeBackupConfig

Last updated: 2025-11-13 20:51:48

1. API Description

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.

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

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. an array with a length of 7, indicating the backup methods corresponding to monday to sunday respectively. full represents full backup, and increment represents incremental backup.
BackupType	String	Backup method. specifies the method of backup. valid values: logic (indicates logical backup), snapshot (indicates snapshot backup).
LogicCrossRegionsConfigUpdateTime	String	Cross-Regional logical backup configuration modification time.
LogicBackupConfig	LogicBackupConfigInfo	Automatic logical 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.

4. Example

Example1

Describe Backup Config

Input Example

POST / HTTP/1.1
Host: cynosdb.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeBackupConfig
<common request parameters>

{
    "ClusterId": "cynosdbmysql-aws1kpv6"
}

Output Example

{
    "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
    }
}

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.

Was this page helpful?

You can also Contact Sales or Submit a Ticket for help.

Yes

Feedback

tencent cloud