云数据库 SQL Server 查询迁移任务列表-API 文档-文档中心-腾讯云

1. 接口描述

接口请求域名： sqlserver.tencentcloudapi.com 。

本接口（DescribeMigrations）根据输入的限定条件，查询符合条件的迁移任务列表

默认接口请求频率限制：20次/秒。

推荐使用 API Explorer

点击调试

API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见公共请求参数。

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：DescribeMigrations。
Version	是	String	公共参数，本接口取值：2018-03-28。
Region	是	String	公共参数，详见产品支持的地域列表。
StatusSet.N	否	Array of Integer	状态集合。只要符合集合中某一状态的迁移任务，就会查出来示例值：["1\r\n","4\r\n"]
MigrateName	否	String	迁移任务的名称，模糊匹配示例值：测试
Limit	否	Integer	分页返回，每页返回的数目，取值为1-100，默认值为100 示例值：10
Offset	否	Integer	分页返回，页编号，默认值为第0页示例值：0
OrderBy	否	String	查询结果按照关键字排序，可选值为name、createTime、startTime，endTime，status 示例值：name
OrderByType	否	String	排序方式，可选值为desc、asc 示例值：desc

3. 输出参数

参数名称	类型	描述
TotalCount	Integer	查询结果的总数示例值：2
MigrateTaskSet	Array of MigrateTask	查询结果的列表
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查询迁移任务列表

输入示例

https://sqlserver.tencentcloudapi.com/?Action=DescribeMigrations
&MigrateName=测试
&Limit=10
&Offset=0
&OrderBy=name
&OrderByType=desc
&StatusSet.0=1
&StatusSet.1=4
&<公共请求参数>

输出示例

{
    "Response": {
        "RequestId": "728ba95f-0443-41ec-82c9-44bc8bfc0802",
        "TotalCount": 2,
        "MigrateTaskSet": [
            {
                "MigrateId": 2734,
                "MigrateName": "测试迁移",
                "AppId": 1251006373,
                "Region": "ap-guangzhou",
                "SourceType": 5,
                "CreateTime": "2018-08-09 11:46:15",
                "StartTime": "0000-00-00 00:00:00",
                "EndTime": "0000-00-00 00:00:00",
                "Status": 1,
                "Message": "",
                "CheckFlag": 0,
                "Progress": 0,
                "MigrateDetail": {
                    "StepName": "",
                    "Progress": 0
                }
            },
            {
                "MigrateId": 2732,
                "MigrateName": "测试接口",
                "AppId": 1251006373,
                "Region": "ap-guangzhou",
                "SourceType": 5,
                "CreateTime": "2018-08-08 21:03:09",
                "StartTime": "0000-00-00 00:00:00",
                "EndTime": "0000-00-00 00:00:00",
                "Status": 1,
                "Message": "",
                "CheckFlag": 0,
                "Progress": 0,
                "MigrateDetail": {
                    "StepName": "",
                    "Progress": 0
                }
            }
        ]
    }
}

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

命令行工具

Tencent Cloud CLI 3.0

6. 错误码

以下仅列出了接口业务逻辑相关的错误码，其他错误码详见公共错误码。

错误码	描述
InternalError	内部错误。
InternalError.DBError	数据库错误。
InternalError.SystemError	系统错误。
InternalError.UnknownError	未知错误。
InvalidParameter	参数错误。
InvalidParameter.InputIllegal	输入错误。
InvalidParameter.ParamsAssertFailed	参数断言转换错误。
UnauthorizedOperation.PermissionDenied	cam鉴权错误。

查询迁移任务列表

本页目录：