更新时间:2024-04-17 GMT+08:00

查询同步映射列表

功能介绍

查询同步映射列表,实时同步映射关系包括对象选择时的库映射、schema映射、表映射和数据加工时的列映射。

URI

POST /v5/{project_id}/jobs/{job_id}/object-mappings

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

租户在某一Region下的Project ID。

获取方法请参见获取项目ID

job_id

String

任务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参数

参数

是否必选

参数类型

描述

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

表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

请求示例

查询同步映射列表请求示例。

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
}

响应示例

状态码: 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."
}

错误码

请参见错误码