更新时间:2022-03-23 GMT+08:00
分享

获取数据源中某个表中所有字段

功能介绍

获取数据源中中某个表中所有字段

调试

您可以在API Explorer中调试该接口。

URI

GET /v2/{project_id}/fdi/instances/{instance_id}/datasources/{datasource_id}/columns

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

项目ID,获取方式请参见API参考的“附录 > 获取项目ID”章节。

最小长度:1

最大长度:64

instance_id

String

实例ID

最小长度:1

最大长度:64

datasource_id

String

数据源ID

最小长度:1

最大长度:64

表2 Query参数

参数

是否必选

参数类型

描述

direction_type

String

数据源所在任务位置

  • SOURCE 数据源处于任务源端

  • TARGET 数据源处于任务目标端

最小长度:0

最大长度:6

db_name

String

数据库名称,只支持MRSHIVE,FIHIVE类型的数据源

最小长度:0

最大长度:64

table_name

String

字段所在的表名

最小长度:0

最大长度:64

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

用户Token。通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。

响应参数

状态码: 200

表4 响应Body参数

参数

参数类型

描述

columns

Array of ColumnInfo objects

返回的实体对象

表5 ColumnInfo

参数

参数类型

描述

field_name

String

字段名称

最小长度:0

最大长度:256

field_type

String

字段类型

最小长度:0

最大长度:256

field_length

String

字段长度

最小值:0

最大值:200

null_able

String

是否允许为空

is_partition

Boolean

是否是分区字段

primary

String

是否是主键字段

unique

String

是否是唯一键字段

decimal_digits

String

小数部分位数,非数字类型返回null

最小值:0

最大值:200

状态码: 400

表6 响应Body参数

参数

参数类型

描述

error_code

String

错误码

最小长度:8

最大长度:36

error_msg

String

错误描述

最小长度:2

最大长度:512

detail

String

描述详情

最小长度:2

最大长度:512

状态码: 404

表7 响应Body参数

参数

参数类型

描述

error_code

String

错误码

最小长度:8

最大长度:36

error_msg

String

错误描述

最小长度:2

最大长度:512

状态码: 500

表8 响应Body参数

参数

参数类型

描述

error_code

String

错误码

最小长度:8

最大长度:36

error_msg

String

错误描述

最小长度:2

最大长度:512

请求示例

响应示例

状态码: 200

OK

  • 示例 1

    null
  • 示例 2

    [ {
      "unique" : "0",
      "field_name" : "name",
      "field_type" : "VARCHAR",
      "field_length" : "255",
      "null_able" : "1",
      "is_partition" : false,
      "fields_name" : "name"
    } ]

状态码

状态码

描述

200

OK

400

Error response

404

Not Found

500

Internal Server Error

错误码

请参见错误码

分享:

    相关文档

    相关产品

close