CreateBackup

Last updated: 2019-09-09 14:59:29

1. API Description

API domain name: sqlserver.tencentcloudapi.com.

This API (CreateBackup) creates a backup.

API request rate limit: 20 requests/sec.

2. Input Parameters

The following parameters are required for requesting this API, including action-specific parameters and common parameters. For more information about common parameters for all requests, see Common Request Parameters.

Parameter name Required Type Description
Action Yes String Common parameter. The name of this API: CreateBackup
Version Yes String Common parameter. The version of this API: 2018-03-28
Region Yes String Common parameter. For more information, 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 the databases to be backed up (required only for multi-database backup)
InstanceId No String Instance ID in the format of mssql-i1z41iwd

3. Output Parameters

Parameter name Type Description
FlowId Integer Async task ID
RequestId String The ID of the request. Each request returns a unique ID. The RequestId is required to troubleshoot issues.

4. Samples

Sample 1. Creating a Backup

Input Sample Code

https://sqlserver.tencentcloudapi.com/?Action=CreateBackup
&InstanceId=mssql-njj2mtpl
&Strategy=1
&DBNames.0=db1
&DBNames.1=db2
&<Common request parameter>

Output Sample Code

{
  "Response": {
    "RequestId": "4be5990d-a4b5-49dc-b2b4-e713b6aa7ba3",
    "FlowId": 5293
  }
}

5. Developer Resources

API Explorer

This tool provides various capabilities such as online call, signature verification, SDK code generation, and quick API retrieval that significantly reduce the difficulty of using TencentCloud API.

SDK

TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call the APIs.

TCCLI

6. Error Codes

The following only lists the error codes related to this API. For other error codes, see Common Error Codes.

Error Code Description
InternalError Internal error.
InternalError.CreateFlowFailed Failed to create the flow.
InternalError.DBError Database error.
InternalError.SystemError System error.
InternalError.UnknownError Unknown error.
InvalidParameter Incorrect parameter.
InvalidParameter.InputIllegal Invalid input.
InvalidParameter.ParamsAssertFailed Parameter assertion conversion error.
ResourceNotFound.InstanceNotFound The instance does not exist.
ResourceUnavailable.InstanceStatusInvalid Invalid instance status.