tencent cloud

PrevNext

文档反馈

请输入关键字

Recent Pages

文档
文档

DescribeMigrationJobs

最后更新时间：2024-07-24 10:31:28

    1. API Description

    Domain name for API request: dts.tencentcloudapi.com.

    This API is used to query the list of data migration tasks.

    A maximum of 20 requests can be initiated per second for this API.

    We recommend you to use API Explorer
    Try it
    API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

    2. Input Parameters

    The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.

    Parameter Name Required Type Description
    Action Yes String Common Params. The value used for this API: DescribeMigrationJobs.
    Version Yes String Common Params. The value used for this API: 2021-12-06.
    Region No String Common Params. This parameter is not required for this API.
    JobId No String Data migration task ID such as dts-amm1jw5q
    JobName No String Data migration task name
    Status.N No Array of String Data migration task status. Valid values: created, checking, checkPass, checkNotPass, readyRun, running, readyComplete, success, failed, stopping, completing.
    SrcInstanceId No String Source instance ID in the format of cdb-c1nl9rpv
    SrcRegion No String Source instance region, such as ap-guangzhou.
    SrcDatabaseType.N No Array of String Source database type, such as sqlserver, mysql, mongodb, redis, tendis, keewidb, clickhouse, cynosdbmysql, percona, tdsqlpercona, mariadb, tdsqlmysql, `postgresql.
    SrcAccessType.N No Array of String Source instance access type. Valid values: extranet (public network); vpncloud (VPN access); dcg (Direct Connect); ccn (CCN); cdb (Database); cvm (self-build on CVM).
    DstInstanceId No String Target instance ID in the format of cdb-c1nl9rpv
    DstRegion No String Target instance region, such as ap-guangzhou.
    DstDatabaseType.N No Array of String Target database type, such as sqlserver, mysql, mongodb, redis, tendis, keewidb, clickhouse, cynosdbmysql, percona, tdsqlpercona, mariadb, tdsqlmysql, `postgresql.
    DstAccessType.N No Array of String Target instance access type. Valid values: extranet (public network); vpncloud (VPN access); dcg (Direct Connect); ccn (CCN); cdb (Database); cvm (self-build on CVM).
    RunMode No String Task running mode. Valid values: immediate, timed.
    OrderSeq No String Sorting order. Valid values: asc, desc. Default value: desc by creation time.
    Limit No Integer Number of instances to be returned. Value range: [1,100]. Default value: 20.
    Offset No Integer Offset. Default value: 0.
    TagFilters.N No Array of TagFilter Tag filter

    3. Output Parameters

    Parameter Name Type Description
    TotalCount Integer Number of migration tasks
    Note: This field may return null, indicating that no valid values can be obtained.
    JobList Array of JobItem Migration task list
    Note: This field may return null, indicating that no valid values can be obtained.
    RequestId String The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.

    4. Example

    Example1 Querying the list of data migration tasks

    Input Example

    POST / HTTP/1.1
Host: dts.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeMigrationJobs
<Common request parameters>

{
    "JobId": "dts-amm1jw5q"
}

    Output Example

    {
    "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. Developer Resources

    SDK

    TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

    Command Line Interface

    6. Error Code

    The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.

    Error Code Description
    AuthFailure.AuthFailureError Authentication failed.
    DryRunOperation.DryRunOperationError DryRun operation, which means an unnecessary DryRun parameter is passed in yet the request will still be successful.
    FailedOperation.FailedOperationError The operation failed.
    InternalError.InternalErrorError An internal error occurred.
    InvalidParameter.ControllerNotFoundError The current API is not registered due to an exception.
    InvalidParameter.InvalidParameterError The parameter is invalid.
    InvalidParameterValue.InvalidParameterValueError The parameter is invalid.
    LimitExceeded.LimitExceededError The quantity exceeds the limit.
    MissingParameter.MissingParameterError The parameter is lost.
    RequestLimitExceeded.RequestLimitExceededError The number of requests exceeds the limit.
    ResourceInUse.ResourceInUseError The resource is being used.
    ResourceInsufficient.ResourceInsufficientError The resources are insufficient.
    ResourceNotFound.BizResourceNotFoundError The resource was not found.
    ResourceNotFound.ResourceNotFoundError The resource was not found.
    ResourceUnavailable.ResourceUnavailableError The resource is unavailable.
    ResourcesSoldOut.ResourcesSoldOutError The resources have been sold out.
    UnauthorizedOperation.UnauthorizedOperationError The operation is unauthorized.
    UnknownParameter.UnknownParameterError The parameter is unknown.
    UnsupportedOperation The operation is not supported.
    UnsupportedOperation.UnsupportedOperationError The operation is not supported.
    Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
    隐私条款服务条款缓存条款