云数据迁移 CDM-随机集群创建作业并执行:请求参数
下载云数据迁移 CDM用户手册完整版
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
X-Auth-Token |
是 |
String |
用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 |
X-Language |
是 |
String |
请求语言。 |
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
jobs |
是 |
Array of Job objects |
作业列表，请参见jobs数据结构说明。 |
clusters |
是 |
Array of strings |
CDM集群ID列表，系统会从里面随机选择一个开机状态的集群，在该集群中创建作业并执行作业。 |
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
job_type |
否 |
String |
作业类型：
枚举值：
|
from-connector-name |
是 |
String |
源端连接类型，对应的连接参数如下：
|
to-config-values |
是 |
ConfigValues object |
目的连接参数配置。根据不同目的端有不同的参数配置，具体可参考目的端作业参数说明下相应的目的端参数配置。 |
to-link-name |
是 |
String |
目的端连接名称，即为通过“创建连接”接口创建的连接对应的连接名。 |
driver-config-values |
是 |
ConfigValues object |
作业任务参数配置。例如配置作业失败重试、抽取并发数，具体可参考作业任务参数说明。 |
from-config-values |
是 |
ConfigValues object |
源连接参数配置。根据不同源端有不同的参数配置，具体可参考源端作业参数说明下相应的源端参数配置。 |
to-connector-name |
否 |
String |
目的端连接类型，对应的连接参数如下：
|
name |
否 |
String |
作业名称，长度在1到240个字符之间 最小长度：1 最大长度：240 |
from-link-name |
否 |
String |
源连接名称，即为通过“创建连接”接口创建的连接对应的连接名。 |
creation-user |
否 |
String |
创建作业的用户。由系统生成，用户无需填写。 |
creation-date |
否 |
Long |
作业创建的时间，单位：毫秒。由系统生成，用户无需填写。 |
update-date |
否 |
Long |
作业最后更新的时间，单位：毫秒。由系统生成，用户无需填写。 |
is_incre_job |
否 |
Boolean |
是否是增量作业。已废弃 |
flag |
否 |
Integer |
是否是定时作业标记，如果是定时作业则为1，否则为0。由系统根据定时任务配置生成，用户无需填写。 |
files_read |
否 |
Integer |
已读文件数。由系统生成，用户无需填写。 |
update-user |
否 |
String |
最后更新作业的用户。由系统生成，用户无需填写。 |
external_id |
否 |
String |
具体执行的作业id，如果是本地作业，则一般为"job_local1202051771_0002"形式，如果是DLI作业，则为DLI作业ID，比如"12345"。由系统生成，用户无需填写。 |
type |
否 |
String |
与job_type一致，作业类型：
|
execute_start_date |
否 |
Long |
最近一次执行任务开始时间，单位：毫秒。由系统生成，用户无需填写。 |
delete_rows |
否 |
Integer |
增量作业删除行数，已废弃。 |
enabled |
否 |
Boolean |
是否激活连接。由系统生成，用户无需填写。 |
bytes_written |
否 |
Long |
作业写入的字节。由系统生成，用户无需填写。 |
id |
否 |
Integer |
作业ID。由系统生成，用户无需填写。 |
is_use_sql |
否 |
Boolean |
用户是否使用sql。由系统根据源端抽取是否使用sql语句生成，用户无需填写 |
update_rows |
否 |
Integer |
增量作业更新行数，已废弃。 |
group_name |
否 |
String |
组名 |
bytes_read |
否 |
Long |
作业读取的字节。由系统生成，用户无需填写。 |
execute_update_date |
否 |
Long |
最近一次执行任务更新时间，单位：毫秒。由系统生成，用户无需填写。 |
write_rows |
否 |
Integer |
增量作业写入行数，已废弃。 |
rows_written |
否 |
Integer |
作业写入的行数。由系统生成，用户无需填写。 |
rows_read |
否 |
Long |
作业读取的行数。由系统生成，用户无需填写。 |
files_written |
否 |
Integer |
写入文件数。由系统生成，用户无需填写。 |
is_incrementing |
否 |
Boolean |
是否是增量作业，同is_incre_job，已废弃。 |
execute_create_date |
否 |
Long |
最近一次执行任务创建时间，单位：毫秒。由系统生成，用户无需填写。 |
status |
否 |
String |
作业最后的执行状态：
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
configs |
是 |
Array of configs objects |
源连接参数、目的连接参数和作业任务参数，它们的配置数据结构相同，其中“inputs”里的参数不一样，详细请参见configs数据结构说明 |
extended-configs |
否 |
extended-configs object |
扩展配置，请参见extended-configs参数说明。扩展配置暂不对外开放，用户无需填写。 |
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
inputs |
是 |
Array of Input objects |
输入参数列表，列表中的每个参数为“name,value”结构，请参考inputs数据结构参数说明。在“from-config-values”数据结构中，不同的源连接类型有不同的“inputs”参数列表，请参见源端作业参数说明下的章节。在“to-config-values”数据结构中，不同的目的连接类型有不同的“inputs”参数列表，请参见目的端作业参数说明下面的子章节。在“driver-config-values”数据结构中，“inputs”具体参数请参见作业任务参数说明。 |
name |
是 |
String |
配置名称：源端作业的配置名称为“fromJobConfig”。目的端作业的配置名称为“toJobConfig”，连接的配置名称固定为“linkConfig”。 |
id |
否 |
Integer |
配置ID，由系统生成，用户无需填写。 |
type |
否 |
String |
配置类型，由系统生成，用户无需填写。值为LINK或者JOB，如果是连接管理API，则为LINK；如果是作业管理API，则为JOB。 |
