Retrieves the details of a specified column in a Data Map table.
Operation description
You must purchase DataWorks Basic Edition or a higher edition to use this API operation.
Try it now
Test
RAM authorization
|
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 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:
Note
Others |
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.