# 批量查询任务详情 - BatchListJobDetails #### 功能介绍 根据任务ID批量查询任务详情。 #### 调试 您可以在[API Explorer](https://apiexplorer.developer.huaweicloud.com/apiexplorer/doc?product=DRS&api=BatchListJobDetails)中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。 #### 接口约束 为保证接口调用性能，建议批量调用数量不超过10个。 #### 授权信息 账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-drs/drs_api_0035.html)。 #### URI POST /v3/{project_id}/jobs/batch-detail 表1路径参数 | **参数** | **是否必选** | **参数类型** | **描述** | |:---|:---|:---|:---| | project_id | 是 | String | **参数解释：** 租户在某一Region下的Project ID。 获取方法请参见[获取项目ID](https://support.huaweicloud.com/api-drs/drs_api_0106.html)。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 | #### 请求参数 表2请求Header参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | 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** | 表3请求Body参数 | **参数** | **是否必选** | **参数类型** | **描述** | |:---|:---|:---|:---| | jobs | 是 | Array of strings | **参数解释**： 批量查询任务详情请求体。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 **默认取值**： 不涉及。 | | page_req | 否 | Object | **参数解释**： 分页信息。 详情请参见[表4]。 | 表4page_req字段数据结构说明 | **参数** | **是否必选** | **参数类型** | **描述** | |:---|:---|:---|:---| | cur_page | 否 | Integer | **参数解释**： 当前页码，用于分页查询时指定返回第几页的数据。 **约束限制**： 不能超过传入jobID数量除每页任务数量的最大页码。如果为0，则获取全部任务信息。 **取值范围**： 0-整数上限。 **默认取值**： 1 | | per_page | 否 | Integer | **参数解释**： 每页任务数量，如果为0，则获取全部任务信息。 **约束限制**： 不涉及 **取值范围**： 0-100。 **默认取值**： 5 | #### 响应参数 **状态码：200** 表5响应Body参数 | **参数** | **参数类型** | **描述** | |:---|:---|:---| | count | Integer | **参数解释**： 任务数量。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 | | results | Array of objects | **参数解释**： 任务详细信息。 详情请参见[表6]。 | 表6results字段数据结构说明 | **参数** | **参数类型** | **描述** | |:---|:---|:---| | id | String | **参数解释**： 任务ID。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 | | parent_id | String | **参数解释**： 父任务ID。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 | | name | String | **参数解释**： 任务名称。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 | | status | String | **参数解释**： 任务状态。 **约束限制**： 不涉及。 **取值范围**： - CREATING：创建中。 - CREATE_FAILED：创建失败。 - CONFIGURATION：配置中。 - STARTJOBING：启动中。 - WAITING_FOR_START：等待启动中。 - START_JOB_FAILED：启动失败。 - PAUSING：已暂停。 - FULL_TRANSFER_STARTED：全量开始，灾备场景下为初始化。 - FULL_TRANSFER_FAILED：全量失败，灾备场景下为初始化失败。 - FULL_TRANSFER_COMPLETE：全量完成，灾备场景下为初始化完成。 - INCRE_TRANSFER_STARTED：增量开始，灾备场景下为灾备中。 - INCRE_TRANSFER_FAILED：增量失败，灾备场景下为灾备异常。 - RELEASE_RESOURCE_STARTED：结束任务中。 - RELEASE_RESOURCE_FAILED：结束任务失败。 - RELEASE_RESOURCE_COMPLETE：已结束。 - REBUILD_NODE_STARTED：故障恢复中。 - REBUILD_NODE_FAILED：故障恢复失败。 - CHANGE_JOB_STARTED：任务变更中。 - CHANGE_JOB_FAILED：任务变更失败。 - DELETED：已删除。 - CHILD_TRANSFER_STARTING：再编辑子任务启动中。 - CHILD_TRANSFER_STARTED：再编辑子任务迁移中。 - CHILD_TRANSFER_COMPLETE：再编辑子任务迁移完成。 - CHILD_TRANSFER_FAILED：再编辑子任务迁移失败。 - RELEASE_CHILD_TRANSFER_STARTED：再编辑子任务结束中。 - RELEASE_CHILD_TRANSFER_COMPLETE：再编辑子任务已结束。 - NODE_UPGRADE_START：升级开始。 - NODE_UPGRADE_COMPLETE：升级完成。 - NODE_UPGRADE_FAILED：升级失败。 | | description | String | **参数解释**： 描述信息。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 | | create_time | String | **参数解释**： 创建时间，时间戳格式。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 | | task_type | String | **参数解释**： 任务模式。 **约束限制**： 不涉及。 **取值范围**： - **FULL_TRANS**：全量。 - **INCR_TRANS**：增量。 - **FULL_INCR_TRANS**：全量+增量。 | | source_endpoint | Object | **参数解释**： 源库信息体。 详情请参见[表7]。 | | dmq_endpoint | Object | **参数解释**： DMQ信息体。 详情请参见[表7]。 | | source_sharding | Array of objects | **参数解释**： 物理源库信息。 详情请参见[表7]。 | | target_endpoint | Object | **参数解释**： 目标库信息体。 详情请参见[表7]。 | | net_type | String | **参数解释**： 网络类型。 **约束限制**： 不涉及。 **取值范围**： - **vpn**：VPN网络。 - **vpc**：VPC网络。 - **eip** **：**EIP网络。 | | failed_reason | String | **参数解释**： 失败原因。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 | | inst_info | Object | **参数解释**： 迁移实例信息。 详情请参见[表9]。 | | actual_start_time | String | **参数解释**： 实际启动时间，时间戳格式。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 | | full_transfer_complete_time | String | **参数解释**： 全量完成时间，时间戳格式。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 | | update_time | String | **参数解释**： 更新时间，时间戳格式。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 | | job_direction | String | **参数解释**： 任务方向。 **约束限制**： 不涉及。 **取值范围**： - **up** ：入云，灾备场景时对应本云为备**。** - **down**：出云，灾备场景时对应本云为主。 - **non-dbs**：自建。 | | job_kernel_direction | String | **参数解释**： 灾备内核方向，非倒换中与job_direction取值相同，倒换中与job_direction取值相反。 **约束限制**： 不涉及。 **取值范围**： - **up**：入云，灾备场景时对应本云为备。 - **down**：出云，灾备场景时对应本云为主。 | | db_use_type | String | **参数解释**： 迁移场景。 **约束限制**： 不涉及。 **取值范围**： - **migration**：实时迁移。 - **sync**：实时同步。 - **cloudDataGuard**：实时灾备。 | | need_restart | Boolean | **参数解释**： 是否需要重启。 **约束限制**： 不涉及。 **取值范围**： - **true**：需要重启。 - **false**：不需要重启。 | | is_target_readonly | Boolean | **参数解释**： 指定目标实例是否限制为只读。 **约束限制**： 不涉及。 **取值范围**： - **true**：指定目标实例限制为只读。 - **false**：指定目标实例不限制为只读。 | | conflict_policy | String | **参数解释**： 冲突忽略策略。 **约束限制**： 不涉及。 **取值范围**： - **stop**：冲突失败。 - **overwrite**：冲突覆盖。 - **ignore**：冲突忽略。 | | filter_ddl_policy | String | **参数解释**： 过滤DDL策略。 **约束限制**： 不涉及。 **取值范围**： - **drop_database**：过滤。 - **drop_databasefilter_all**：过滤所有DDL。 - **""**：不过滤。 | | speed_limit | Array of objects | **参数解释**： 迁移速度限制。 详情请参见[表10]。 | | schema_type | String | **参数解释**： 迁移方案。 **约束限制**： 不涉及。 **取值范围**： - **Replication**：主从复制。 - **Tungsten**：日志解析。 - **PGBaseBackup**：PG备份。 | | node_num | String | **参数解释**： 节点个数。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 | | object_switch | Boolean | **参数解释**： 对象选择开关。 **约束限制**： 不涉及。 **取值范围**： - **true**：开启对象选择。 - **false**：关闭对象选择。 | | master_job_id | String | **参数解释**： 主任务ID。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 | | full_mode | String | **参数解释**： 全量快照模式。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 | | struct_trans | Boolean | **参数解释**： 是否迁移结构。 **约束限制**： 不涉及。 **取值范围**： - **true**：迁移结构。 - **false**：不迁移结构。 | | index_trans | Boolean | **参数解释**： 是否迁移索引。 **约束限制**： 不涉及。 **取值范围**： - **true**：迁移索引。 - **false**：不迁移索引。 | | replace_definer | Boolean | **参数解释**： 是否使用目标库的用户替换掉definer。 **约束限制**： 不涉及。 **取值范围**： - **true**：使用目标库的用户替换掉definer。 - **false**：不使用目标库的用户替换掉definer。 | | migrate_user | Boolean | **参数解释**： 是否迁移用户。 **约束限制**： 不涉及。 **取值范围**： - **true**：迁移用户。 - **false**：不迁移用户。 | | sync_database | Boolean | **参数解释**： 是否库级同步。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 - **true**：库级同步。 - **false**：非库级同步。 | | 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。 **约束限制**： 不涉及。 **取值范围**： - **true**：多主灾备。 - **false**：非多主灾备。 | | support_ip_v6 | Boolean | **参数解释**： 是否支持IPV6。 **约束限制**： 不涉及。 **取值范围**： - **true**：支持IPV6。 - **false**：不支持IPV6。 | | inherit_id | String | **参数解释**： 继承的任务ID。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 | | gtid | String | **参数解释**： 断点的GTID集合。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 | | alarm_notify | Object | **参数解释**： 异常通知设置信息。 详情请参见[表12]。 | | is_multi_az | Boolean | **参数解释**： 是否是主备任务。 **约束限制**： 不涉及。 **取值范围**： - **true**：是主备任务。 - **false**：非主备任务。 | | 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。 **约束限制**： 不涉及。 **取值范围**： - **up** ：入云，灾备场景时对应本云为备**。** - **down**：出云，灾备场景时对应本云为主。 - **non-dbs**：自建。 | | 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快速清理。 **约束限制**： 不涉及。 **取值范围**： - **true**：开启开始清理。 - **false**：不开启开始清理。 | 表7source_endpoint、dmq_endpoint、source_sharding和target_endpoint字段数据结构说明 | **参数** | **参数类型** | **描述** | |:---|:---|:---| | db_type | String | **参数解释**： 数据库类型。 **约束限制**： 不涉及。 **取值范围**： - **mysql**：MySQL - **mongodb**：MongoDB - **gaussdbv5**：GaussDB分布式版 - **taurus**：TaurusDB - **gaussdbv5ha**：GaussDB集中式版 - **kafka**：Kafka - **postgresql**：PostgreSQL - **oracle**：Oracle | | 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集群运行模式。 **约束限制**： 不涉及。 **取值范围**： - **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+** | | kafka_security_config | Object | **参数解释**： Kafka安全认证相关，非安全认证不需要此参数。 详情请参见[表8]。 | 表8kafka_security_config字段数据结构说明 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | 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 **约束限制**： 不涉及。 **取值范围**： - 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。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 | 表9inst_info字段数据结构说明 | **参数** | **参数类型** | **描述** | |:---|:---|:---| | 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。 详细取值可参考[引擎类型说明](https://support.huaweicloud.com/api-drs/drs_api_0159.html)。 | | inst_type | String | **参数解释**： 实例类型。 **约束限制**： 不涉及。 **取值范围**： - **common** - **high** - **ultrahigh** | | ip | String | **参数解释**： 迁移实例所在的私有IP。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 | | public_ip | String | **参数解释**： 迁移实例所在的公网IP。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 | | start_time | String | **参数解释**： 迁移实例任务定时启动时间。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 | | status | String | **参数解释**： 迁移实例的状态。 **约束限制**： 不涉及。 **取值范围**： - **active** - **deleted** | | volume_size | Integer | **参数解释**： 迁移实例的磁盘大小。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 | 表10speed_limit字段数据结构说明 | **参数** | **参数类型** | **描述** | |:---|:---|:---| | begin | String | **参数解释**： 开始限速时间。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 | | end | String | **参数解释**： 结束时间。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 | | is_utc | Boolean | **参数解释**： 是否为UTC时间。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 | | speed | String | **参数解释**： 限速。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 | 表11target_root_db字段数据结构说明 | **参数** | **参数类型** | **描述** | |:---|:---|:---| | db_name | String | **参数解释**： 库名。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 | | db_encoding | String | **参数解释**： 编码格式。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 | 表12alarm_notify字段数据结构说明 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | subscriptions | Array of objects | **参数解释**： SMN信息。 详情请参见[表13]。 | | topic_name | String | **参数解释**： 主题名称。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 | | delay_time | Long | **参数解释**： 订阅延迟时间。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 | | rto_delay | Long | **参数解释**： RTO延迟时间。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 | | rpo_delay | Long | **参数解释**： RPO延迟时间。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 | | alarm_to_user | Boolean | **参数解释**： 异常告警是否通知用户。 **约束限制**： 不涉及。 **取值范围**： - **true**：通知用户。 - **false**：不通知用户。 | 表13subscriptions字段数据结构说明 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | endpoints | Array of strings | **参数解释**： 短信或者邮件列表。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 | | protocol | String | **参数解释**： 收件方式。 **约束限制**： 不涉及。 **取值范围**： - **sms**：短信。 - **email**：邮件。 | 表14period_order字段数据结构说明 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | status | String | **参数解释**： 订单状态。 **约束限制**： 不涉及。 **取值范围**： - INITIALIZATION：初始化 - AWAITING_AUDIT：待审核 - AWAITING_REFUND：待退款 - PROCESSING：处理中 - CANCELED：已取消 - COMPLETED：已完成 - AWAITING_PAID：待付款 - AWAITING_APPROVE：待审批 - UNORDERED：未下单 - FROZEN_CAN_RENEW：冻结可续费 - FROZEN_CAN_UNSUBSCRIBE：冻结可退订 - FROZEN_CAN_RENEW_FREE：冻结可续费可结束 - FROZEN_CAN_FREE：冻结可结束 - LOCK_RESOURCE：限制资源锁定 | | order_id | String | **参数解释**： 订单ID。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 | | charging_mode | Integer | **参数解释**： 计费模式。 **约束限制**： 不涉及。 **取值范围**： - 0：包年包月。 - 1：按需计费。 | | period_type | Integer | **参数解释**： 订购周期类型。 **约束限制**： 不涉及。 **取值范围**： - 2：周期类型为月。 - 3：周期类型为年。 | | period_num | Integer | **参数解释**： 订购周期数。 **约束限制**： 不涉及。 **取值范围**： - period_type=2（周期类型为月）时，取值为\[1，9\]。 - period_type=3（周期类型为年）时，取值为\[1，3\]。 | | is_auto_renew | Integer | **参数解释**： 是否自动续订。 **约束限制**： 不涉及。 **取值范围**： - 0：不自动续订。 - 1：自动续订。 | | 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）。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 | 表15object_infos字段数据结构说明 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | id | String | **参数解释**： type为database时，为库名；type为table或者view时，字段值参考示例。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 | | parent_id | String | **参数解释**： type为table或view时为库名。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 | | type | String | **参数解释**： 类型。 **约束限制**： 不涉及。 **取值范围**： - **table**：表名 - **function**：函数 - **database**：SCHEMA - **procedure**：存储过程 | | name | String | **参数解释**： 数据库对象名称，库名、表名、视图名。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 | | alias_name | String | **参数解释**： 别名，映射的新名称。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 | 表16data_transformation字段数据结构说明 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | total_count | Long | **参数解释**： 数据过滤条件总数。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 | | filter_conditions | Array of objects | **参数解释**： 数据过滤配置信息。 约束：最大支持返回10000条数据过滤条件。 详情请参见[表17]。 | 表17filter_conditions字段数据结构说明 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | transformation_info | Object | **参数解释**： 普通行过滤数据加工配置。 详情请参见[表19]。 | | config_transformation | Object | **参数解释**： 行过滤高级配置信息。 详情请参见[表20]。 | | data_transformation_object_infos | Array of objects | **参数解释**： 数据过滤对象信息。 详情请参见[表18]。 | 表18data_transformation_object_infos字段数据结构说明 | **参数** | **是否必选** | **参数类型** | **描述** | |:---|:---|:---|:---| | id | 否 | String | **参数解释**： 数据库对象、数据库表名称和过滤类型名称，例如格式为db1-\*-\*-tb1-\*-\*---conditionFilter--。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 | | data_transformation_type | 否 | String | **参数解释**： 数据加工过滤规则或配置规则的值。 **约束限制**： 不涉及。 **取值范围**： - **contentConditionalFilter**：生成加工规则值。 - **configConditionalFilter**：生成配置规则值。 | | schema_name | 否 | String | **参数解释**： 数据加工选择的schema名称。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 | | table_name | 否 | String | **参数解释**： 数据加工选择的表名称。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 | 表19transformation_info字段数据结构说明 | **参数** | **是否必选** | **参数类型** | **描述** | |:---|:---|:---|:---| | transformation_type | 是 | String | **参数解释**： 数据加工过滤规则或配置规则的值。 **约束限制**： 不涉及。 **取值范围**： - **contentConditionalFilter：**生成加工规则值。 - **configConditionalFilter** | | value | 是 | String | **参数解释**： 过滤条件，生成加工规则值为sql条件语句，生成配置规则值为config。长度限制256。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 | 表20config_transformation字段数据结构说明 | **参数** | **是否必选** | **参数类型** | **描述** | |:---|:---|:---|:---| | 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。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 | 表21tags字段数据结构说明 | **参数** | **是否必选** | **参数类型** | **描述** | |:---|:---|:---|:---| | key | 是 | String | **参数解释**： 标签key。 **约束限制**： 不涉及。 **取值范围**： - "key1" : "value1" - "key2" : "value2" | | value | 是 | String | **参数解释**： 标签value。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 | 表22public_ip_list字段数据结构说明 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | id | String | **参数解释**： 指定公网IP的ID。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 | | public_ip | String | **参数解释**： 指定公网IP。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 | | type | String | **参数解释**： 指定公网IP绑定任务的类型。 **约束限制**： - 主备任务：主是master，备是slave。 - 其他固定为master。 **取值范围**： - **master** - **slave** | 表23children字段数据结构说明 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | id | String | **参数解释**： 子任务ID。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 | | name | String | **参数解释**： 子任务名称。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 | #### 请求示例 查询任务详情请求示例： ``` 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 | 其他状态请参见[状态码](https://support.huaweicloud.com/api-drs/drs_api_0108.html)。 #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-drs/drs_05_0004.html)。