1. 接口描述
接口请求域名： sqlserver.tencentcloudapi.com 。
本接口（DescribeBackupCommand）用于查询以规范的格式创建备份的命令。
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：DescribeBackupCommand。 |
| Version | 是 | String | 公共参数，本接口取值：2018-03-28。 |
| Region | 是 | String | 公共参数，详见产品支持的 地域列表。 |
| BackupFileType | 是 | String | 备份文件类型，FULL-全量备份，FULL_LOG-全量备份需要日志增量，FULL_DIFF-全量备份需要差异增量，LOG-日志备份，DIFF-差异备份 示例值：FULL |
| DataBaseName | 是 | String | 数据库名称 示例值：db1 |
| IsRecovery | 是 | String | 是否需要恢复，NO-不需要，YES-需要 示例值：YES |
| LocalPath | 否 | String | 备份文件保存的路径；如果不填则默认在D:\ 示例值：E:/ |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| Command | String | 创建备份命令 示例值：BACKUP DATABASE db1 TO DISK='E:/db1.bak' WITH INIT |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 查询创建全量备份的命令
输入示例
https://sqlserver.tencentcloudapi.com/?Action=DescribeBackupCommand
&BackupFileType=FULL
&DataBaseName=db1
&IsRecovery=YES
&LocalPath=E:/
&<公共请求参数>输出示例
{
"Response": {
"Command": "BACKUP DATABASE db1 TO DISK='E:/db1.bak' WITH INIT",
"RequestId": "1de3aea3-5fef-4891-b8b0-faeb4e3b5543"
}
}示例2 查询创建日志增量的命令
在需要事务日志做增量导入时使用，此时获取的是恢复的事务日志增量备份。
命令中\\n为换行符。
输入示例
https://sqlserver.tencentcloudapi.com/?Action=DescribeBackupCommand
&BackupFileType=LOG
&DataBaseName=db1
&IsRecovery=YES
&LocalPath=E:/
&<公共请求参数>输出示例
{
"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"
}
}示例3 查询创建全量备份+日志增量的命令
在需要事务日志做增量导入时使用，此时获取的是不恢复的全量备份。
命令中\\n为换行符。
输入示例
https://sqlserver.tencentcloudapi.com/?Action=DescribeBackupCommand
&BackupFileType=FULL_LOG
&DataBaseName=db1
&IsRecovery=NO
&LocalPath=E:/
&<公共请求参数>输出示例
{
"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"
}
}5. 开发者资源
腾讯云 API 平台
腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台，方便您从同一入口查询及使用腾讯云提供的所有 API 服务。
API Inspector
用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况，并自动生成各语言版本的 API 代码，也可前往 API Explorer 进行在线调试。
SDK
云 API 3.0 提供了配套的开发工具集（SDK），支持多种编程语言，能更方便的调用 API。
- Tencent Cloud SDK 3.0 for Python: GitHub Gitee
- Tencent Cloud SDK 3.0 for Java: GitHub Gitee
- Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
- Tencent Cloud SDK 3.0 for Go: GitHub Gitee
- Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
- Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
- Tencent Cloud SDK 3.0 for C++: GitHub Gitee
- Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| InvalidParameter.InputIllegal | 输入错误。 |
| InvalidParameter.ParamsAssertFailed | 参数断言转换错误。 |
| UnauthorizedOperation.PermissionDenied | cam鉴权错误。 |
