华为云用户手册

响应示例 状态码： 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." }

请求参数 表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：否，表示从已缓存中数据查询。

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

响应示例 状态码： 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." }

请求参数 表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：备份迁移使用

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