Domain name for API request: cdb.intl.tencentcloudapi.com.
This API is used to create a database backup.
A maximum of 5 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: CreateBackup. |
| Version | Yes | String | Common Params. The value used for this API: 2017-03-20. |
| Region | Yes | String | Common Params. For more information, please see the list of regions supported by the product. |
| 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. |
| BackupMethod | Yes | String | Target backup method. Valid values: logical (logical cold backup), physical (physical cold backup), snapshot (snapshot backup). Basic Edition instances only support snapshot backups. |
| BackupDBTableList.N | No | Array of BackupItem | Database table information to be backed up. If this parameter is not set, the whole instance is backed up by default. This parameter can only be set when BackupMethod=logical. The specified database and tables must exist. Otherwise, backup may fail. If necessary to back up tables tb1 and tb2 in database db1 and database db2, configure the parameter as [{"Db": "db1", "Table": "tb1"}, {"Db": "db1", "Table": "tb2"}, {"Db": "db2"}]. |
| ManualBackupName | No | String | Manually back up the alias. Keep the input length within 60 characters. |
| EncryptionFlag | No | String | Whether the physical backup needs encryption, optional values: on - yes, off - no. This value is meaningful only when BackupMethod is physical. If not specified, use the default encryption policy of instance backup. Here, the default encryption policy refers to the current instance encryption policy queried via the api for the query DescribeBackupEncryptionStatus. |
| Parameter Name | Type | Description |
|---|---|---|
| BackupId | Integer | Backup task ID |
| 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: cdb.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateBackup
<Common request parameters>
{
"InstanceId": "cdb-c1nl9rpv",
"BackupDBTableList": [
{
"Table": "tb1",
"Db": "db1"
}
],
"BackupMethod": "logical"
}
{
"Response": {
"BackupId": 102996666,
"RequestId": "6EF60BEC-0242-43AF-BB20-270359FB54A7"
}
}
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 | CAM signature/authentication error. |
| CdbError | Backend or process error. |
| FailedOperation | Operation failed. |
| FailedOperation.StatusConflict | Task status conflict. |
| FailedOperation.TaskConflictError | A same task already exists |
| InternalError.CdbError | System error. |
| InternalError.DatabaseAccessError | Internal database error. |
| InternalError.DesError | Internal system error. |
| InternalError.HttpError | Exceptional HTTP request |
| InternalError.NetworkError | Network error |
| InternalError.OssError | An error occurred in TencentDB for MySQL High-Availability Edition database service. |
| InternalError.UndefinedError | Unknown error |
| InternalError.UnknownError | Unknown error |
| InvalidParameter | Parameter error. |
| InvalidParameter.InstanceNotFound | The instance does not exist. |
| InvalidParameterValue.DataConvertError | Data conversion failed. |
| OperationDenied.ActionInProcess | The instance is performing another task. |
| OperationDenied.ActionNotSupport | Unsupported operation. |
| OperationDenied.UserHasNoStrategy | This account is not authorized to access the requested resource. |
| OverQuota | Limit exceeded. |
Esta página foi útil?
Você também pode entrar em contato com a Equipe de vendas ou Enviar um tíquete em caso de ajuda.
comentários