All Products
Search
Document Center

DataWorks:GetMetaTableColumn

Last Updated:Nov 21, 2024

Queries the field information of a metatable.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • The required resource types are displayed in bold characters.
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
dataworks:*get
*All Resources
*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
TableGuidstringYes

The GUID of the metatable. You can call the GetMetaDBTableList operation to query the GUID.

odps.engine_name.table_name
PageNumintegerNo

The page number.

1
PageSizeintegerNo

The number of entries per page. Default value: 10. Maximum value: 100.

10
ClusterIdstringNo

The ID of the E-MapReduce (EMR) cluster. You can log on to the EMR console to obtain the ID.

C-010A704DA760****
DatabaseNamestringNo

The name of the metadatabase of the EMR cluster. You can call the ListMetaDB operation to query the name.

abc
TableNamestringNo

The name of the metatable in the EMR cluster. You can call the GetMetaDBTableList operation to query the name.

abc
DataSourceTypestringNo

The type of the data source. Set the value to emr.

emr

Response parameters

ParameterTypeDescriptionExample
object

The response parameters.

HttpStatusCodeinteger

The HTTP status code.

200
ErrorMessagestring

The error message.

The connection does not exist.
RequestIdstring

The request ID. You can locate logs and troubleshoot issues based on the ID.

0bc1ec92159376
Successboolean

Indicates whether the request was successful.

true
ErrorCodestring

The error code.

Invalid.Tenant.ConnectionNotExists
Dataobject

The business data.

PageNuminteger

The page number.

1
PageSizeinteger

The number of entries per page. Default value: 10. Maximum value: 100.

10
TotalCountlong

The total number of fields.

100
ColumnListarray<object>

The information about fields.

ColumnListobject
ColumnGuidstring

The GUID of the field.

odps.engine_name.table_name.name
ColumnNamestring

The name of the field.

name
IsPartitionColumnboolean

Indicates whether the field is a partition field. Valid values:

  • true
  • false
false
Commentstring

The remarks of the field.

comment
ColumnTypestring

The data type of the field.

string
IsPrimaryKeyboolean

Indicates whether the field is a primary key. Valid values:

  • true
  • false
false
Positioninteger

The sequence number of the field.

1
Captionstring

The description of the field.

data column
IsForeignKeyboolean

Indicates whether the field is a foreign key. Valid values:

  • true
  • false
true
RelationCountlong

The number of times the field is read.

2

Examples

Sample success responses

JSONformat

{
  "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 codeError codeError messageDescription
400InvalidParameter.Meta.CommonErrorThe specified parameter is invalid.The request parameter is invalid.
400InvalidParameter.Meta.GuidFormatThe GUID format is invalid.The GUID format is invalid.
400InvalidParameter.Meta.IllegalThe app guid parameter is invalid.The app guid parameter is invalid.
400InvalidParameter.Meta.IllegalDateThe date format is invalid.The date format is invalid.
400InvalidParameter.Meta.IllegalPageErrorThe parameter for paging is invalid.The parameter for paging is invalid.
400InvalidParameter.Meta.NotExistThe object does not exist.-
400InternalError.UserId.MissingAn internal system error occurred. Try again later.-
400InternalError.Meta.NoCalcEngineAn error occurred while retrieving the compute engine based on the MaxCompute project.Incorrect project entered by user
403Forbidden.Meta.NoTenantThe user is not the owner of any tenants.The user is not the owner of any tenants.
403Forbidden.AccessAccess is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.No permission, please authorize
429Throttling.ApiThe request for this resource has exceeded your available limit.-
429Throttling.Api.RiskThe request for this resource has exceeded your daily available limit.-
429Throttling.SystemThe DataWorks system is busy. Try again later.-
429Throttling.UserYour request is too frequent. Try again later.-
500InternalError.SystemAn internal system error occurred. Try again later.-
500InternalError.Meta.TenantTimeOutFailed to connect to the interface network.Failed to connect to the interface network.
500InternalError.Meta.UnknownAn unknown error occurred while processing your request.An unknown error occurred while processing your request.

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
No change history