1. 接口描述
接口请求域名： sqlserver.tencentcloudapi.com 。
本接口（DescribeBackupMigration）用于创建增量备份导入任务。
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：DescribeBackupMigration。 |
| Version | 是 | String | 公共参数，本接口取值：2018-03-28。 |
| Region | 是 | String | 公共参数，详见产品支持的 地域列表。 |
| InstanceId | 是 | String | 导入目标实例ID 示例值：mssql-rdc0gajn |
| BackupMigrationId | 否 | String | 备份导入任务ID，由CreateBackupMigration接口返回 示例值：mssql-backup-migration-kpl74n9l |
| MigrationName | 否 | String | 导入任务名称 示例值：字符串 |
| BackupFileName | 否 | String | 备份文件名称 示例值：db1 |
| StatusSet.N | 否 | Array of Integer | 导入任务状态集合 示例值：["2\n"] |
| RecoveryType | 否 | String | 导入任务恢复类型，FULL,FULL_LOG,FULL_DIFF 示例值：FULL |
| UploadType | 否 | String | COS_URL-备份放在用户的对象存储上，提供URL。COS_UPLOAD-备份放在业务的对象存储上，用户上传 示例值：COS_UPLOAD |
| Limit | 否 | Integer | 分页，页大小，默认值：100 示例值：100 |
| Offset | 否 | Integer | 分页，页数，默认值：0 示例值：0 |
| OrderBy | 否 | String | 排序字段，name；createTime；startTime；endTime，默认按照createTime递增排序。 示例值：createTime |
| OrderByType | 否 | String | 排序方式，desc-递减排序，asc-递增排序。默认按照asc排序，且在OrderBy为有效值时，本参数有效 示例值：desc |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| TotalCount | Integer | 迁移任务总数 示例值：1 |
| BackupMigrationSet | Array of Migration | 迁移任务集合 |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 查询全量备份导入任务
输入示例
POST / HTTP/1.1
Host: sqlserver.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeBackupMigration
<公共请求参数>
{
"BackupMigrationId": "mssql-backup-migration-kpl74n9l",
"OrderBy": "createTime",
"MigrationName": "字符串",
"UploadType": "COS_UPLOAD",
"Offset": "0",
"StatusSet": [
"2"
],
"InstanceId": "mssql-rdc0gajn",
"Limit": "100",
"OrderByType": "desc",
"BackupFileName": "db1",
"RecoveryType": "FULL"
}输出示例
{
"Response": {
"BackupMigrationSet": [
{
"Action": {
"AllAction": [
"start",
"delete",
"incremental",
"modify",
"view",
"upload"
],
"AllowedAction": [
"view",
"modify",
"delete",
"upload",
"start"
]
},
"AppId": 251006279,
"BackupFiles": [
"db1.bak"
],
"CreateTime": "2020-09-27 16:23:47",
"Detail": {
"Progress": 0,
"StepAll": 0,
"StepInfo": [],
"StepNow": 0
},
"EndTime": "0000-00-00 00:00:00",
"InstanceId": "mssql-rdc0gajn",
"IsRecovery": "",
"Message": "",
"MigrationId": "mssql-backup-migration-kpl74n9l",
"MigrationName": "字符串",
"RecoveryType": "FULL",
"Region": "ap-guangzhou",
"StartTime": "0000-00-00 00:00:00",
"Status": 2,
"DBRename": [
{
"NewName": "newdb",
"OldName": "olddb"
}
],
"UploadType": "COS_UPLOAD"
}
],
"RequestId": "cf4b1509-8029-4daf-b7b1-e504ff82cbba",
"TotalCount": 1
}
}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. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| InternalError.DBError | 数据库错误。 |
| InternalError.SystemError | 系统错误。 |
| InvalidParameter.ParamsAssertFailed | 参数断言转换错误。 |
| UnauthorizedOperation.PermissionDenied | cam鉴权错误。 |