华为云用户手册

响应示例 状态码： 200 OK { "id" : "05ef2a25-a472-4144-b444-2e0a11eb5902", "status" : "success" } 状态码： 400 Bad Request { "error_code" : "DRS.10030015", "error_msg" : "Failed to update database object" }

URI GET /v5/{project_id}/jobs/{job_id}/db-objects/saving-status 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 租户在某一Region下的Project ID。 获取方法请参见获取项目ID。 job_id 是 String 任务ID。 表2 Query参数 参数 是否必选 参数类型 描述 query_id 是 String 指保存对象接口返回的ID。

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

响应参数 状态码： 200 表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

响应示例 状态码： 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" : "0eacda0b-9422-4535-8b62-537d1833638b", "status" : "success" } 状态码： 400 Bad Request { "error_code" : "DRS.10030014", "error_msg" : "Firstly, please the query object info." }

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

URI GET /v5/{project_id}/jobs/{job_id}/db-objects/collection-status 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 租户在某一Region下的Project ID。 获取方法请参见获取项目ID。 job_id 是 String 任务ID。 表2 Query参数 参数 是否必选 参数类型 描述 query_id 是 String 对象信息采集的ID，指的是提交查询对象接口返回的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

响应参数 状态码： 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

响应示例 状态码： 202 OK { "id" : "036ceb63-51f8-43fb-9164-82c17b2eadbc", "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." }

URI POST /v5/{project_id}/jobs/{job_id}/db-objects/collect 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 租户在某一Region下的Project ID。 获取方法请参见获取项目ID。 job_id 是 String 任务ID。 表2 Query参数 参数 是否必选 参数类型 描述 offset 否 Integer 偏移量，表示从此偏移量开始查询，offset大于等于0。 limit 否 Integer 每页显示的条目数量。 type 是 String 查询对象信息类型。取值： source：查询源库对象信息。 modified：查询已选择的（未下发与已同步的）对象信息。 synchronized：查询已同步的（已下发的）对象信息 ， 使用场景在任务处于全量中或者增量中。 is_refresh 否 Boolean 是否强制刷新。取值： true 是，表示从源库重新查询。 false 否，表示从缓存中查询。 db_names 否 Array 查询指定库的信息。

请求示例 批量操作租户指定ID任务。 https://{endpoint}/v5/054ba152d480d55b2f5dc0069e7ddef0/jobs/action { "jobs" : [ { "job_id" : "c7debc9c-8e09-4a5d-8dd6-cc44f78jb20r", "action_name" : "start" }, { "job_id" : "dc6016cf-f3b6-4c2d-b4d7-5084b0fjb20r", "action_name" : "stop" } ] }

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

响应示例 状态码： 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.10000010", "error_msg" : "Job does not exist, please check job ID" } ] } 状态码： 202 Accepted { "jobs" : [ { "id" : "c7debc9c-8e09-4a5d-8dd6-cc44f78jb20r", "name" : "DRS-1234", "query_id" : "7debc9c-8e09-4a5d-8dd6-cc44f45566" }, { "id" : "dc6016cf-f3b6-4c2d-b4d7-5084b0fjb20r", "name" : "DRS-2345", "query_id" : "7debc9c-8e09-4a5d-8dd6-cc44f45566" } ] } 状态码： 400 Bad Request { "error_code" : "DRS.10000001", "error_msg" : "Failed." }

响应参数 状态码： 200 表29 响应Body参数 参数 参数类型 描述 error_code String 错误码。 最小长度：12 最大长度：12 error_msg String 错误描述。 最小长度：1 最大长度：512 id String 任务ID。 name String 任务名称。 status String 操作结果。 状态码： 202 表30 响应Body参数 参数 参数类型 描述 query_id String 异步操作任务响应查询ID。 状态码： 400 表31 响应Body参数 参数 参数类型 描述 error_code String 错误码。 最小长度：12 最大长度：12 error_msg String 错误描述。 最小长度：1 最大长度：512

请求示例 执行预检查（异步调用）。 https://{endpoint}/v5/054ba152d480d55b2f5dc0069e7ddef0/jobs/c7debc9c-8e09-4a5d-8dd6-cc44f78jb20r/action { "job" : { "action_name" : "precheck", "action_params" : { "precheck_mode" : "forStartJob" } } } 测试连接目标库（异步调用）。 https://{endpoint}/v5/054ba152d480d55b2f5dc0069e7ddef0/jobs/c7debc9c-8e09-4a5d-8dd6-cc44f78jb20r/action { "job" : { "action_name" : "network", "action_params" : { "endpoints" : [ { "db_type" : "gaussdbv5", "endpoint_type" : "cloud", "endpoint_role" : "ta", "endpoint" : { "endpoint_name" : "cloud_gaussdbv5", "instance_id" : "c2c7579bc09c490b9d8009db715aeb0ain14", "db_user" : "root", "db_password" : "******" }, "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" } } ] } } } 测试连接源库（异步调用）。 https://{endpoint}/v5/054ba152d480d55b2f5dc0069e7ddef0/jobs/c7debc9c-8e09-4a5d-8dd6-cc44f78jb20r/action { "job" : { "action_name" : "network", "action_params" : { "endpoints" : [ { "db_type" : "oracle", "endpoint_type" : "offline", "endpoint_role" : "so", "endpoint" : { "endpoint_name" : "oracle", "ip" : "10.154.217.239", "db_port" : "1521", "db_user" : "ORACLE_USER", "db_password" : "******", "id" : "971e1840-9395-4044-b6c8-00ef1f83ce48", "db_name" : "serviceName.orcl" }, "ssl" : { "ssl_link" : false } } ] } } } 创建对象对比任务（异步调用）。 https://{endpoint}/v5/054ba152d480d55b2f5dc0069e7ddef0/jobs/d0f96c1d-571f-4b63-98a5-3b85b36jb20r/action { "job" : { "action_name" : "create_compare", "action_params" : { "compare_task_param" : { "type" : "object" } } } } 创建行对比任务（异步调用）。 https://{endpoint}/v5/054ba152d480d55b2f5dc0069e7ddef0/jobs/d0f96c1d-571f-4b63-98a5-3b85b36jb20r/action { "job" : { "action_name" : "create_compare", "action_params" : { "compare_task_param" : { "type" : "lines", "option" : { "comparePolicy" : "normal" }, "db_object" : { "db1" : { "name" : "db1", "tables" : { "table1" : { "name" : "table1" } } } } } } } }

响应示例 状态码： 200 OK { "status": "success" } 状态码： 202 Accepted { "query_id" : "c5c1ffb3-c902-4b31-a606-dfa1231831f9" } 状态码： 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/{project_id}/jobs/{job_id}/db-object/template/result 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 租户在某一Region下的Project ID。 获取方法请参见获取项目ID。 job_id 是 String 任务ID。 表2 Query参数 参数 是否必选 参数类型 描述 type 是 String 导入的结果类型。取值： detail：获取最新导入的文件与校验结果，上传后的文件如果存在错误，会同时将错误原因标记在文件内。 synchronized：获取已同步的（已下发的）对象文件结果。 change： 获取新增和删除的对象结果（任务再编辑时使用）。 枚举值： detail synchronized change

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 send_success Boolean 是否上传完成。 process_status String 文件解析状态。 parsed_success_number String 解析成功的行数。 状态码： 400 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码。 最小长度：12 最大长度：12 error_msg String 错误描述。 最小长度：1 最大长度：512

响应示例 状态码： 200 OK { "process_status" : "success", "parsed_success_number" : "1" } 状态码： 400 Bad Request { "error_code" : "DRS.10000010", "error_msg" : "Job does not exist, please check job ID." }

URI GET /v5/{project_id}/jobs/{job_id}/db-object/template/progress 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 租户在某一Region下的Project ID。 获取方法请参见获取项目ID。 job_id 是 String 任务ID。 表2 Query参数 参数 是否必选 参数类型 描述 offset 否 Integer 偏移量，表示从此偏移量开始查询， offset大于等于0 limit 否 Integer 每页显示的条目数量

请求参数 表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 POST /v5/{project_id}/jobs/{job_id}/db-object/template 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 租户在某一Region下的Project ID。 获取方法请参见获取项目ID。 job_id 是 String 任务ID。 表2 Query参数 参数 是否必选 参数类型 描述 file_import_db_level 否 String 文件模板支持数据同步级别，不填默认为table表级。 缺省值：table 枚举值： database table

请求参数 表3 请求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 表4 FormData参数 参数 是否必选 参数类型 描述 file 是 File 待上传的模板文件。

响应参数 状态码： 200 表5 响应Body参数 参数 参数类型 描述 send_success Boolean 是否上传完成。 process_status String 文件解析状态。 parsed_success_number String 解析成功的行数。 状态码： 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}/db-object/template 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 租户在某一Region下的Project ID。 获取方法请参见获取项目ID。 job_id 是 String 任务ID。 表2 Query参数 参数 是否必选 参数类型 描述 file_import_db_level 否 String 文件模板支持数据同步级别，不填默认为table表级。 缺省值：table 枚举值： database table

URI GET /v5/{project_id}/jobs/{job_id}/db-objects 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 租户在某一Region下的Project ID。 获取方法请参见获取项目ID。 job_id 是 String 任务ID。 表2 Query参数 参数 是否必选 参数类型 描述 offset 否 Integer 偏移量，表示从此偏移量开始查询， offset大于等于0 limit 否 Integer 每页显示的条目数量 type 是 String 查询对象信息类型。取值： source：查询源库对象信息。 modified：查询已选择的（未下发与已同步的）对象信息。 synchronized：查询已同步的（已下发的）对象信息 。 db_names 否 Array 查询指定库的信息。

响应示例 状态码： 200 OK { "target_root_db" : { "db_name" : "db1", "db_encoding" : "UTF-8" }, "object_scope" : "table", "object_info" : { "db1" : { "name" : "db1", "all" : false, "schemas" : { "schema1" : { "name" : "schema1", "all" : false, "tables" : { "table1" : { "name" : "table1", "type" : "table", "all" : true, "is_synchronized" : false } } } }, "total_table_num" : 1 } }, "max_table_num" : 500 } 状态码： 400 Bad Request { "error_code" : "DRS.10000010", "error_msg" : "Job does not exist, please check job ID." }