更新时间:2024-04-17 GMT+08:00

任务创建示例

本小节以创建实时迁移任务为示例,介绍如何通过调用API创建任务。

涉及API

  • IAM获取Token的API。

    当您使用Token认证方式完成认证鉴权时,需要获取用户Token并在调用接口时增加“X-Auth-Token”到业务接口请求消息头中。

  • 创建DRS实时迁移任务的API。

具体步骤

  1. Token认证,并获取Token值,具体操作请参考认证鉴权
  2. 获取DRS的Endpoint。

    • 调用接口前,您需要提前联系企业管理员,获取地区和终端节点,即下文中的Endpoint值。
    • 调用接口前,您需要提前获取到地区和终端节点,即下文中的Endpoint值。

  3. 获取用户在某一Region下的Project ID,请参见获取项目ID
  4. 发送“POST https://{DRS的Endpoint}//v3/{projectId}/jobs”。
  5. 在Request Header中增加“X-Auth-Token”,值为用户Token。
  6. 在Request Header中增加“Content-Type”,值为“application/json”。
  7. 在Request Body中传入参数如下:

    关于创建实例接口的详细说明,请参见批量创建任务

    {
        "bind_eip": true,// 在公网网络场景下确认迁移实例是否绑定弹性IP
        "db_use_type": "migration",// 使用类型,取值:migration-实时迁移,sync-实时同步,cloudDataGuard-实时灾备,必填。
        "description": "",// 任务描述。
        "engine_type": "mysql",//引擎类型,取值:mysql,mongodb,cloudDataGuard-mysql,gaussdbv5。
        "is_target_readonly": true,// 指定目标实例是否限制为只读。
        "job_direction": "up",// 任务方向,取值up,down
        "name": "DRS-2057",// 任务名称,必填。
        "net_type": "eip",// 网络类型,取值:vpn,vpc,eip,必填。
        "node_type": "high",// 规格类型,必填。
        "source_Endpoint": { // 源数据库信息体,必填。
            "db_type": "mysql",// 数据库类型,取值:mysql,mongodb,gaussdbv5,必填。
        },
        "target_Endpoint": { // 目标数据库信息体。
            "db_type": "mysql",// 数据库类型,必填。
            "inst_id": "63e0699063494a8a93798f38abf3247ein01",// RDS实例id,数据库为RDS实例必填。
            "region": "cn-xianhz-1" // RDS实例所在region,数据库为rds时必填。
        },
        "task_type": "FULL_INCR_TRANS" // 任务模式,取值:FULL_TRANS, FULL_INCR_TRANS。
    }

    如果请求失败,会返回错误码及对应的错误信息说明,详细错误码信息请参见错误码