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

Operation description

DataWorks Basic Edition or a higher edition is required.

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

No authorization for this operation. If you encounter issues with this operation, contact technical support.

Request parameters

Parameter	Type	Required	Description	Example
Id	string	Yes	The ID. You can refer to the response of the ListColumns operation and the description of concepts related to metadata entities. The format: `${EntityType}:${Instance ID or escaped URL}:${Catalog identifier}:${Database name}:${Schema name}:${Table name}:${Column name}`. Use empty strings as placeholders for levels that do not exist. Note For the MaxCompute and DLF types, use an empty string as the placeholder for the instance ID. For MaxCompute, the database name refers to the MaxCompute project name. If the project has schema enabled, you must specify the schema name. Otherwise, use an empty string as the placeholder for the schema name. Note The catalog identifier of the StarRocks is the catalog name, and the catalog identifier of the DLF type is the catalog ID. Other types do not support catalog levels. Use empty strings as placeholders. Examples of common ID formats `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 `instance_id`: the ID of the instance, which is required when the data source is registered in instance mode. `encoded_jdbc_url`: The URL-encoded JDBC connection string, which is required when the data source is registered via 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 the MaxCompute type, this is required only if the project has enabled schema; otherwise, use an empty string as a placeholder. `table_name`: The table name. `column_name`: The field 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 succeeded.	true
Column	Column	The columns in the table.

Examples

Success response

JSON format

{
  "RequestId": "D1E2E5BC-xxxx-xxxx-xxxx-xxxxxx",
  "Success": true,
  "Column": {
    "Id": "maxcompute-column:123456::test_project:default:test_tbl:col1",
    "Name": "col1",
    "Comment": "column1",
    "TableId": "maxcompute-table:123456::test_project:default:test_tbl",
    "Position": 1,
    "Type": "bigint",
    "PrimaryKey": false,
    "PartitionKey": false,
    "ForeignKey": false,
    "BusinessMetadata": {
      "Description": "Business description of column1"
    }
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.