调用GetColumn API获取数据地图数据表字段信息-大数据开发治理平台 DataWorks-阿里云-大数据开发治理平台 DataWorks(DataWorks)-阿里云帮助中心

接口说明

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

调试

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

调试

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

dataworks:GetColumn

get

*全部资源

*

无

请求参数

名称	类型	必填	描述	示例值
Id	string	是	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	返回结果。
RequestId	string	请求 ID。	D1E2E5BC-xxxx-xxxx-xxxx-xxxxxx
Success	boolean	请求是否成功。	true
Column	Column	字段列表。

示例

正常返回示例

JSON格式

{
  "RequestId": "D1E2E5BC-xxxx-xxxx-xxxx-xxxxxx",
  "Success": true,
  "Column": {
    "Id": "maxcompute-column:123456::test_project:default:test_tbl:col1",
    "Name": "col1",
    "Comment": "字段1",
    "TableId": "maxcompute-table:123456::test_project:default:test_tbl",
    "Position": 1,
    "Type": "bigint",
    "PrimaryKey": false,
    "PartitionKey": false,
    "ForeignKey": false,
    "BusinessMetadata": {
      "Description": "字段1的业务描述",
      "CustomAttributes": {
        "key": [
          "张三"
        ]
      }
    }
  }
}

错误码

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

变更历史

更多信息，参考变更详情。