华为云用户手册

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 job_action Object 允许、不允许的操作集合。 详情请参见表4。 表4 job_action字段数据结构说明 参数 参数类型 描述 available_actions Array of strings 任务可操作命令集合。 取值： CREATE：创建任务 CHOOSE_OBJECT：选择对象，任务增量中再编辑 PRE_CHECK：预检查 CHANGE_MODE：修改任务模式 FREE_RESOURCE：释放资源 MODIFY_DB_CONFIG：修改数据库配置 RESET_DB_PWD：重置数据库密码（源库、目标库） MODIFY_CONFIGURATION：修改任务配置 PAUSE：暂停任务 START：启动任务 CHANGE：修改任务 RETRY：重试任务 RESET：重置任务 DELETE：删除任务 QUERY_PRE_CHECK：预检查 SWITCH_OVER：容灾倒换 START_INCR：CASSANDRA启动增量任务 MODIFY_TASK_NUMBER：CASSANDRA修改线程数配置 CONTINUE_JOB：oracle- GaussDB 分布式:启动失败或者停止的任务 STOP_JOB：oracle-GaussDB分布式:停止任务 CONTINUE_CAPTURE：启动抓取 STOP_CAPTURE：停止抓取 CONTINUE_APPLY：启动回放 STOP_APPLY：停止回放 PAY_ORDER：包年包月支付订单 UNSUBSCRIBE：包年包月退订 TO_PERIOD：转包周期 TO_RENEW：包周期续费 ORDER_INFO：订单详情 CHANGE_FLAVOR：规格变更 CLONE：克隆任务 unavailable_actions Array of strings 任务不可操作命令集合。 取值： CREATE：创建任务 CHOOSE_OBJECT：选择对象，任务增量中再编辑 PRE_CHECK：预检查 CHANGE_MODE：修改任务模式 FREE_RESOURCE：释放资源 MODIFY_DB_CONFIG：修改数据库配置 RESET_DB_PWD：重置数据库密码（源库、目标库） MODIFY_CONFIGURATION：修改任务配置 PAUSE：暂停任务 START：启动任务 CHANGE：修改任务 RETRY：重试任务 RESET：重置任务 DELETE：删除任务 QUERY_PRE_CHECK：预检查 SWITCH_OVER：容灾倒换 START_INCR：CASSANDRA启动增量任务 MODIFY_TASK_NUMBER：CASSANDRA修改线程数配置 CONTINUE_JOB：oracle-GaussDB分布式:启动失败或者停止的任务 STOP_JOB：oracle-GaussDB分布式:停止任务 CONTINUE_CAPTURE：启动抓取 STOP_CAPTURE：停止抓取 CONTINUE_APPLY：启动回放 STOP_APPLY：停止回放 PAY_ORDER：包年包月支付订单 UNSUBSCRIBE：包年包月退订 TO_PERIOD：转包周期 TO_RENEW：包周期续费 ORDER_INFO：订单详情 CHANGE_FLAVOR：规格变更 CLONE：克隆任务 current_action String 当前操作。 状态码： 422 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码。 最小长度：12 最大长度：12 error_msg String 错误描述。 最小长度：1 最大长度：512

响应示例 状态码： 200 OK { "job_action": { "available_actions": [ "CREATE", "CHOOSE_OBJECT", "PRE_CHECK" ], "unavailable_actions": [ "START", "QUICK_START", "CHANGE", "RETRY" ], "current_action": "SWITCH_OVER" } } 状态码： 400 Bad Request { "error_code": "DRS.10000001", "error_msg": "Failed." }

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 Content-Type 是 String 发送的实体的MIME类型。推荐用户默认使用application/json，如果API是对象、镜像上传等接口，媒体类型可按照流类型的不同进行确定。 缺省值：application/json X-Auth-Token 是 String 从 IAM 服务获取的用户Token。 用户Token也就是调用获取用户Token接口的响应值，该接口是唯一不需要认证的接口。 请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。 X-Language 否 String 请求语言类型。 缺省值：en-us 枚举值： en-us zh-cn

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 count Long 总数。 object_mapping_list Array of objects 同步映射数据列表。 详情请参见表5。 表5 object_mapping_list参数说明 参数 参数类型 描述 source_db_name String 源数据库库名。 source_schema_name String 源数据库模式名。 source_table_name String 源数据库表名。 target_db_name String 目标数据库库名。 target_schema_name String 目标数据库模式名。 target_table_name String 目标数据库表名。 has_column_info Boolean 是否有列映射。 状态码： 400 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码。 最小长度：12 最大长度：12 error_msg String 错误描述。 最小长度：1 最大长度：512

响应示例 状态码： 200 OK { "object_mapping_list" : [ { "source_db_name" : "yf", "source_table_name" : "aaaa", "target_db_name" : "yf", "target_table_name" : "aaaa" } ], "count" : 1 } 状态码： 400 Bad Request { "error_code": "DRS.M05003", "error_msg": "Task information not found." }

请求示例 查询同步映射列表请求示例。 https://{endpoint}/v5/5237e10fe9aa4ad5b16b6a5245248314/jobs/163b98e8-6088-46c3-8b86-c18fea6jb502/object-mappings { "db_name": "", "schema_name": "", "table_name": "", "offset": 1, "limit": 10, "has_column_info": false }

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 Content-Type 是 String 发送的实体的MIME类型。推荐用户默认使用application/json，如果API是对象、镜像上传等接口，媒体类型可按照流类型的不同进行确定。 缺省值：application/json X-Auth-Token 是 String 从IAM服务获取的用户Token。 用户Token也就是调用获取用户Token接口的响应值，该接口是唯一不需要认证的接口。 请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。 X-Language 否 String 请求语言类型。 缺省值：en-us 枚举值： en-us zh-cn 表3 请求Body参数 参数 是否必选 参数类型 描述 offset 否 Integer 偏移量，表示从此偏移量开始查询， offset 大于等于 0。默认为0 缺省值：0 limit 否 Integer 每页显示的条目数量。默认为10，取值范围【1-1000】 最小值：1 最大值：1000 缺省值：10 db_name 否 String 库名。 schema_name 否 String 模式名。 table_name 否 String 表名。 has_column_info 否 Boolean 是否有列映射。

响应示例 状态码： 200 OK { "count": 1, "create_time": "1686038576882", "flow_compare_data": [ { "src_db": "a", "src_tb": "b", "dst_db": "c", "dst_tb": "d", "progress": 10 } ] } 状态码： 400 Bad Request { "error_code": "DRS.M05003", "error_msg": "Task information not found." }

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 count Long 总数。 create_time String 数据生成时间。 flow_compare_data Array of objects 对比结果。 详情请参见表5。 表5 flow_compare_data参数说明 参数 参数类型 描述 src_db String 源数据库名称。 src_tb String 源对象名称。 dst_db String 目标数据库名称。 dst_tb String 目标对象名称。 progress Integer 进度。 状态码： 400 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码。 最小长度：12 最大长度：12 error_msg String 错误描述。 最小长度：1 最大长度：512

请求参数 表3 请求Header参数 参数 是否必选 参数类型 描述 Content-Type 是 String 发送的实体的MIME类型。推荐用户默认使用application/json，如果API是对象、镜像上传等接口，媒体类型可按照流类型的不同进行确定。 缺省值：application/json X-Auth-Token 是 String 从IAM服务获取的用户Token。 用户Token也就是调用获取用户Token接口的响应值，该接口是唯一不需要认证的接口。 请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。 X-Language 否 String 请求语言类型。 缺省值：en-us 枚举值： en-us zh-cn

URI GET /v5/{project_id}/jobs/{job_id}/progress-data/{type} 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 租户在某一Region下的Project ID。 获取方法请参见获取项目ID。 job_id 是 String 任务ID。 type 是 String 迁移对象类型。 table event table_structure procedure view function database trigger table_indexs 表2 Query参数 参数 是否必选 参数类型 描述 limit 否 String 每页显示的条目数量。默认为10，取值范围【1-1000】 最小值：1 最大值：1000 缺省值：10 offset 否 String 偏移量，表示从此偏移量开始查询， offset 大于等于 0。默认为0 缺省值：0

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 count Integer 总数。 compare_jobs Array of objects 健康对比任务列表。 详情请参见表5。 表5 compare_jobs参数说明 参数 参数类型 描述 id String 任务ID。 type String 对比类型。 start_time String 对比开始时间。 end_time String 对比结束时间。 status String 状态。 WAITING_FOR_RUNNING：等待启动中 RUNNING：运行中 SUC CES SFUL：完成 FAILED：失败 CANCELLED：已取消 TIMEOUT_INTERRUPT：超时中断 FULL_DOING：全量校验中 INCRE_DOING：增量校验中 compute_type String 对比计算资源。 状态码： 400 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码。 最小长度：12 最大长度：12 error_msg String 错误描述。 最小长度：1 最大长度：512

响应示例 状态码： 200 OK { "count": 1, "compare_jobs": [ { "id": "cd05434c-ad91-479c-a8d3-d90d58eccc43", "type": "lines,account,object_comparison", "status": "SUCCESSFUL", "start_time": "1686038400512", "end_time": "1686038408711", "compute_type": "drs" } ] } 状态码： 400 Bad Request { "error_code": "DRS.M05003", "error_msg": "Task information not found." }

请求参数 表3 请求Header参数 参数 是否必选 参数类型 描述 Content-Type 是 String 发送的实体的MIME类型。推荐用户默认使用application/json，如果API是对象、镜像上传等接口，媒体类型可按照流类型的不同进行确定。 缺省值：application/json X-Auth-Token 是 String 从IAM服务获取的用户Token。 用户Token也就是调用获取用户Token接口的响应值，该接口是唯一不需要认证的接口。 请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。 X-Language 否 String 请求语言类型。 缺省值：en-us 枚举值： en-us zh-cn

URI GET /v5/{project_id}/jobs/{job_id}/health-compare-jobs 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 租户在某一Region下的Project ID。 获取方法请参见获取项目ID。 job_id 是 String 任务ID。 表2 Query参数 参数 是否必选 参数类型 描述 status 否 String 状态，不传查询所有状态。 WAITING_FOR_RUNNING：等待启动中 RUNNING：运行中 SUCCESSFUL：完成 FAILED：失败 CANCELLED：已取消 TIMEOUT_INTERRUPT：超时中断 FULL_DOING：全量校验中 INCRE_DOING：增量校验中 枚举值： WAITING_FOR_RUNNING RUNNING SUCCESSFUL FAILED CANCELLED TIMEOUT_INTERRUPT FULL_DOING INCRE_DOING limit 否 String 每页显示的条目数量。默认为10，取值范围【1-1000】 最小值：1 最大值：1000 缺省值：10 offset 否 String 偏移量，表示从此偏移量开始查询， offset 大于等于 0。默认为0 缺省值：0

响应示例 状态码： 200 OK { "period": "* * 1,2,3,4,5,6,7", "status": "OPEN", "begin_time": "08:00:00", "end_time": "10:00:00", "compare_type": [ "lines", "account", "object_comparison" ], "next_compare_time": "2023-06-12T08:00:00Z", "compare_policy": "normal" } 状态码： 400 Bad Request { "error_code": "DRS.M05003", "error_msg": "Task information not found." }

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 Content-Type 是 String 发送的实体的MIME类型。推荐用户默认使用application/json，如果API是对象、镜像上传等接口，媒体类型可按照流类型的不同进行确定。 缺省值：application/json X-Auth-Token 是 String 从IAM服务获取的用户Token。 用户Token也就是调用获取用户Token接口的响应值，该接口是唯一不需要认证的接口。 请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。 X-Language 否 String 请求语言类型。 缺省值：en-us 枚举值： en-us zh-cn

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 interval_hour Integer 间隔时间。 period String 对比时间。 begin_time String 对比开始时间。 end_time String 对比结束时间。 compare_type Array of strings 对比类型。 object：对象对比 lines：行对比 account：用户对比 status String 对比策略状态。 OPEN：开启 CLOSED：关闭，没有设置对比策略 NO_SUPPORT：当前无数据 枚举值： OPEN CLOSED NO_SUPPORT next_compare_time String 下次对比时间，UTC时间，例如：2023-06-12T08:00:00Z compare_policy String 对比策略。 normal：普通对比 manyToOne：多对一对比 状态码： 400 表4 响应Body参数 参数 参数类型 描述 error_code String 错误码。 最小长度：12 最大长度：12 error_msg String 错误描述。 最小长度：1 最大长度：512

响应示例 状态码： 200 OK { "count": 1, "dirty_data_list": [ { "db_name": "gltest01", "schema_name": "gltest", "table_name": "decimal_01", "error_sql": "INSERT INTO \"gltest\".\"decimal_01\" (\"c1\",\"c2\",\"c3\") VALUES (2,NULL,'2.000000000000000000000000000'::numeric)", "error_time": "2020-09-01T18:50:20.200Z", "error_msg": "ERROR: null value in column \"c2\" violates not-null constraint" } ] } 状态码： 400 Bad Request { "error_code": "DRS.M05003", "error_msg": "Task information not found." }

请求参数 表3 请求Header参数 参数 是否必选 参数类型 描述 Content-Type 是 String 发送的实体的MIME类型。推荐用户默认使用application/json，如果API是对象、镜像上传等接口，媒体类型可按照流类型的不同进行确定。 缺省值：application/json X-Auth-Token 是 String 从IAM服务获取的用户Token。 用户Token也就是调用获取用户Token接口的响应值，该接口是唯一不需要认证的接口。 请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。 X-Language 否 String 请求语言类型。 缺省值：en-us 枚举值： en-us zh-cn

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 count Integer 总数。 dirty_data_list Array of objects 异常数据列表。 详情请参见表5。 表5 dirty_data_list参数说明 参数 参数类型 描述 db_name String 数据库名称。 schema_name String schema名称。 table_name String 表名称。 error_sql String 异常SQL。 error_time String 发生异常时间，UTC时间，例如：2023-06-10T03:01:52Z error_msg String 异常信息。 状态码： 400 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码。 最小长度：12 最大长度：12 error_msg String 错误描述。 最小长度：1 最大长度：512

URI GET /v5/{project_id}/jobs/{job_id}/dirty-data 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 租户在某一Region下的Project ID。 获取方法请参见获取项目ID。 job_id 是 String 任务ID。 表2 Query参数 参数 是否必选 参数类型 描述 begin_time 否 Integer 开始时间，UTC时间，例如：2020-09-01T18:50:20Z end_time 否 Integer 结束时间，UTC时间，例如：2020-09-01T19:50:20Z limit 否 String 每页显示的条目数量。默认为10，取值范围【1-1000】 最小值：1 最大值：1000 缺省值：10 offset 否 String 偏移量，表示从此偏移量开始查询， offset 大于等于 0。默认为0 缺省值：0

响应示例 状态码： 200 OK { "product_info_list": [ { "id": "78f3a9f1-3d8d-43f0-acc4-ee93f8a9d934", "cloud_service_type": "hws.service.type.drs", "resource_type": "hws.resource.type.drs.vm", "resource_spec_code": "drs.lg.dr", "resource_size": 1, "usage_factor": "Duration", "usage_value": 1, "usage_measure_id": 4 }, { "id": "f52a74ce-5b11-4c5b-b365-488d9fc38882", "cloud_service_type": "hws.service.type.drs", "resource_type": "hws.resource.type.drs.flow", "resource_spec_code": "drs.flow.free", "resource_size": 1, "usage_factor": "flow", "usage_value": 1, "usage_measure_id": 17 } ] } 状态码： 400 Bad Request { "error_code": "DRS.M00202", "error_msg": "The value of parameter jobId is invalid." }

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 product_info_list Array of objects 资源信息列表。 详情请参见表4。 表4 product_info_list字段数据结构说明 参数 参数类型 描述 id String ID标识，同一次询价中不能重复，用于标识返回询价结果和请求的映射关系。 cloud_service_type String 用户购买云服务产品的云服务类型，例如EC2，云服务类型为hws.service.type.ec2。 resource_type String 用户购买云服务产品的资源类型，例如EC2中的VM，资源类型为hws.resource.type.vm。 resource_spec_code String 用户购买云服务产品的资源规格，例如VM的小型规格，资源规格为m1.tiny。 resource_size Integer 资源容量度量标识。 resource_size_measure_id Integer 资源容量大小，例如购买的卷大小或带宽大小。 usage_factor String 使用量因子，按需计费必填，取值和话单中的使用量因子一致，云服务和使用量因子对应关系如下： Duration：云服务器 flow：流量 usage_value Double 使用量值，按需询价必填，例如按小时询价，使用量值为1，使用量单位为小时。 usage_measure_id Integer 使用量单位标识，按需询价必填，例如按小时询价，使用量值为1，使用量单位为小时。 4：小时 10：GB 11：MB 13：Byte 17：FLOW_GB 状态码： 400 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码。 最小长度：12 最大长度：12 error_msg String 错误描述。 最小长度：1 最大长度：512

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 Content-Type 是 String 发送的实体的MIME类型。推荐用户默认使用application/json，如果API是对象、镜像上传等接口，媒体类型可按照流类型的不同进行确定。 缺省值：application/json X-Auth-Token 是 String 从IAM服务获取的用户Token。 用户Token也就是调用获取用户Token接口的响应值，该接口是唯一不需要认证的接口。 请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。 X-Language 否 String 请求语言类型。 缺省值：en-us 枚举值： en-us zh-cn

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 Content-Type 是 String 发送的实体的MIME类型。推荐用户默认使用application/json，如果API是对象、镜像上传等接口，媒体类型可按照流类型的不同进行确定。 缺省值：application/json X-Auth-Token 是 String 从IAM服务获取的用户Token。 用户Token也就是调用获取用户Token接口的响应值，该接口是唯一不需要认证的接口。 请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。 X-Language 否 String 请求语言类型。 缺省值：en-us 枚举值： en-us zh-cn 表3 请求Body参数 参数 是否必选 参数类型 描述 name 是 String 克隆任务名称。名称在4位到50位之间，必须以字母开头，可以包含字母、数字、中划线或下划线，不能包含其他特殊字符，任务名称不能重复。 job_id 是 String 被克隆任务ID。 task_version 否 String 任务版本号，新UX任务为2.0。默认为空，即克隆老任务。 枚举值： 2.0

响应参数 状态码： 202 表4 响应Body参数 参数 参数类型 描述 id String 任务ID。 name String 任务名称。 status String 任务状态。 is_clone_job String 是否为克隆任务。 create_time String 任务创建时间。 状态码： 400 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码。 最小长度：12 最大长度：12 error_msg String 错误描述。 最小长度：1 最大长度：512

响应示例 状态码： 202 Accepted { "id": "c7debc9c-8e09-4a5d-8dd6-cc44f78jb20r", "name": "DRS-1234", "status": "CREATING", "is_clone_job": true, "create_time": "2022-11-07T16:15:18Z" } 状态码： 400 Bad Request { "error_code" : "DRS.10000001", "error_msg" : "Failed." }

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 Content-Type 是 String 发送的实体的MIME类型。使用multipart/form-data，如果API是对象、镜像上传等接口，媒体类型可按照流类型的不同进行确定。 缺省值：multipart/form-data X-Auth-Token 是 String 从IAM服务获取的用户Token。 用户Token也就是调用获取用户Token接口的响应值，该接口是唯一不需要认证的接口。 请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。 X-Language 否 String 请求语言类型。 缺省值：en-us 枚举值： en-us zh-cn 表3 FormData参数 参数 是否必选 参数类型 描述 file 是 File 待上传的模板文件。

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 async_job_id String 批量导入创建的任务ID。 import_error_messages Array of objects 导入失败的错误信息。 详情请参见import_error_messages字段数据结构说明。 error_code String 错误码。 最小长度：12 最大长度：12 error_msg String 错误描述。 最小长度：1 最大长度：512 表5 import_error_messages字段数据结构说明 参数 参数类型 描述 sheet_name String sheet名称。 row_rum String 错误行号。 value String 错误行的value列字段值。 error_message String 错误信息。