华为云用户手册

  • 请求参数 表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参数 参数 是否必选 参数类型 描述 driver_names 是 Array of strings jdbc驱动文件列表,列表长度1-20,driver_name的长度5-64,结尾以.jar结尾。
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 Content-Type 是 String 发送的实体的MIME类型。推荐用户默认使用multipart/form-data,如果API是对象、镜像上传等接口,媒体类型可按照流类型的不同进行确定。 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 驱动文件,驱动文件名称长度5-64,以jar结尾,name相同会替换远程驱动文件
  • 响应示例 状态码: 202 Accepted { "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." }
  • 响应参数 状态码: 202 表4 响应Body参数 参数 参数类型 描述 id String 查询结果ID。 job_id String 任务ID。 status String 查询状态。 枚举值: pending failed success 状态码: 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参数 参数 是否必选 参数类型 描述 reset_position_time 是 String 重置位点时间,使用UTC时间 示例:2023-09-19 15:00:00,UTC时间是2023-09-19T07:00:00Z。
  • 响应示例 状态码: 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." }
  • 响应参数 状态码: 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
  • 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
  • 请求参数 表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参数 参数 参数类型 描述 tags Array of objects 标签列表。 详情请参见表4。 表4 tags字段数据结构说明 参数 参数类型 描述 key String 标签键。 长度为1-128个unicode字符。 可以包含任何语种字母、数字、空格和_.:=+-@,但首尾不能含有空格,不能以_sys_开头。 最小长度:1 最大长度:128 value String 标签值,删除标签时非必填。 最大长度255个unicode字符。 可以包含任何语种字母、数字、空格和_.:=+-@。 最大长度:255
  • URI GET /v5/{project_id}/jobs/{resource_type}/{job_id}/tags 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 租户在某一Region下的Project ID。 获取方法请参见获取项目ID。 resource_type 是 String 资源类型。 migration:实时迁移 sync:实时同步 cloudDataGuard:实时灾备 subscription:数据订阅 backupMigration:备份迁移 replay:仿真回放 枚举值: migration sync cloudDataGuard subscription backupMigration replay job_id 是 String 任务ID。
  • 请求参数 表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
  • URI GET /v5/{project_id}/jobs/{resource_type}/tags 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 租户在某一Region下的Project ID。 获取方法请参见获取项目ID。 resource_type 是 String 资源类型。 migration:实时迁移 sync:实时同步 cloudDataGuard:实时灾备 subscription:数据订阅 backupMigration:备份迁移 replay:仿真回放 枚举值: migration sync cloudDataGuard subscription backupMigration replay
  • 请求示例 批量添加标签示例: https://{endpoint}/v5/246765b9f59445c3919fce121ea801f4/jobs/sync/ada96925-ceb7-4fa7-8b6f-a344f84jb201/tags/action { "action" : "create", "tags" : [ { "key" : "aaa", "value" : "bbb" }, { "key" : "test", "value" : "test111" } ] } 批量删除标签示例: https://{endpoint}/v5/246765b9f59445c3919fce121ea801f4/jobs/sync/ada96925-ceb7-4fa7-8b6f-a344f84jb201/tags/action { "action" : "delete", "tags" : [ { "key" : "aaa", "value" : "bbb" }, { "key" : "test", "value" : "test111" } ] }
  • URI POST /v5/{project_id}/jobs/{resource_type}/{job_id}/tags/action 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 租户在某一Region下的Project ID。 获取方法请参见获取项目ID。 resource_type 是 String 资源类型。 migration:实时迁移 sync:实时同步 cloudDataGuard:实时灾备 subscription:数据订阅 backupMigration:备份迁移 replay:仿真回放 job_id 是 String 任务ID。
  • 请求参数 表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 表3 请求Body参数 参数 是否必选 参数类型 描述 action 是 String 操作标识(区分大小写): 创建时为“create” 删除时为“delete” 枚举值: create delete tags 是 Array of objects 标签列表。最多添加20个标签。 详情请参见表4。 表4 tags字段数据结构说明 参数 是否必选 参数类型 描述 key 是 String 标签键。 长度为1-128个unicode字符。 可以包含任何语种字母、数字、空格和_.:=+-@,但首尾不能含有空格,不能以_sys_开头。 最小长度:1 最大长度:128 value 否 String 标签值,删除标签时非必填。 最大长度255个unicode字符。 可以包含任何语种字母、数字、空格和_.:=+-@。 最大长度:255
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 results Array of objects 指定数据库表列信息。 详情请参见表5。 total_count Integer 列表中的项目总数,与分页无关。 表5 results字段数据结构说明 参数 参数类型 描述 db_name String 数据库库名称。 schema_name String 数据库schema名称。 table_name String 数据库表名称。 column_infos Array of objects 数据库列信息。 详情请参见表6。 total_count Integer 数据库列信息总数,与分页无关,仅作为返回体参数。 表6 column_infos字段数据结构说明 参数 参数类型 描述 column_name String 列名。 column_type String 列类型。 primary_key_or_unique_index String 主键或者唯一索引。 column_mapped_name String 列映射后的名称。 is_filtered Boolean 该列是否过滤。 is_partition_key Boolean 该列是否partitionKey。 状态码: 400 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码。 最小长度:12 最大长度:12 error_msg String 错误描述。 最小长度:1 最大长度:512
  • 响应示例 状态码: 200 OK { "results" : [ { "db_name" : "testdb02", "table_name" : "test5", "column_infos" : [ { "column_name" : "id", "column_type" : "NUMBER", "primary_key_or_unique_index" : "PRI", "column_mapped_name" : null, "is_filtered" : false, "is_partition_key" : false }, { "column_name" : "C1", "column_type" : "VARCHAR2", "primary_key_or_unique_index" : "", "column_mapped_name" : null, "is_filtered" : false, "is_partition_key" : false }, { "column_name" : "C2", "column_type" : "VARCHAR2", "primary_key_or_unique_index" : "", "column_mapped_name" : null, "is_filtered" : false, "is_partition_key" : false } ], "total_count" : 3 } ], "total_count" : 1 } 状态码: 400 Bad Request { "error_code" : "DRS.10000010", "error_msg" : "Job does not exist, please check job ID." }
  • URI GET /v5/{project_id}/job/{job_id}/columns 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 租户在某一Region下的Project ID。 获取方法请参见获取项目ID。 job_id 是 String 任务ID。 表2 Query参数 参数 是否必选 参数类型 描述 query_id 是 String 指定数据库表的列信息采集的ID,提交采集指定数据库表的列信息接口返回的ID。 offset 否 Integer 偏移量,表示查询该偏移量后面的记录。 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
  • 请求参数 表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参数 参数 是否必选 参数类型 描述 is_force_refresh 否 Boolean 是否从Node获取最新的列信息。 db_object_infos 是 Array of objects 指定数据库表信息。 详情请参见表4。 表4 db_object_infos字段数据结构说明 参数 是否必选 参数类型 描述 db_name 是 String 数据库名称。 schema_name 否 String 数据库schema名称。 table_name 是 String 数据库表名称。
  • 响应参数 状态码: 202 表5 响应Body参数 参数 参数类型 描述 id String 查询结果id job_id String 任务ID。 status String 查询状态 枚举值: pending failed success 状态码: 400 表6 响应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.10030016", "error_msg" : "Query column info failed" }
  • 请求示例 采集指定数据库表的列信息: POST https://{endpoint}/v5/054ba152d480d55b2f5dc0069e7ddef0/job/c7debc9c-8e09-4a5d-8dd6-cc44f78jb20r/columns/collect { "is_force_refresh" : false, "db_object_infos" : [ { "db_name" : "testDb", "schema_name" : "testSchema", "table_name" : "testTable" } ] }
  • 响应示例 状态码: 200 OK { "db_object_filtering_result" : [ { "db_name" : "testDb", "schema_name" : "testSchema", "table_name" : "testTable", "is_success" : true, "message" : null }, { "db_name" : "testDb", "schema_name" : "testSchema", "table_name" : "testTable", "is_success" : false, "message" : "DATA_TRANSFORMATION_ALREADY_EXISTED" } ], "success_count" : 1, "failed_count" : 1 } 状态码: 400 Bad Request { "error_code" : "DRS.10000010", "error_msg" : "Job does not exist, please check job ID." }
  • URI GET /v5/{project_id}/job/{job_id}/data-filtering/result 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 租户在某一Region下的Project ID。 获取方法请参见获取项目ID。 job_id 是 String 任务ID。 表2 Query参数 参数 是否必选 参数类型 描述 query_id 是 String 数据过滤校验请求ID
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 success_count Long 数据过滤规则校验成功的数量。 failed_count Long 数据过滤规则校验失败的数量。 db_object_filtering_result Array of objects 库表过滤规则校验结果。 详情请参见表5。 表5 db_object_filtering_result字段数据结构说明 参数 参数类型 描述 db_name String 数据库库名。 schema_name String 数据库Schema名称。 table_name String 数据库表名称。 is_success Boolean 数据过滤校验结果。 message String 当数据过滤校验结果是false,返回校验失败的原因。 source String 对比的来源。 job:表示数据同步时的过滤。 compare:表示数据对比的过滤。 枚举值: job compare target_result String 校验目标库比对条件过滤的结果。 source_result String 校验源库比对条件过滤的结果。 target_message String 校验目标库比对条件过滤的失败原因。 source_message 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
  • 响应参数 状态码: 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
共100000条
提示

您即将访问非华为云网站,请注意账号财产安全