查询数据地图给定数据表的字段列表。
接口说明
- 需要购买 DataWorks 基础版及以上版本才能使用。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：
- 操作：是指具体的权限点。
- 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
- 资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用
全部资源表示。
- 条件关键字：是指云产品自身定义的条件关键字。
- 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
| 操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
|---|---|---|---|---|
| dataworks:ListColumns | list | *全部资源 * |
| 无 |
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| TableId | string | 是 | 数据表 ID，可参考 ListTables 接口返回结果， 以及元数据实体相关概念说明。 | maxcompute-table:::project_name:[schema_name]:table_name |
| Name | string | 否 | 名称，模糊匹配。 | test_table |
| Comment | string | 否 | 注释，模糊匹配。 | test comment |
| SortBy | string | 否 | 排序字段，默认为 Position，枚举值，当前支持
| Position |
| Order | string | 否 | 排序方向，默认为 Asc，枚举值，当前支持
| Asc |
| PageNumber | integer | 否 | 分页页码，默认为 1。 | 1 |
| PageSize | integer | 否 | 分页大小，默认为 10，最大为 100。 | 10 |
返回参数
示例
正常返回示例
JSON格式
{
"RequestId": "D1E2E5BC-xxxx-xxxx-xxxx-xxxxxx",
"Success": true,
"PagingInfo": {
"TotalCount": 1,
"PageNumber": 1,
"PageSize": 10,
"Columns": [
{
"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的业务描述"
}
}
]
}
}错误码
访问错误中心查看更多错误码。