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

Retrieves the complete information about a table, including column information.

Note

This API has been deprecated with no replacement. While temporary access is maintained, no further updates or bug fixes will be provided. To ensure continued functionality, plan your migration and contact your account manager for support.

Operation description

Only tables of the EMR engine type are supported.

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 globally unique identifier (GUID) of the table. You can call GetMetaDBTableList to obtain the GUID of the table.	odps.engine_name.table_name
PageNum	integer	No	The page number for pagination.	1
PageSize	integer	No	The number of entries per page. Default value: 10. Maximum value: 100.	10
ClusterId	string	No	The ID of the EMR cluster. This parameter is required only when the data source type is EMR. You can log on to the EMR console to obtain the cluster ID.	C-010A704DA760****
DatabaseName	string	No	The name of the database. This parameter is required only when the data source type is EMR. You can call the ListMetaDB operation to obtain the database name.	abc
TableName	string	No	The name of the EMR table. This parameter is required only when the data source type is EMR. You can call the GetMetaDBTableList operation to obtain the table name.	abc
DataSourceType	string	No	The data source type. Currently, only EMR is supported.	emr

Response elements

Element	Type	Description	Example
	object	The response struct.
HttpStatusCode	integer	The HTTP status code.	200
ErrorMessage	string	The error message.	The specified parameters are invalid.
RequestId	string	The request ID. You can use this ID to locate logs and troubleshoot issues.	0bc1411515937****
Success	boolean	Indicates whether the call was successful.	true
ErrorCode	string	The error code.	1031203110005
Data	object	The business data.
TableName	string	The name of the table.	table_name
Comment	string	The comment of the table.	comment
LifeCycle	integer	The lifecycle of the table, in days.	5
CreateTime	integer	The time when the table was created. The value is a timestamp. You can convert the timestamp to a date based on the time zone that you use.	1589870293000
ProjectName	string	The name of the workspace to which the table belongs.	test
ProjectId	integer	The ID of the workspace to which the table belongs.	22
OwnerId	string	The ID of the table owner.	123
EnvType	integer	The environment type. Valid values: 0: The table is in the development environment. 1: The table is in the production environment.	1
LastAccessTime	integer	The time when the table was last accessed. The value is a timestamp. You can convert the timestamp to a date based on the time zone that you use.	1589870294000
DataSize	integer	The storage space occupied by the table, in bytes.	10
LastModifyTime	integer	The time when the table was last updated. The value is a timestamp. You can convert the timestamp to a date based on the time zone that you use.	1589870294000
DatabaseName	string	The name of the database.	abc
IsVisible	integer	The visibility of the table. Valid values: 0: The table is visible to workspace members. 1: The table is visible within the tenant. 2: The table is visible across tenants. 3: The table is visible only to the owner.	1
TotalColumnCount	integer	The total number of columns.	22
TableGuid	string	The GUID of the table.	odps.engine_name.table_name
PartitionKeys	string	The partition keys.	abc
LastDdlTime	integer	The time when the table schema was last changed. The value is a timestamp. You can convert the timestamp to a date based on the time zone that you use.	1589870294000
Location	string	The storage path of the Hive table.	hdfs://localhost:777/user/hadoop/test.txt
ClusterId	string	The ID of the EMR cluster.	C-010A704DA760****
TenantId	integer	The tenant ID.	12345
Schema	string	The schema information of the table.	default
ColumnList	array<object>	The list of columns.
	object	The response struct.
ColumnName	string	The name of the column.	1
ColumnGuid	string	The GUID of the column.	odps.engine_name.table_name.1
IsPartitionColumn	boolean	Indicates whether the column is a partition column. Valid values: true: The column is a partition column. false: The column is not a partition column.	true
Comment	string	The comment of the column.	comment
ColumnType	string	The type of the column.	string
IsPrimaryKey	boolean	Indicates whether the column is a primary key. Valid values: true: The column is a primary key. false: The column is not a primary key.	false
Position	integer	The ordinal position of the column.	1
Caption	string	The description of the column.	data comment
IsForeignKey	boolean	Indicates whether the column is a foreign key. Valid values: true: The column is a foreign key. false: The column is not a foreign key.	true

Examples

Success response

JSON format

{
  "HttpStatusCode": 200,
  "ErrorMessage": "The specified parameters are invalid.",
  "RequestId": "0bc1411515937****",
  "Success": true,
  "ErrorCode": "1031203110005",
  "Data": {
    "TableName": "table_name",
    "Comment": "comment",
    "LifeCycle": 5,
    "CreateTime": 1589870293000,
    "ProjectName": "test",
    "ProjectId": 22,
    "OwnerId": "123",
    "EnvType": 1,
    "LastAccessTime": 1589870294000,
    "DataSize": 10,
    "LastModifyTime": 1589870294000,
    "DatabaseName": "abc",
    "IsVisible": 1,
    "TotalColumnCount": 22,
    "TableGuid": "odps.engine_name.table_name",
    "PartitionKeys": "abc",
    "LastDdlTime": 1589870294000,
    "Location": "hdfs://localhost:777/user/hadoop/test.txt",
    "ClusterId": "C-010A704DA760****",
    "TenantId": 12345,
    "Schema": "default",
    "ColumnList": [
      {
        "ColumnName": "1",
        "ColumnGuid": "odps.engine_name.table_name.1",
        "IsPartitionColumn": true,
        "Comment": "comment",
        "ColumnType": "string",
        "IsPrimaryKey": false,
        "Position": 1,
        "Caption": "data comment",
        "IsForeignKey": true
      }
    ]
  }
}

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.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.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.UserId.Missing	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.