tencent cloud

1. API Description

Domain name for API request: sqlserver.tencentcloudapi.com.

This API is used to query the commands of creating backups canonically.

A maximum of 20 requests can be initiated per second for this API.

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.
This document describes the parameters for Signature V1. It's recommended to use the V3 signature, which provides higher security. Note that for Signature V3, the common parameters need to be placed in the HTTP Header. See details.

3. Output Parameters

4. Example

Example1 Querying the command of creating a full backup

Used when transaction logs need an incremental import. What is acquired is a full backup that is not restored.
\\\\n in the command means a line feed.

Input Example

https://sqlserver.tencentcloudapi.com/?Action=DescribeBackupCommand
&BackupFileType=FULL
&DataBaseName=db1
&IsRecovery=YES
&LocalPath=E:/
&<Common request parameters>

Output Example

{
  "Response": {
    "Command": "BACKUP DATABASE db1 TO DISK='E:/db1.bak' WITH INIT",
    "RequestId": "1de3aea3-5fef-4891-b8b0-faeb4e3b5543"
  }
}

Example2 Querying the command of creating a full backup and an incremental transaction log backup

This example shows you how to query the command to create a full backup and an incremental transaction log backup when you need to import the incremental transaction log backup. The full backup created does not need to be restored.
\\n in the command means a line feed.

Input Example

https://sqlserver.tencentcloudapi.com/?Action=DescribeBackupCommand
&BackupFileType=FULL_LOG
&DataBaseName=db1
&IsRecovery=NO
&LocalPath=E:/
&<Common request parameters>

Output Example

{
  "Response": {
    "Command": "declare @dbname varchar(100)\\\\ndeclare @localtime varchar(20)\\\\ndeclare @str varchar(8000)\\\\nset @dbname='db1'\\\\nset @localtime =replace(replace(replace(CONVERT(varchar, getdate(), 120 ),'-',''),' ',''),':','')\\\\nset @str='BACKUP DATABASE [' + @dbname + '] TO  DISK = N''E:/' + @dbname + '_' + @localtime + '_2full2_2noreconvery2.bak'' WITH INIT'\\\\nexec(@str)\\\\ngo",
    "RequestId": "03199d88-9dda-49eb-a045-7c69eb4d3591"
  }
}

Example3 Querying the command of creating an incremental transaction log backup

This example shows you how to query the command to create an incremental transaction log backup when you need to import it. The incremental transaction log backup created needs to be restored.
\\n in the command means a line feed.

Input Example

https://sqlserver.tencentcloudapi.com/?Action=DescribeBackupCommand
&BackupFileType=LOG
&DataBaseName=db1
&IsRecovery=YES
&LocalPath=E:/
&<Common request parameters>

Output Example

{
  "Response": {
    "Command": "declare @dbname varchar(100)\\\\ndeclare @localtime varchar(20)\\\\ndeclare @str varchar(8000)\\\\nset @dbname='db1'\\\\nset @localtime =replace(replace(replace(CONVERT(varchar, getdate(), 120 ),'-',''),' ',''),':','')\\\\nset @str='BACKUP LOG [' + @dbname + '] TO  DISK = N''E:/' + @dbname + '_' + @localtime + '_2log2_2reconvery2.bak'' WITH FORMAT, INIT'\\\\nexec(@str)\\\\ngo",
    "RequestId": "8d53700f-b80b-415a-8738-0c340eff2057"
  }
}

5. Developer Resources

SDK

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

• Tencent Cloud SDK 3.0 for Python
• Tencent Cloud SDK 3.0 for Java
• Tencent Cloud SDK 3.0 for PHP
• Tencent Cloud SDK 3.0 for Go
• Tencent Cloud SDK 3.0 for NodeJS
• Tencent Cloud SDK 3.0 for .NET
• Tencent Cloud SDK 3.0 for C++

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.