华为云用户手册

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 Content-Type 是 String 指定类型为application/json。 缺省值：application/json X-Auth-Token 是 String 从 IAM 服务获取的用户Token。 X-Language 否 String 请求语言类型。 缺省值：en-us 取值： en-us zh-cn 表3 请求Body参数 参数 是否必选 参数类型 描述 group 是 String 参数分组。取值： common performance params 是 Array of objects 修改的参数信息。 详情请参见表4。 表4 params字段数据结构说明 参数 是否必选 参数类型 描述 key 是 String 数据库参数名。 target_value 是 String 目标数据库参数值。

请求示例 批量设置灾备任务限速，限速15MB/s，限速时间段为 https://{endpoint}/v3/054ba152d480d55b2f5dc0069e7ddef0/jobs/batch-limit-speed { "speed_limits" : [ { "job_id" : "7d0504f1-aba3-435f-914f-936b861jb502", "speed_limit" : [ { "begin" : "16:00", "end" : "15:59", "speed" : "15" } ] } ] }

接口约束 限速可以通过设定时间段来定时控制迁移速度。目前默认设定为全天，您也可以根据业务场景自定义限速时间段。 自定义限速时间段支持最多设置3个，每个限速时段之间不能存在交叉的时间段，没有设定在限速时间段内的时间默认为不限速。 开始限速时间不能与结束时间相同。 开始时间为16:00且结束时间为15:59，为全天限速。 speed_limit参数设置为[]为不限速。 开始时间忽略分钟，结束时间必须以59结尾例如03:59相当于4点（UTC时间），小时数为两位数字。 双主灾备时父任务不支持。 任务模式为INCR_TRANS时不支持。

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 Content-Type 是 String 指定类型为application/json。 缺省值：application/json X-Auth-Token 是 String 从IAM服务获取的用户Token。 X-Language 否 String 请求语言类型。 缺省值：en-us 取值： en-us zh-cn 表3 请求Body参数 参数 是否必选 参数类型 描述 speed_limits 是 Array of objects 灾备限速设置信息。 详情请参见表4。 表4 speed_limits字段数据结构说明 参数 是否必选 参数类型 描述 job_id 是 String 任务ID。 speed_limit 是 Array of objects 限速信息请求体。 详情请参见表5。 表5 speed_limit字段数据结构说明 参数 是否必选 参数类型 描述 begin 是 String 开始限速时间，此时间为UTC时间，开始时间为整时，如果有分钟，则会忽略，格式为hh:mm，小时数为两位，例如：01:00。 end 是 String 结束时间，此时间为UTC时间，输入必须为59分结尾，格式为hh:mm，例如：15:59。 speed 是 String 限速，取值范围为1~9999，单位为MB/s。 is_utc 否 Boolean 是否为UTC时间。

响应参数 状态码： 200 表6 响应Body参数 参数 参数类型 描述 count Integer 总数。 results Array of objects 批量修改任务返回列表。 详情请参见表7。 表7 results字段数据结构说明 参数 参数类型 描述 id String 任务ID。 status String 状态。取值： success：成功。 failed：失败。 error_code String 错误码。 error_msg String 错误信息。

具体步骤 Token认证，并 获取Token 值，具体操作请参考认证鉴权。 获取DRS的Endpoint。 调用接口前，您需要提前获取到地区和终端节点，即下文中的Endpoint值。 调用接口前，您需要提前联系企业管理员，获取地区和终端节点，即下文中的Endpoint值。 获取用户在某一Region下的Project ID，请参见获取项目ID。 发送“POST https://{DRS的Endpoint}//v3/{projectId}/jobs”。 在Request Header中增加“X-Auth-Token”，值为用户Token。 在Request Header中增加“Content-Type”，值为“application/json”。 在Request Body中传入参数如下： 关于创建实例接口的详细说明，请参见批量创建任务。 { "bind_eip": true,// 在公网网络场景下确认迁移实例是否绑定弹性IP "db_use_type": "migration",// 使用类型，取值：migration-实时迁移，sync-实时同步，cloudDataGuard-实时灾备，必填。 "description": "",// 任务描述。 "engine_type": "mysql",//引擎类型，取值：mysql，mongodb，cloudDataGuard-mysql，gaussdbv5。 "is_target_readonly": true,// 指定目标实例是否限制为只读。 "job_direction": "up",// 任务方向，取值up，down "name": "DRS-2057",// 任务名称，必填。 "net_type": "eip",// 网络类型，取值：vpn，vpc，eip，必填。 "node_type": "high",// 规格类型，必填。 "source_Endpoint": { // 源数据库信息体，必填。 "db_type": "mysql",// 数据库类型，取值：mysql，mongodb，gaussdbv5，必填。 }, "target_Endpoint": { // 目标数据库信息体。 "db_type": "mysql",// 数据库类型，必填。 "inst_id": "63e0699063494a8a93798f38abf3247ein01"，// RDS实例id，数据库为RDS实例必填。 "region": "cn-xianhz-1" // RDS实例所在region，数据库为rds时必填。 }, "task_type": "FULL_INCR_TRANS" // 任务模式，取值：FULL_TRANS, FULL_INCR_TRANS。 } 如果请求失败，会返回错误码及对应的错误信息说明，详细错误码信息请参见错误码。

操作步骤 参考认证鉴权，通过调用IAM服务的API，获取用户的Token。 参考获取任务ID，获取需要查询的任务ID。 URI格式： /v3/{project_id}/jobs/batch-starting 请求示例： POST: https://{endpoint}/ /v3/054ba152d480d55b2f5dc0069e7ddef0/jobs/batch-starting {endpoint}信息请从地区和终端节点获取。 请求样例： https://{endpoint}/v3/054ba152d480d55b2f5dc0069e7ddef0/jobs/batch-starting { "jobs" : [ { "job_id" : "140b5236-88ad-43c8-811c-1268453jb101" } ] } 响应示例： { "count" : 1, "results" : [ { "id" : "140b5236-88ad-43c8-811c-1268453jb101", "status" : "success" } ] }

操作步骤 参考认证鉴权，通过调用IAM服务的API，获取用户的Token。 参考获取任务ID，获取需要查询的任务ID。 URI格式： /v3/{project_id}/jobs/batch-status 请求示例： POST: https://{endpoint}/v3/054ba152d480d55b2f5dc0069e7ddef0/jobs/batch-status {endpoint}信息请从地区和终端节点获取。 请求样例： https://{endpoint}/v3/054ba152d480d55b2f5dc0069e7ddef0/jobs/batch-status { "jobs" : [ "9a470239-2308-4bb5-a6bc-1040402fjb21", "dc67695a-ee3e-49b8-a022-a099bd81jb21" ], "page_req" : { "cur_page" : 1, "per_page" : 10 } } 响应示例： { "results" : [ { "id" : "9a470239-2308-4bb5-a6bc-1040402fjb21", "status" : "INCRE_TRANSFER_STARTED" }, { "id" : "dc67695a-ee3e-49b8-a022-a099bd81jb21", "status" : "INCRE_TRANSFER_FAILED" } ], "count" : 2 }

响应示例 状态码： 200 OK { "results" : [ { "id" : "b683ea69-a29c-456f-952f-2b682180jb52", "data_guard_minitor" : { "src_normal" : true, "dst_normal" : true, "sr_offset" : "mysql-bin.000445:191", "node_offset" : "mysql-bin.000445:191", "dst_offset" : "N/A", "sr_delay" : 0, "dst_delay" : 81046806, "src_rps" : "0", "src_io" : "0.0", "bandwidth" : "37", "dst_rps" : "0", "dst_io" : "0.0", "trans_inMB" : "0", "trans_lines" : "0", "volume_used_inGB" : "5", "mem_used_inMB" : "2166", "cpuUsed_percent" : "1.4", "node_volume_inGB" : 100, "node_mem_inMB" : 8192, "migration_bytes_per_second": 789456 } } ], "count" : 1 }

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 results Array of objects 容灾监控数据响应体集合。 详情请参见表5。 count Integer 查询总数。 表5 results字段数据结构说明 参数 参数类型 描述 id String 任务ID。 data_guard_minitor object 灾备任务监控数据。 详情请参见表6。 表6 data_guard_minitor字段数据结构说明 参数 参数类型 描述 bandwidth String 带宽。 cpuUsed_percent String CPU百分比。 dst_delay Long 目标库时延。 dst_io String 目标IO。 dst_normal Boolean 目标库连接状态。 dst_offset String 目标库offSet位点。 dst_rps String 目标RPS。 mem_used_inMB string 内存使用。 node_mem_inMB Long Node内存总大小。 node_offset String 迁移实例offSet位点。 node_volume_inGB Long Node磁盘总大小。 sr_delay Long 源库时延。 sr_offset String 源库offSet位点。 src_io String 源IO。 src_normal Boolean 源库连接状态。 src_rps String 源RPS。 trans_inMB String 迁移数据量。 trans_lines String 迁移数据行数。 volume_used_inGB String 磁盘使用。 migration_bytes_per_second Long 每秒迁移字节大小。

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 Content-Type 是 String 指定类型为application/json。 缺省值：application/json X-Auth-Token 是 String 从IAM服务获取的用户Token。 X-Language 否 String 请求语言类型。 缺省值：en-us 取值： en-us zh-cn 表3 请求Body参数 参数 是否必选 参数类型 描述 jobs 是 Array of strings 查询任务请求体。

响应示例 状态码： 202 Accepted { "count" : 1, "results" : [ { "job_id" : "8d0e8e36-a618-490d-8a46-8c61ac9jb502", "updated_at" : "2020-12-18T06:38:37Z", "source_db" : { "id" : "2706a49b-6dd0-4b70-b2a8-36cf0034703d", "region" : "cn-xianhz-1", "ip" : "192.168.1.144", "topic" : null, "obj_id" : "0b51710fd4e54d6bb90ab91bf68f86efno01", "instance_name" : "rds-zw-source", "db_type" : "mysql", "db_user" : "root", "db_password" : "********", "manage_ip" : null, "traffic_ip" : "192.168.1.144", "db_port" : 3306, "created_at" : "2020-12-16T12:09:54Z", "updated_at" : "2020-12-18T06:33:09Z", "public_ip" : null, "az_code" : "az3xahz", "security_group_id" : "652cbe2d-d487-407e-b666-d01948b33879", "subnet_id" : "c6f66ccb-be7a-499e-aa8a-1389355e67a8", "vpc_id" : "7c73a425-885b-4e54-a0e6-ef9ee271a1db", "volume_size" : null, "full_trans_user_pwd" : "******", "increment_trans_user_pwd" : "******", "ssl_link" : false, "ssl_cert_key" : null, "ssl_cert_name" : null, "ssl_cert_check_sum" : null, "ssl_cert_password" : null, "db_version" : "5.7.31", "mongo_ha_mode" : null, "project_id" : "054ba152d480d55b2f5dc0069e7ddef0", "cluster_mode" : "Single", "instance_id" : "3efbb0f1241f429e8e1d8f99ab094c7ain01", "db_name" : null, "safe_mode" : null, "kerberos_vo" : null, "multi_write_db_id" : null }, "target_db" : { "id" : "81ca3c57-029b-4a37-8f2d-2ee5f128ef9d", "region" : "cn-xianhz-1", "ip" : "192.168.1.60", "topic" : null, "obj_id" : "b46e908dbbb44bb3b17f0a75c908d1d7no01", "instance_name" : "rds-zw-target", "db_type" : "mysql", "db_user" : "root", "db_password" : "********", "manage_ip" : null, "traffic_ip" : "192.168.1.60", "db_port" : 3306, "created_at" : "2020-12-16T12:09:55Z", "updated_at" : "2020-12-18T06:33:08Z", "public_ip" : null, "az_code" : "az3xahz", "security_group_id" : "652cbe2d-d487-407e-b666-d01948b33879", "subnet_id" : "c6f66ccb-be7a-499e-aa8a-1389355e67a8", "vpc_id" : "7c73a425-885b-4e54-a0e6-ef9ee271a1db", "volume_size" : 40, "full_trans_user_pwd" : "******", "increment_trans_user_pwd" : "******", "ssl_link" : false, "ssl_cert_key" : null, "ssl_cert_name" : null, "ssl_cert_check_sum" : null, "ssl_cert_password" : null, "db_version" : "5.7.31", "mongo_ha_mode" : null, "project_id" : "054ba152d480d55b2f5dc0069e7ddef0", "cluster_mode" : "Single", "instance_id" : "a3ab61173b1b4533b8c3dfc2bb3ec828in01", "db_name" : null, "safe_mode" : null, "kerberos_vo" : null, "multi_write_db_id" : null }, "job_direction" : "down", "is_target_readonly" : false } ] }

响应参数 状态码： 202 表4 响应Body参数 参数 参数类型 描述 results Array of objects 批量主备倒换任务返回列表。 详情请参见表5。 count Integer 总数。 表5 results字段数据结构说明 参数 参数类型 描述 job_id String 任务ID。 updated_at String 更新时间，格式yyyy-MM-dd'T'HH:mm:ss'Z'。 source_db Object 源数据库。 详情请参见表6。 target_db Object 目标数据库。 详情请参见表6。 job_direction String 任务方向。取值： up：入云，灾备场景时对应本云为备。 down：出云，灾备场景时对应本云为主。 non-dbs：自建。 is_target_readonly Boolean 目标库是否只读。 error_msg String 错误信息。 error_code String 错误码。 表6 source_db和target_db字段数据结构说明 参数 参数类型 描述 id String 数据库ID。 obj_id String 对象ID。 instance_name String RDS实例名称。 db_type String 数据库类型。取值： mysql mongodb db_user String 数据库用户。 db_password String 数据库密码。 manage_ip String 管理IP。 traffic_ip String 流量IP。 db_port Integer 数据库端口。 region String RDS实例所在Region。 created_at String 创建日期，格式yyyy-MM-dd'T'HH:mm:ss'Z'。 updated_at String 修改日期，格式yyyy-MM-dd'T'HH:mm:ss'Z'。 ip String 迁移实例所在的私有IP。 public_ip String 迁移实例所在的公网IP。 az_code String 可用区azCode。 security_group_id String 源库所在的安全组ID。 subnet_id String 源库所在的子网ID。 vpc_id String 源库所在的虚拟私有云ID。 volume_size Long 迁移实例的磁盘大小。 full_trans_user_pwd String 全量迁移用户密码，密文。 increment_trans_user_pwd String 增量迁移用户密码，密文。 ssl_link Boolean 是否SSL安全连接。 ssl_cert_key String SSL证书内容。 ssl_cert_name String SSL证书名字。 ssl_cert_check_sum String SSL证书内容checksum值。 ssl_cert_password String SSL证书密码，密文。 db_version String 数据库版本。 mongo_ha_mode String mongoHa模式。取值： Sharding：集群。 ReplicaSet：副本集。 ReplicaSingle：单节点。 project_id String RDS实例projectId。 cluster_mode String 集群模式。取值： Single：单节点RDS。 Ha：主备RDS。 GR：金融版RDS。 Sharding：MongoDB集群或DDM的模式，均默认为分片。 ReplicaSet：MongoDB副本集。 Replica：RDS只读副本。 ReplicaSingle：MongoDB单节点。 Cluster：集群。 Independent： GaussDB independent模式。 Combined：GaussDB Combined模式。 Distributed：分布式GaussDB(for MySQL)。 instance_id String RDS实例ID。 db_name String Oracle服务名serviceName。 topic String mrskafka topic名称。 safe_mode Integer MRS kafka是否开启kerberos认证。取值： 0：非安全认证。 1：安全认证。 kerberos_vo Object kerberos认证需要的信息。 详情请参见表7。 multi_write_db_id String 多写数据库ID。 表7 kerberos_vo字段数据结构说明 参数 参数类型 描述 krb5_conf_file String krb5配置文件。 key_tab_file String key文件。 domain_name String 域名 。 user_principal String Kerberos用户对象。

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 Content-Type 是 String 指定类型为application/json。 缺省值：application/json X-Auth-Token 是 String 从IAM服务获取的用户Token。 X-Language 否 String 请求语言类型。 缺省值：en-us 取值： en-us zh-cn 表3 请求Body参数 参数 是否必选 参数类型 描述 jobs 是 Array of strings 批量主备调换的任务详情ID请求列表。

响应示例 状态码： 202 Accepted { "count" : 1, "results" : [ { "job_id" : "8d0e8e36-a618-490d-8a46-8c61ac9jb502", "rpo_info" : { "delay" : "0", "time" : "2020-12-18 15:47:05", "gtid_set" : "NA", "check_point" : "mysql-bin.000514:197" }, "rto_info" : { "delay" : "0", "time" : "2020-12-18 15:47:05", "gtid_set" : "NA", "check_point" : "mysql-bin.000514:197" } } ] }

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 Content-Type 是 String 指定类型为application/json。 缺省值：application/json X-Auth-Token 是 String 从IAM服务获取的用户Token。 X-Language 否 String 请求语言类型。 缺省值：en-us 取值： en-us zh-cn 表3 请求Body参数 参数 是否必选 参数类型 描述 jobs 是 Array of strings 批量查询RPO和RTO的任务详情ID请求列表。

响应参数 状态码： 202 表4 响应Body参数 参数 参数类型 描述 count Integer 总数。 results Array of objects 批量查询RPO和RTO的响应体集合。 详情请参见表5。 表5 results字段数据结构说明 参数 参数类型 描述 job_id String 任务ID。 rpo_info Object RPO信息。 详情请参见表6。 rto_info Object RTO信息。 详情请参见表6。 error_code String 错误码。 error_msg String 错误信息。 表6 rpo_info和rto_info字段数据结构说明 参数 参数类型 描述 check_point String 检查点。 delay String 延迟（单位ms）。 gtid_set String gtid。 time String 当前时间 ，格式为“yyyy-MM-dd HH:mm:ss”。

响应示例 状态码： 200 OK 查询灾备进度响应示例 1： { "count" : 1, "results" : [ { "progress" : "100", "job_id" : "8d0e8e36-a618-490d-8a46-8c61ac9jb502", "incre_trans_delay" : "0", "task_mode" : "FULL_INCR_TRANS", "transfer_status" : "INCRE_TRANSFER_STARTED", "process_time" : "1608274919000", "remaining_time" : "0" } ] } 查询灾备进度响应示例 2： { "count" : 2, "results" : [ { "progress" : "100", "job_id" : "edae91cb-5892-49b6-a529-4921fb26jb21", "incre_trans_delay" : "0", "task_mode" : "FULL_INCR_TRANS", "transfer_status" : "INCRE_TRANSFER_STARTED", "process_time" : "1594864576000", "remaining_time" : "10" }, { "progress" : "0", "job_id" : "f95c5d83-d0c9-42bd-b295-38c31cd1jb15", "incre_trans_delay" : "-1", "task_mode" : "FULL_INCR_TRANS", "transfer_status" : "FULL_TRANSFER_COMPLETE", "process_time" : "0", "remaining_time" : "0", "progress_map" : { "struct" : { "completed" : "94%", "remaining_time" : null }, "data" : { "completed" : "100%", "remaining_time" : null }, "index" : { "completed" : "100%", "remaining_time" : null } } } ] }

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 Content-Type 是 String 指定类型为application/json。 缺省值：application/json X-Auth-Token 是 String 从IAM服务获取的用户Token。 X-Language 否 String 请求语言类型。 缺省值：en-us 取值： en-us zh-cn 表3 请求Body参数 参数 是否必选 参数类型 描述 jobs 是 Array of strings 批量查询进度任务ID请求列表。

响应示例 状态码： 202 Accepted 结束任务响应示例 { "count" : 2, "results" : [ { "id" : "4c6ac8c0-2f51-426a-97b2-cb2c668jb201", "status" : "success" }, { "id" : "6211d20d-0006-41da-836e-db3301ajb20b", "status" : "failed", "error_code" : "DRS.M01504", "error_msg" : "Another operation is being performed on the migration task or the migration task is abnormal. Try again later." } ] } 删除任务响应示例 { "count" : 1, "results" : [ { "id" : "140b5236-88ad-43c8-811c-1268453jb101", "status" : "success" } ] }

响应参数 状态码： 202 表5 响应Body参数 参数 参数类型 描述 results Array of objects 批量结束任务或删除任务的响应体集合。 详情请参见表6。 count Integer 总数。 表6 results字段数据结构说明 参数 参数类型 描述 id String 任务ID。 status String 状态。取值： success failed error_code String 错误码。 error_msg String 错误信息。

请求示例 结束指定的两个任务 https://{endpoint}/v3/054ba152d480d55b2f5dc0069e7ddef0/jobs/batch-jobs { "jobs" : [ { "delete_type" : "terminate", "job_id" : "4c6ac8c0-2f51-426a-97b2-cb2c668jb201" }, { "delete_type" : "terminate", "job_id" : "6211d20d-0006-41da-836e-db3301ajb20b" } ] } 删除指定任务 https://{endpoint}/v3/054ba152d480d55b2f5dc0069e7ddef0/jobs/batch-jobs { "jobs" : [ { "delete_type" : "delete", "job_id" : "140b5236-88ad-43c8-811c-1268453jb101" } ] }

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 Content-Type 是 String 指定类型为application/json。 缺省值：application/json X-Auth-Token 是 String 从IAM服务获取的用户Token。 X-Language 否 String 请求语言类型。 缺省值：en-us 取值： en-us zh-cn 表3 请求Body参数 参数 是否必选 参数类型 描述 jobs 是 Array of objects 批量结束与删除任务请求列表。 详情请参见表4。 表4 jobs字段数据结构说明 参数 是否必选 参数类型 描述 delete_type 是 String terminate：结束迁移任务，force_terminate：强制结束迁移任务，delete：删除迁移任务。 取值： terminate force_terminate delete 说明： 包年/包月任务需要先手动退订，然后delete_type参数设置为delete调用该接口删除任务。 job_id 是 String 任务ID。 is_show_breakpoint_position 否 Boolean MySQL为源的实时迁移、实时同步、实时灾备任务，结束任务时是否展示断点信息。缺省为null，表示不展示断点信息。

响应参数 状态码： 202 表5 响应Body参数 参数 参数类型 描述 results Array of StartJobResp objects 批量启动实时灾备任务返回列表。 count Integer 总数。 表6 StartJobResp 参数 参数类型 描述 id String 任务ID。 status String 状态。取值： success failed order_id String 订单ID。 说明： 通过API创建的包年/包月任务返回该字段。 error_code String 错误码。 error_msg String 错误信息。

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 Content-Type 是 String 指定类型为application/json。 缺省值：application/json X-Auth-Token 是 String 从IAM服务获取的用户Token。 X-Language 否 String 请求语言类型。 缺省值：en-us 取值： en-us zh-cn 表3 请求Body参数 参数 是否必选 参数类型 描述 jobs 是 Array of objects 批量启动任务请求列表。 详情请参见表4。 表4 jobs字段数据结构说明 参数 是否必选 参数类型 描述 job_id 是 String 任务ID。 start_time 否 String 任务启动时间，时间戳格式精确到毫秒，例如：1608188903063，取值为空代表立即启动。

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 results Array of objects 批量查询预检查结果响应体集合。 详情请参见表5。 count Integer 总记录数。 表5 results字段数据结构说明 参数 参数类型 描述 precheck_id String 查询预检查结果的任务ID。 result Boolean 返回的预检查结果是否通过。true表示预检查通过，通过后才可进行启动任务。 process String 预检查进度百分比。 total_passed_rate String 预检查通过百分比。 rds_instance_id String RDS实例ID。 job_direction String 任务方向。取值： up：入云，灾备场景时对应本云为备。 down：出云，灾备场景时对应本云为主。 non-dbs：自建。 precheck_result Array of object 预检查各项结果。 详情请参见表6。 error_msg String 错误信息。 error_code String 任务错误码。 表6 precheck_result字段数据结构说明 参数 参数类型 描述 item String 检查项。 result String 检查结果。取值： PASSED ALARM FAILED failed_reason String 失败原因。 data String 加密的数据。 raw_error_msg String 行错误信息。 group String 检查项分组。 failed_sub_jobs Array of objects 失败的子任务信息。 详情请参见表7。 表7 failed_sub_jobs字段数据结构说明 参数 参数类型 描述 id String 预检查失败子任务ID。 name String 预检查失败子任务名称。 check_result String 检查结果。

响应示例 状态码： 200 OK 实时迁移MySQL查询预检查结果响应示例 ： { "count" : 1, "results" : [ { "result" : true, "process" : "100%", "precheck_id" : "140b5236-88ad-43c8-811c-1268453jb101", "total_passed_rate" : "100%", "rds_instance_id" : "e05a3679efe241d8b5dee80b17c1a863in01", "job_direction" : "up", "precheck_result" : [ { "item" : "dstDbDiskSize", "result" : "PASSED", "data" : "{\"diskSizeTimes\":\"1.5\",\"dstVolumeSize\":\"37660000000\",\"srcIndexSize\":0,\"size\":\"0\",\"srcIndexAmount\":0}", "group" : "db_disk_size" }, { "item" : "checkIncreSrcDbExistedInDstDb", "result" : "PASSED", "group" : "db_params" }, { "item" : "dbCharacterSetConsistency", "result" : "PASSED", "group" : "db_params" }, { "item" : "dbClockConsistency", "result" : "PASSED", "group" : "db_params" }, { "item" : "dbCollationServerConsistency", "result" : "PASSED", "group" : "db_params" }, { "item" : "dbIsolationLevelConsistency", "result" : "PASSED", "group" : "db_params" }, { "item" : "dbParamConsistency", "result" : "PASSED", "group" : "db_params" }, { "item" : "dbServerUuidConsistency", "result" : "PASSED", "group" : "db_params" }, { "item" : "dstMaxAllowedPacketCheck", "result" : "PASSED", "group" : "db_params" }, { "item" : "hasForeignKeyOnUnselectedTable", "result" : "PASSED", "group" : "db_params" }, { "item" : "innodbStrictModeConsistency", "result" : "PASSED", "group" : "db_params" }, { "item" : "isUserRequireSslLink", "result" : "PASSED", "group" : "db_params" }, { "item" : "sqlModeConsistency", "result" : "PASSED", "group" : "db_params" }, { "item" : "sqlModeNoEngine", "result" : "PASSED", "group" : "db_params" }, { "item" : "srcBinlogFormatCheck", "result" : "PASSED", "group" : "db_params" }, { "item" : "srcBinlogRowImageCheck", "result" : "PASSED", "group" : "db_params" }, { "item" : "srcDbBinlogExpireLogsDays", "result" : "PASSED", "group" : "db_params" }, { "item" : "srcDbBinlogIsOff", "result" : "PASSED", "group" : "db_params" }, { "item" : "srcDbExistUnsupportEngineTable", "result" : "PASSED", "group" : "db_params" }, { "item" : "srcDbIndexKeyLength", "result" : "PASSED", "group" : "db_params" }, { "item" : "srcDbNameContainsUnsupportedSymbols", "result" : "PASSED", "group" : "db_params" }, { "item" : "srcDbServerIdCheck", "result" : "PASSED", "group" : "db_params" }, { "item" : "srcDstTableNameCaseSensitiveCheck", "result" : "PASSED", "group" : "db_params" }, { "item" : "srcHasNoPkTableWhenTgtHasInvisiblePk", "result" : "PASSED", "group" : "db_params" }, { "item" : "srcRoutinesWithoutPrivilegeCheck", "result" : "PASSED", "group" : "db_params" }, { "item" : "srcTableNameContainsNonAscii", "result" : "PASSED", "group" : "db_params" }, { "item" : "srcTriggerAndEventCheck", "result" : "PASSED", "group" : "db_params" }, { "item" : "srcViewNameContainsNonAscii", "result" : "PASSED", "group" : "db_params" }, { "item" : "srclogSlaveUpdatesCheck", "result" : "PASSED", "group" : "db_params" }, { "item" : "userRequirementIsEnoughForDefiner", "result" : "PASSED", "group" : "db_params" }, { "item" : "userSelectObjectsCheck", "result" : "PASSED", "group" : "db_params" }, { "item" : "dstStatusCheck", "result" : "PASSED", "data" : "", "group" : "db_target_status", "failed_reason" : "" }, { "item" : "dstDbPrivilegesIsEnough", "result" : "PASSED", "group" : "db_user_privilege" }, { "item" : "srcDbPrivilegesIsEnoughForIncre", "result" : "PASSED", "group" : "db_user_privilege" }, { "item" : "dbVersionMeetRequirement", "result" : "PASSED", "group" : "db_version" }, { "item" : "dstDbVersionSupport", "result" : "PASSED", "group" : "db_version" }, { "item" : "srcDbVersionSupport", "result" : "PASSED", "group" : "db_version" }, { "item" : "dstDbConnection", "result" : "PASSED", "group" : "network" }, { "item" : "srcDbConnection", "result" : "PASSED", "group" : "network" } ] } ] } 实时迁移DDS查询预检查结果响应示例 ： { "count" : 1, "results" : [ { "result" : true, "process" : "100%", "precheck_id" : "a281f62f-4631-45d6-a2d3-679a9f4jb105", "total_passed_rate" : "100%", "rds_instance_id" : "3cadd5a0ef724f55ac7fa5bcb5f4fc5fin02", "job_direction" : "up", "precheck_result" : [ { "item" : "dstDbDiskSize", "result" : "PASSED", "data" : "{'size': '5263360', 'dstVolumeSize':'19089431762', 'diskSizeTimes':'1.5'}", "group" : "db_disk_size" }, { "item" : "srcAndDstCappedCollConsistency", "result" : "PASSED", "group" : "db_object_conflict_check" }, { "item" : "srcCollAlreadyExistedInDstColl", "result" : "PASSED", "group" : "db_object_conflict_check" }, { "item" : "srcViewAlreadyExistedInDstView", "result" : "PASSED", "group" : "db_object_conflict_check" }, { "item" : "rolesDependentCheck", "result" : "PASSED", "group" : "db_object_dependency_check" }, { "item" : "usersDependentCheck", "result" : "PASSED", "group" : "db_object_dependency_check" }, { "item" : "srcCollHasTtlIndex", "result" : "ALARM", "data" : "{\"srcHasTtlIndexColls\":\"fastunit.ttlsuoyin\"}", "group" : "db_params", "failed_reason" : "SRC_HAS_TTL_INDEXES" }, { "item" : "dbSslConsistency", "result" : "PASSED", "group" : "db_params" }, { "item" : "dstChunkNumCheck", "result" : "PASSED", "group" : "db_params" }, { "item" : "mongoTypeFitTransferMode", "result" : "PASSED", "group" : "db_params" }, { "item" : "srcCollIndexNumCheck", "result" : "PASSED", "group" : "db_params" }, { "item" : "srcCollNameContainsUnsupportedSymbols", "result" : "PASSED", "group" : "db_params" }, { "item" : "srcDbInstanceIsEmpty", "result" : "PASSED", "group" : "db_params" }, { "item" : "srcDbNameContainsUnsupportedSymbols", "result" : "PASSED", "group" : "db_params" }, { "item" : "srcIdIndexCheck", "result" : "PASSED", "group" : "db_params" }, { "item" : "userSelectObjectsCheck", "result" : "PASSED", "group" : "db_params" }, { "item" : "dstStatusCheck", "result" : "PASSED", "data" : "", "group" : "db_target_status", "failed_reason" : "" }, { "item" : "dstDbPrivilegesIsEnough", "result" : "PASSED", "group" : "db_user_privilege" }, { "item" : "srcDbPrivilegesIsEnough", "result" : "PASSED", "group" : "db_user_privilege" }, { "item" : "dbVersionMeetRequirement", "result" : "PASSED", "group" : "db_version" }, { "item" : "dstDbVersionSupport", "result" : "PASSED", "group" : "db_version" }, { "item" : "srcDbVersionSupport", "result" : "PASSED", "group" : "db_version" }, { "item" : "dstDbConnection", "result" : "PASSED", "group" : "network" }, { "item" : "srcDbConnection", "result" : "PASSED", "group" : "network" }, { "item" : "srcShardKeyConfiguration", "result" : "ALARM", "data" : "{\"notConfigShardIndexColls\":\"ycsb.usertable,mgo.mycollection7,mgo.mycollection9,mgo.mycollection5,mgo.mycollection4,mgo.mycollection3,mgo.mycollection,mgo.mycollection8,mgo.mycollection2,mgo.mycollection6,testdb3.testuk,testdb3.coll2,testdb3.coll6,testdb3.coll1,testdb3.Coll1,testdb3.testuk2,testdb3.coll5,testdb3.coll4,testdb1.coll6,testdb1.coll1,testdb1.testuk2,testdb1.coll2,testdb1.testuk,testdb1.coll5,testdb1.coll4,testdb1.Coll1,Testdb5.coll1,Testdb5.collx,Testdb5.Coll1,fastunit.gudingjihe,fastunit.geohaystack,fastunit.coll,fastunit.weiyisuoyin,fastunit.testSpecial\\\\u4E2D\\\\u6587~!@#%^&*()_+=-[]{};:?,`,fastunit.log,fastunit.twoD,fastunit.lianhesuoyin,fastunit.xishusuoyin,fastunit.quanwensuoyin,fastunit.ttlsuoyin,fastunit.putongsuoyin,fastunit.collcount,fastunit.shuzusuoyin,fastunit.twodsphere,fastunit.qiantaowendangsuoyin,fastunit.indexpartial\"}", "group" : "src_info_check", "failed_reason" : "SRC_INSTANCE_TYPE_IS_REPLICA_SET" }, { "item" : "checkBalanceStatus", "result" : "PASSED", "group" : "src_info_check" }, { "item" : "srcMongoInstanceType", "result" : "PASSED", "group" : "src_info_check" } ] } ] }

请求示例 查询DDS实时迁移预检查结果 https://{endpoint}/v3/054ba152d480d55b2f5dc0069e7ddef0/jobs/batch-precheck-result { "jobs" : [ "a281f62f-4631-45d6-a2d3-679a9f4jb105" ] } 查询MySQL实时迁移预检查结果 https://{endpoint}/v3/054ba152d480d55b2f5dc0069e7ddef0/jobs/batch-precheck-result { "jobs" : [ "140b5236-88ad-43c8-811c-1268453jb101" ] }

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 Content-Type 是 String 指定类型为application/json。 缺省值：application/json X-Auth-Token 是 String 从IAM服务获取的用户Token。 X-Language 否 String 请求语言类型。 缺省值：en-us 取值： en-us zh-cn 表3 请求Body参数 参数 是否必选 参数类型 描述 jobs 是 Array of strings 批量查询预检查结果请求列表。 约束：不能包含空对象。集合中的元素取值严格匹配UUID规则。任务id不能重复。

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 Content-Type 是 String 指定类型为application/json。 缺省值：application/json X-Auth-Token 是 String 从IAM服务获取的用户Token，请参见认证鉴权。 X-Language 否 String 请求语言类型。 缺省值：en-us 取值： en-us zh-cn 表3 请求Body参数 参数 是否必选 参数类型 描述 jobs 是 Array of objects 批量预检查请求列表。 详情请参见表4。 表4 jobs字段数据结构说明 参数 是否必选 参数类型 描述 job_id 是 String 任务ID。 precheck_mode 是 String 预检查模式。取值： forStartJob：任务配置中，首次启动时传该值。 forRetryJob：任务增量中，编辑对象后预检查，或者任务失败后重试，传该值。 说明： 请按照任务对应的状态传值，否则可能导致预检查失败，影响任务启动。