All Products
Search
Document Center

DataWorks:SearchMetaTables

Last Updated:Jan 08, 2026

Queries metatables based on specific conditions.

Operation description

You can call this operation to query only metatables in a MaxCompute or E-MapReduce (EMR) compute engine.

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:
    • For mandatory resource types, indicate with a prefix of * .
    • 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
PageNumberintegerNo

The page number.

1
PageSizeintegerNo

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

10
AppGuidstringYes

The GUID of the workspace where the metatables reside.

odps.engine_name
KeywordstringYes

The keyword based on which metatables are queried. During the query, the system tokenizes the names of metatables and matches the names with the keyword. If no name is matched, the value null is returned. By default, the system uses underscores (_) to tokenize the names.

test
EntityTypeintegerNo

The type of the metatables. Valid values: 0 and 1. The value 0 indicates that tables are queried. The value 1 indicates that views are queried. If you do not configure this parameter, all types of metatables are queried.

0
ClusterIdstringNo

The ID of the EMR cluster. This parameter is required only if you set the DataSourceType parameter to emr.

You can log on to the EMR console to obtain the ID.

abc
DataSourceTypestringYes

The type of the data source. Valid values: odps and emr.

emr
SchemastringNo

The schema information of the table. You must configure this parameter if you enable the three-layer model of MaxCompute.

default

Response parameters

ParameterTypeDescriptionExample
object

The response parameters.

HttpStatusCodeinteger

The HTTP status code.

200
ErrorMessagestring

The error message.

The specified parameters are invalid.
RequestIdstring

The request ID.

0bc1ec92159376****
Successboolean

Indicates whether the request was successful.

true
ErrorCodestring

The error code.

1031203110005
Dataobject

The search results.

PageNumberinteger

The page number.

1
PageSizeinteger

The number of entries per page.

10
TotalCountlong

The total number of metatables.

100
DataEntityListarray<object>

The list of metatables.

DataEntityListobject
TableNamestring

The name of the metatable.

test_name
DatabaseNamestring

The name of the metadatabase.

abc
EntityTypeinteger

The type of the metatable. Valid values:

  • 0: table
  • 1: view
0
ProjectNamestring

The name of the workspace.

test
ProjectIdlong

The ID of the workspace.

323
TableGuidstring

The GUID of the metatable.

odps.engine_name.test_name
OwnerIdstring

The ID of the Alibaba Cloud account used by the workspace owner.

123
ClusterIdstring

The ID of the EMR cluster.

abc
EnvTypeinteger

The type of the environment. Valid values:

  • 1: production environment
  • 0: development environment
1
TenantIdlong

The tenant ID.

12345
Schemastring

The schema information of the table. You must configure this parameter if you enable the three-layer model of MaxCompute.

default

Examples

Sample success responses

JSONformat

{
  "HttpStatusCode": 200,
  "ErrorMessage": "The specified parameters are invalid.",
  "RequestId": "0bc1ec92159376****",
  "Success": true,
  "ErrorCode": 1031203110005,
  "Data": {
    "PageNumber": 1,
    "PageSize": 10,
    "TotalCount": 100,
    "DataEntityList": [
      {
        "TableName": "test_name",
        "DatabaseName": "abc",
        "EntityType": 0,
        "ProjectName": "test",
        "ProjectId": 323,
        "TableGuid": "odps.engine_name.test_name",
        "OwnerId": 123,
        "ClusterId": "abc",
        "EnvType": 1,
        "TenantId": 12345,
        "Schema": "default"
      }
    ]
  }
}

Error codes

HTTP status codeError codeError messageDescription
400Invalid.Meta.TableNotExistThe table does not exist.The table does not exist.
400InvalidParameter.Meta.CommonErrorThe specified parameter is invalid.The request parameter 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
403ResourceNotAuthorized.ApiYou are not authorized to access the resources.-
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
2025-11-03API Description Update. The Error code has changedView Change Details