# 查询任务详情 - ShowJobDetail #### 功能介绍 查询任务详情。 #### 调试 您可以在[API Explorer](https://apiexplorer.developer.huaweicloud.com/apiexplorer/doc?product=DRS&api=ShowJobDetail&version=v5)中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。 #### 接口约束 - 目前仅支持Redis单机/主备-\>GeminiDB Redis迁移、Redis集群-\>GeminiDB Redis迁移、MySQL-\>MySQL迁移与同步、Oracle-\>GaussDB分布式同步场景。 - 仅支持部分Region使用，详情参考[终端节点](https://support.huaweicloud.com/api-drs/drs_api_0111.html)。 #### 授权信息 账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。 - 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-drs/drs_api_0035.html)。 - 如果使用身份策略授权，当前API调用无需身份策略权限。 #### URI GET /v5/{project_id}/jobs/{job_id} 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | project_id | 是 | String | **参数解释**： 租户在某一Region下的Project ID。 获取方法请参见[获取项目ID](https://support.huaweicloud.com/api-drs/drs_api_0106.html)。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 **默认取值**： 不涉及 | | job_id | 是 | String | **参数解释**： 任务ID，用于唯一标识一个数据复制任务，在查询、修改、删除等操作中作为任务的识别凭证。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 **默认取值**： 不涉及 | 表2Query参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | type | 是 | String | **参数解释**： 任务详情类型，指定查询任务详情的信息类别。 **约束限制**： 不涉及。 **取值范围**： - detail：任务基本信息。 - network：测试连接结果信息，需配合query_id参数一起查询。 - precheck：预检查结果信息，需配合query_id参数一起查询。 - progress：任务进度信息。 - log：任务日志信息，支持分页查询参数offset与limit。 - compare：查询对比任务。 - file：对象导入信息。 - is_writable：目标库解除只读结果。 - cloud_connection：录制回放他云连通性测试，需配合query_id参数一起查询。 - diagnosis：查询一键诊断结果，需配合query_id参数一起查询。 - diagnosis_history：查询一键诊断历史结果。 - repair_progress：数据修复进度，需配合query_id参数一起查询。 - repair_detail：数据修复详情，需配合query_id参数一起查询。 - repair_export_status：查询数据修复SQL导出状态，需配合compare_task_id参数一起查询。 **默认取值**： 不涉及。 | | query_id | 否 | String | **参数解释**： 通过指定Query ID查询任务详情，部分type类型需通过触发该操作的请求返回的query_id进行操作结果查询。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 **默认取值**： 不涉及。 | | offset | 否 | Integer | **参数解释**： 偏移量，表示查询该偏移量后面的记录，用于分页查询。 **约束限制**： 部分type类型的任务详情支持分页查询，可以通过传递该参数进行分页控制。 **取值范围**： 不涉及。 **默认取值**： 不涉及。 | | limit | 否 | Integer | **参数解释**： 查询返回记录的数量限制，用于分页查询时控制每页返回的数据条数。 **约束限制**： 部分type类型的任务详情支持分页查询。 **取值范围**： 不涉及。 **默认取值**： 不涉及。 | | compare_type | 否 | String | **参数解释**： 对比任务类型，type参数是compare时必填。 **约束限制**： type参数是compare时必填。 **取值范围**： - object_compare：对象对比。 - line_compare：行对比。 - content_compare：内容对比。 - data_compare：数据对比。 **默认取值**： 不涉及。 | | query_type | 否 | String | **参数解释**： 查询对比内容。 **约束限制**： type参数是compare时必填。 **取值范围**： - overview：对比任务概览。 - list：数据对比任务列表。 - detail：对比详情。 - diff：不一致详情。 **默认取值**： 不涉及。 | | object_type | 否 | String | **参数解释**： 查询对象对比详情类型。 **约束限制**： 选择对象比对时必填。 **取值范围**： - DB：库级对比详情。 - TABLE：表级对比详情。 - INDEX：索引对比详情。 **默认取值**： 不涉及。 | | compare_task_id | 否 | String | **参数解释**： 对比任务ID，用于指定查询的对比任务。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 **默认取值**： 不涉及。 | | source_db_name | 否 | String | **参数解释**： 数据对比源库名称，用于按源库筛选对比结果。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 **默认取值**： 不涉及。 | | target_db_name | 否 | String | **参数解释**： 数据对比目标库名称，用于按目标库筛选对比结果。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 **默认取值**： 不涉及。 | | compare_detail_type | 否 | String | **参数解释**： 对比结果类型，用于筛选对比完成或无法对比的记录。 **约束限制**： 不涉及。 **取值范围**： - compare：对比完成。 - uncompare：无法对比。 **默认取值**： 不涉及。 | | log_level | 否 | String | **参数解释**： 查询日志的级别，用于按日志严重程度筛选查询结果。 **约束限制**： 不涉及。 **取值范围**： - Info：提示级别。 - Warn：警告级别。 - Error：错误级别。 **默认取值**： 不涉及。 | #### 请求参数 表3请求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** | #### 响应参数 **状态码：200** 表4响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | job | Object | **参数解释**： 查询单任务详情响应体，包含任务的完整信息。 详情请参见[表5]。 | 表5job字段数据结构说明 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | id | String | **参数解释**： 任务ID，用于唯一标识一个数据复制任务。 **约束限制**： 不涉及。 **取值范围**： 不涉及 | | 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：升级失败 | | create_time | String | **参数解释**： 任务的创建时间，表示任务首次被创建的时间戳。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 | | total_count | Integer | **参数解释**： 列表中的项目总数，与分页无关。表示满足查询条件的记录总数量，用于分页计算。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 | | master_job_id | String | **参数解释**： 多任务主节点的任务ID，在多对一同步场景中标识主任务。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 | | base_info | Object | **参数解释**： 任务基本信息体，详情请参见[表6]。 | | source_endpoint | Array of objects | **参数解释**： 任务源数据库信息体，详情请参见[表8]。 | | target_endpoint | Array of objects | **参数解释**： 任务目标数据库信息体，详情请参见[表8]。 | | alarm_notify | Object | **参数解释**： 异常通知信息设置信息体。配置该参数时，代表当任务状态异常时，系统将发送通知给指定的SMN Topic。 详情请参见[表15]。 | | speed_limit | Array of objects | **参数解释**： 限速信息体。 - 限速：自定义的最大迁移速度，迁移过程中的迁移速度将不会超过该速度。 - 不限速：对迁移速度不进行限制，通常会最大化使用源数据库的出口带宽。 该流速模式同时会对源数据库造成读消耗，消耗取决于源数据库的出口带宽。比如：源数据库的出口带宽为100MB/s，假设高速模式使用了80%带宽，则迁移对源数据库将造成80MB/s的读操作IO消耗。 详情请参见[表16]。 | | user_migration | Object | **参数解释**： 用户迁移信息体，详情请参见[表17]。 | | policy_config | Object | **参数解释**： 策略信息体。设置迁移和同步任务的策略，包括冲突策略、过滤DROP Database、对象同步范围等。 详情请参见[表20]。 | | db_param | Object | **参数解释**： 数据库参数信息体，详情请参见[表21]。 | | tuning_params | Object | **参数解释**： 高级设置信息体，详情请参见[表23]。 | | period_order | Object | **参数解释**： 包年/包月信息体。 详情请参见[表25]。 | | node_info | Object | **参数解释**： 任务实例信息体。 详情请参见[表26]。 | | logs | Array of objects | **参数解释**： 日志查询结果信息体。 详情请参见[表30]。 | | network_results | Array of objects | **参数解释**： 网络打通测试结果信息体。 详情请参见[表31]。 | | precheck_result | Object | **参数解释**： 预检查结果信息体。 详情请参见[表32]。 | | progress_info | Object | **参数解释**： 任务进度信息体。 详情请参见[表35]。 | | migration_object_progress_info | Object | **参数解释**： 迁移中对象进度信息体。 详情请参见[表37]。 | | metrics | Object | **参数解释**： Node节点指标项。 详情请参见[表39]。 | | compare_result | Object | **参数解释**： 任务对比结果。 详情请参见[表40]。 | | support_import_file_resp | Object | **参数解释**： 对象导入信息。 详情请参见[表51]。 | | instance_features | Map\ | **参数解释**： 由开关和版本共同控制的任务级别的功能列表，格式为key/value键值对。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 | | task_version | String | **参数解释**： 任务版本，标识当前数据复制任务所使用的版本号。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 | | connection_management | Object | **参数解释**： 连接管理信息，详情请参见[表52]。 | | public_ip_list | Array of objects | **参数解释**： 指定公网IP的信息。 详情请参见[表54]。 | | bind_public_ip_state | String | **参数解释**： 是否成功绑定公网IP，标识为任务绑定公网IP操作的执行结果。 **约束限制**： 不涉及。 **取值范围**： - SUCCESS：成功 - FAILED：失败 | | children | Array of objects | **参数解释**： 多任务时，存在子任务绑定失败时，返回子任务的信息。 详情请参见[表55]。 | | is_writable | String | **参数解释**： 解除目标库只读操作后，目标库解除只读是否成功。 **约束限制**： 不涉及。 **取值范围**： - pending：目标库解除操作进行中 - success：目标库解除只读操作成功 | | diagnoses | Array of objects | **参数解释**： 一键诊断结果。 详情请见[表 QueryDiagnosisResult]。 | | repair_progress_info | object | **参数解释**： 修复进度明细。 详情请见[表 repair_progress_info]。 | | repair_detail_info | object | **参数解释**： 数据修复详情。 详情请见[表 QueryRepairDetailResp]。 | | repair_export_status | String | **参数解释**： 修复SQL导出状态，标识数据修复SQL文件的导出进度。 **约束限制**： 不涉及。 **取值范围**： - INIT：初始状态 - EXPORTING：比对结果导出中 - EXPORT_COMPLETE：比对结果导出完成 - EXPORT_COMMON_FAILED：比对结果导出失败 | | job_kernel_direction | String | **参数解释**： 灾备内核方向，非倒换中与job_direction取值相同，倒换中与job_direction取值相反。 **约束限制**： 不涉及。 **取值范围**： - up：入云，灾备场景时对应本云为备 - down：出云，灾备场景时对应本云为主 | 表6base_info字段数据结构说明 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | name | String | **参数解释**： 任务名称，用于标识和区分不同的数据复制任务。 **约束限制**： - 长度在4到50位之间，不区分大小写。 - 可以包含字母、数字、中划线或下划线，不能包括其他特殊字符。 **取值范围**： 不涉及。 | | job_type | String | **参数解释**： DRS任务场景类型，用于区分不同的数据复制场景。 **约束限制**： 不涉及。 **取值范围**： - migration：实时迁移 - sync：实时同步 - cloudDataGuard：实时灾备 | | multi_write | Boolean | **参数解释**： 灾备类型是否双主灾备，指定灾备场景下是否启用双向写入功能。 **约束限制**： - job_type为cloudDataGuard时必填。灾备类型是双主灾备时，multi_write取值true，否则为false。 - job_type 是其他类型时，multi_write是非必选参数。 **取值范围**： - true：双主灾备 - false：非双主灾备 **默认取值**： false | | engine_type | String | **参数解释**： DRS任务引擎类型。 **约束限制**： 不涉及。 **取值范围**： - oracle-to-gaussdbv5：Oracle同步到GaussDB分布式版，实时同步场景使用。 - mysql-to-mysql：MySQL到MySQL，实时迁移、实时同步场景使用。 - redis-to-gaussredis：Redis迁移到GeminiDB Redis，实时迁移场景使用。 - rediscluster-to-gaussredis：Redis集群迁移到GeminiDB Redis，实时迁移场景使用。 | | job_direction | String | **参数解释**： 任务的迁移方向。 **约束限制**： 不涉及。 **取值范围**： - up：入云，灾备场景时对应本云为备 - down：出云，灾备场景时对应本云为主 - non-dbs：自建 | | task_type | String | **参数解释**： 任务迁移模式，指定数据复制任务的执行方式。 **约束限制**： 不涉及。 **取值范围**： - FULL_TRANS：全量迁移，仅迁移历史数据 - FULL_INCR_TRANS：全量+增量迁移，先迁移历史数据再持续同步增量 - INCR_TRANS：增量迁移，仅同步数据变更 | | net_type | String | **参数解释**： 任务使用的网络类型。 **约束限制**： 灾备场景不支持选择VPC网络。 **取值范围**： - eip：公网网络。 - vpc：VPC网络。 - vpn：VPN、专线网络。 | | charging_mode | String | **参数解释**： 任务的计费模式，指定数据复制任务的付费方式。 **约束限制**： 不涉及。 **取值范围**： - period：包周期 - on_demand：按需 **默认取值**： on_deman | | enterprise_project_id | String | **参数解释**： 企业项目ID，用于按企业项目过滤查询结果。 **约束限制**： - 不传值时设置为null，不能设置为空字符串。 - 当企业项目开关打开时，可以传值。 **取值范围**： 不涉及。 **默认取值**： "0"，表示default企业项目 | | description | String | **参数解释**： 任务描述，用于对数据复制任务添加补充说明信息。 **约束限制**： - 长度不能超过256位。 - 不能包含!\<\>\&'"\\特殊字符。 **取值范围**： 不涉及。 | | start_time | String | **参数解释**： 任务定时启动时间，设置后任务将在指定时间自动启动。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 | | expired_days | String | **参数解释**： 任务处于异常状态一段时间后，将会自动结束。单位为天。 **约束限制**： 不涉及。 **取值范围**： 14-100 **默认取值**： 14 | | tags | Array of objects | **参数解释**： 标签信息，用于为数据复制任务添加标签以便分类管理。 详情请参见[表7]。 **约束限制**： - 最多添加20个标签。 | | is_open_fast_clean | Boolean | **参数解释**： 是否开启云数据库RDS for MySQL/MariaDB的binlog快速清理，开启后可自动清理已同步的binlog以释放磁盘空间。 **约束限制**： 仅MySQL/MariaDB引擎类型适用。 **取值范围**： - true：开启binlog快速清理 - false：不开启binlog快速清理 **默认取值**： false | 表7tags字段数据结构说明 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | key | String | **参数解释**： 标签键。 **约束限制**： 最大长度36，只能包含字母、数字、下划线、中划线和中文。 **取值范围**： 1-36。 | | value | String | **参数解释**： 标签值。 **约束限制**： 最大长度43，只能包含字母、数字、下划线、中划线和中文。 **取值范围**： 1-36。 | 表8source_endpoint和target_endpoint字段数据结构说明 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | db_type | String | **参数解释**： 数据库类型，标识源库或目标库的数据库引擎种类。 **约束限制**： 不涉及。 **取值范围**： - oracle：Oracle。 - gaussdbv5：GaussDB分布式版。 - redis：Redis单机/主备。 - rediscluster：Redis集群版。 - gaussredis: GeminiDB Redis。 | | endpoint_type | String | **参数解释**： 数据库实例类型，标识数据库的部署方式。 **约束限制**： 不涉及。 **取值范围**： - offline：自建数据库 - ecs：华为云ECS自建数据库 - cloud：华为云数据库 | | endpoint_role | String | **参数解释**： 数据库实例角色，标识该数据库在数据复制任务中是源端还是目标端。 **约束限制**： 不涉及。 **取值范围**： - so：源库 - ta：目标库 | | endpoint | Object | **参数解释**： 数据库基本信息体。 详情请参见[表9]。 | | cloud | Object | **参数解释**： 数据库实例所在Region，项目等信息。 详情请参见[表10]。 | | vpc | Object | **参数解释**： 数据库实例所在VPC，子网，安全组等信息。 详情请参见[表11]。 | | config | Object | **参数解释**： 数据库基本设置信息体。 详情请参见[表12]。 | | ssl | Object | **参数解释**： 数据库SSL证书信息体。 详情请参见[表13]。 | | customized_dns | Object | **参数解释**： 客户自定义DNS服务。 详情请参见[表14]。 | 表9endpoint和source_sharding字段数据结构说明 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | 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。 | | 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 | **参数解释**： 物理源库信息。 详情请参见[表9]。 | 表10cloud字段数据结构说明 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | region | String | **参数解释**： 区域ID。 **约束限制**： 当数据库实例类型为ecs（华为云ECS自建数据库），cloud（华为云数据库）时为必填项。获取方法请参见[地区和终端节点](https://developer.huaweicloud.com/endpoint)。 注意：当该Region下存在子项目时，Region ID为区域项目ID与子项目ID，由"_"下划线拼接，例如：cn-north-4_abc。 **取值范围**： 不涉及。 | | project_id | String | **参数解释**： 租户在某一Region下的Project ID。 获取方法请参见获取项目ID。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 | | az_code | String | **参数解释**： 数据库所在可用分区（AZ）名称。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 | 表11vpc字段数据结构说明 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | vpc_id | String | **参数解释**： 数据库实例所在的虚拟私有云ID，获取方法如下： 方法1：登录虚拟私有云服务的控制台界面，在虚拟私有云的详情页面查找VPC ID。 方法2：通过虚拟私有云服务的API接口查询，具体操作可参考[查询VPC列表](https://support.huaweicloud.com/api-vpc/vpc_api01_0003.html)。 | | subnet_id | String | **参数解释**： 数据库实例所在子网ID，获取方法如下： 方法1：登录虚拟私有云服务的控制台界面，单击VPC下的子网，进入子网详情页面，查找网络ID。 方法2：通过虚拟私有云服务的API接口查询，具体操作可参考[查询子网列表](https://support.huaweicloud.com/api-vpc/vpc_subnet01_0003.html)。 | | security_group_id | String | **参数解释**： 数据库实例所在的安全组ID，获取方法如下： 方法1：登录虚拟私有云服务的控制台界面，在安全组的详情页面查找安全组ID。 方法2：通过虚拟私有云服务的API接口查询，具体操作可参考[查询安全组列表](https://support.huaweicloud.com/api-vpc/vpc_sg01_0003.html)。 | 表12config字段数据结构说明 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | is_target_readonly | Boolean | **参数解释**： 目标实例是否设置为只读。 **约束限制**： MySQL迁移和灾备，且job_direction为up时设置有效。（灾备场景下，单主灾备且本云为备为必填且为true，不填默认设置为true）。 **取值范围**： - **true**：设置为只读。 - **false**：不设置为只读。 **默认取值**： true | | node_num | Integer | **参数解释**： 节点数。 **约束限制**： Redis集群到GeminiDB Redis迁移场景填写，连接源端Redis集群的子任务个数，输入值在1到16之间，且输入值不能大于源端Redis集群的分片个数，请根据源端Redis集群的规模合理选择。建议集群的每4个分片设置1个源端分片个数，即每1个子任务连接源端集群的4个分片。 **取值范围**： 1-16 **默认取值**： 0 | 表13ssl字段数据结构说明 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | ssl_link | Boolean | **参数解释**： 是否SSL安全连接。 **约束限制**： 如果数据库启用了SSL安全连接，参数值为true。 **取值范围**： - **true**：使用SSL安全连接。 - **false**：不使用SSL安全连接。 | | ssl_cert_name | String | **参数解释**： SSL证书名字。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 | | ssl_cert_key | String | **参数解释**： SSL证书内容，用base64加密。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 | | ssl_cert_check_sum | String | **参数解释**： SSL证书内容checksum值，后端校验，源库安全连接必选。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 | | ssl_cert_password | String | **参数解释**： SSL证书密码，证书文件后缀为.p12时必填。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 | 表14customized_dns字段数据结构说明 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | is_set_dns | Boolean | **参数解释**： 是否设置客户自定义DNS。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 | | set_dns_action | String | **参数解释**： 设置客户自定义DNS的行为。 **约束限制**： 不涉及。 **取值范围**： - add：新增客户自定义DNS IP。 - keep：保持客户自定义DNS IP。 - update：更新客户自定义DNS IP（当DNS IP变化时更新生效）。 - recover：还原系统默认DNS IP（还原时可能会导致域名解析失败，请谨慎操作）。 | | dns_ip | String | **参数解释**： 设置客户自定义DNS IP。 **约束限制**： 不涉及。 **取值范围**： 0-15 | 表15alarm_notify字段数据结构说明 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | alarm_to_user | Boolean | **参数解释**： 异常告警是否通知用户，指定当任务状态异常时是否向用户发送告警通知。 **约束限制**： 不涉及。 **取值范围**： - true：异常告警通知用户。 - false：异常告警不通知用户。 **默认取值**： false | | topic_urn | String | **参数解释**： SMN主题URN，指定异常告警通知发送的目标SMN主题。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 | | delay_time | Long | **参数解释**： 时延阈值（单位为s）。 **约束限制**： - 源数据库和目标数据库之间的同步有时会存在一个时间差，称为时延，单位为秒。 - 时延阈值设置是指时延超过一定的值并持续6分钟后，DRS可以发送通知给指定收件人。（初次进入增量迁移阶段，会有较多数据等待同步，存在较大的时延，属于正常情况，不在此功能的监控范围之内。） - 只有全量+增量的任务支持此选项。 **取值范围**： 1-3600 **默认取值**： 0 | | rpo_delay | Long | **参数解释**： RPO时延阈值（单位为s）。 **约束限制**： RPO时延阈值设置是业务数据库与DRS实例间同步的时延超过一定的值并持续6分钟后，DRS可以发送通知给指定收件人。（初次进入增量灾备阶段，会有较多数据等待同步，存在较大的时延，属于正常情况，不在此功能的监控范围之内。） **取值范围**： 1-3600 **默认取值**： 0 | | rto_delay | Long | **参数解释**： RTO时延阈值（单位为s）。 **约束限制**： RTO时延阈值设置是DRS实例与灾备数据库间同步的时延超过一定的值并持续6分钟后，DRS可以发送通知给指定收件人。 **取值范围**： 1-3600 **默认取值**： 0 | 表16speed_limit字段数据结构说明 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | begin | String | **参数解释**： 开始限速时间。 **约束限制**： 此时间为UTC时间，开始时间为整时，如果有分钟，则会忽略，格式为hh:mm，小时数为两位，例如：01:00。 **取值范围**： 不涉及。 | | end | String | **参数解释**： 结束时间。 **约束限制**： 此时间为UTC时间，输入必须为59分结尾，格式为hh:mm，例如：15:59。 **取值范围**： 不涉及。 | | speed | String | **参数解释**： 限速值，单位为MB/s。 **约束限制**： 不涉及。 **取值范围**： 1\~9999。 | 表17user_migration字段数据结构说明 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | is_migrate_user | Boolean | **参数解释**： 是否迁移用户。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 | | is_set_password | Boolean | **参数解释**： 是否统一重置密码。 **约束限制**： 不涉及。 **取值范围**： - true：重置密码为统一密码。 - false：不统一重置密码。 当前支持的场景： - 实时迁移场景：MySQL迁移。 | | password | String | **参数解释**： 重置后的统一密码。 **约束限制**： 统一重置密码为true时必填。 密码不能为空。 **取值范围**： 不涉及。 | | user_list | Array of objects | **参数解释**： 用户迁移信息用户列表字段。当前支持的场景： - 实时迁移场景：MySQL-\>MySQL迁移，MongoDB-\>DDS迁移。 详情请参见[表18]。 | | role_list | Array of objects | **参数解释**： 用户迁移信息角色列表字段。当前支持的场景： - 实时迁移场景：MongoDB-\>DDS迁移。 详情请参见[表19]。 | 表18user_list字段数据结构说明 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | id | String | **参数解释**： 用户ID。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 | | account | String | **参数解释**： 用户。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 | | is_set_password | Boolean | **参数解释**： 是否重置该用户密码。当前支持的场景： - 实时迁移场景：MySQL迁移。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 | | password | String | **参数解释**： 重置后的密码。 **约束限制**： 统一重置密码或单个用户重置密码为true时必填。密码不能为空。 **取值范围**： 不涉及。 | 表19role_list字段数据结构说明 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | role | String | **参数解释**： 角色。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 | 表20policy_config字段数据结构说明 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | filter_ddl_policy | String | **参数解释**： 过滤DDL策略，指定增量同步阶段需要过滤的DDL操作类型。 **约束限制**： - 实时迁移场景：MySQL迁移可填""，表示不过滤DROP DATABASE。 - 实时同步场景：MySQL同步只能填drop_database。 **取值范围**： drop_database：过滤DROP DATABASE操作 | | conflict_policy | String | **参数解释**： 增量阶段冲突策略，指定当目标库已存在相同数据时的处理方式。该冲突策略特指增量同步中的冲突处理策略，全量阶段的冲突默认忽略。 **约束限制**： - 实时迁移场景：不支持。 - 实时同步场景：支持。 **取值范围**： - ignore：忽略。当同步数据与目标库已有数据冲突时（主键/唯一键重复等），DRS将忽略源库的冲突数据，并保留目标库中的冲突数据，继续进行后续同步。 - stop：报错。当同步数据与目标库已有数据冲突时（主键/唯一键重复等），同步任务将失败并立即中止。可在同步日志中查看详细信息。 - overwrite：覆盖。当同步数据与目标库已有数据冲突时（主键/唯一键重复等），将覆盖原来的冲突数据。 | | index_trans | Boolean | **参数解释**： 对象同步范围：是否同步普通索引。 **约束限制**： DRS将默认同步主键/唯一索引，普通索引是指除主键/唯一索引以外的其他类型索引。 **取值范围**： - true：将会同步全部的索引。 - false：仅同步主键/唯一索引，普通索引不会同步。 **默认取值**： **true** | | ddl_trans | Boolean | **参数解释**： 对象同步范围：同步增量阶段是否同步DDL。 **约束限制**： 不涉及。 **取值范围**： - true：增量阶段同步DDL。 - false：增量阶段不同步DDL。 **默认取值**： **true** | | data_sync_topology_type | String | **参数解释**： 数据同步拓扑。 **约束限制**： 数据同步功能支持多种同步拓扑，您可以根据业务需求规划您的同步实例。 **取值范围**： - one2one：一对一。 - one2many：一对多。 - many2one：多对一。 **默认取值**： **one2one** | | support_ddl_info | String | **参数解释**： 增量支持的DDL，指定增量同步阶段允许同步的DDL操作类型。 **约束限制**： - 一对一，一对多场景，如果业务上认为源和目标应该使用保持严格一致，那么高危类DDL也应该勾选并同步。 - 一对一，一对多场景，如果业务上确定某个高危DDL不应该发生，则可以不勾选同步高危类DDL，这样DRS将拦截过滤这个DDL，从而起到保护目标数据的作用，但需要知晓过滤DDL的附带问题是可能导致同步失败，例如过滤删列动作。 - 多对一数据聚合场景，最佳实践是推荐只选择同步加列DDL，其他大部分DDL同步都因目标表修改而导致其他任务失败/数据不一致的情况发生，常见情况有： - 同步truncate导致目标数据全部被清空。 - 同步创建索引导致目标表被锁定。 - 同步rename导致其他任务找不到目标表而失败。 - 同步改列导致其他任务因数据类型不兼容而失败。 **取值范围**： - **CREATE_TABLE**：创建表 - **ADD_COLUMN**：加列 - **MODIFY_COLUMN**：改列属性 - **CHANGE_COLUMN**：改列属性 - **DROP_INDEX**：删除索引 - **ADD_INDEX**：加索引 - **CREATE_INDEX**：创建索引 - **RENAME_INDEX**：重命名索引 | | sync_type_policy | String | **参数解释**： 同步数据类型，指定增量同步阶段需要同步的数据类型范围。 **约束限制**： 除supportAllType以外，其他类型可组合填写，例如："tableData,tableStructure" 。 **取值范围**： - supportAllType：同步所有类型 - tableData：同步数据 - tableStructure：同步表结构 - constraintData：索引同步 | | increment_read_mode | String | **参数解释**： Oracle-GaussDB增量读取方式，指定Oracle同步到GaussDB时增量数据的读取模式。 **约束限制**： 不涉及。 **取值范围**： - logminer：Logminer方式 - xstream：Xstream方式 | | dml_types | String | **参数解释**： DML同步类型，指定增量同步阶段需要同步的数据操作类型，包括插入、更新和删除操作。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 | | is_create_table_with_index | Boolean | **参数解释**： 索引与表结构是否同时建立，指定在同步过程中创建表时是否同时创建索引。 **约束限制**： 不涉及。 **取值范围**： - true：索引与表结构同时建立。 - false：索引与表结构不同时建立。 | 表21db_param字段数据结构说明 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | common | Array of objects | **参数解释**： 常规参数。只有对比结果为不一致的目标库参数能被修改。 详情请参见[表22]。 | | performance | Array of objects | **参数解释**： 性能参数。对比结果一致也可以修改目标库的值。 详情请参见[表22]。 | 表22common和performance字段数据结构说明 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | key | String | **参数解释**： 数据库参数名。 **约束限制**： 不涉及。 **取值范围**： - **binlog_cache_size** - **binlog_stmt_cache_size** - **bulk_insert_buffer_size** - **innodb_buffer_pool_size** - **key_buffer_size** - **long_query_time** - **query_cache_type** - **read_buffer_size** - **read_rnd_buffer_size** - **sort_buffer_size** - **sync_binlog** - **innodb_buffer_pool_instances** | | target_value | String | **参数解释**： 目标数据库参数值。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 | 表23tuning_params字段数据结构说明 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | full_sync | Array of objects | **参数解释**： 全量调优参数。 详情请参见[表24]。 | | incre_capture | Array ofobjects | **参数解释**： 增量抓取调优参数。 详情请参见[表24]。 | | incre_apply | Array of objects | **参数解释**： 增量回放调优参数。 详情请参见[表24]。 | | incre_relay | Array of objects | **参数解释**： 增量日志拉取调优参数。 详情请参见[表24]。 | 表24full_sync、incre_capture、incre_apply和incre_relay字段数据结构说明 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | param_name | String | **参数解释**： 参数名称。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 | | param_value | String | **参数解释**： 参数取值。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 | | availability | Boolean | **参数解释**： 是否可用。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 | 表25period_order字段数据结构说明 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | period_type | Integer | **参数解释**： 订购周期类型。 **约束限制**： 不涉及。 **取值范围**： - 2：月。 - 3：年。 **默认取值**： 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：是（自动支付）。 | 表26node_info字段数据结构说明 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | spec | Object | **参数解释**： 任务实例规格信息体。 详情请参见[表27]。 | | vpc | Object | **参数解释**： 任务实例VPC信息体,自建任务必填。 详情请参见[表28]。 | | base_info | Object | **参数解释**： 任务实例基本信息。 详情请参见[表29]。 | 表27spec字段数据结构说明 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | node_type | String | **参数解释**： DRS任务实例规格编码，决定迁移实例的计算资源大小。 **约束限制**： 不涉及。 **取值范围**： - micro：极小规格 - small：小规格 - medium：中规格 - high：大规格 | 表28vpc字段数据结构说明 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | 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。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 | 表29base_info字段数据结构说明 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | instance_type | String | **参数解释**： 实例类型。 **约束限制**： 不涉及。 **取值范围**： - single：单机。 - ha：主备。 | | arch | String | **参数解释**： CPU架构。 **约束限制**： 不涉及。 **取值范围**： - x86 - arm | | availability_zone | String | **参数解释**： 可用区ID。 **约束限制**： 对于任务实例类型不是单机的实例，需要分别为实例所有节点指定可用区，并用","英文逗号隔开。示例： - 实例类型为single："cn-north-4a" - 实例类型为ha："cn-north-4a,cn-north-4b" **取值范围**： 不涉及。 | | 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**：全量迁移失败 | | role | String | **参数解释**： 任务主备角色。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 | 表30logs字段数据结构说明 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | level | String | **参数解释**： 日志级别。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 | | message | String | **参数解释**： 日志信息。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 | | create_time | String | **参数解释**： 日志时间。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 | 表31network_results字段数据结构说明 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | ip | String | **参数解释**： 测试连接IP。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 | | success | Boolean | **参数解释**： 测试连接是否成功。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 | | result | String | **参数解释**： 测试连接结果。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 | | status | String | **参数解释**： 测试连接是否成功。 **约束限制**： 不涉及。 **取值范围**： - success：成功。 - failed：不成功。 | | error_code | String | **参数解释**： 测试连接失败错误码。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 | | error_msg | String | **参数解释**： 测试连接失败错误内容。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 | 表32precheck_result字段数据结构说明 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | result | Boolean | **参数解释**： 返回的预检查结果是否通过。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 | | process | String | **参数解释**： 预检查进度百分比。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 | | total_passed_rate | String | **参数解释**： 预检查通过百分比。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 | | rds_instance_id | String | **参数解释**： 数据库实例ID。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 | | job_direction | String | **参数解释**： 迁移方向。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 | | precheck_results | Array of objects | **参数解释**： 预检查各项结果。 详情请参见[表33]。 | 表33precheck_results字段数据结构说明 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | item | String | **参数解释**： 检查项。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 | | result | String | **参数解释**： 检查结果。 **约束限制**： 不涉及。 **取值范围**： - PASSED：检查通过。 - ALARM：检查告警项。 - FAILED：检查失败。 | | failed_reason | String | **参数解释**： 失败原因。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 | | data | String | **参数解释**： 失败数据。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 | | raw_error_msg | String | **参数解释**： 失败详情。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 | | group | String | **参数解释**： 检查项分组。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 | | is_support_skip | Boolean | **参数解释**： 是否支持跳过。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 | | is_skipped | Boolean | **参数解释**： 是否已跳过。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 | | failed_sub_jobs | Array of objects | **参数解释**： 失败子任务详情。 详情请参见[表34]。 | 表34failed_sub_jobs字段数据结构说明 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | id | String | **参数解释**： 子任务ID。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 | | name | String | **参数解释**： 子任务名称。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 | | check_result | String | **参数解释**： 子任务检查结果。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 | 表35progress_info字段数据结构说明 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | progress | String | **参数解释**： 迁移对比百分比。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 | | incr_trans_delay | String | **参数解释**： 增量迁移时延（单位：s）。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 | | incr_trans_delay_millis | String | **参数解释**： 增量迁移时延（单位：ms）。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 | | task_mode | String | **参数解释**： 迁移模式。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 | | transfer_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**：升级失败 | | process_time | String | **参数解释**： 迁移时间。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 | | remaining_time | String | **参数解释**： 预计剩余时间。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 | | progress_map | Map\ | **参数解释**： 全量迁移进度详情。 详情请参见[表36]。 | 表36progress_map字段数据结构说明 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | completed | String | **参数解释**： 完成进度。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 | | remaining_time | String | **参数解释**： 预计剩余时间。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 | 表37migration_object_progress_info字段数据结构说明 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | migration_object_overview | Array of objects | **参数解释**： 概览详情。 详情请参见[表38]。 | | create_time | String | **参数解释**： 数据生成时间。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 | | full_start_time | String | **参数解释**： 全量开始时间。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 | | full_complete_time | String | **参数解释**： 全量完成时间。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 | | incr_start_time | String | **参数解释**： 增量开始时间。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 | | end_time | String | **参数解释**： 结束时间。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 | 表38migration_object_overview字段数据结构说明 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | type | String | **参数解释**： 类型。 **约束限制**： 不涉及。 **取值范围**： - **DATABASE**：数据库 - **SCHEMA**：SCHEMA - **PACKAGE**：package - **TABLE**：数据表 - **COLUMN**：列 - **VIEW**：视图 - **FUNCTION**：函数 - **PROCEDURE**：存储过程 - **ROUTINE**：routine - **TRIGGER**：触发器 - **INDEX**：索引 - **TABLE_INDEX**：普通索引，根据表汇聚 - **TABLE_RENAME_OR_COPY**：表重命名或复制 - **TABLE_STRUCTURE**：表结构 - **EVENT**：事件 - **SYNONYM**：同义词，sqlserver特有 - **TYPE**：自定义类型，sqlserver特有 - **RULE**：规则，sqlserver特有 - **DEFAULT**：缺省值，sqlserver特有 - **PLAN_GUIDE**：执行计划，sqlserver特有 - **FILE_GROUP**：文件组，sqlserver特有 - **PARTITION_FUNCTION**：分区函数，sqlserver特有 - **SHARD_KEY**：mongo特有 - **VALIDATOR**：mongo特有 - **SEQUENCE**：序列 - **MATVIEW**：物化视图 - **PARTITION_SCHEME**：分区方案，sqlserver特有 - **ACCOUNT**：账户 - **EXTENSION**：插件，PG特有的一些对象 - **AGGREGATE**：聚合函数，PG特有的一些对象 - **MATERIALIZED_VIEW**：物化视图，PG特有的一些对象 - **TEXT_SEARCH_DICTIONARY**：文本搜索字典，PG特有的一些对象 - **CONVERSION**：类型转换，PG特有的一些对象 - **DATA_TYPE**：数据类型，PG特有的一些对象 - **TEXT_SEARCH_CONFIGURATION**：文本搜索配置，PG特有的一些对象 - **STATISTICS_EXTENSION**：插件统计，PG特有的一些对象 - **MEMBERSHIP**：用户成员关系，PG特有的一些对象 - **EVENT_TRIGGER**：事件触发器，PG特有的一些对象 - **COLLATION**：排序规则，PG特有的一些对象 - **TEXT_SEARCH_PARSER**：文本搜索解析器，PG特有的一些对象 - **PRIVILEGE** **S**：权限，PG特有的一些对象 - **FOREIGN_KEY**：外键，PG特有的一些对象 - **ROLE**：权限 | | src_count | String | **参数解释**： 待迁移数量。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 | | dst_count | String | **参数解释**： 已迁移数量。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 | | status | String | **参数解释**： 状态。 **约束限制**： 不涉及。 **取值范围**： - **NOT_START**：未启动 - **TRANSFERING**：迁移中 - **COMPLETED**：已完成 - **FAILED**：失败 - **TRANSFER_WHEN_END**：结束后迁移 | | start_time | String | **参数解释**： 开始时间。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 | | end_time | String | **参数解释**： 结束时间。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 | 表39metrics字段数据结构说明 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | job_id | String | **参数解释**： 任务ID。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 | | node_id | String | **参数解释**： 实例ID。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 | | time_stamp | String | **参数解释**： 上报时间。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 | | cpu_util | String | **参数解释**： CPU使用率。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 | | mem_util | String | **参数解释**： 内存使用率。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 | | network_incoming_bytes_rate | String | **参数解释**： 网络输入吞吐量。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 | | network_outgoing_bytes_rate | String | **参数解释**： 网络输出吞吐量。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 | | disk_read_bytes_rate | String | **参数解释**： 磁盘读吞吐量。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 | | disk_write_bytes_rate | String | **参数解释**： 磁盘写吞吐量。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 | | apply_rows_rate | String | **参数解释**： 写目标库频率。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 | | apply_transactions_rate | String | **参数解释**： DML TPS。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 | | apply_ddl_rate | String | **参数解释**： DDL TPS。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 | | apply_average_execute_time | String | **参数解释**： 事务平均执行时间。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 | | apply_average_commit_time | String | **参数解释**： 事务平均提交时间。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 | | apply_current_state | String | **参数解释**： 同步状态。 **约束限制**： 不涉及。 **取值范围**： - **succeed**：同步成功。 - **failed**：同步失败。 - **processing**：同步中。 - **waiting**：等待中。 | 表40compare_result字段数据结构说明 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | objects_compare_overview_info | Object | **参数解释**： 对象级对比任务信息体。 详情请参见[表41]。 | | objects_compare_detail_infos | Array of objects | **参数解释**： 对象级对比详情信息体。 详情请参见[表43]。 | | data_compare_task_list | Array of objects | **参数解释**： 数据对比任务列表。 详情请参见[表44]。 | | line_compare_overview_infos | Array of objects | **参数解释**： 行数对比概览信息体。 详情请参见[表45]。 | | line_compare_detail_infos | Array of objects | **参数解释**： 行数对比任务表级详情。 详情请参见[表46]。 | | content_compare_overview_infos | Array of objects | **参数解释**： 内容对比概览信息体。 详情请参见[表47]。 | | content_compare_detail_infos | Array of objects | **参数解释**： 内容对比详情信息体。 详情请参见[表48]。 | | content_diff_detail_info | Object | **参数解释**： 内容对比不一致数据的详情。 详情请参见[表49]。 | 表41objects_compare_overview_info字段数据结构说明 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | create_time | String | **参数解释**： 对比任务创建时间。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 | | compare_results | Array of objects | **参数解释**： 对比结果。 详情请参见[表42] | | start_time | String | **参数解释**： 对比任务开始时间。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 | | status | String | **参数解释**： 对比任务状态。 **约束限制**： 不涉及。 **取值范围**： - RUNNING：运行中。 - WAITING_FOR_RUNNING：等待启动中。 - SUCCESSFUL：完成。 - FAILED：失败。 - CANCELLED：已取消。 | | export_status | String | **参数解释**： 导出比对结果状态。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 | | report_remain_seconds | Long | **参数解释**： 导出比对结果有效期剩余时间。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 | | compare_job_id | String | **参数解释**： 对比任务ID。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 | | error_msg | String | **参数解释**： 失败原因。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 | 表42compare_results字段数据结构说明 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | type | String | **参数解释**： 对象类型。 **约束限制**： 不涉及。 **取值范围**： - DB：数据库。 - TABLE：表。 - VIEW：视图。 - EVENT：事件。 - ROUTINE：存储过程和函数。 - INDEX：索引。 - TRIGGER：触发器。 - SYNONYM：同义词。 - FUNCTION：函数。 - PROCEDURE：存储过程。 - TYPE：自定义类型。 - RULE：规则。 - DEFAULT_TYPE：缺省值。 - PLAN_GUIDE：执行计划。 - CONSTRAINT：约束。 - FILE_GROUP：文件组。 - PARTITION_FUNCTION：分区函数。 - PARTITION_SCHEME：分区方案。 - TABLE_COLLATION：表的排序规则。 - EXTENSIONS：插件。 | | source_count | Long | **参数解释**： 源数量。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 | | target_count | Long | **参数解释**： 目标数量。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 | | status | String | **参数解释**： 对比结果。 **约束限制**： 不涉及。 **取值范围**： - **CONSISTENT**：一致。 - **INCONSISTENT**：不一致。 - **COMPARING**：正在对比。 - **WAITING_FOR_COMPARISON**：等待对比。 - **FAILED_TO_COMPARE**：对比失败。 - **TARGET_DB_NOT_EXIST**：目标库不存在。 - **CAN_NOT_COMPARE**：无法对比。 | 表43objects_compare_detail_infos字段数据结构说明 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | source_db_value | String | **参数解释**： 源库对比值。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 | | target_db_value | String | **参数解释**： 目标库对比值。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 | | source_db_name | String | **参数解释**： 源库名称。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 | | target_db_name | String | **参数解释**： 目标库名称。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 | | error_message | String | **参数解释**： 失败原因。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 | 表44data_compare_task_list字段数据结构说明 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | id | String | **参数解释**： 对比任务ID。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 | | type | String | **参数解释**： 对比类型。 **约束限制**： 不涉及。 **取值范围**： - **object**：对象对比。 - **lines**：行对比。 - **contents**：内容对比。 | | start_time | String | **参数解释**： 开始时间。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 | | end_time | String | **参数解释**： 结束时间。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 | | status | String | **参数解释**： 对比任务的状态。 **约束限制**： 不涉及。 **取值范围**： - RUNNING：运行中。 - WAITING_FOR_RUNNING：等待启动中。 - SUCCESSFUL：完成。 - FAILED：失败。 - CANCELLED：已取消。 - TIMEOUT_INTERRUPT：超时中断。 - FULL_DOING：全量校验中。 - INCRE_DOING：增量校验中。 | | compute_type | String | **参数解释**： 对比计算资源。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 | | export_status | String | **参数解释**： 导出比对结果状态。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 | | report_remain_seconds | Long | **参数解释**： 导出比对结果有效期剩余时间。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 | | compare_job_tag | Map\ | **参数解释**： 对比任务的标签。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 | | options | Map\ | **参数解释**： 对比任务选项。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 | | dynamic_compare_delay | Long | **参数解释**： 动态比对时延。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 | | error_msg | String | **参数解释**： 失败原因。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 | 表45line_compare_overview_infos字段数据结构说明 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | source_db_name | String | **参数解释**： 源库库名。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 | | target_db_name | String | **参数解释**： 目标库库名。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 | | status | String | **参数解释**： 行对比结果。 **约束限制**： 不涉及。 **取值范围**： - CONSISTENT：一致。 - INCONSISTENT：不一致。 - COMPARING：正在对比。 - WAITING_FOR_COMPARISON：等待对比。 - FAILED_TO_COMPARE：对比失败。 - TARGET_DB_NOT_EXIST：目标库不存在。 - CAN_NOT_COMPARE：无法对比。 | 表46line_compare_detail_infos字段数据结构说明 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | source_table_name | String | **参数解释**： 源库表名称。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 | | source_row_num | String | **参数解释**： 源库表行数。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 | | target_table_name | String | **参数解释**： 目标库表名称。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 | | target_row_num | String | **参数解释**： 目标库表行数。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 | | difference_row_num | String | **参数解释**： 差异值。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 | | status | String | **参数解释**： 对比结果。 **约束限制**： 不涉及。 **取值范围**： - CONSISTENT：一致。 - INCONSISTENT：不一致。 - COMPARING：正在对比。 - WAITING_FOR_COMPARISON：等待对比。 - FAILED_TO_COMPARE：对比失败。 - TARGET_DB_NOT_EXIST：目标库不存在。 - CAN_NOT_COMPARE：无法对比。 | | message | String | **参数解释**： 信息。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 | 表47content_compare_overview_infos字段数据结构说明 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | source_db | String | **参数解释**： 源库库名。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 | | target_db | String | **参数解释**： 目标库库名。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 | | status | String | **参数解释**： 对比结果。 **约束限制**： 不涉及。 **取值范围**： - CONSISTENT：一致。 - INCONSISTENT：不一致。 - COMPARING：正在对比。 - WAITING_FOR_COMPARISON：等待对比。 - FAILED_TO_COMPARE：对比失败。 - TARGET_DB_NOT_EXIST：目标库不存在。 - CAN_NOT_COMPARE：无法对比。 | | compare_result | Boolean | **参数解释**： 对比结果。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 | 表48content_compare_detail_infos字段数据结构说明 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | source_db | String | **参数解释**： 源库库名。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 | | target_db | String | **参数解释**： 目标库库名。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 | | source_table_name | String | **参数解释**： 源库表名。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 | | target_table_name | String | **参数解释**： 目标库表名。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 | | source_row_num | Long | **参数解释**： 源库表行数。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 | | target_row_num | Long | **参数解释**： 目标库表行数。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 | | difference_row_num | Long | **参数解释**： 对比不一致行数。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 | | line_compare_result | Boolean | **参数解释**： 行对比结果。 **约束限制**： 不涉及。 **取值范围**： - true：一致。 - false：不一致。 | | content_compare_result | Boolean | **参数解释**： 内容对比结果。 **约束限制**： 不涉及。 **取值范围**： - true：一致。 - false：不一致。 | | message | String | **参数解释**： 失败原因。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 | 表49content_diff_detail_info字段数据结构说明 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | count | Long | **参数解释**： 数量。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 | | target_meta_is_null | Long | **参数解释**： 对比不一致详情：只有源库存在。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 | | source_meta_is_null | Long | **参数解释**： 对比不一致详情：只有目标库存在。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 | | source_target_meta_not_null | Long | **参数解释**： 对比不一致详情：源和目标端均存在。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 | | contents_infos | Array of objects | **参数解释**： 信息列表。 详情请参见[表50]。 | 表50contents_infos字段数据结构说明 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | source_key_value | Array of strings | **参数解释**： 源库KEY值。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 | | target_key_value | Array of strings | **参数解释**： 目标库KEY值。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 | | source_select_sql | String | **参数解释**： 查询源库SQL。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 | | target_select_sql | String | **参数解释**： 查询目标库SQL。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 | 表51support_import_file_resp字段数据结构说明 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | file_size | String | **参数解释**： 文件导入阈值。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 | | previous_select | String | **参数解释**： 上一次选择对象的方式。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 | 表52connection_management字段数据结构说明 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | driver_management | Object | **参数解释**： 驱动管理。 详情请参见[表53] | 表53driver_management字段数据结构说明 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | driver_name | String | **参数解释**： 驱动名称。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 | 表54public_ip_list字段数据结构说明 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | id | String | **参数解释**： 指定公网IP的ID。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 | | public_ip | String | **参数解释**： 指定公网IP。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 | | type | String | **参数解释**： 指定公网IP绑定任务的类型。 **约束限制**： - 主备任务：主是master，备是slave。 - 其他固定为master。 **取值范围**： - **master** - **slave** | 表55children字段数据结构说明 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | id | String | **参数解释**： 子任务ID。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 | | name | String | **参数解释**： 子任务名称。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 | 表56QueryDiagnosisResult | 参数 | 参数类型 | 描述 | |:---|:---|:---| | score | Integer | **参数解释**： 得分。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 | | status | String | **参数解释**： 状态。 **约束限制**： 不涉及。 **取值范围**： - **INIT**：初始化 - **RUNNING**：诊断中 - **SUCCESS**：诊断完成 - **FAILED**：诊断失败 | | progress | Integer | **参数解释**： 进度。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 | | error_msg | String | **参数解释**： 失败原因。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 | | start_time | String | **参数解释**： 开始时间。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 | | end_time | String | **参数解释**： 结束时间。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 | | total | Long | **参数解释**： 诊断项总数。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 | | normal_count | Long | **参数解释**： 正常数量。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 | | abnormal_count | Long | **参数解释**： 异常数量。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 | | alarm_count | Long | **参数解释**： 告警数量。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 | | failure_count | Long | **参数解释**： 失败数量。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 | | timeout_count | Long | **参数解释**： 超时数量。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 | | diagnosis_results | Array of objects | **参数解释**： 诊断结果。 详情请见[表 diagnosis_results]。 | 表57diagnosis_results | 参数 | 参数类型 | 描述 | |:---|:---|:---| | item | object | **参数解释**： 诊断项。 详情请见[表 item]。 | | state | String | **参数解释**： 诊断项状态。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 | | result_list | Array of objects | **参数解释**： 诊断结果。 详情请见[表 result_list] 。 | | suggestion_list | Array of objects | **参数解释**： 诊断建议。 详情请见[表 suggestion_list]。 | | score | Integer | **参数解释**： 诊断项得分。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 | | time | String | **参数解释**： 完成时间。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 | 表58item | 参数 | 参数类型 | 描述 | |:---|:---|:---| | category | String | **参数解释**： 诊断项类别。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 | | name | String | **参数解释**： 诊断项名称。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 | | weight | Double | **参数解释**： 诊断项权重。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 | 表59result_list | 参数 | 参数类型 | 描述 | |:---|:---|:---| | key | String | **参数解释**： 内容key。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 | | value | String | **参数解释**： 结果值。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 | | is_multi_language | Boolean | **参数解释**： 结果值是否需要国际化。 **约束限制**： 不涉及。 **取值范围**： - true：需要国际化。 - false：不需要国际化。 | | module_name | String | **参数解释**： 模块名称。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 | | level | String | **参数解释**： 等级。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 | 表60suggestion_list | 参数 | 参数类型 | 描述 | |:---|:---|:---| | content | String | **参数解释**： 诊断建议内容。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 | 表61repair_progress_info | 参数 | 参数类型 | 描述 | |:---|:---|:---| | status | String | **参数解释**： 修复状态。 **约束限制**： 不涉及。 **取值范围**： - **"FAILED"**：失败。 - **"SUCCEEDED"**：已成功。 - **"FINISHED"**：已完成。 - **"SUCCESS"**：成功。 | | progress | String | **参数解释**： 修复进度，百分比。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 | | error_msg | String | **参数解释**： 错误信息。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 | | count | Integer | **参数解释**： 总数。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 | | repair_progress_details | object | **参数解释**： 修复进度明细。 详情请见[表 repair_progress_details]。 | 表62repair_progress_details | 参数 | 参数类型 | 描述 | |:---|:---|:---| | query_id | String | **参数解释**： 对比任务ID。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 | | db_name | String | **参数解释**： 库名。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 | | schema_name | String | **参数解释**： schema名。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 | | table_name | String | **参数解释**： 表名。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 | | total_row_count | Integer | **参数解释**： 总行数。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 | | complete_row_count | Integer | **参数解释**： 完成行数。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 | | filter_row_count | Integer | **参数解释**： 过滤行数。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 | | repaired_row_count | Integer | **参数解释**： 已修复行数。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 | | failed_row_count | Integer | **参数解释**： 失败行数。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 | | repair_status | Integer | **参数解释**： 修复状态。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 | | start_time | String | **参数解释**： 开始时间。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 | | update_time | String | **参数解释**： 更新时间。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 | 表63QueryRepairDetailResp | 参数 | 参数类型 | 描述 | |:---|:---|:---| | count | Integer | **参数解释**： 总数。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 | | repair_details | Array of objects | **参数解释**： 修复详情。 详情请见[表 repair_details]。 | 表64repair_details | 参数 | 参数类型 | 描述 | |:---|:---|:---| | source_meta | String | **参数解释**： 源表标志列值。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 | | target_meta | String | **参数解释**： 目标表标志列值。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 | | repair_sql_state | Integer | **参数解释**： 修复SQL状态。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 | | repair_sql_info | String | **参数解释**： 修复SQL。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 | **状态码：400** 表65响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | **参数解释**： 错误码，当任务报错时返回的错误代码。 **约束限制**： - 最小长度：12 - 最大长度：12 **取值范围**： 格式为DRS.XXXXXX。 | | error_msg | String | **参数解释**： 错误详细信息，当任务执行失败时返回的具体错误描述。 **约束限制**： - 最小长度：1 - 最大长度：512 **取值范围**： 不涉及。 | #### 请求示例 - 查询任务同步进度。 ``` https://{endpoint}/v5/054ba152d480d55b2f5dc0069e7ddef0/jobs/c7debc9c-8e09-4a5d-8dd6-cc44f78jb20r?type=progress ``` - 查询行对比任务概览 ``` https://{endpoint}/v5/054ba152d480d55b2f5dc0069e7ddef0/jobs/c7debc9c-8e09-4a5d-8dd6-cc44f78jb20r?type=compare&query_type=overview&compare_type=line_compare&compare_task_id=1994b3e6-15ef-471e-8af1-7e2ed3e85b06&offset=0&limit=10 ``` - 查询任务详情。 ``` https://{endpoint}/v5/054ba152d480d55b2f5dc0069e7ddef0/jobs/c7debc9c-8e09-4a5d-8dd6-cc44f78jb20r?type=detail ``` - 查询数据对比任务列表 ``` https://{endpoint}/v5/054ba152d480d55b2f5dc0069e7ddef0/jobs/c7debc9c-8e09-4a5d-8dd6-cc44f78jb20r?type=compare&compare_type=data_compare&query_type=list&limit=10&offset=0 ``` - 查询同步日志。 ``` https://{endpoint}/v5/054ba152d480d55b2f5dc0069e7ddef0/jobs/c7debc9c-8e09-4a5d-8dd6-cc44f78jb20r?type=log&offset=0&limit=10 ``` - 查询测试连接结果。 ``` https://{endpoint}/v5/054ba152d480d55b2f5dc0069e7ddef0/jobs/c7debc9c-8e09-4a5d-8dd6-cc44f78jb20r?type=network&query_id=669c9c19-99e3-4628-8c90-397136266701 ``` - 查询一键诊断结果，query_id为调用开始诊断接口返回的query_id。 ``` https://{endpoint}/v5/5237e10fe9aa4ad5b16b6a5245248314/jobs/781055ed-787f-4bfc-8886-b6ffc88jb201?type=diagnosis&query_id=8193ebe8-aac5-46bb-9330-810b62657adc ``` - 查询修复进度明细，query_id为此次对比任务的ID。 ``` https://{endpoint}/v5/5237e10fe9aa4ad5b16b6a5245248314/jobs/781055ed-787f-4bfc-8886-b6ffc88jb201?type=repair_progress&query_id=d77dd50c-24b9-47b7-8f2e-9009efca4ab2&offset=0&limit=10 ``` #### 响应示例 **状态码：200** OK 查询任务基本信息（type=detail） ``` { "job" : { "id" : "c7debc9c-8e09-4a5d-8dd6-cc44f78jb20r", "status" : "CONFIGURATION", "create_time" : "2022-11-07T16:15:18Z", "base_info" : { "name" : "DRS-1234", "job_type" : "sync", "engine_type" : "oracle-to-gaussdbv5", "job_direction" : "up", "task_type" : "FULL_INCR_TRANS", "net_type" : "eip", "charging_mode" : "on_demand", "enterprise_project_id" : "0", "description" : "", "expired_days" : "14", "tags" : [ { "key" : "test", "value" : "test" } ] }, "source_endpoint" : [ { "db_type" : "oracle", "endpoint_type" : "offline", "endpoint_role" : "so", "endpoint" : { "id" : "f59e6118-da89-4fdb-9b98-65f56709928a", "endpoint_name" : "oracle", "ip" : "10.154.217.239", "db_port" : "1521", "db_user" : "ORACLE_USER", "db_name" : "serviceName.orcl" }, "ssl" : { "ssl_link" : false } } ], "target_endpoint" : [ { "db_type" : "gaussdbv5", "endpoint_type" : "cloud", "endpoint_role" : "ta", "endpoint" : { "id" : "10deb576-8885-473b-a213-4d76e668dc0d", "endpoint_name" : "cloud_gaussdbv5", "instance_id" : "c2c7579bc09c490b9d8009db715aeb0ain14", "db_user" : "root" }, "cloud" : { "region" : "cn-north-4", "project_id" : "9dc8c0f3f74c4dbb23c29cf0318ee561", "az_code" : "cn-north-4a,cn-north-4g,cn-north-4c" }, "vpc" : { "vpc_id" : "2cb5d364-ae63-4fbb-85b7-7d59f4a88f8f", "subnet_id" : "2cb54324-ae63-4fbb-85b7-7d59f4a88f8f", "security_group_id" : "039a3s89-665a-43e2-9b4f-bda7d9ee148d" } } ], "alarm_notify" : { "alarm_to_user" : true, "topic_urn" : "urn:smn:cn-north-4:f2c2468c3ee7410c862a461ca073d2f2:test", "delay_time" : 60 }, "speed_limit" : [ { "begin" : "16:00", "end" : "15:59", "speed" : "10" } ], "policy_config" : { "ddl_trans" : false }, "node_info" : { "spec" : { "node_type" : "medium" } } } } ``` **状态码：400** Bad Request ``` { "error_code" : "DRS.10000010", "error_msg" : "Job does not exist, please check job ID." } ``` #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | OK | | 400 | Bad Request | 其他状态请参见[状态码](https://support.huaweicloud.com/api-drs/drs_api_0108.html)。 #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-drs/drs_05_0004.html)。