GetMetaTableColumn-DataWorks(DataWorks)-阿里云帮助中心

Queries the field information of a metatable.

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
TableGuid	string	No	The GUID of the metatable. You can call the GetMetaDBTableList operation to query the GUID.	odps.engine_name.table_name
PageNum	integer	No	The page number.	1
PageSize	integer	No	The number of entries per page. Default value: 10. Maximum value: 100.	10
ClusterId	string	No	The ID of the E-MapReduce (EMR) cluster. You can log on to the EMR console to obtain the ID.	C-010A704DA760****
DatabaseName	string	No	The name of the metadatabase of the EMR cluster. You can call the ListMetaDB operation to query the name.	abc
TableName	string	No	The name of the metatable in the EMR cluster. You can call the GetMetaDBTableList operation to query the name.	abc
DataSourceType	string	No	The type of the data source. Set the value to emr.	emr

Response elements

Element	Type	Description	Example
	object	The response parameters.
HttpStatusCode	integer	The HTTP status code.	200
ErrorMessage	string	The error message.	The connection does not exist.
RequestId	string	The request ID. You can locate logs and troubleshoot issues based on the ID.	0bc1ec92159376
Success	boolean	Indicates whether the request was successful.	true
ErrorCode	string	The error code.	Invalid.Tenant.ConnectionNotExists
Data	object	The business data.
PageNum	integer	The page number.	1
PageSize	integer	The number of entries per page. Default value: 10. Maximum value: 100.	10
TotalCount	integer	The total number of fields.	100
ColumnList	array<object>	The information about fields.
	object	The returned structure.
ColumnGuid	string	The GUID of the field.	odps.engine_name.table_name.name
ColumnName	string	The name of the field.	name
IsPartitionColumn	boolean	Indicates whether the field is a partition field. Valid values: true false	false
Comment	string	The remarks of the field.	comment
ColumnType	string	The data type of the field.	string
IsPrimaryKey	boolean	Indicates whether the field is a primary key. Valid values: true false	false
Position	integer	The sequence number of the field.	1
Caption	string	The description of the field.	data column
IsForeignKey	boolean	Indicates whether the field is a foreign key. Valid values: true false	true
RelationCount	integer	The popularity of the field.	2

Examples

Success response

JSON format

{
  "HttpStatusCode": 200,
  "ErrorMessage": "The connection does not exist.",
  "RequestId": "0bc1ec92159376",
  "Success": true,
  "ErrorCode": "Invalid.Tenant.ConnectionNotExists",
  "Data": {
    "PageNum": 1,
    "PageSize": 10,
    "TotalCount": 100,
    "ColumnList": [
      {
        "ColumnGuid": "odps.engine_name.table_name.name",
        "ColumnName": "name",
        "IsPartitionColumn": false,
        "Comment": "comment ",
        "ColumnType": "string",
        "IsPrimaryKey": false,
        "Position": 1,
        "Caption": "data column",
        "IsForeignKey": true,
        "RelationCount": 2
      }
    ]
  }
}

Error codes

HTTP status code	Error code	Error message	Description
400	InvalidParameter.Meta.CommonError	The specified parameter is invalid.	The request parameter is invalid.
400	InvalidParameter.Meta.GuidFormat	The GUID format is invalid.	The GUID format is invalid.
400	InvalidParameter.Meta.Illegal	The app guid parameter is invalid.	The app guid parameter is invalid.
400	InvalidParameter.Meta.IllegalDate	The date format is invalid.	The date format is invalid.
400	InvalidParameter.Meta.IllegalPageError	The parameter for paging is invalid.	The parameter for paging is invalid.
400	InvalidParameter.Meta.NotExist	The object does not exist.
400	InternalError.UserId.Missing	An internal system error occurred. Try again later.
400	InternalError.Meta.NoCalcEngine	An error occurred while retrieving the compute engine based on the MaxCompute project.	Incorrect project entered by user
500	InternalError.System	An internal system error occurred. Try again later.
500	InternalError.Meta.TenantTimeOut	Failed to connect to the interface network.	Failed to connect to the interface network.
500	InternalError.Meta.Unknown	An unknown error occurred while processing your request.	An unknown error occurred while processing your request.
403	Forbidden.Meta.NoTenant	The user is not the owner of any tenants.	The user is not the owner of any tenants.
403	Forbidden.Access	Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.	No permission, please authorize
429	Throttling.Api	The request for this resource has exceeded your available limit.
429	Throttling.Api.Risk	The request for this resource has exceeded your daily available limit.
429	Throttling.System	The DataWorks system is busy. Try again later.
429	Throttling.User	Your request is too frequent. Try again later.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.