Domain name for API request: cdb.tencentcloudapi.com.
This API (DescribeBackupConfig) is used to query the configuration information of a TencentDB instance backup.
A maximum of 100 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: 2017-03-20. |
Region | No | String | Common Params. This parameter is not required for this API. |
InstanceId | Yes | String | Instance ID in the format of cdb-c1nl9rpv. It is the same as the instance ID displayed on the TencentDB Console page. |
Parameter Name | Type | Description |
---|---|---|
StartTimeMin | Integer | Earliest start time point of automatic backup, such as 2 (for 2:00 AM). (This field has been disused. You are recommended to use the BackupTimeWindow field) |
StartTimeMax | Integer | Latest start time point of automatic backup, such as 6 (for 6:00 AM). (This field has been disused. You are recommended to use the BackupTimeWindow field) |
BackupExpireDays | Integer | Backup file retention period in days. |
BackupMethod | String | Backup mode. Value range: physical, logical |
BinlogExpireDays | Integer | Binlog file retention period in days. |
BackupTimeWindow | CommonTimeWindow | Time window for automatic instance backup. |
EnableBackupPeriodSave | String | Switch for archive backup retention. Valid values: off (disable), on (enable). Default value:off . |
BackupPeriodSaveDays | Integer | Maximum days of archive backup retention. Valid range: 90-3650. Default value: 1080. |
BackupPeriodSaveInterval | String | Archive backup retention period. Valid values: weekly (a week), monthly (a month), quarterly (a quarter), yearly (a year). Default value: monthly . |
BackupPeriodSaveCount | Integer | Number of archive backups. Minimum value: 1 , Maximum value: Number of non-archive backups in archive backup retention period. Default value: 1 . |
StartBackupPeriodSaveDate | String | The start time in the format: yyyy-mm-dd HH:MM:SS, which is used to enable archive backup retention policy. |
EnableBackupArchive | String | Whether to enable the archive backup. Valid values: off (disable), on (enable). Default value: off . |
BackupArchiveDays | Integer | The period (in days) of how long a data backup is retained before being archived, which falls between 180 days and the number of days from the time it is created until it expires. |
EnableBinlogArchive | String | Whether to enable the archive backup of logs. Valid values: off (disable), on (enable). Default value: off . |
BinlogArchiveDays | Integer | The period (in days) of how long a log backup is retained before being archived, which falls between 180 days and the number of days from the time it is created until it expires. |
EnableBackupStandby | String | Whether to enable the standard storage policy for data backup. Valid values: off (disable), on (enable). Default value: off . |
BackupStandbyDays | Integer | The period (in days) of how long a data backup is retained before switching to standard storage, which falls between 30 days and the number of days from the time it is created until it expires. If the archive backup is enabled, this period cannot be greater than archive backup period. |
EnableBinlogStandby | String | Whether to enable the standard storage policy for log backup. Valid values: off (disable), on (enable). Default value: off . |
BinlogStandbyDays | Integer | The period (in days) of how long a log backup is retained before switching to standard storage, which falls between 30 days and the number of days from the time it is created until it expires. If the archive backup is enabled, this period cannot be greater than archive backup period. |
RequestId | String | The unique request ID, which is returned for each request. RequestId is required for locating a problem. |
This API shows you how to query the configuration information of a TencentDB instance backup.
POST / HTTP/1.1
Host: cdb.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeBackupConfig
<Common request parameters>
{
"InstanceId": "cdb-c1nl9rpv"
}
{
"Response": {
"BackupMethod": "physical",
"BinlogExpireDays": 7,
"BackupExpireDays": 7,
"StartTimeMin": 10,
"StartTimeMax": 14,
"BackupTimeWindow": {
"BackupPeriodStrategy": "weekly",
"BackupPeriodTime": "00:00-12:00",
"Days": [],
"Friday": "10:00-14:00",
"Monday": "10:00-14:00",
"Saturday": "10:00-14:00",
"Sunday": "10:00-14:00",
"Thursday": "10:00-14:00",
"Tuesday": "10:00-14:00",
"Wednesday": "10:00-14:00"
},
"EnableBackupPeriodSave": "off",
"BackupPeriodSaveDays": 1080,
"BackupPeriodSaveInterval": "monthly",
"BackupPeriodSaveCount": 1,
"StartBackupPeriodSaveDate": "2021-12-12 00:00:00",
"EnableBackupArchive": "on",
"BackupArchiveDays": 180,
"EnableBinlogArchive": "on",
"BinlogArchiveDays": 180,
"EnableBackupStandby": "on",
"BackupStandbyDays": 30,
"EnableBinlogStandby": "on",
"BinlogStandbyDays": 30,
"RequestId": "9d73ec37-89b8-4d36-9f40-123123123"
}
}
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 |
---|---|
InternalError.CdbCgwError | Internal system error. |
InternalError.DatabaseAccessError | Internal database error. |
InternalError.FtpError | File transfer exception |
InternalError.UndefinedError | Unknown error |
InvalidParameter | Parameter error. |
InvalidParameter.ControllerNotFoundError | This API was not found. |
InvalidParameter.InstanceNotFound | The instance does not exist. |
OperationDenied.ActionNotSupport | Unsupported operation. |
OperationDenied.UserHasNoStrategy | This account is not authorized to access the requested resource. |
本页内容是否解决了您的问题?