批量查询任务详情
功能介绍
根据任务ID批量查询任务详情。
调试
您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。
接口约束
为保证接口调用性能,建议批量调用数量不超过10个。
URI
POST /v3/{project_id}/jobs/batch-detail
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
租户在某一Region下的Project ID。 获取方法请参见获取项目ID。 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
Content-Type |
是 |
String |
指定类型为application/json。 缺省值:application/json |
X-Auth-Token |
是 |
String |
从IAM服务获取的用户Token。 |
X-Language |
否 |
String |
请求语言类型。 缺省值:en-us 取值:
|
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
jobs |
是 |
Array of strings |
批量查询任务详情。 |
page_req |
否 |
Object |
分页信息。 详情请参见表4。 |
响应参数
状态码: 200
参数 |
参数类型 |
描述 |
---|---|---|
count |
Integer |
任务数量。 |
results |
Array of objects |
任务详细信息。 详情请参见表6。 |
参数 |
参数类型 |
描述 |
---|---|---|
id |
String |
任务ID。 |
parent_id |
String |
父任务ID。 |
name |
String |
任务名称。 |
status |
String |
任务状态。
枚举值:
|
description |
String |
描述信息。 |
create_time |
String |
创建时间,时间戳格式。 |
task_type |
String |
任务模式。取值:
|
source_endpoint |
Object |
源库信息体。 详情请参见表7。 |
dmq_endpoint |
Object |
DMQ信息体。 详情请参见表7。 |
source_sharding |
Array of objects |
物理源库信息。 详情请参见表7。 |
target_endpoint |
Object |
目标库信息体。 详情请参见表7。 |
net_type |
String |
网络类型。取值:
|
failed_reason |
String |
失败原因。 |
inst_info |
Object |
迁移实例信息。 详情请参见表9。 |
actual_start_time |
String |
实际启动时间,时间戳格式。 |
full_transfer_complete_time |
String |
全量完成时间,时间戳格式。 |
update_time |
String |
更新时间,时间戳格式。 |
job_direction |
String |
任务方向。取值:
|
db_use_type |
String |
迁移场景。取值:
|
need_restart |
Boolean |
是否需要重启。 |
is_target_readonly |
Boolean |
指定目标实例是否限制为只读。 |
conflict_policy |
String |
冲突忽略策略。取值:
|
filter_ddl_policy |
String |
过滤DDL策略。取值:
|
speed_limit |
Array of objects |
迁移速度限制。 详情请参见表10。 |
schema_type |
String |
迁移方案。取值:
|
node_num |
String |
节点个数。 |
object_switch |
Boolean |
对象选择开关 |
master_job_id |
String |
主任务ID。 |
full_mode |
String |
全量快照模式。 |
struct_trans |
Boolean |
是否迁移结构。 |
index_trans |
Boolean |
否迁移索引。 |
replace_definer |
Boolean |
是否使用目标库的用户替换掉definer。 |
migrate_user |
Boolean |
是否迁移用户。 |
sync_database |
Boolean |
是否库级同步。 |
error_code |
String |
错误码。 |
error_message |
String |
错误信息。 |
target_root_db |
Object |
目标实例根节点库信息。 详情请参见表11。 |
az_code |
String |
node所在AZ。 |
vpc_id |
String |
node所在VPC。 |
subnet_id |
String |
node所在子网。 |
security_group_id |
String |
node所在安全组。 |
multi_write |
Boolean |
是否多主灾备任务,双主灾备时有值为true。 |
support_ip_v6 |
Boolean |
是否支持IPV6。 |
inherit_id |
String |
继承的任务ID。 |
gtid |
String |
断点的GTID集合。 |
alarm_notify |
Object |
异常通知设置信息。 详情请参见表12。 |
is_multi_az |
Boolean |
是否是主备任务。 |
az_name |
String |
node所在节点AZ名称。 |
master_az |
String |
主备任务主AZ。 |
slave_az |
String |
主备任务备AZ。 |
node_role |
String |
任务主备角色。 |
incre_start_position |
String |
增量任务启动位点。 |
period_order |
Object |
包年/包月信息。 详情请参见表14。
说明:
包年/包月任务才会返回该参数。 |
object_infos |
Array of objects |
已同步对象信息。 详情请参见表15。 |
original_job_direction |
String |
任务创建时的direction。取值:
|
data_transformation |
Object |
数据过滤配置信息。 详情请参见表16。 |
tags |
Array of objects |
任务标签。 详情请参见表21。 |
public_ip_list |
Array of objects |
指定公网IP的信息。 详情请参见表22。 |
bind_public_ip_state |
String |
是否成功绑定公网IP。 |
children |
Array of objects |
多任务时,存在子任务绑定失败时,返回子任务的信息。 详情请参见表23。 |
is_open_fast_clean |
Boolean |
是否开启云数据库RDS for MySQL或MariaDB的Binlog快速清理。 |
参数 |
参数类型 |
描述 |
---|---|---|
db_type |
String |
数据库类型。取值:
|
az_code |
String |
数据库所在可用区azCode。 |
region |
String |
数据库实例所在region,数据库为云上实例时,比如RDS实例时必填。 |
inst_id |
String |
数据库实例id,数据库为云上实例时,比如RDS实例时必填。 |
vpc_id |
String |
数据库所在的虚拟私有云ID。 |
subnet_id |
String |
数据库所在的子网ID。 |
security_group_id |
String |
数据库所在的安全组ID。 |
project_id |
String |
数据库实例所在的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集群运行模式,取值:
|
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 |
MongDB集群4.0及以上版本,当集群实例无法获取到分片节点的IP时,source_endpoint中需要填写,值为:Sharding4.0+。 缺省值:Sharding4.0+ 枚举值:Sharding4.0+ |
kafka_security_config |
Object |
Kafka安全认证相关,非安全认证不需要此参数。 详情请参见表8。 |
参数 |
参数类型 |
描述 |
---|---|---|
type |
String |
安全协议,安全认证时必填,对应Kafka字段:security.protocol。
枚举值:
|
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,支持以下四项,取值:
|
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。 |
参数 |
参数类型 |
描述 |
---|---|---|
engine_type |
String |
DRS任务引擎类型。取值:
详细取值可参考引擎类型说明。 |
inst_type |
String |
实例类型。取值:high |
ip |
String |
迁移实例所在的私有IP。 |
public_ip |
String |
迁移实例所在的公网IP。 |
start_time |
String |
迁移实例任务定时启动时间。 |
status |
String |
迁移实例的状态。取值:
|
volume_size |
Integer |
迁移实例的磁盘大小。 |
参数 |
参数类型 |
描述 |
---|---|---|
begin |
String |
开始限速时间。 |
end |
String |
结束时间。 |
is_utc |
Boolean |
是否为UTC时间。 |
speed |
String |
限速。 |
参数 |
参数类型 |
描述 |
---|---|---|
subscriptions |
Array of objects |
SMN信息。 详情请参见表13。 |
topic_name |
String |
主题名称。 |
delay_time |
Long |
订阅延迟时间。 |
rto_delay |
Long |
RTO延迟时间。 |
rpo_delay |
Long |
RPO延迟时间。 |
alarm_to_user |
Boolean |
异常告警是否通知用户。 |
参数 |
参数类型 |
描述 |
---|---|---|
endpoints |
Array of strings |
短信或者邮件列表 |
protocol |
String |
收件方式,sms:短信,email:邮件。 枚举值:
|
参数 |
参数类型 |
描述 |
---|---|---|
status |
String |
订单状态。 |
order_id |
String |
订单ID。 |
charging_mode |
Integer |
计费模式。 取值范围:
|
period_type |
Integer |
订购周期类型。 取值范围:
|
period_num |
Integer |
订购周期数。 取值范围:
|
is_auto_renew |
Integer |
是否自动续订。 取值范围:
|
eff_time |
String |
资源生效时间(即资源创建时间);UTC时间,格式:yyyy-MM-ddTHH:mm:ssZ(2016-06-28T00:00:00Z)。 |
exp_time |
String |
资源失效时间(包周期资源:即资源到期时间,如果已经进行了续费,即为续费后的到期时间),UTC时间,格式:yyyy-MM-ddTHH:mm:ssZ(2016-03-28T00:00:00Z)。 |
参数 |
参数类型 |
描述 |
---|---|---|
id |
String |
type为database时,为库名;type为table或者view时,字段值参考示例。 |
parent_id |
String |
type为table或view时为库名。 |
type |
String |
类型。取值:
|
name |
String |
数据库对象名称,库名、表名、视图名。 |
alias_name |
String |
别名,映射的新名称。 |
参数 |
参数类型 |
描述 |
---|---|---|
total_count |
Long |
数据过滤条件总数。 |
filter_conditions |
Array of objects |
数据过滤配置信息。 约束:最大支持返回10000条数据过滤条件。 详情请参见表17。 |
参数 |
参数类型 |
描述 |
---|---|---|
transformation_info |
Object |
普通行过滤数据加工配置。 详情请参见表19。 |
config_transformation |
Object |
行过滤高级配置信息。 详情请参见表20。 |
data_transformation_object_infos |
Array of objects |
数据过滤对象信息。 详情请参见表18。 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
id |
否 |
String |
数据库对象、数据库表名称和过滤类型名称,例如格式为db1-*-*-tb1-*-*---conditionFilter--。 |
data_transformation_type |
否 |
String |
|
schema_name |
否 |
String |
数据加工选择的schema名称。 |
table_name |
否 |
String |
数据加工选择的表名称。 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
transformation_type |
是 |
String |
|
value |
是 |
String |
过滤条件,生成加工规则值为sql条件语句,生成配置规则值为config。长度限制256。 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
db_table_name |
是 |
String |
库名.表名,例如格式为lxl_test1.test_1,其中lxl_test1为库名,test_1为表名。 |
db_name |
是 |
String |
库名。长度限制256。 |
table_name |
是 |
String |
表名。长度限制256。 |
col_names |
是 |
String |
列名。长度限制256。 |
prim_key_or_index |
是 |
String |
主键或唯一索引。长度限制256。 |
indexs |
是 |
String |
优化查询所需的索引。长度限制256。 |
values |
是 |
String |
过滤条件。长度限制256。 |
请求示例
查询任务详情请求示例:
https://{endpoint}/v3/054ba152d480d55b2f5dc0069e7ddef0/jobs/batch-detail { "jobs" : [ "24834eb6-be30-464e-a299-f7aa730jb101", "140b5236-88ad-43c8-811c-1268453jb101" ], "page_req" : { "cur_page" : 1, "per_page" : 10 } }
响应示例
状态码: 200
OK
{ "count" : 2, "results" : [ { "id" : "24834eb6-be30-464e-a299-f7aa730jb101", "name" : "DRS-3999-lws", "status" : "STARTJOBING", "description" : "", "create_time" : "1608519469412", "task_type" : "FULL_INCR_TRANS", "source_endpoint" : { "ip" : "172.22.74.56", "region" : "cn-xianhz-1", "db_type" : "mysql", "db_port" : 3306, "ssl_link" : false, "project_id" : "054ba152d480d55b2f5dc0069e7ddef0", "db_user" : "root" }, "target_endpoint" : { "ip" : "172.21.176.219", "region" : "cn-xianhz-1", "db_type" : "mysql", "db_port" : 3306, "ssl_link" : false, "inst_id" : "3ef57dbcc8db478a9e346d26ef2575bfin01", "project_id" : "054ba152d480d55b2f5dc0069e7ddef0", "inst_name" : "rds-lws-target", "db_user" : "root", "vpc_id" : "0ff8df7b-f0e9-4b16-ac16-1db3dacb69e4", "subnet_id" : "f857d371-2f03-4622-85f6-2b7d42d0d82c" }, "inst_info" : { "ip" : "172.16.213.101", "inst_type" : "high", "engine_type" : "mysql", "volume_size" : 100, "public_ip" : "******", "start_time" : "0" }, "actual_start_time" : "1608520069393", "update_time" : "1608520068979", "job_direction" : "up", "db_use_type" : "migration", "need_restart" : false, "is_target_readonly" : true, "speed_limit" : [ ], "schema_type" : "Tungsten", "object_switch" : true, "replace_definer" : true, "migrate_user" : false, "az_code" : "az2xahz", "vpc_id" : "0ff8df7b-f0e9-4b16-ac16-1db3dacb69e4", "subnet_id" : "f857d371-2f03-4622-85f6-2b7d42d0d82c", "security_group_id" : "d90c971b-4b9d-402c-9c59-5c239389b8dd", "support_ip_v6" : false, "original_job_direction": "up", "is_open_fast_clean": true, "object_infos":[{ "id":"test", "type":"database", "name":"test", "select":"true" },{ "id":"test-*-*-table01", "type":"table", "name":"table01", "select":"true", "parent_id":"test" }] }, { "id" : "140b5236-88ad-43c8-811c-1268453jb101", "name" : "DRS-0042-linxiaolu", "status" : "CONFIGURATION", "description" : "", "create_time" : "1608366204171", "task_type" : "FULL_INCR_TRANS", "source_endpoint" : { "ip" : "192.168.0.27", "region" : "cn-xianhz-1", "db_type" : "mysql", "db_port" : 3306, "ssl_link" : false, "project_id" : "054ba152d480d55b2f5dc0069e7ddef0", "db_user" : "root" }, "target_endpoint" : { "ip" : "192.168.0.131", "region" : "cn-xianhz-1", "db_type" : "mysql", "db_port" : 3306, "ssl_link" : false, "inst_id" : "e05a3679efe241d8b5dee80b17c1a863in01", "project_id" : "054ba152d480d55b2f5dc0069e7ddef0", "inst_name" : "rds-1417-lxl", "db_user" : "root", "vpc_id" : "65f0391c-0582-44a6-aa50-248f97ed82e1", "subnet_id" : "352ad828-3467-4f03-987a-c55a5a9dd417" }, "inst_info" : { "ip" : "192.168.0.229", "status" : "ACTIVE", "inst_type" : "high", "engine_type" : "mysql", "volume_size" : 100, "public_ip" : "10.154.219.72", "start_time" : "0" }, "actual_start_time" : "1608369232412", "full_transfer_complete_time" : "1608369510202", "update_time" : "1608517066434", "job_direction" : "up", "db_use_type" : "migration", "need_restart" : false, "is_target_readonly" : true, "speed_limit" : [ ], "schema_type" : "Tungsten", "object_switch" : false, "replace_definer" : true, "migrate_user" : false, "tags": [{ "key1" : "value1", "key2" : "value2" }], "az_code" : "az2xahz", "vpc_id" : "65f0391c-0582-44a6-aa50-248f97ed82e1", "subnet_id" : "352ad828-3467-4f03-987a-c55a5a9dd417", "security_group_id" : "d90c971b-4b9d-402c-9c59-5c239389b8dd", "support_ip_v6" : false, "original_job_direction": "up", "object_infos":[{ "id":"test2", "type":"database", "name":"test2", "select":"true" },{ "id":"test2-*-*-table02", "type":"table", "name":"table02", "select":"true", "parent_id":"test2" }] } ], "data_transformation": { "total_count": 2, "filter_conditions": [ { "data_transformation_object_infos": [ { "id": "test02-*-*-table02-*-*---conditionFilter--", "db_name": "test02", "table_name": "table02", "data_transformation_type": "contentConditionalFilter" } ], "transformation_info": { "value": "id1<1", "transformation_type": "contentConditionalFilter" } }, { "data_transformation_object_infos": [ { "id": "test02-*-*-table01-*-*---configConditionFilter--", "db_name": "test02", "table_name": "test01", "data_transformation_type": "configConditionalFilter" } ], "transformation_info": { "value": "config", "transformation_type": "configConditionalFilter" }, "config_transformation": { "indexs": "id", "values": "id <= 6", "db_table_name": "test02.table01", "db_name": "test02", "table_name": "table01", "col_names": "id", "prim_key_or_index": "id" } } ] } }
状态码
状态码 |
描述 |
---|---|
200 |
OK |
错误码
请参见错误码。