查询迁移任务列表

最近更新时间:2018-11-15 19:05:42

1. 接口描述

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

本接口(DescribeMigrations)根据输入的限定条件,查询符合条件的迁移任务列表

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

注意:本接口支持金融区地域。由于金融区和非金融区是隔离不互通的,因此当公共参数 Region 为金融区地域(例如 ap-shanghai-fsi)时,需要同时指定带金融区地域的域名,最好和 Region 的地域保持一致,例如:sqlserver.ap-shanghai-fsi.tencentcloudapi.com 。

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeMigrations
Version String 公共参数,本接口取值:2018-03-28
Region String 公共参数,详见产品支持的地域列表
StatusSet.N Array of Integer 状态集合。只要符合集合中某一状态的迁移任务,就会查出来
MigrateName String 迁移任务的名称,模糊匹配
Limit Integer 每页的记录数
Offset Integer 查询第几页的记录
OrderBy String 查询结果按照关键字排序,可选值为name、createTime、startTime,endTime,status
OrderByType String 排序方式,可选值为desc、asc

3. 输出参数

参数名称 类型 描述
TotalCount Integer 查询结果的总数
MigrateTaskSet Array of MigrateTask 查询结果的列表
RequestId String 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 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": {
    "MigrateTaskSet": [
      {
        "AppId": 1251006373,
        "CheckFlag": 0,
        "CreateTime": "2018-08-09 11:46:15",
        "EndTime": "0000-00-00 00:00:00",
        "Message": "",
        "MigrateDetail": {
          "Progress": 0,
          "StepName": ""
        },
        "MigrateId": 2734,
        "MigrateName": "测试迁移",
        "Progress": 0,
        "Region": "ap-guangzhou",
        "SourceType": 5,
        "StartTime": "0000-00-00 00:00:00",
        "Status": 1
      },
      {
        "AppId": 1251006373,
        "CheckFlag": 0,
        "CreateTime": "2018-08-08 21:03:09",
        "EndTime": "0000-00-00 00:00:00",
        "Message": "",
        "MigrateDetail": {
          "Progress": 0,
          "StepName": ""
        },
        "MigrateId": 2732,
        "MigrateName": "测试接口",
        "Progress": 0,
        "Region": "ap-guangzhou",
        "SourceType": 5,
        "StartTime": "0000-00-00 00:00:00",
        "Status": 1
      }
    ],
    "RequestId": "728ba95f-0443-41ec-82c9-44bc8bfc0802",
    "TotalCount": 2
  }
}

5. 开发者资源

API Explorer

该工具提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力,能显著降低使用云 API 的难度,推荐使用。

SDK

云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

命令行工具

6. 错误码

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

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