华为云用户手册

请求参数 表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

响应参数 状态码： 202 表16 响应Body参数 参数 参数类型 描述 id String 查询结果ID。 job_id String 任务ID。 status String 查询状态。 枚举值： pending failed success 状态码： 400 表17 响应Body参数 参数 参数类型 描述 error_code String 错误码。 最小长度：12 最大长度：12 error_msg String 错误描述。 最小长度：1 最大长度：512

响应示例 状态码： 202 Accept { "id" : "0eacda0b-9422-4535-8b62-537d1833638b", "job_id": "177738d1-4eee-4fcb-a4e1-09aea79jb20i", "status" : "pending" } 状态码： 400 Bad Request { "error_code" : "DRS.10000010", "error_msg" : "Job does not exist, please check job ID." }

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 update_time String 更新时间。 increment_components_list Array of objects 增量组件详情。 详情请参见表4。 表4 increment_components_list参数说明 参数 参数类型 描述 type String 组件类型。取值： capture：抓取 apply：回放 枚举值： capture apply status String 状态。 STOPPED：停止 STARTED：运行中 STOPPING：停止中 STARTING：启动中 start_time String 启动时间。 start_point String 启动位点。 current_point String 当前位点。 resolution_time String 解析时间。 delay String 时延，单位：秒。

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

响应示例 状态码： 200 OK { "increment_components_list" : [ { "type" : "capture", "status" : "STARTED", "start_time" : "2023-07-19T03:09:25Z", "start_point" : "0;0|0", "current_point" : "0;0|0", "resolution_time" : "2023-07-19T03:09:25Z", "delay" : "2" }, { "type" : "apply", "status" : "STARTED", "start_time" : "2023-07-19T03:09:25Z", "start_point" : "-1", "current_point" : "0;0|0", "resolution_time" : "2023-07-19T03:09:25Z", "delay" : "3" } ], "update_time" : "2023-07-19T03:09:25Z" }

响应示例 状态码： 200 OK { "bandwidth" : "37", "is_src_normal" : true, "is_dst_normal" : true, "src_offset" : "mysql-bin.000646:196", "node_offset" : "mysql-bin.000646:196", "dst_offset" : "mysql-bin.000646:196", "src_delay" : 0, "dst_delay" : 0, "src_rps" : "0", "src_io" : "0.0", "dst_rps" : "0", "dst_io" : "0.0", "trans_data" : "0", "trans_lines" : "29", "used_volumes" : "4", "used_memory" : "2124", "used_cpu_percent" : "1.4", "node_volume_size" : 500, "node_memory_size" : 8192, "update_time" : "2023-07-19T03:09:25Z", "apply_rate" : 0 }

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

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 bandwidth String EIP带宽，单位：MB/s。 is_src_normal Boolean 源库连接状态是否正常。 is_dst_normal Boolean 目标库连接状态是否正常。 src_offset String 源库offSet位点。 node_offset String 迁移实例offSet位点。 dst_offset String 目标库offSet位点。 src_delay Integer 源库时延。 dst_delay Integer 目标库时延。 src_rps String 源库RPS。 src_io String 源库IO。 dst_rps String 目标库RPS。 dst_io String 目标库IO。 trans_data String 迁移数据量。单位：MB。 trans_lines String 迁移数据行数。 used_volumes String 磁盘使用量。单位：GB。 used_memory String 内存使用量。单位：MB。 used_cpu_percent String CPU使用百分比。 node_volume_size Integer node磁盘总大小。单位：GB。 node_memory_size Integer node内存总大小。单位：MB。 update_time String 更新时间。 apply_rate Integer 同步速度。单位：byte/s。

请求参数 表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 OK { "is_full_trans_support_object" : false, "is_incre_trans_support_object" : false, "is_full_incre_trans_support_object" : false, "file_size" : "5.0", "support_object_import_engine" : [ "oracle-to-mrsKafka", "oracle-to-kafka" ], "is_support_column_mapping" : false, "is_database_support_search" : true, "is_table_support_search" : true }

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

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 is_full_trans_support_object Boolean 全量任务是否支持对象选择。 is_incre_trans_support_object Boolean 增量任务是否支持对象选择。 is_full_incre_trans_support_object Boolean 全量加增量任务是否支持对象选择。 support_object_import_engine Array of strings 支持对象导入的引擎。 is_support_column_mapping Boolean 是否支持列映射。 is_database_support_search Boolean 库是否支持搜索。 is_schema_support_search Boolean schema是否支持搜索。 is_table_support_search Boolean 表是否支持搜索。 file_size String 对象导入支持的文件大小，单位为MB。 previous_select String 上一次选择迁移对象或者同步对象的方式。 为空时表示当前还未选择需要的方式。 srcImportObject：当前任务上次选择的方式为导入方式。 import_level String 对象导入类型。 table：表级。 database：库级。 is_import_cloumn Boolean 当前任务上次选择列加工的方式。 true： 当前任务上次选择列加工方式为导入方式。 false 或者 空：当前任务上次选择列加工方式为手动选择方式。

响应示例 状态码： 200 OK { "object_scope" : "table", "target_root_db" : { "db_name" : "mytest", "db_encoding" : "utf8" }, "object_info" : { "TEST" : { "name" : "TEST", "tables" : { "TBL_2" : { "name" : "TBL_2", "type" : "table", "all" : true, "is_synchronized" : true } }, "is_synchronized" : true, "total_table_num" : 1 } }, "max_table_num" : 50000, "id" : "c7debc9c-8e09-4a5d-8dd6-cc44f78jb20r" } 状态码： 400 Bad Request { "error_code" : "DRS.10000010", "error_msg" : "Job does not exist, please check job ID." }

请求参数 表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.1/{project_id}/jobs/{job_id}/db-object 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 租户在某一Region下的Project ID。 获取方法请参见获取项目ID。 job_id 是 String 任务ID。 表2 Query参数 参数 是否必选 参数类型 描述 type 是 String 查询对象信息类型。 取值： modified：查询已选择的（已同步的和未下发的）对象信息。

响应参数 状态码： 202 表4 响应Body参数 参数 参数类型 描述 id String 查询结果ID。 status String 查询状态。 枚举值： pending failed success job_id String 任务ID。 状态码： 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 表3 请求Body参数 参数 是否必选 参数类型 描述 db_names 否 Array of strings 查询指定库的信息。 type 是 String 查询对象信息类型。取值： source：查询源库对象信息。 modified：查询已选择的（已同步的和未下发的）对象信息。 synchronized：查询已同步的（已下发的）对象信息 ， 使用场景在任务处于全量中或者增量中。 is_refresh 否 String 是否强制刷新。取值： true：是，表示从源库重新查询。 false：否，表示从已缓存中数据查询。

响应示例 状态码： 202 OK { "id" : "0eacda0b-9422-4535-8b62-537d1833638b", "status" : "pending", "job_id" : "2fccbe0d-4e6b-4957-981a-edca4e2jb201" } 状态码： 400 Bad Request { "error_code" : "DRS.10000010", "error_msg" : "Job does not exist, please check job ID." }

响应示例 状态码： 200 OK { "jobs" : [ { "id" : "c7debc9c-8e09-4a5d-8dd6-cc44f78jb20r", "name" : "DRS-1234", "status" : "Success" }, { "id" : "dc6016cf-f3b6-4c2d-b4d7-5084b0fjb20r", "name" : "DRS-2345", "status" : "Failed", "error_code" : "DRS.10020102", "error_msg" : "Job does not exist, please check job ID" } ] } 状态码： 400 Bad Request { "error_code" : "DRS.10000001", "error_msg" : "Failed." }

响应参数 状态码： 200 表5 响应Body参数 参数 参数类型 描述 jobs Array of objects 批量操作任务响应体。 详情请参见表6。 表6 jobs字段数据结构说明 参数 参数类型 描述 error_code String 错误码。 最小长度：12 最大长度：12 error_msg String 错误描述。 最小长度：1 最大长度：512 id String 任务ID。 name String 任务名称。 status String 操作结果。 状态码： 400 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码。 最小长度：12 最大长度：12 error_msg String 错误描述。 最小长度：1 最大长度：512

请求示例 批量结束租户指定ID任务。 https://{endpoint}/v5/054ba152d480d55b2f5dc0069e7ddef0/jobs/batch-stop { "jobs": [ { "job_id": "c7debc9c-8e09-4a5d-8dd6-cc44f78jb20r" }, { "job_id": "dc6016cf-f3b6-4c2d-b4d7-5084b0fjb20s", "is_force_stop": false }, { "job_id": "dc6016cf-f3b6-4c2d-b4d7-5084b0fjb20t", "is_force_stop": true } ] }

请求参数 表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参数 参数 是否必选 参数类型 描述 jobs 是 Array of objects 批量结束任务请求体。 详情请参见表4。 表4 jobs字段数据结构说明 参数 是否必选 参数类型 描述 job_id 是 String 任务ID。 is_force_stop 否 Boolean 强制结束任务时取值true，默认false。 缺省值：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 zh-cn 表3 请求Body参数 参数 是否必选 参数类型 描述 is_force_stop 否 Boolean 强制结束任务时取值true，默认false。 缺省值：false

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 error_code String 错误码。 最小长度：12 最大长度：12 error_msg String 错误描述。 最小长度：1 最大长度：512 id String 任务ID。 name String 任务名称。 status String 操作结果。 状态码： 400 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码。 最小长度：12 最大长度：12 error_msg String 错误描述。 最小长度：1 最大长度：512

响应示例 状态码： 200 OK { "count": 113, "enterprise_project_list": [ { "id": "0", "name": "default", "status": "1" }, { "id": "2d8315f3-f25f-4481-a867-b7ef05a4b9c2", "name": "eps_test_new_改名", "status": "1", "created_at": "2023-01-20T07:18:26Z", "updated_at": "2023-01-20T15:32:29Z" }, { "id": "81b344c4-5644-485b-8ea7-398f3b8013cf", "name": "(!@$%^-_=+[{}]:,./?~#*;|)", "status": "1", "created_at": "2022-09-27T02:41:22Z", "updated_at": "2023-03-01T09:42:02Z" }, { "id": "59add094-0be7-49d0-a3ee-22de62f7eb4c", "name": "DDS-test01_01", "status": "1", "created_at": "2022-02-25T08:04:44Z", "updated_at": "2022-07-13T03:45:24Z" }, { "id": "6e2795dd-6fd1-4413-9038-cf1c1acc0940", "name": "gaussdb_test02", "description": "gaussdb_test02", "status": "1", "created_at": "2022-02-25T07:39:05Z", "updated_at": "2022-02-25T07:39:05Z" } ] } 状态码： 422 Bad Request { "error_code": "DRS.M00277", "error_msg": "该任务名称已存在" }

URI GET /v5/{project_id}/enterprise-projects 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 租户在某一Region下的Project ID。 获取方法请参见获取项目ID。 表2 Query参数 参数 是否必选 参数类型 描述 offset 否 Integer 偏移量，表示从此偏移量开始查询， offset 大于等于 0。默认为0 缺省值：0 limit 否 Integer 每页显示的条目数量。默认为1000，取值范围【1-1000】 最小值：1 最大值：1000 缺省值：1000 name 否 String 企业项目名称，支持模糊搜索。 domain_id 否 String IAM用户所属账号ID。op_service权限必须携带此参数，非op_service权限可不携带此参数。

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 count Integer 总数。 enterprise_project_list Array of objects 企业项目列表。 详情请参见表5。 表5 enterprise_project_list字段数据结构说明 参数 参数类型 描述 id String 企业项目ID。 name String 企业项目名称。 description String 描述。 status String 企业项目状态。 created_at String 创建时间，例如：2023-01-20T07:18:26Z updated_at String 更新时间，例如：2023-03-01T09:42:02Z 状态码： 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

请求参数 表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位之间，必须以字母开头，可以包含字母、数字、中划线或下划线，不能包含其他特殊字符。 type 是 String 任务类型。 trans：实时迁移、同步、灾备使用 subscription：数据订阅使用 offline：备份迁移使用