创建任务

project_id

是

String

租户在某一Region下的Project ID。

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

Content-Type

是

String

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

缺省值：application/json

X-Auth-Token

是

String

从IAM服务获取的用户Token。

用户Token也就是调用获取用户Token接口的响应值，该接口是唯一不需要认证的接口。

请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。

X-Language

否

String

请求语言类型。

缺省值：en-us

枚举值：

• en-us
• zh-cn

job

是

Object

创建单个任务请求体。

详情请参见表4。

base_info

是

Object

创建任务基本信息体。

详情请参见表5。

source_endpoint

是

Array of objects

创建任务数据库信息体。

详情请参见表7。

target_endpoint

是

Array of objects

创建任务数据库信息体。

详情请参见表7。

period_order

否

Object

包年/包月信息体。

详情请参见表14。

node_info

是

Object

创建任务实例信息体。

详情请参见表15。

public_ip_list

否

Array of objects

指定公网IP的信息。

详情请参见表19。

name

否

String

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

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

job_type

否

String

任务场景。取值：

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

枚举值：

• migration
• sync
• cloudDataGuard

multi_write

否

Boolean

灾备类型是否双主灾备。说明：

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

engine_type

否

String

引擎类型。取值：

• oracle-to-gaussdbv5：Oracle同步到GaussDB分布式版，实时同步场景使用。
• redis-to-gaussredis：Redis迁移到GeminiDB Redis，实时迁移场景使用。
• rediscluster-to-gaussredis：Redis集群迁移到GeminiDB Redis，实时迁移场景使用。

枚举值：

• oracle-to-gaussdbv5
• redis-to-gaussredis
• rediscluster-to-gaussredis

job_direction

否

String

迁移方向。取值：

• up：入云，灾备场景时对应本云为备。
• down：出云，灾备场景时对应本云为主。
• non-dbs：自建。

枚举值：

• up
• down
• non-dbs

task_type

否

String

迁移模式。取值：

• FULL_TRANS ：全量。
• FULL_INCR_TRANS：全量+增量。
• INCR_TRANS：增量。

枚举值：

• FULL_TRANS
• FULL_INCR_TRANS
• INCR_TRANS

net_type

否

String

网络类型。取值：

• eip：公网网络。
• vpc：VPC网络，灾备场景不支持选择VPC网络。
• vpn：VPN、专线网络。

枚举值：

• eip
• vpc
• vpn

charging_mode

否

String

计费模式，默认按需。取值：

• period：包周期。
• on_demand：按需。

枚举值：

• period
• on_demand

enterprise_project_id

否

String

企业项目ID。 缺省值："0"，表示"default"企业项目。

缺省值：0

description

否

String

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

最小长度：0

最大长度：256

start_time

否

String

任务定时启动时间。

expired_days

否

String

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

缺省值：14

tags

否

Array of objects

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

详情请参见表6。

is_open_fast_clean

否

Boolean

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

key

否

String

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

最小长度：1

最大长度：36

value

否

String

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

最小长度：1

最大长度：43

db_type

是

String

数据库类型。取值：

• oracle：Oracle。
• gaussdbv5：GaussDB分布式版。
• redis：Redis。
• rediscluster：Redis集群版。
• gaussredis: GeminiDB Redis。

枚举值：

• oracle
• gaussdbv5
• redis
• rediscluster
• gaussredis

endpoint_type

是

String

数据库实例类型。取值：

• offline：自建数据库。
• ecs：华为云ECS自建数据库。
• cloud：华为云数据库。

枚举值：

• offline
• ecs
• cloud

endpoint_role

是

String

数据库实例角色。取值：

• so：源库。
• ta：目标库。

枚举值：

• so
• ta

endpoint

是

Object

数据库基本信息体。

详情请参见表8。

cloud

否

Object

数据库实例所在Region，项目等信息。

详情请参见表9.

vpc

否

Object

数据库实例所在VPC，子网，安全组等信息，数据库实例类型为ECS时必填。

详情请参见表10。

config

否

Object

数据库基本设置信息体。

详情请参见表11。

ssl

否

Object

数据库SSL证书信息体。

详情请参见表12。

customized_dns

否

Object

客户自定义DNS服务。

详情请参见表13。

id

否

String

数据库信息ID。

endpoint_name

是

String

数据库场景类型。取值：

• oracle：云下自建Oracle数据库。
• ecs_oracle：华为云ECS自建Oracle数据库。
• cloud_gaussdbv5：华为云数据库GaussDB分布式。
• mysql：他云/本地自建MySQL数据库。
• ecs_mysql：华为云ECS自建MySQL数据库。
• cloud_mysql：华为云数据库RDS for MySQL。
• redis：云下自建Redis数据。
• ecs_redis：华为云ECS自建Redis数据。
• rediscluster：云下自建Redis集群数据库。
• ecs_rediscluster：华为云ECS自建Redis集群数据库。
• cloud_gaussdb_redis：华为云数据库GeminiDB Redis。

枚举值：

• oracle
• ecs_oracle
• cloud_gaussdbv5
• mysql
• ecs_mysql
• cloud_mysql
• redis
• ecs_redis
• rediscluster
• ecs_rediscluster
• cloud_gaussdb_redis

ip

否

String

数据库IP。约束：

• 数据库为自建MongoDB时，数据库IP与端口之间用“:”英文冒号拼接，多个值之间请用“,”英文逗号隔开，最多支持填写3个IP地址或域名。
• 数据库为DDS实例时，数据库IP与端口之间用“:”英文冒号拼接，多个IP端口之间请用“,”英文逗号分隔。
• 数据库为Redis集群时，请填写源端Redis集群所有分片的IP地址和对应端口，数据库IP与端口之间用“:”英文冒号拼接，多个IP端口之间请用“,”英文逗号分隔，并且推荐填写集群分片的Slave节点的IP地址。最多支持填写32个IP地址或域名，多个值之间请用英文逗号隔开。

示例：

• MongoDB：192.168.0.10:8080,192.168.0.11:8080,192.168.0.12:8080
• DDS：192.168.205.130:8635,192.168.250.64:8635
• Redis集群：192.168.0.1:8080,192.168.0.2:8080

db_port

否

String

数据库端口。

约束：输入范围为1-65535之间的整数。

db_user

是

String

数据库用户名。

db_password

是

String

数据库密码。

instance_id

否

String

华为云数据库实例ID。

instance_name

否

String

华为云数据库实例名称。

db_name

否

String

指定数据库名称。例如：

• oracle：serviceName.orcl。

source_sharding

否

Array of objects

物理源库信息。

详情请参见表8.

region

是

String

区域ID，当数据库实例类型为ecs（华为云ECS自建数据库），cloud（华为云数据库）时为必填项。获取方法请参见地区和终端节点。 注意：当该Region下存在子项目时，Region ID为区域项目ID与子项目ID，由“_”下划线拼接，例如：cn-north-4_abc。

project_id

是

String

租户在某一Region下的Project ID。

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

az_code

否

String

数据库所在可用分区（AZ）名称。

vpc_id

是

String

数据库实例所在的虚拟私有云ID，获取方法如下：

方法1：登录虚拟私有云服务的控制台界面，在虚拟私有云的详情页面查找VPC ID。

方法2：通过虚拟私有云服务的API接口查询，具体操作可参考查询VPC列表。

subnet_id

是

String

数据库实例所在子网ID，获取方法如下：

方法1：登录虚拟私有云服务的控制台界面，单击VPC下的子网，进入子网详情页面，查找网络ID。

方法2：通过虚拟私有云服务的API接口查询，具体操作可参考查询子网列表。

security_group_id

否

String

数据库实例所在的安全组ID，获取方法如下：

方法1：登录虚拟私有云服务的控制台界面，在安全组的详情页面查找安全组ID。

方法2：通过虚拟私有云服务的API接口查询，具体操作可参考查询安全组列表。

is_target_readonly

否

Boolean

目标实例是否设置为为只读。

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

缺省值：true

node_num

否

Integer

Redis集群到GeminiDB Redis迁移场景填写，连接源端Redis集群的子任务个数，输入值在1到16之间，且输入值不能大于源端Redis集群的分片个数，请根据源端Redis集群的规模合理选择。建议集群的每4个分片设置1个源端分片个数，即每1个子任务连接源端集群的4个分片。

最小值：1

最大值：16

缺省值：0

ssl_link

否

Boolean

是否SSL安全连接。如果数据库启用了SSL安全连接，参数值为true。

ssl_cert_name

否

String

SSL证书名字。

ssl_cert_key

否

String

SSL证书内容，用base64加密。

ssl_cert_check_sum

否

String

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

ssl_cert_password

否

String

SSL证书密码，证书文件后缀为.p12时必填。

is_set_dns

是

Boolean

是否设置客户自定义DNS。

set_dns_action

是

String

设置客户自定义DNS的行为。

• add：新增客户自定义DNS IP。
• keep：保持客户自定义DNS IP。
• update：更新客户自定义DNS IP（当DNS IP变化时更新生效）。
• recover：还原系统默认DNS IP（还原时可能会导致域名解析失败，请谨慎操作）。

枚举值：

• add
• keep
• update
• recover

dns_ip

是

String

设置客户自定义DNS IP。

最小长度：0

最大长度：15

period_type

是

Integer

订购周期类型。取值：

• 2：月。
• 3：年。

缺省值：3

枚举值：

• 2
• 3

period_num

是

Integer

订购周期数。根据period_type取值不同，代表不同周期数，例如：

• 当period_type为2时，period_num为1代表1月。
• 当period_type为3时，period_num为1代表1年。

is_auto_renew

否

Integer

是否自动续订。取值：

• 0：否（默认值，需要客户手动去支付）。
• 1：是（自动支付）。

缺省值：0

枚举值：

• 0
• 1

spec

是

Object

任务实例规格信息体。

详情请参见表16。

vpc

否

Object

任务实例VPC信息体，自建任务必填。

详情请参见表17。

base_info

否

Object

任务实例VPC信息体，自建任务必填。

详情请参见表18。

node_type

是

String

实例规格编码。取值：

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

枚举值：

• micro
• small
• medium
• high

vpc_id

是

String

任务实例所在虚拟私有云ID。

subnet_id

是

String

任务实例所在子网ID。

custom_node_ip

否

String

指定创建任务实例IP地址，多个IP端口之间请用“,”英文逗号分隔，目前仅支持设置IPv4地址，获取方法如下：

• 方法1：登录虚拟私有云服务的控制台界面，单击VPC下的子网，进入子网详情页面，查找子网的网段，选择未被占用的IP 。
• 方法2：通过虚拟私有云服务的API接口查询，具体操作可参考查询私有IP列表，选择“device_owner”为空的私有IP。 示例： "192.168.0.10,192.168.0.11"。

security_group_id

否

String

任务实例所在的安全组ID。

instance_type

是

String

实例类型。取值：

• single：单机。
• ha：主备。

枚举值：

• single
• ha

arch

是

String

CPU架构。取值：

• x86
• arm

枚举值：

• x86
• arm

availability_zone

是

String

可用区ID。约束：对于任务实例类型不是单机的实例，需要分别为实例所有节点指定可用区，并用“,”英文逗号隔开。示例：

• 实例类型为single："cn-north-4a"
• 实例类型为ha："cn-north-4a,cn-north-4b"

status

否

String

状态。

role

否

String

任务主备角色。

id

是

String

指定公网IP的ID。

public_ip

是

String

指定公网IP。

type

是

String

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

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

枚举值：

• master
• slave

id

String

任务ID。

name

String

任务名称。

status

String

任务状态。

create_time

String

任务创建时间。

is_clone_job

String

是否为克隆任务。

error_code

String

错误码。

最小长度：12

最大长度：12

error_msg

String

错误描述。

最小长度：1

最大长度：512

200

OK

400

Bad Request