All Products
Search
Document Center

DataWorks:GetColumn

Last Updated:Oct 27, 2026

Retrieves the details of a specified column in a Data Map table.

Operation description

  1. You must purchase DataWorks Basic Edition or a higher edition to use this API operation.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

  • Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.

  • API: The API that you can call to perform the action.

  • Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.

  • Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.

    • For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.

    • For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.

  • Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.

  • Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

dataworks:GetColumn

get

*All Resource

*

None None

Request parameters

Parameter

Type

Required

Description

Example

Id

string

Yes

The ID. You can refer to the response of the ListColumns operation and Metadata entity concepts.

The format is ${EntityType}:${Instance ID or URL-encoded URL}:${Catalog identifier}:${Database name}:${Schema name}:${Table name}:${Column name}. Use an empty string as a placeholder for non-existent levels.

Note

For MaxCompute and DLF, use an empty string as a placeholder for the instance ID. For MaxCompute, the database name is the MaxCompute project name. If the three-level model is enabled for the project, the schema name is required. Otherwise, use an empty string as a placeholder for the schema name.

Note

For StarRocks, the catalog identifier is the catalog name. For DLF, the catalog identifier is the catalog ID. Other types do not support the catalog level, so use an empty string as a placeholder.

The following are the ID formats for common types:

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

Note

Others
instance_id: The instance ID. This is required when the data source is registered in instance mode.
encoded_jdbc_url: The URL-encoded JDBC connection string. This is required when the data source is registered by using a connection string.
catalog_id: The DLF catalog ID.
project_name: The MaxCompute project name.
database_name: The database name.
schema_name: The schema name. For MaxCompute, this is required only when the three-level model is enabled for the project. Otherwise, use an empty string as a placeholder.
table_name: The table name.
column_name: The column name.






















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

Response elements

Element

Type

Description

Example

object

The response.

Column Column

The list of columns.

RequestId

string

The request ID.

D1E2E5BC-xxxx-xxxx-xxxx-xxxxxx

Success

boolean

Indicates whether the request is successful.

true

Examples

Success response

JSON format

{
  "Column": {
    "BusinessMetadata": {
      "CustomAttributes": {
        "key": [
          "Zhang San"
        ]
      },
      "Description": "Business description of Column 1"
    },
    "Comment": "Column 1",
    "ForeignKey": false,
    "Id": "maxcompute-column:::project_name:[schema_name]:table_name:column_name",
    "Name": "column_name",
    "PartitionKey": false,
    "Position": 1,
    "PrimaryKey": false,
    "StatisticsInfos": {
      "key": "96"
    },
    "TableId": "maxcompute-table:::project_name:[schema_name]:table_name",
    "TechnicalMetadata": {
      "Parameters": {
        "key": "keyword"
      }
    },
    "Type": "bigint"
  },
  "RequestId": "D1E2E5BC-xxxx-xxxx-xxxx-xxxxxx",
  "Success": true
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.