Queries the basic information about a table.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes GetMetaTableBasicInfo

The operation that you want to perform.

RegionId String Yes cn-shanghai

The ID of the region where your project resides.

TableGuid String Yes odps.engine_name.table_name

The globally unique identifier (GUID) of the table.

ClusterId String No abc

The ID of the e-MapReduce cluster.

DatabaseName String No abc

The name of the database.

TableName String No abc

The name of the table.

DataSourceType String No emr

The data type. Valid values: maxcompute and emr.

Response parameters

Parameter Type Example Description
Data Struct

Business data.

Caption String Display Name

The display name of the table.

ClusterId String abc

The ID of the E-MapReduce cluster.

Comment String test table

The description of the table.

CreateTime Long 1589870294000

The time when the table was created.

DataSize Long 10

The storage space occupied by the table.

DatabaseName String abc

Database name

EnvType Integer 1

The environment type. A value of 0 indicates the development table and a value of 1 indicates the production table.

IsVisible Integer 1

Visibility: 0 indicates that the workspace members are visible, 1 indicates that the members in the workspace are visible, 2 indicates that the members in the workspace are visible, and 3 indicates that the owner is visible.

LastAccessTime Long 1589870294000

The time of the last access.

LastDdlTime Long 1589870294000

The time when the schema was last changed.

LastModifyTime Long 1589870294000

The time when the rule was last updated.

LifeCycle Integer 5

The lifecycle of the table.

Location String hdfs://

The storage path of the Hive database.

OwnerId String 123

The ID of the table owner.

PartitionKeys String ab

The number of Hive partitions.

ProjectId Long 232

The ID of the DataWorks workspace.

ProjectName String test

The name of the workspace.

TableGuid String odps.engine_name.table_name

The globally unique identifier (GUID) of the table.

TableName String table_name

The name of the table.

TenantId Long 12345

The ID of the tenant.

ErrorCode String Invalid.Tenant.ConnectionNotExists

The error code.

ErrorMessage String The connection does not exist.

The error message.

HttpStatusCode Integer 200

The HTTP status code.

RequestId String 0bc1411515937

The ID of the request.

Success Boolean true

Indicates whether the request is successful.

Examples

Sample requests


     http(s)://[Endpoint]/? Action=GetMetaTableBasicInfo &RegionId=cn-shanghai &TableGuid=odps.engine_name.table_name &<common request parameters> 
   

Sample success responses

XML format


     <RequestId> 0bc1411515937 </RequestId> <HttpStatusCode> 200 </HttpStatusCode> <Data> <LifeCycle> 5 </LifeCycle> <Comment> test table </Comment> <ProjectName> test </ProjectName> <ClusterId> abc </ClusterId> <LastDdlTime> 1589870294000 </LastDdlTime> <CreateTime> 1589870294000 </CreateTime> <ProjectId> 232 </ProjectId> <DatabaseName> abc </DatabaseName> <LastModifyTime> 1589870294000 </LastModifyTime> <LastAccessTime> 1589870294000 </LastAccessTime> <EnvType> 1 </EnvType> <Caption> Chinese </Caption> <TableName> table_name </TableName> <TableGuid> odps.engine_name.table_name </TableGuid> <TenantId> 12345 </TenantId> <OwnerId> 123 </OwnerId> <DataSize> 10 </DataSize> <PartitionKeys> ab </PartitionKeys> <IsVisible> 1 </IsVisible> <Location> hdfs:// </Location> </Data> <ErrorCode> Invalid.Tenant.ConnectionNotExists </ErrorCode> <ErrorMessage> The connection does not exist. </ErrorMessage> <Success>true</Success> 
   

JSON Format


     {"RequestId": "0bc1411515937", "HttpStatusCode": 200, "Data": { "LifeCycle": 5, "Comment": "test table", "ProjectName": "test", "ClusterId": "abc", "LastDdlTime": 1589870294000, "CreateTime": 1589870294000, "ProjectId": 232, "DatabaseName":" abc ", " LastModifyTime ": 1589870294000," LastAccessTime ": " EnvType ": 1, " Caption ": " Chinese name ", " TableName ": " table_name ", " TableGuid ": " odps.engine_name.table_name ", " TenantId ": 12345," own_name "dataserid": 123", "ize": "10, " PartitionKeys ": " ab ", " IsVisible ": 1, "Location": "hdfs://" }, "ErrorCode": "Invalid.Tenant.ConnectionNotExists", "ErrorMessage": "The connection does not exist.", "Success": true} 
   

Error codes

HttpCode Error codes Error message Description
403 Forbidden.Access Access is forbidden. Activate DataWorks first. You have restricted access. Please activate DataWorks Enterprise Edition or above.
500 InternalError.System An internal system error occurred. Try again later. An internal system error occurred. Please try again later.
500 InternalError.UserId.Missing An internal system error occurred. Try again later. An internal system error occurred. Please try again later.
403 ResourceNotAuthorized.Api You are not authorized to access the resources. You cannot access resources without authorization.
429 Throttling.Api The request for this resource has exceeded your available limit. The request for the resource exceeds your available upper limit.
429 Throttling.Api.Risk The request for this resource has exceeded your daily available limit. The request for the resource has exceeded your daily availability limit.
429 Throttling.System The DataWorks system is busy. Try again later. DataWorks the system is busy, please try again later.
429 Throttling.User Your request is too frequent. Try again later. Your request is too frequent, please try to slow down the request speed.
403 Forbidden.Meta.NoTenant The user is not the owner of any tenants. The current user is not the owner of any of the tenants.
500 InternalError.Meta.NoCalcEngine An error occurred while retrieving the compute engine based on the MaxCompute project. Failed to get compute engine based on maxcompute project {0}.
500 InternalError.Meta.TenantTimeOut Failed to connect to the interface network. The interface network is disconnected.
500 InternalError.Meta.Unknown An unknown error occurred while processing your request. Resolve the error based on the error message.
400 Invalid.Meta.TableNotExist The table does not exist. The error message returned because
400 InvalidParameter.Meta.CommonError The specified parameter is invalid. The error message returned because one or more request parameters are invalid.
400 InvalidParameter.Meta.GuidFormat The GUID format is invalid. Bad Guid information.
400 InvalidParameter.Meta.Illegal The app guid parameter is invalid. The error message returned because the App parameter is invalid.
400 InvalidParameter.Meta.IllegalDate The date format is invalid. Date format error.
400 InvalidParameter.Meta.IllegalPageError The parameter for paging is invalid. The pagination information is incorrect.
400 InvalidParameter.Meta.NotExist The object does not exist. Data does not exist.

Go to the Error CenterFor more information, see error codes.