批量创建任务 - BatchCreateJobs

project_id

是

String

参数解释：

租户在某一Region下的Project ID。

获取方法请参见获取项目ID。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

Content-Type

是

String

参数解释：

发送的实体的MIME类型。推荐用户默认使用application/json，如果API是对象、镜像上传等接口，媒体类型可按照流类型的不同进行确定。

约束限制：

不涉及。

取值范围：

application/json

默认取值：

application/json

X-Auth-Token

是

String

参数解释：

从IAM服务获取的用户Token。 用户Token也就是调用获取用户Token接口的响应值，该接口是唯一不需要认证的接口。 请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

X-Language

否

String

参数解释：

请求语言类型。

约束限制：

不涉及。

取值范围：

• en-us：英语
• zh-cn：中文

默认取值：

en-us

jobs

是

Array of objects

参数解释：

创建任务请求体列表。

详情请参见表4。

name

是

String

参数解释：

任务名称。

约束限制：

必须以字母开头，不区分大小写，可以包含字母、数字、中划线或下划线，不能包括其他特殊字符。

取值范围：

长度为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灾备。
• gaussdbv5：GaussDB同步。
• mysql-to-kafka：MySQL到Kafka同步。
• taurus-to-kafka：TaurusDB到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（弹性公网IP）。

约束限制：

网络类型为EIP时必填且为true。

取值范围：

• true：绑定EIP。
• false：不绑定EIP。

默认取值：

false

customize_sutnet_id

是

String

参数解释：

DRS实例所在子网ID，对应目标库相同VPC下已创建的子网（subnet）的网络ID。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

product_id

否

String

参数解释：

产品ID。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

is_target_readonly

否

Boolean

参数解释：

指定目标实例是否限制为只读。

约束限制：

MySQL迁移和灾备，且job_direction为up时设置有效。（灾备场景下，单主灾备且本云为备为必填且为true，不填默认设置为true）。

取值范围：

• true：限制为只读。
• false：不限制为只读。

默认取值：

不涉及。

net_type

是

String

参数解释：

任务使用的网络类型。

约束限制：

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

取值范围：

• vpn：VPN网络。
• vpc：VPC网络。
• eip：EIP网络。

默认取值：

不涉及。

node_type

是

String

参数解释：

DRS任务实例规格编码，决定迁移实例的计算资源大小。

约束限制：

不涉及。

取值范围：

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

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

默认取值：

不涉及。

node_num

否

Integer

参数解释：

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

约束限制：

不涉及。

取值范围：

1-32，MySQL双主灾备时会默认设置为2。

默认取值：

不涉及。

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

参数解释：

标签信息列表。

详情请参见表7。

约束限制：

最多添加20个标签

description

否

String

参数解释：

任务描述。

约束限制：

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

取值范围：

不涉及。

默认取值：

不涉及。

multi_write

否

Boolean

参数解释：

灾备类型是否为双主灾备。

约束限制：

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

取值范围：

• true：双主灾备。
• false：不是双主灾备。

默认取值：

false

sys_tags

否

Array of object

参数解释：

企业项目标签列表。

约束限制：

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

详情请参见表7。

expired_days

否

String

参数解释：

任务处于异常状态一段时间后自动结束的天数。

约束限制：

不涉及

取值范围：

14-100

默认取值：

14

master_az

否

String

参数解释：

主备任务主任务所在可用区编码，可以通过查询规格未售罄的可用区接口获取，不填写取值默认为单az任务。

约束限制：

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

取值范围：

不涉及。

默认取值：

不涉及。

slave_az

否

String

参数解释：

主备任务备任务所在可用区编码，可以通过查询规格未售罄的可用区接口获取，不填写取值默认为单az任务。

约束限制：

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

取值范围：

不涉及。

默认取值：

不涉及。

charging_mode

否

String

参数解释：

任务的计费模式，指定数据复制任务的付费方式。

约束限制：

• db_use_type为migration时不支持包年包月。
• 支持的engine_type为：mysql，cloudDataGuard-mysql，postgresql，gaussdbv5ha-to-kafka

取值范围：

• period：包年包月。
• on_demand：按需计费。

默认取值：

on_demand

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快速清理。

约束限制：

不涉及。

取值范围：

• true：开启快速清理。
• false：不开启快速清理。

默认取值：

false

db_type

否

String

参数解释：

数据库类型，标识源库或目标库的数据库引擎种类。

约束限制：

测试连接之后修改调用时必填。

取值范围：

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

默认取值：

不涉及。

az_code

否

String

参数解释：

数据库所在可用区（AZ，Availability Zone）编码。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

region

否

String

参数解释：

数据库实例所在区域。数据库为云上实例时，比如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

参数解释：

数据库所在的虚拟私有云（VPC，Virtual Private Cloud）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

参数解释：

MongoDB高可用模式。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

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安全连接，指定数据库连接是否启用SSL加密传输。

约束限制：

不涉及。

取值范围：

• true：使用SSL安全连接。
• false：不使用SSL安全连接。

默认取值：

不涉及。

topic

否

String

参数解释：

kafka topic名称。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

cluster_mode

否

String

参数解释：

MongoDB集群模式，当集群实例无法获取到分片节点的IP时，source_endpoint中需要填写。

约束限制：

不涉及。

取值范围：

Sharding4.0+：MongoDB集群4.0及以上版本。

默认取值：

Sharding4.0+

kafka_security_config

否

Object

参数解释：

Kafka安全认证相关相关配置，非安全认证不需要此参数。

详情请参见表6。

type

否

String

参数解释：

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

约束限制：

不涉及。

取值范围：

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

默认取值：

不涉及。

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。

约束限制：

认证类型为SASL_PLAINTEXT、SASL_SSL时必填。

取值范围：

• GSSAPI：GSSAPI机制。
• PLAIN：PLAIN机制。
• SCRAM-SHA-256：SCRAM-SHA-256机制。
• SCRAM-SHA-512：SCRAM-SHA-512机制。

默认取值：

不涉及。

delegation_tokens

否

Boolean

参数解释：

是否为委托令牌鉴权。

约束限制：

安全协议为SASL_SSL和SASL_PLAINTEXT，且SASL机制选择“SCRAM-SHA-256”或者“SCRAM-SHA-512”时生效。

取值范围：

• true：委托令牌鉴权。
• false：不委托令牌鉴权。

默认取值：

不涉及。

enable_key_store

否

Boolean

参数解释：

是否开启SSL双向认证。

约束限制：

不涉及。

取值范围：

• true：开启SSL双向认证。
• false：不开启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私钥密码。

约束限制：

不涉及。

取值范围：

• true：设置Keystore私钥密码。
• false：不设置Keystore私钥密码。

默认取值：

false

key_password

否

String

参数解释：

Keystore私钥密码，对应Kafka字段：ssl.key.password。

约束限制：

开启SSL双向认证时，set_private_key_password为true时必填。

取值范围：

不涉及。

默认取值：

不涉及。

key

否

String

参数解释：

标签键。

约束限制：

• 最大长度36个字符。
• 只能包含字母、数字、下划线、中划线和中文。
• 需要修改标签时填写。

取值范围：

不涉及。

默认取值：

不涉及。

value

否

String

参数解释：

标签值。

约束限制：

• 最大长度43个字符。
• 只能包含字母、数字、下划线、中划线和中文。
• 需要修改标签时填写。

取值范围：

不涉及。

默认取值：

不涉及。

period_type

否

Integer

参数解释：

订购周期类型。

约束限制：

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

取值范围：

• 2：表示周期类型为月。
• 3：表示周期类型为年。

默认取值：

不涉及。

period_num

否

Integer

参数解释：

订购周期数。

约束限制：

• charging_mode为period时生效且为必选值。
• period_num为正整数。

取值范围：

• period_type=2（周期类型为月）时，取值为[1，9]。
• period_type=3（周期类型为年）时，取值为[1，3]。

默认取值：

不涉及。

is_auto_renew

否

Integer

参数解释：

是否自动续订。

约束限制：

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

取值范围：

• 0：表示不自动续订。
• 1：表示自动续订。

默认取值：

不涉及。

id

是

String

参数解释：

指定公网IP的ID。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

public_ip

是

String

参数解释：

指定公网IP。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

type

是

String

参数解释：

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

约束限制：

• 主备任务：主是master，备是slave。
• 其他固定为master。

取值范围：

• master：主任务。
• slave：备任务。

默认取值：

不涉及。

results

Array of objects

参数解释：

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

详情请参见表11。

count

Integer

参数解释：

返回的任务信息总记录数，表示本次查询成功返回的任务数量，与results数组的长度一致。

约束限制：

不涉及。

取值范围：

不涉及。

id

String

参数解释：

任务ID，用于唯一标识一个数据复制任务，在查询、修改、删除等操作中作为任务的识别凭证。

约束限制：

不涉及。

取值范围：

不涉及。

child_ids

Array of strings

参数解释：

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

约束限制：

不涉及。

取值范围：

不涉及。

name

String

参数解释：

任务名称。

约束限制：

不涉及。

取值范围：

不涉及。

status

String

参数解释：

任务当前运行状态。

约束限制：

不涉及。

取值范围：

• CREATING：创建中。
• CREATE_FAILED：创建失败。
• CONFIGURATION：配置中。
• WAITING_FOR_START：等待启动中。
• RELEASE_RESOURCE_COMPLETE：已结束。
• DELETED：已删除。
• INCRE_TRANSFER_STARTED：增量迁移中。
• INCRE_TRANSFER_FAILED：增量迁移失败。
• FULL_TRANSFER_STARTED：全量迁移中。
• FULL_TRANSFER_COMPLETE：全量迁移完成。
• PAUSING：暂停中。
• FULL_TRANSFER_FAILED：全量迁移失败。

create_time

String

参数解释：

创建时间，时间戳格式。

约束限制：

不涉及。

取值范围：

不涉及。

error_code

String

参数解释：

错误码，当任务报错时返回的错误代码。

约束限制：

不涉及。

取值范围：

不涉及。

error_msg

String

参数解释：

错误详细信息，当任务执行失败时返回的具体错误描述。

约束限制：

不涉及。

取值范围：

不涉及。

202

Accepted

400

Bad Request