计算
弹性云服务器 ECS
Flexus云服务
裸金属服务器 BMS
弹性伸缩 AS
镜像服务 IMS
专属主机 DeH
函数工作流 FunctionGraph
云手机服务器 CPH
Huawei Cloud EulerOS
网络
虚拟私有云 VPC
弹性公网IP EIP
虚拟专用网络 VPN
弹性负载均衡 ELB
NAT网关 NAT
云专线 DC
VPC终端节点 VPCEP
云连接 CC
企业路由器 ER
企业交换机 ESW
全球加速 GA
安全与合规
安全技术与应用
Web应用防火墙 WAF
企业主机安全 HSS
云防火墙 CFW
安全云脑 SecMaster
DDoS防护 AAD
数据加密服务 DEW
数据库安全服务 DBSS
云堡垒机 CBH
数据安全中心 DSC
云证书管理服务 CCM
边缘安全 EdgeSec
威胁检测服务 MTD
CDN与智能边缘
内容分发网络 CDN
CloudPond云服务
智能边缘云 IEC
迁移
主机迁移服务 SMS
对象存储迁移服务 OMS
云数据迁移 CDM
迁移中心 MGC
大数据
MapReduce服务 MRS
数据湖探索 DLI
表格存储服务 CloudTable
云搜索服务 CSS
数据接入服务 DIS
数据仓库服务 GaussDB(DWS)
数据治理中心 DataArts Studio
数据可视化 DLV
数据湖工厂 DLF
湖仓构建 LakeFormation
企业应用
云桌面 Workspace
应用与数据集成平台 ROMA Connect
云解析服务 DNS
专属云
专属计算集群 DCC
IoT物联网
IoT物联网
设备接入 IoTDA
智能边缘平台 IEF
用户服务
账号中心
费用中心
成本中心
资源中心
企业管理
工单管理
国际站常见问题
ICP备案
我的凭证
支持计划
客户运营能力
合作伙伴支持计划
专业服务
区块链
区块链服务 BCS
Web3节点引擎服务 NES
解决方案
SAP
高性能计算 HPC
视频
视频直播 Live
视频点播 VOD
媒体处理 MPC
实时音视频 SparkRTC
数字内容生产线 MetaStudio
存储
对象存储服务 OBS
云硬盘 EVS
云备份 CBR
存储容灾服务 SDRS
高性能弹性文件服务 SFS Turbo
弹性文件服务 SFS
云硬盘备份 VBS
云服务器备份 CSBS
数据快递服务 DES
专属分布式存储服务 DSS
容器
云容器引擎 CCE
容器镜像服务 SWR
应用服务网格 ASM
华为云UCS
云容器实例 CCI
管理与监管
云监控服务 CES
统一身份认证服务 IAM
资源编排服务 RFS
云审计服务 CTS
标签管理服务 TMS
云日志服务 LTS
配置审计 Config
资源访问管理 RAM
消息通知服务 SMN
应用运维管理 AOM
应用性能管理 APM
组织 Organizations
优化顾问 OA
IAM 身份中心
云运维中心 COC
资源治理中心 RGC
应用身份管理服务 OneAccess
数据库
云数据库 RDS
文档数据库服务 DDS
数据管理服务 DAS
数据复制服务 DRS
云数据库 GeminiDB
云数据库 GaussDB
分布式数据库中间件 DDM
数据库和应用迁移 UGO
云数据库 TaurusDB
人工智能
人脸识别服务 FRS
图引擎服务 GES
图像识别 Image
内容审核 Moderation
文字识别 OCR
AI开发平台ModelArts
图像搜索 ImageSearch
对话机器人服务 CBS
华为HiLens
视频智能分析服务 VIAS
语音交互服务 SIS
应用中间件
分布式缓存服务 DCS
API网关 APIG
微服务引擎 CSE
分布式消息服务Kafka版
分布式消息服务RabbitMQ版
分布式消息服务RocketMQ版
多活高可用服务 MAS
事件网格 EG
企业协同
华为云会议 Meeting
云通信
消息&短信 MSGSMS
云生态
合作伙伴中心
云商店
开发者工具
SDK开发指南
API签名指南
Terraform
华为云命令行工具服务 KooCLI
其他
产品价格详情
系统权限
管理控制台
客户关联华为云合作伙伴须知
消息中心
公共问题
开发与运维
应用管理与运维平台 ServiceStage
软件开发生产线 CodeArts
需求管理 CodeArts Req
部署 CodeArts Deploy
性能测试 CodeArts PerfTest
编译构建 CodeArts Build
流水线 CodeArts Pipeline
制品仓库 CodeArts Artifact
测试计划 CodeArts TestPlan
代码检查 CodeArts Check
代码托管 CodeArts Repo
云应用引擎 CAE
开天aPaaS
云消息服务 KooMessage
云手机服务 KooPhone
云空间服务 KooDrive

批量创建任务

功能介绍

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

调试

您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。

接口约束

为保证接口调用性能,建议批量调用数量不超过10个。

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

租户在某一Region下的Project ID。

获取方法请参见获取项目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 objects

创建任务请求体。

详情请参见表4

表4 jobs字段数据结构说明

参数

是否必选

参数类型

描述

name

String

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

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

db_use_type

String

迁移场景。

取值:

  • migration:实时迁移
  • sync:实时同步
  • cloudDataGuard:实时灾备

engine_type

String

DRS任务引擎类型。

取值:

  • mysql:MySQL到MySQL迁移,MySQL到MySQL同步
  • mongodb:MongoDB到DDS迁移
  • cloudDataGuard-mysql:MySQL到MySQL灾备
  • gaussdbv5GaussDB同步
  • mysql-to-kafka:MySQL到Kafka同步
  • taurus-to-kafkaTaurusDB到Kafka同步
  • gaussdbv5ha-to-kafka:GaussDB集中式版到Kafka同步
  • postgresql:PostgreSQL到PostgreSQL同步
  • oracle-to-gaussdbv5:Oracle-GaussDB 分布式版
  • oracle-to-gaussdbv5ha:Oracle-GaussDB 集中式版
  • gaussdbv5-to-oracle:GaussDB 分布式版-Oracle
  • gaussdbv5ha-to-oracle:GaussDB 集中式版-Oracle
  • gaussdbv5-to-kafka:GaussDB 分布式版-Kafka

详细取值可参考引擎类型说明

job_direction

String

任务方向。

取值:

  • 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

规格类型。取值:

  • micro:极小规格。
  • small:小规格。
  • medium:中规格。
  • high:大规格。
  • xlarge:超大规格。
  • 2xlarge:极大规格。

具体某种场景支持的取值可以通过查询可用的Node规格接口获取

node_num

Integer

节点个数。

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

MongoDB数据库时对应源端分片个数,源库为集群时必填,[1-32]。

source_endpoint

Object

源库信息。

详情请参见表5

target_endpoint

Object

目标库信息。

详情请参见表5

task_type

String

任务模式,缺省值:FULL_INCR_TRANS

取值:

  • FULL_TRANS:全量
  • FULL_INCR_TRANS:全量+增量
  • INCR_TRANS:增量

单主灾备场景仅支持选择全量加增量(FULL_INCR_TRANS)。

tags

Array of object

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

详情请参见表7

description

String

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

multi_write

Boolean

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

缺省值:false

sys_tags

Array of object

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

详情请参见表7

expired_days

String

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

master_az

String

主备任务主任务所在可用区code,可以通过查询规格未售罄的可用区接口获取

  • master_az和slave_az同时填写时生效。
  • 目前支持mysql,gaussdbv5ha-to-kafka。

slave_az

String

主备任务备任务所在可用区code,可以通过查询规格未售罄的可用区接口获取

  • master_az和slave_az同时填写时生效。
  • 目前支持mysql,gaussdbv5ha-to-kafka。

charging_mode

String

计费模式,不填默认为按需计费。

取值范围:

  • period:包年包月。
  • on_demand:按需计费。
    说明:
    • db_use_type为migration时不支持包年包月。
    • 支持的engine_type为:mysql,cloudDataGuard-mysql,postgresql,gaussdbv5ha-to-kafka

period_order

Object

包年包月信息。

详情请参见表8

说明:

charging_mode为period时必填。

public_ip_list

Array of objects

指定公网IP的信息。

详情请参见表9

is_open_fast_clean

Boolean

是否开启云数据库RDS for MySQL或MariaDB的Binlog快速清理。不传默认为false,不开启快速清理。

表5 source_endpoint和target_endpoint字段数据结构说明

参数

是否必选

参数类型

描述

db_type

String

数据库类型。取值:

  • mysql:MySQL
  • mongodb:MongoDB
  • gaussdbv5:GaussDB分布式版
  • taurusTaurusDB
  • gaussdbv5ha:GaussDB集中式版
  • kafka:Kafka
  • postgresql:PostgreSQL
  • oracle:Oracle

az_code

String

数据库所在可用区azCode。

region

String

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

inst_id

String

数据库实例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

如果数据库为云上实例时,填写数据库实例所在Region下的Project ID。否则,填写当前任务所在Region下的Project ID。

获取方法请参见获取项目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+

kafka_security_config

Object

Kafka安全认证相关,非安全认证不需要此参数。

详情请参见表6

表6 kafka_security_config字段数据结构说明

参数

是否必选

参数类型

描述

type

String

安全协议,安全认证时必填,对应Kafka字段:security.protocol。

  • PLAINTEXT:无安全认证方式,仅需输入IP和端口进行连接。
  • SASL_PLAINTEXT:使用SASL机制连接Kafka,需要设置SASL相关配置。
  • SSL:使用SSL加密方式连接Kafka,需要设置SSL相关配置。
  • SASL_SSL:使用SASL及SSL加密认证方式,需要设置SSL及SASL相关参数配置信息。

枚举值:

  • PLAINTEXT
  • SASL_PLAINTEXT
  • SASL_SSL
  • SSL

trust_store_key_name

String

证书名称,安全协议为SSL、SASL_SSL时必填。

trust_store_key

String

安全证书base64转码后的值,安全协议为SSL、SASL_SSL时必填。

trust_store_password

String

证书密码,证书设置了密码时必填。

endpoint_algorithm

String

主机名端点识别算法,指定通过服务端证书验证服务端主机名的端点识别算法,不填表示禁用主机名验证。对应Kafka字段:ssl.endpoint.identification.algorithm

sasl_mechanism

String

SASL机制,用于客户端连接的SASL机制,对应Kafka字段:sasl.mechanism,支持以下四项,取值:

  • GSSAPI
  • PLAIN
  • SCRAM-SHA-256
  • SCRAM-SHA-512

delegation_tokens

Boolean

是否为委托令牌鉴权,安全协议为SASL_SSL和SASL_PLAINTEXT时,SASL机制选择“SCRAM-SHA-256”或者“SCRAM-SHA-512”时生效。

enable_key_store

Boolean

是否开启SSL双向认证。

key_store_key

String

Keystore证书,开启SSL双向认证时需要。

key_store_key_name

String

Keystore证书名称,开启SSL双向认证时需要。

key_store_password

String

Keystore证书密码,证书设置了密码时需要。对应Kafka字段:ssl.keystore.password

set_private_key_password

Boolean

是否设置Keystore私钥密码,默认为false。

key_password

String

Keystore私钥密码,开启SSL双向认证时,set_private_key_password为true时必填。对应Kafka字段:ssl.key.password

表7 tags和sys_tags字段数据结构说明

参数

是否必选

参数类型

描述

key

String

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

value

String

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

表8 period_order字段数据结构说明

参数

是否必选

参数类型

描述

period_type

Integer

订购周期类型。

取值范围:

  • 2:表示周期类型为月。
  • 3:表示周期类型为年。
    说明:

    charging_mode为period时生效且为必选值。

period_num

Integer

订购周期数。

取值范围:

  • period_type=2(周期类型为月)时,取值为[1,9]。
  • period_type=3(周期类型为年)时,取值为[1,3]。
    说明:
    • charging_mode为period时生效且为必选值。
    • period_num为正整数。

is_auto_renew

Integer

是否自动续订。

取值范围:

  • 0:表示不自动续订。
  • 1:表示自动续订。
    说明:

    charging_mode为period时生效,不传该字段时默认为不自动续订。

表9 public_ip_list字段数据结构说明

参数

是否必选

参数类型

描述

id

String

指定公网IP的ID。

public_ip

String

指定公网IP。

type

String

指定公网IP绑定任务的类型:

  • 主备任务:主是master,备是slave。
  • 其他固定为master。

枚举值:

  • master
  • slave

响应参数

状态码: 202

表10 响应Body参数

参数

参数类型

描述

results

Array of objects

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

详情请参见表11

count

Integer

总记录数。

表11 results字段数据结构说明

参数

参数类型

描述

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-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
      } ]
    }
  • 批量创建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-linxiaolu-test3",
        "engine_type" : "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" : "64e8d7a31afa476ca85609a17af83765in01",
          "project_id" : "054ba152d480d55b2f5dc0069e7ddef0"
        },
        "bind_eip" : true,
        "db_use_type" : "sync",
        "task_type" : "FULL_INCR_TRANS",
        "customize_sutnet_id" : "0cf77cfb-3785-4065-a9c4-74b7bb2df071",
        "master_az" : "az2xahz",
        "slave_az" : "az3xahz"
      } ]
    }

响应示例

状态码: 202

Accepted

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

状态码

状态码

描述

202

Accepted

400

Bad Request

错误码

请参见错误码

我们使用cookie来确保您的高速浏览体验。继续浏览本站,即表示您同意我们使用cookie。 详情

文档反馈

文档反馈

意见反馈

0/500

标记内容

同时提交标记内容