GetColumn - 获取数据地图数据表字段信息

获取数据地图数据表给定字段的详细信息。

接口说明

  1. 需要购买 DataWorks 基础版及以上版本才能使用。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

当前API暂无授权信息透出。

请求参数

名称类型必填描述示例值
Idstring

ID,可参考 ListColumns 接口返回结果,以及元数据实体相关概念说明

格式为${EntityType}:${实例 ID 或转义后的 URL}:${数据目录标识}:${数据库名称}:${模式名称}:${数据表名称}:${字段名称},不存在的层级使用空字符占位。

说明 对于 maxcompute 和 dlf 类型,实例 ID 使用空字符占位。对于 maxcompute 类型,数据库名称即为 maxcompute 项目名称,开启三层模型的项目需要提供模式名称,未开启的项目模式名称处使用空字符占位。
说明 starrocks 类型的数据目录标识为目录名称,dlf 类型的数据目录标识为目录 ID, 其他类型不支持目录层级,可用空字符占位。

几种常用类型 ID 格式参考如下

maxcompute-column:::project_name:[schema_name]:table_name:column_name

dlf-column::catalog_id:database_name::table_name:column_name

hms-column:instance_id::database_name::table_name:column_name

holo-column:instance_id::database_name:schema_name:table_name:column_name

mysql-column:(instance_id|encoded_jdbc_url)::database_name::table_name:column_name

说明 其他
instance_id: 实例 ID,对应数据源以实例模式注册时需要提供
encoded_jdbc_url: JDBC 连接串的 URLEncode 编码,对应数据源以连接串方式注册时需要提供
catalog_id: dlf 目录 ID
project_name: maxcompute 项目名称
database_name: 数据库名称
schema_name: schema 名称,对于 maxcompute 类型,仅所属项目开启三层模型后需要提供,若未开启则使用空字符占位。
table_name: 表名称
column_name: 字段名称
maxcompute-column:::project_name:[schema_name]:table_name:column_name

返回参数

名称类型描述示例值
object

返回结果。

RequestIdstring

请求 ID。

D1E2E5BC-xxxx-xxxx-xxxx-xxxxxx
Successboolean

请求是否成功。

true
ColumnColumn

字段列表。

示例

正常返回示例

JSON格式

{
  "RequestId": "D1E2E5BC-xxxx-xxxx-xxxx-xxxxxx",
  "Success": true,
  "Column": {
    "Id": "maxcompute-column:::project_name:[schema_name]:table_name:column_name",
    "Name": "column_name",
    "Comment": "字段1",
    "TableId": "maxcompute-table:::project_name:[schema_name]:table_name",
    "Position": 1,
    "Type": "bigint",
    "PrimaryKey": false,
    "PartitionKey": false,
    "ForeignKey": false,
    "BusinessMetadata": {
      "Description": "字段1的业务描述"
    }
  }
}

错误码

访问错误中心查看更多错误码。