文档首页/ 应用与数据集成平台 ROMA Connect/ API参考/ 数据集成API/ 数据源管理/ 获取数据源中某个表中所有字段 - ListDatasourceColumns
更新时间：2025-10-22 GMT+08:00
在线调试
CLI示例
查看PDF
分享

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

功能介绍

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

授权信息

账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限，具体权限要求请参见权限和授权项。

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

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

instance_id

是

String

实例ID。

datasource_id

是

String

数据源ID。
表2 Query参数

参数

是否必选

参数类型

描述

direction_type

是

String

数据源所在任务位置。

  • SOURCE 数据源处于任务源端

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

db_name

否

String

数据库名称，只支持MRSHIVE类型的数据源。

table_name

是

String

字段所在的表名。

请求参数

表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

字段名称。

field_type

String

字段类型。

field_length

String

字段长度。

null_able

String

是否允许为空。

is_partition

Boolean

是否是分区字段。

primary

String

是否是主键字段。

unique

String

是否是唯一键字段。

decimal_digits

String

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

状态码：400

表6 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误描述。

detail

String

描述详情。

状态码：404

表7 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误描述。

状态码：500

表8 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误描述。

请求示例

无

响应示例

状态码：500

Internal Server Error

{
  "error_code" : "FDI.3126",
  "error_msg" : "Failed to query the field."
}

状态码

状态码

描述

200

OK

400

Error response

404

Not Found

500

Internal Server Error

错误码

请参见错误码。

父主题： 数据源管理