GetColumn API Reference for Table Field Metadata - DataWorks - Alibaba Cloud - DataWorks

Operation description

You must purchase DataWorks Basic Edition or a higher edition to use this feature.

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

Request parameters

Parameter	Type	Required	Description	Example
Id	string	Yes	The ID. You can obtain this value from the response of the ListColumns operation. For more information, see Metadata entity concepts. The format is `${EntityType}:${InstanceID or encoded URL}:${DataCatalogIdentifier}:${DatabaseName}:${SchemaName}:${TableName}:${ColumnName}`. Use an empty string as a placeholder for levels that do not exist. Note For MaxCompute and DLF types, use an empty string as a placeholder for the instance ID. For MaxCompute, the database name is the MaxCompute project name. Projects with the three-layer model enabled must include the schema name. For projects without the three-layer model, use an empty string as a placeholder for the schema name. Note For StarRocks, the data catalog identifier is the catalog name. For DLF, the data catalog identifier is the catalog ID. Other types do not support the catalog level. Use an empty string as a placeholder. The following are ID format examples 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 Other parameters: `instance_id`: The instance ID. This parameter is required when the data source is registered in instance mode. `encoded_jdbc_url`: The URL-encoded JDBC connection string. This parameter 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 parameter is required only when the three-layer model is enabled for the project. If the three-layer model is not enabled, 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.
RequestId	string	The request ID.	D1E2E5BC-xxxx-xxxx-xxxx-xxxxxx
Success	boolean	Indicates whether the request was successful.	true
Column	Column	The column list.

Examples

Success response

JSON format

{
  "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的业务描述",
      "CustomAttributes": {
        "key": [
          "张三"
        ]
      }
    },
    "StatisticsInfos": {
      "key": ""
    }
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.