DescribeMigrations

Last updated: 2020-03-16 11:21:23

    1. API Description

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

    This API is used to query the list of eligible migration tasks based on the entered criteria.

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

    Note: This API supports Finance regions. If the common parameter Region is a Finance region, a domain name with the Finance region needs to be specified, for example: sqlserver.ap-shanghai-fsi.tencentcloudapi.com

    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 parameter. The value used for this API: DescribeMigrations.
    Version Yes String Common parameter. The value used for this API: 2018-03-28.
    Region Yes String Common parameter. For more information, please see the list of regions supported by the product.
    StatusSet.N No Array of Integer Status set. As long as a migration task is in a status therein, it will be listed
    MigrateName No String Migration task name (fuzzy match)
    Limit No Integer Number of results per page. Value range: 1–100. Default value: 100
    Offset No Integer Page number. Default value: 0
    OrderBy No String The query results are sorted by keyword. Valid values: name, createTime, startTime, endTime, status
    OrderByType No String Sorting order. Valid values: desc, asc

    3. Output Parameters

    Parameter Name Type Description
    TotalCount Integer Total number of query results
    MigrateTaskSet Array of MigrateTask List of query results
    RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

    4. Example

    Example1 Query the list of migration tasks

    Input Example

    https://sqlserver.tencentcloudapi.com/?Action=DescribeMigrations
    &MigrateName=test
    &Limit=10
    &Offset=0
    &OrderBy=name
    &OrderByType=desc
    &StatusSet.0=1
    &StatusSet.1=4
    &<common request parameters>

    Output Example

    {
      "Response": {
        "RequestId": "728ba95f-0443-41ec-82c9-44bc8bfc0802",
        "TotalCount": 2,
        "MigrateTaskSet": [
          {
            "MigrateId": 2734,
            "MigrateName": "testing migration",
            "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": "testing interface",
            "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. Developer Resources

    API Explorer

    This tool allows online call, signature authentication, SDK code generation and quick search of APIs to greatly improve the efficiency of using TencentCloud APIs.

    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
    InternalError Internal error.
    InternalError.DBError Database error
    InternalError.SystemError System error.
    InternalError.UnknownError Unknown error.
    InvalidParameter Invalid parameter.
    InvalidParameter.InputIllegal Input error.
    InvalidParameter.ParamsAssertFailed An error occurred while converting parameter assertion.

    Was this page helpful?

    Was this page helpful?

    • Not at all
    • Not very helpful
    • Somewhat helpful
    • Very helpful
    • Extremely helpful
    Send Feedback
    Help