RegisterMigrationTask

Last updated: 2020-11-16 10:03:24

    1. API Description

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

    This API is used to register a migration task.

    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 parameter. The value used for this API: RegisterMigrationTask.
    Version Yes String Common parameter. The value used for this API: 2018-03-19.
    Region No String Common parameter. This parameter is not required for this API.
    TaskType Yes String Task type, valid values include database (database migration), file (file migration) or host (host migration).
    TaskName Yes String Task name
    ServiceSupplier Yes String Service supplier name
    CreateTime Yes Timestamp Migration task creation time
    UpdateTime Yes Timestamp Migration task update time
    MigrateClass Yes String Migration type, for example mysql:mysql in database migration means migration from mysql to mysql and oss:cos in file migration means migration from Alibaba Cloud OSS to Tencent COS.
    SrcInfo No SrcInfo Migration task source information
    DstInfo No DstInfo Migration task destination information
    SrcAccessType No String Source instance access type. Valid values for database migration include extranet (public network), cvm (CVM-created instance), dcg (Direct Connect-enabled instance), vpncloud (Tencent Cloud VPN-enabled instance), vpnselfbuild (self-built VPN-enabled instance), cdb (TencentDB instance)
    SrcDatabaseType No String Database type of the source instance. Valid values for database migration: mysql, redis, percona, mongodb, postgresql, sqlserver, mariadb
    DstAccessType No String Target instance access type. Valid values for database migration include extranet (public network), cvm (CVM-created instance), dcg (Direct Connect-enabled instance), vpncloud (Tencent Cloud VPN-enabled instance), vpnselfbuild (self-built VPN-enabled instance), cdb (TencentDB instance)
    DstDatabaseType No String Database type of the target instance. Valid values for database migration: mysql, redis, percona, mongodb, postgresql, sqlserver, mariadb

    3. Output Parameters

    Parameter Name Type Description
    TaskId String Task ID
    RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

    4. Example

    Example1 Registering a migration task

    This example shows you how to register a migration task.

    Input Example

    https://msp.tencentcloudapi.com/?Action=RegisterMigrationTask
    &TaskType=database
    &TaskName=ccc
    &ServiceSupplier=TencentCloud
    &CreateTime=2018-07-13 15:00:00
    &UpdateTime=2018-07-13 15:00:00
    &MigrateClass=mysql:mysql
    &SrcInfo.Region=ap-beijing
    &SrcInfo.Ip=127.0.0.1
    &SrcInfo.Port=80
    &DstInfo.Region=ap-beijing
    &DstInfo.Ip=127.0.0.1
    &DstInfo.Port=80
    &SrcAccessType=cvm
    &SrcDatabaseType=mysql
    &DstAccessType=cvm
    &DstDatabaseType=mysql
    &<Common request parameter>

    Output Example

    {
      "Response": {
        "TaskId": "msp-jitoh33n",
        "RequestId": "be64a8a3-932f-4ea0-91af-843f537c5648"
      }
    }

    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
    InvalidParameterValue Incorrect parameter value.
    ResourceUnavailable The resource is unavailable.

    Was this page helpful?

    Was this page helpful?

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