查询数据迁移任务列表

最近更新时间：2024-03-12 01:28:11

我的收藏

本页目录：

1. 接口描述

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

查询数据迁移任务列表

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

推荐使用 API Explorer

点击调试

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

2. 输入参数

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

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：DescribeMigrationJobs。
Version	是	String	公共参数，本接口取值：2021-12-06。
Region	是	String	公共参数，详见产品支持的地域列表。
JobId	否	String	数据迁移任务ID，如：dts-amm1jw5q 示例值：dts-amm1jw5q
JobName	否	String	数据迁移任务名称示例值：dts-amm1jw5q
Status.N	否	Array of String	数据迁移任务状态，可取值包括：created(创建完成)、checking(校验中)、checkPass(校验通过)、checkNotPass(校验不通过)、readyRun(准备运行)、running(任务运行中)、readyComplete(准备完成)、success(任务成功)、failed(任务失败)、stopping(中止中)、completing(完成中) 示例值：["running"]
SrcInstanceId	否	String	源实例ID，格式如：cdb-c1nl9rpv 示例值：cdb-c1nl9rpv
SrcRegion	否	String	源实例地域，如：ap-guangzhou 示例值：ap-guangzhou
SrcDatabaseType.N	否	Array of String	源实例数据库类型，如：sqlserver,mysql,mongodb,redis,tendis,keewidb,clickhouse,cynosdbmysql,percona,tdsqlpercona,mariadb,tdsqlmysql,postgresql 示例值：["mysql"]
SrcAccessType.N	否	Array of String	源实例接入类型，值包括：extranet(外网)、vpncloud(云vpn接入的实例)、dcg(专线接入的实例)、ccn(云联网接入的实例)、cdb(云上cdb实例)、cvm(cvm自建实例) 示例值：["cdb"]
DstInstanceId	否	String	目标实例ID，格式如：cdb-c1nl9rpv 示例值：cdb-c1nl9rpv
DstRegion	否	String	目标实例地域，如：ap-guangzhou 示例值：ap-guangzhou
DstDatabaseType.N	否	Array of String	目标源实例数据库类型，如：sqlserver,mysql,mongodb,redis,tendis,keewidb,clickhouse,cynosdbmysql,percona,tdsqlpercona,mariadb,tdsqlmysql,postgresql 示例值：["mysql"]
DstAccessType.N	否	Array of String	目标实例接入类型，值包括：extranet(外网)、vpncloud(云vpn接入的实例)、dcg(专线接入的实例)、ccn(云联网接入的实例)、cdb(云上cdb实例)、cvm(cvm自建实例) 示例值：["cdb"]
RunMode	否	String	任务运行模式，值包括：immediate(立即运行)，timed(定时运行) 示例值：immediate
OrderSeq	否	String	排序方式，可能取值为asc、desc，默认按照创建时间倒序示例值：desc
Limit	否	Integer	返回实例数量，默认20，有效区间[1,100] 示例值：20
Offset	否	Integer	偏移量，默认为0 示例值：0
TagFilters.N	否	Array of TagFilter	标签过滤

3. 输出参数

参数名称	类型	描述
TotalCount	Integer	迁移任务数量注意：此字段可能返回 null，表示取不到有效值。示例值：1
JobList	Array of JobItem	迁移任务列表注意：此字段可能返回 null，表示取不到有效值。
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查询数据迁移任务列表

输入示例

POST / HTTP/1.1
Host: dts.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeMigrationJobs
<公共请求参数>

{
    "JobId": "dts-amm1jw5q"
}

输出示例

{
    "Response": {
        "JobList": [
            {
                "Action": {
                    "AllAction": [
                        "view",
                        "modify",
                        "check",
                        "start",
                        "configure",
                        "stop",
                        "complete",
                        "resume",
                        "createCmpTask",
                        "isolate",
                        "offline",
                        "resize",
                        "recover"
                    ],
                    "AllowedAction": [
                        "view",
                        "stop",
                        "complete",
                        "createCmpTask",
                        "view",
                        "isolate",
                        "resize"
                    ]
                },
                "CompareTask": {
                    "CompareTaskId": "dts-amm1jw5q-cmp-bmuum7jk",
                    "Status": "consistent"
                },
                "CreateTime": "2022-07-11 16:20:49",
                "DstInfo": {
                    "AccessType": "cdb",
                    "DatabaseType": "mysql",
                    "ExtraAttr": [],
                    "Info": [
                        {
                            "Account": "",
                            "AccountMode": "",
                            "AccountRole": "",
                            "CcnGwId": "",
                            "CvmInstanceId": "",
                            "DbKernel": "",
                            "EngineVersion": "",
                            "Host": "",
                            "InstanceId": "cdb-o7uph0cj",
                            "Password": "Rogerp@ssw0rd",
                            "Port": 0,
                            "Role": "",
                            "SubnetId": "",
                            "TmpSecretId": "",
                            "TmpSecretKey": "",
                            "TmpToken": "",
                            "UniqDcgId": "",
                            "UniqVpnGwId": "",
                            "User": "root",
                            "VpcId": ""
                        }
                    ],
                    "NodeType": "simple",
                    "Region": "ap-guangzhou",
                    "Supplier": ""
                },
                "EndTime": "0000-00-00 00:00:00",
                "ExpectRunTime": "",
                "JobId": "dts-amm1jw5q",
                "JobName": "test_config_api",
                "RunMode": "immediate",
                "SrcInfo": {
                    "AccessType": "intranet",
                    "DatabaseType": "mysql",
                    "ExtraAttr": [],
                    "Info": [
                        {
                            "Account": "",
                            "AccountMode": "",
                            "AccountRole": "",
                            "CcnGwId": "",
                            "CvmInstanceId": "",
                            "DbKernel": "",
                            "EngineVersion": "5.7",
                            "Host": "9.123.210.37",
                            "InstanceId": "",
                            "Password": "Rogerp@ssw0rd",
                            "Port": 31035,
                            "Role": "",
                            "SubnetId": "",
                            "TmpSecretId": "",
                            "TmpSecretKey": "",
                            "TmpToken": "",
                            "UniqDcgId": "",
                            "UniqVpnGwId": "",
                            "User": "root",
                            "VpcId": ""
                        }
                    ],
                    "NodeType": "simple",
                    "Region": "ap-guangzhou",
                    "Supplier": ""
                },
                "StartTime": "2022-07-11 17:20:56",
                "Status": "readyComplete",
                "Tags": [],
                "TradeInfo": {
                    "BillingType": "billing",
                    "DealName": "20220711715001047929481",
                    "ExpireTime": "0000-00-00 00:00:00",
                    "InstanceClass": "xlarge",
                    "IsolateReason": "",
                    "LastDealName": "",
                    "OfflineReason": "",
                    "PayType": "postpay",
                    "TradeStatus": "normal"
                },
                "UpdateTime": "2022-07-11 17:26:40"
            }
        ],
        "RequestId": "asdfadfasdfasdf",
        "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

命令行工具

Tencent Cloud CLI 3.0

6. 错误码

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

错误码	描述
AuthFailure.AuthFailureError	认证失败。
DryRunOperation.DryRunOperationError	DryRun 操作，代表请求将会是成功的，只是多传了 DryRun 参数。
FailedOperation.FailedOperationError	操作失败。
InternalError.InternalErrorError	内部错误。
InvalidParameter.ControllerNotFoundError	异常错误导致当前接口未注册。
InvalidParameter.InvalidParameterError	参数无效。
InvalidParameterValue.InvalidParameterValueError	非法参数。
LimitExceeded.LimitExceededError	数量超出限制。
MissingParameter.MissingParameterError	参数丢失。
RequestLimitExceeded.RequestLimitExceededError	请求次数超限。
ResourceInUse.ResourceInUseError	资源在使用中。
ResourceInsufficient.ResourceInsufficientError	资源短缺。
ResourceNotFound.BizResourceNotFoundError	未找到资源。
ResourceNotFound.ResourceNotFoundError	资源未找到。
ResourceUnavailable.ResourceUnavailableError	资源不可用。
ResourcesSoldOut.ResourcesSoldOutError	资源售罄。
UnauthorizedOperation.UnauthorizedOperationError	未授权的操作。
UnknownParameter.UnknownParameterError	未知参数。
UnsupportedOperation	操作不支持。
UnsupportedOperation.UnsupportedOperationError	不支持的操作。