华为云用户手册

请求示例 查询任务的参数配置修改历史 https://{endpoint}/v5/054ba152d480d55b2f5dc0069e7ddef0/jobs/c7debc9c-8e09-4a5d-8dd6-cc44f78jb20r/configuration-histories?offset={offset}&limit={limit}&begin_time={begin_time}&end_time={end_time}

响应示例 状态码： 200 任务参数配置修改历史列表 { "count" : 0, "parameter_history_config_list" : [ { "name" : "strapplier_thread_numing", "old_value" : "10", "new_value" : "20", "is_update_success" : true, "is_applied" : "true", "update_time" : "2020-09-01T18:50:20Z", "apply_time" : "2020-09-01T18:50:20Z" } ] }

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 count Integer 历史记录总数。 parameter_history_config_list Array of objects 任务参数历史修改列表。 详情请参见表4。 表4 parameter_history_config_list字段数据结构说明 参数 参数类型 描述 name String 参数名称。 old_value String 旧参数值。 new_value String 新参数值。 is_update_success Boolean 更新结果。true：成功，false：失败 is_applied Boolean 是否已应用。true：已应用，false：未应用 update_time String 参数修改时间。 apply_time String 参数应用时间。

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

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

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

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

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 查询指定库的信息。

请求参数 表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 OK { "jobs" : [ { "async_job_id" : "bd4193aa-072d-4ce6-beec-adffc7252341", "status" : "AUTO_PA RAM _VALIDATE_SUC CES S", "domain_name" : "domain_name1", "user_name" : "user_name1", "create_time" : "2022-11-07T06:41:08Z" }, { "async_job_id" : "7b65d750-51e5-4647-a088-663d28152a3d", "status" : "COMMIT_SUCCESS", "domain_name" : "domain_name2", "user_name" : "user_name2", "create_time" : "2022-11-05T16:03:45Z" } ], "total_count" : 2 } 状态码： 400 Bad Request { "error_code" : "DRS.10000001", "error_msg" : "Failed." }

URI GET /v5/{project_id}/batch-async-jobs 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 租户在某一Region下的Project ID。 获取方法请参见获取项目ID。 表2 Query参数 参数 是否必选 参数类型 描述 async_job_id 否 String 批量异步创建的任务ID。 status 否 String 批量异步创建的任务状态。 domain_name 否 String 批量异步创建的任务的租户名。 user_name 否 String 批量异步创建的任务的用户名。 offset 否 Integer 偏移量，表示查询该偏移量后面的记录。 limit 否 Integer 查询返回记录的数量限制。 sort_key 否 String 返回结果按该关键字排序，默认为“create_time”。 sort_dir 否 String 降序或升序（分别对应desc和asc，默认为“desc”）。

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 total_count Integer 列表中的项目总数，与分页无关。 jobs Array of objects 所有批量异步创建任务响应体。 详情请参见表5。 表5 jobs字段数据结构说明 参数 参数类型 描述 async_job_id String 批量异步创建的任务ID。 status String 批量异步创建的任务状态。取值： ASYNC_JOB_VALIDATING：批量异步任务参数校验中。 ASYNC_JOB_VALIDATE_FAILED：批量异步任务参数校验失败。 AUTO_PARAM_VALIDATE_SUCCESS：批量异步任务参数校验成功 COMMIT_SUCCESS：批量异步任务提交成功。 枚举值： ASYNC_JOB_VALIDATING ASYNC_JOB_VALIDATE_FAILED AUTO_PARAM_VALIDATE_SUCCESS COMMIT_SUCCESS domain_name String 批量异步创建的任务的租户名。 user_name String 批量异步创建的任务的用户名。 create_time 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-position 表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

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 job_id String 任务ID。 status String 查询状态。 枚举值： pending failed success position String 位点信息。 状态码： 400 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码。 最小长度：12 最大长度：12 error_msg String 错误描述。 最小长度：1 最大长度：512

响应示例 状态码： 200 OK { "job_id" : "c7debc9c-8e09-4a5d-8dd6-cc44f78jb20r", "position" : "mysql-bin.000277:805", "status" : "pending" } 状态码： 400 Bad Request { "error_code" : "DRS.10030014", "error_msg" : "Firstly, please the query object info." }

URI GET /v5/{project_id}/agency/permissions 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 租户在某一Region下的Project ID。 获取方法请参见获取项目ID。 表2 Query参数 参数 是否必选 参数类型 描述 source_type 否 String 源库类型。 mysql：MySQL sqlserver：Microsoft SQL Server postgresql：PostgreSQL mongodb：MongoDB、DDS dws： GaussDB (DWS) oracle：Oracle taurus：GaussDB(for MySQL) ddm：DDM kafka：Kafka gaussdbv5：GaussDB分布式版 gaussdbv5ha：GaussDB主备版 gaussmongodb：GeminiDB Mongo elasticsearch： CSS /ES db2：DB2 tidb：TiDB redis：Redis rediscluster：Redis集群 gaussredis：GeminiDB Redis mariadb：MariaDB informix：Informix dynamo：Dynamo target_type 否 String 目标库类型。 mysql：MySQL sqlserver：Microsoft SQL Server postgresql：PostgreSQL mongodb：MongoDB、DDS dws：GaussDB(DWS) oracle：Oracle taurus：GaussDB(for MySQL) ddm：DDM kafka：Kafka gaussdbv5：GaussDB分布式版 gaussdbv5ha：GaussDB主备版 gaussmongodb：GeminiDB Mongo elasticsearch： CS S/ES db2：DB2 tidb：TiDB redis：Redis rediscluster：Redis集群 gaussredis：GeminiDB Redis mariadb：MariaDB informix：Informix dynamo：Dynamo is_non_dbs 是 Boolean 是否自建。

请求参数 表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参数 参数 参数类型 描述 common_permissions Array of strings DRS FullAccess： 数据复制服务 所有权限 engine_permissions Array of strings GaussDB ReadOnlyAccess：云数据库 GaussDB服务的只读访问权限。 GeminiDB ReadOnlyAccess：分布式多模NoSQL数据库服务只读权限。 GaussDBforMSQLReadOnlyAccess：云数据库HUAWEIGaussDBforMSQL服务的只读访问权限。 DWS ReadOnlyAccess： 数据仓库 服务只读权限。 DDM ReadOnlyAccess： 分布式数据库 中间件服务只读权限。 DDS ReadOnlyPolicy：文档数据库服务资源只读权限。 RDS ReadOnlyAccess：关系型数据库服务资源只读权限。 MRS ReadOnlyAccess： MapReduce服务 只读权限，包括集群查询操作、基础服务弹性云服务器、裸金属服务器、云硬盘、虚拟私有云只读权限。

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

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

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

请求示例 更新租户指定ID任务对象信息 https://{endpoint}/v5/054ba152d480d55b2f5dc0069e7ddef0/jobs/c7debc9c-8e09-4a5d-8dd6-cc44f78jb20r { "job" : { "type" : "db_object", "params" : { "db_object" : { "object_scope" : "table", "target_root_db" : { "db_name" : "mytest", "db_encoding" : "utf8" }, "object_info" : { "TEST1" : { "name" : "TEST1", "tables" : { "TBL_1" : { "name" : "TBL_1", "type" : "table", "all" : true, "is_synchronized" : false }, "TBL_2" : { "name" : "TBL_2", "type" : "table", "all" : true, "is_synchronized" : false } } }, "TEST2" : { "name" : "TEST2", "all" : true, "tables" : { "WT_1" : { "name" : "WT_1", "type" : "table", "all" : true, "is_synchronized" : false }, "WT_2" : { "name" : "WT_2", "type" : "table", "all" : true, "is_synchronized" : false } } } } } } } } 更新租户指定ID任务名称为DRS-1234。 https://{endpoint}/v5/054ba152d480d55b2f5dc0069e7ddef0/jobs/c7debc9c-8e09-4a5d-8dd6-cc44f78jb20r { "job" : { "type" : "name", "params" : { "base_info" : { "name" : "DRS-1234" } } } } 更新任务源库、目标库的信息。 https://{endpoint}/v5/054ba152d480d55b2f5dc0069e7ddef0/jobs/c7debc9c-8e09-4a5d-8dd6-cc44f78jb20r { "job" : { "type" : "endpoint", "params" : { "source_endpoint" : [ { "db_type" : "oracle", "endpoint_type" : "offline", "endpoint_role" : "so", "endpoint" : { "id" : "f59e6118-da89-4fdb-9b98-65f56709928a", "endpoint_name" : "oracle", "ip" : "10.154.217.239", "db_port" : "1521", "db_user" : "ORACLE_USER", "db_name" : "serviceName.orcl", "db_password" : "******" }, "ssl" : { "ssl_link" : false } } ], "target_endpoint" : [ { "db_type" : "gaussdbv5", "endpoint_type" : "cloud", "endpoint_role" : "ta", "endpoint" : { "id" : "10deb576-8885-473b-a213-4d76e668dc0d", "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" } } ] } } }

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

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

URI POST /v5/{project_id}/driver 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 租户在某一Region下的Project ID。 获取方法请参见获取项目ID。 表2 Query参数 参数 是否必选 参数类型 描述 driver_type 是 String 指定待上传的驱动文件类型。取值范围： db2：DB2 for LUW informix：Informix

URI GET /v5/{project_id}/drivers 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 租户在某一Region下的Project ID。 获取方法请参见获取项目ID。 表2 Query参数 参数 是否必选 参数类型 描述 limit 否 Integer 每页显示的条目数量。默认为10。 offset 否 Integer 偏移量，表示从此偏移量开始查询， offset 大于等于 0。默认为0。 driver_type 是 String 指定待查询的驱动文件类型。取值范围： db2：DB2 for LUW informix：Informix

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