Domain name for API request: sqlserver.tencentcloudapi.com.
This API is used to create a backup.
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: CreateBackup. |
Version | Yes | String | Common Params. The value used for this API: 2018-03-28. |
Region | Yes | String | Common Params. For more information, please see the list of regions supported by the product. |
Strategy | No | Integer | Backup policy (0: instance backup, 1: multi-database backup) |
DBNames.N | No | Array of String | List of names of databases to be backed up (required only for multi-database backup) |
InstanceId | No | String | (Required) Instance ID in the format of mssql-i1z41iwd |
BackupName | No | String | Backup name. If this parameter is left empty, a backup name in the format of "[Instance ID]_[Backup start timestamp]" will be automatically generated. |
StorageStrategy | No | Integer |
Parameter Name | Type | Description |
---|---|---|
FlowId | Integer | The async job ID |
RequestId | String | The unique request ID, which is returned for each request. RequestId is required for locating a problem. |
This example shows you how to create a backup.
https://sqlserver.tencentcloudapi.com/?Action=CreateBackup
&InstanceId=mssql-njj2mtpl
&Strategy=1
&DBNames.0=db1
&DBNames.1=db2
&<Common request parameters>
{
"Response": {
"RequestId": "4be5990d-a4b5-49dc-b2b4-e713b6aa7ba3",
"FlowId": 5293
}
}
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.DBError | Database error. |
InternalError | Internal error. |
InternalError.DBError | Database error |
InternalError.GcsError | GCS API error. |
InternalError.SystemError | System error. |
InternalError.UnknownError | Unknown error. |
InvalidParameter | Invalid parameter. |
InvalidParameter.InputIllegal | Input error. |
InvalidParameter.ParamsAssertFailed | An error occurred while converting parameter assertion. |
InvalidParameterValue.BackupNameIsIllegal | The backup name contains invalid characters. |
LimitExceeded.TooManyDB | The database limit is exceeded. |
ResourceNotFound.DBNotFound | The database does not exist. |
ResourceNotFound.InstanceNotFound | The instance does not exist. |
ResourceUnavailable.DBInvalidStatus | Invalid database status. |
ResourceUnavailable.InstanceStatusInvalid | Invalid instance status. |
UnauthorizedOperation.PermissionDenied | CAM authentication error. |
Was this page helpful?