更新时间:2022-04-18 GMT+08:00
分享

批量创建任务

功能介绍

根据请求参数不同,可以批量创建实时迁移、实时同步、实时灾备任务。

调试

您可以在API Explorer中调试该接口。

URI

POST /v3/{project_id}/jobs/batch-creation

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

租户在某一Region下的Project ID。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

Content-Type

String

指定类型为application/json。

缺省值:application/json

X-Auth-Token

String

从IAM服务获取的用户Token。

X-Language

String

请求语言类型,缺省值:en-us

取值:

  • en-us
  • zh-cn
表3 请求Body参数

参数

是否必选

参数类型

描述

jobs

Array of CreateJobReq objects

创建任务请求体。

表4 CreateJobReq

参数

是否必选

参数类型

描述

name

String

任务名称,约束:任务名称在4位到50位之间,不区分大小写,可以包含字母、数字、中划线或下划线,不能包括其他特殊字符。

  • 最小长度:4
  • 最大长度:50

db_use_type

String

迁移场景,migration:实时迁移,sync:实时同步,cloudDataGuard:实时灾备。

取值:

  • migration
  • sync
  • cloudDataGuard

engine_type

String

引擎类型,

mysql:MySQL迁移,MySQL同步使用;

mongodb:迁移使用;

cloudDataGuard-mysql:灾备使用;

gaussdbv5:GaussDB(for openGauss)同步使用;

postgresql:PostgreSQL同步使用;

取值:

  • mysql
  • mongodb
  • cloudDataGuard-mysql
  • gaussdbv5
  • postgresql

job_direction

String

  • 迁移方向,up :入云 ,灾备场景时对应本云为备,down:出云,灾备场景时对应本云为主,non-dbs:自建。

    取值:

    • up
    • down
    • non-dbs

bind_eip

Boolean

是否绑定EIP,网络类型为EIP时必填且为true。

customize_sutnet_id

String

DRS实例所在子网ID,对应目标库相同VPC下已创建的子网(subnet)的网络ID,UUID格式。

product_id

String

产品id。

is_target_readonly

Boolean

指定目标实例是否限制为只读,MySQL迁移和灾备,且job_direction为up时设置有效。(灾备场景下,单主灾备且本云为备为必填且为true,不填默认设置为true)。

net_type

String

网络类型。取值:

  • vpn
  • vpc
  • eip

灾备场景不支持选择VPC网络。

node_type

String

规格类型。取值:

  • high

node_num

Integer

节点个数。MongoDB数据库时对应源端分片个数,源库为集群时必填,[1-32],MySQL双主灾备时会默认设置为2。

source_endpoint

Endpoint object

源库信息。

target_endpoint

Endpoint object

目标库信息。

task_type

String

迁移模式,FULL_TRANS:全量。FULL_INCR_TRANS:全量+增量,INCR_TRANS:增量,灾备场景单主灾备仅支持全量加增量(FULL_INCR_TRANS)。

缺省值:FULL_INCR_TRANS

取值:

  • FULL_TRANS
  • FULL_INCR_TRANS
  • INCR_TRANS

tags

Array of ResourceTag object

标签信息,最多添加10个标签。

description

String

任务描述。 约束:任务描述不能超过256位,且不能包含!<>&'"\特殊字符。

multi_write

Boolean

  • db_use_type 是cloudDataGuard时,必填,灾备类型是双主灾备时 multi_write取值true, 否则为false。
  • db_use_type 是其他类型时,multi_write是非必选参数。

缺省值:false

sys_tags

Array of ResourceTag object

企业项目,不填默认为default,key值必须为_sys_enterprise_project_id,value为企业项目ID,只能有一个企业项目。

expired_days

String

任务处于异常状态一段时间后,将会自动结束。单位为天。(范围14-100),不传默认为14天。

表5 Endpoint

参数

是否必选

参数类型

描述

db_type

String

数据库类型。取值:

  • mysql
  • mongodb
  • gaussdbv5
  • postgresql

az_code

String

数据库所在可用区azCode。

region

String

RDS实例所在Region,数据库为RDS实例时必填(灾备场景下job_direction为down时source_endpoint中该值为必填,job_direction为up时target_endpoint中该值为必填)。

inst_id

String

RDS实例ID,数据库为RDS实例必填(灾备场景下job_direction为down时source_endpoint中该值为必填,job_direction为up时target_endpoint中该值为必填)。

vpc_id

String

数据库所在的虚拟私有云ID。

subnet_id

String

数据库所在的子网ID。

security_group_id

String

数据库所在的安全组ID。

project_id

String

RDS实例的Project ID。

db_name

String

服务名serviceName,源库为Oracle场景时必填。约束:不能超过128位,不能包含!<>&'"\特殊字符。待还原数据库名称是指备份文件中包含的数据库名称,当您选择部分数据库恢复时,需要选择恢复一个或者多个数据库。

db_password

String

数据库密码。

db_port

Integer

数据库端口。约束:输入范围为1-65535之间的整数。

db_user

String

数据库用户。

inst_name

String

RDS实例名称。

ip

String

数据库IP。

mongo_ha_mode

String

mongo ha模式。

safe_mode

Integer

MRS集群运行模式,取值:

  • 0普通集群
  • 1安全集群

ssl_cert_password

String

SSL证书密码,证书文件后缀为.p12。

ssl_cert_check_sum

String

SSL证书内容checksum值,后端校验,源库安全连接必选。

ssl_cert_key

String

SSL证书内容,用base64加密。

ssl_cert_name

String

SSL证书名字。

ssl_link

Boolean

是否SSL安全连接。

topic

String

kafka topic名称。

cluster_mode

String

MongoDB集群4.0及以上版本,当集群实例无法获取到分片节点的IP时,source_endpoint中需要填写,值为:Sharding4.0+。

缺省值:Sharding4.0+

取值:

  • Sharding4.0+
表6 ResourceTag

参数

是否必选

参数类型

描述

key

String

标签键,最大长度36,只能包含字母、数字、下划线、中划线和中文。

value

String

标签值,最大长度43,只能包含字母、数字、下划线、中划线和中文。

响应参数

状态码: 202

表7 响应Body参数

参数

参数类型

描述

results

Array of CreateJobResp objects

批量创建任务的响应体集合。

count

Integer

总记录数。

表8 CreateJobResp

参数

参数类型

描述

id

String

任务ID。

child_ids

Array of strings

子任务ID集合,有子任务时返回该字段。

name

String

任务名称。

status

String

任务状态。

create_time

String

创建时间,时间戳。

error_code

String

错误码。

error_msg

String

错误信息。

请求示例

  • 批量创建MySQL实时灾备任务,本云为备示例:
    https://{Endpoint}/v3/054ba152d480d55b2f5dc0069e7ddef0/jobs/batch-creation
    {
      "jobs" : [ {
        "name" : "DRS-api-test",
        "engine_type" : "cloudDataGuard-mysql",
        "net_type" : "eip",
        "node_type" : "high",
        "job_direction" : "up",
        "source_endpoint" : {
          "db_type" : "mysql"
        },
        "target_endpoint" : {
          "region" : "cn-xianhz-1",
          "db_type" : "mysql",
          "inst_id" : "e05a3679efe241d8b5dee80b17c1a863in01",
          "project_id" : "054ba152d480d55b2f5dc0069e7ddef0"
        },
        "is_target_readonly" : true,
        "bind_eip" : true,
        "db_use_type" : "cloudDataGuard",
        "task_type" : "FULL_INCR_TRANS",
        "customize_sutnet_id" : "352ad828-3467-4f03-987a-c55a5a9dd417",
        "multi_write" : false
      } ]
    }
  • 批量创建DDS副本实时迁移任务示例:
    https://{Endpoint}/v3/054ba152d480d55b2f5dc0069e7ddef0/jobs/batch-creation
    {
      "jobs" : [
    {
      "name" : "DRS-3371-linxiaolu",
      "node_type" : "high",
      "engine_type" : "mongodb",
      "net_type" : "eip",
      "job_direction" : "up",
      "db_use_type" : "migration",
      "task_type" : "FULL_INCR_TRANS",
      "customize_sutnet_id" : "faf513f3-7a88-4a5c-bec7-238699c29c17",
      "source_endpoint" : {
        "db_type" : "mongodb"
      },
      "target_endpoint" : {
        "region" : "cn-xianhz-1",
        "db_type" : "mongodb",
        "inst_id" : "3cadd5a0ef724f55ac7fa5bcb5f4fc5fin02"
      },
      "bind_eip" : true
    
    }
     ]
    }
  • 批量创建MySQL实时迁移任务请求示例:
    https://{Endpoint}/v3/054ba152d480d55b2f5dc0069e7ddef0/jobs/batch-creation
    {
      "jobs" : [ {
        "name" : "DRS-9228",
        "node_type" : "high",
        "engine_type" : "mysql",
        "net_type" : "eip",
        "job_direction" : "up",
        "db_use_type" : "migration",
        "task_type" : "FULL_INCR_TRANS",
        "customize_sutnet_id" : "352ad828-3467-4f03-987a-c55a5a9dd417",
        "source_endpoint" : {
          "db_type" : "mysql"
        },
        "target_endpoint" : {
          "region" : "cn-xianhz-1",
          "db_type" : "mysql",
          "inst_id" : "e05a3679efe241d8b5dee80b17c1a863in01"
        },
        "is_target_readonly" : false,
        "bind_eip" : true
      } ]
    }
  • 创建同步任务自建-自建示例:
    https://{Endpoint}/v3/054ba152d480d55b2f5dc0069e7ddef0/jobs/batch-creation
    {
      "jobs" : [
    {
      "task_type" : "FULL_INCR_TRANS",
      "name" : "DRS-2715-linxiaolu-non-dbs",
      "node_type" : "high",
      "engine_type" : "mysql",
      "net_type" : "eip",
      "job_direction" : "non-dbs",
      "bind_eip" : true,
      "db_use_type" : "sync",
      "customize_sutnet_id" : "3f94e724-e99f-4477-8828-9fef481cbdd6",
      "source_endpoint" : {
        "db_type" : "mysql"
      },
      "target_endpoint" : {
        "db_type" : "mysql",
        "vpc_id" : "65f0391c-0582-44a6-aa50-248f97ed82e1",
        "subnet_id" : "3f94e724-e99f-4477-8828-9fef481cbdd6",
        "security_group_id" : "001dfb60-5397-44f1-bd9a-e1596127ba97",
        "az_code" : "az1xahz"
      }
    }
     ]
    }

响应示例

状态码: 202

Accepted

{
  "results" : [ {
    "id" : "e11eaf8f-71ef-4fad-8890-aed7572ajb11",
    "name" : "DRS-9228",
    "status" : "CREATING",
    "create_time" : "1599188556112"
  } ],
  "count" : 1
}

状态码

状态码

描述

202

Accepted

400

Bad Request

错误码

请参见错误码

分享:

    相关文档

    相关产品

close