Call SearchMetaTables to search for tables based on specified conditions.

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 Required SearchMetaTables

The operation that you want to perform.

AppGuid String Required odps.engine_name.table_name

The ID of the workspace to which the table belongs.

DataSourceType String Required emr

The type of the database engine. odps、emr

Keyword String Required test

The keyword to specify.

RegionId String Required cn-shanghai

The ID of the region where your project resides.

PageNumber Integer No 1

The number of the page to return.

PageSize Integer No 10

The size of each page in the paged query.

EntityType Integer No 0

The table type. A value of 0 indicates a table, and a value of 1 indicates a view. If you do not specify this parameter, all data types are searched.

ClusterId String No abc

The id of the emr cluster. For emr scenarios

Response parameters

Parameter Type Example Description
Data Struct

Business data.

DataEntityList Array of DataEntityList

The list of instances.

ClusterId String abc

The id of the emr cluster.

DatabaseName String abc

Database Name

EntityType Integer 0

The table type. A value of 0 indicates a table, and a value of 1 indicates a view.

EnvType Integer 1

Environment type: 1 indicates the production environment, and 0 indicates the development environment.

OwnerId String 123

The Alibaba Cloud account ID of the workspace Owner.

ProjectId Long 323

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.

PageNumber Integer 1

The number of the page to return.

PageSize Integer 10

The size of each page in the paged query.

TotalCount Long 100

The total number of tables.

ErrorCode String success

The error code.

ErrorMessage String success

The returned message.

HttpStatusCode Integer 200

The HTTP status code.

RequestId String 0bc1ec92159376****

The ID of the request.

Success Boolean true

Indicates whether the request is successful. A value of true indicates that the request is successful. A value of false indicates that the request has failed.

Examples

Sample requests

http(s)://[Endpoint]/? Action=SearchMetaTables
&AppGuid=odps.engine_name.table_name
&DataSourceType=emr
&Keyword=test
&RegionId=cn-shanghai
&<Common request parameters>

Sample success responses

XML format

<RequestId>0bc1ec92159376****</RequestId>
<HttpStatusCode>200</HttpStatusCode>
<Data>
    <TotalCount>100</TotalCount>
    <PageSize>10</PageSize>
    <PageNumber>1</PageNumber>
    <DataEntityList>
        <EntityType>0</EntityType>
        <TableName>table_name</TableName>
        <TableGuid>odps.engine_name.table_name</TableGuid>
        <TenantId>12345</TenantId>
        <OwnerId>123</OwnerId>
        <ProjectName>test</ProjectName>
        <ClusterId>abc</ClusterId>
        <ProjectId>323</ProjectId>
        <DatabaseName>abc</DatabaseName>
        <EnvType>1</EnvType>
    </DataEntityList>
</Data>
<ErrorCode>success</ErrorCode>
<ErrorMessage>success</ErrorMessage>
<Success>true</Success>

JSON format

{"RequestId":"0bc1ec92159376****","HttpStatusCode":"200","Data":{"TotalCount":"100","PageSize":"10","PageNumber":"1","DataEntityList":[{"EntityType":"0","TableName":"table_name","TableGuid":"odps.engine_name.table_name","TenantId":"12345","OwnerId":"123","ProjectName":"test","ClusterId":"abc","ProjectId":"323","DatabaseName":"abc","EnvType":"1"}]},"ErrorCode":"success","ErrorMessage":"success","Success":"true"}

Error code

HttpCode Error code Error message Description
403 Forbidden.Access Access is forbidden. Activate DataWorks first. Your access is restricted, probably because you have not activated DataWorks.
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 to 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 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 tenant.
500 InternalError.Meta.NoCalcEngine An error occurred while retrieving the compute engine based on the MaxCompute project. Failed to retrieve the compute engine based on maxcompute project {0}.
500 InternalError.Meta.TenantTimeOut Failed to connect to the interface network. The network of the interface is disconnected.
500 InternalError.Meta.Unknown An unknown error occurred while processing your request. An unknown error has occurred.
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. Guid information error.
400 InvalidParameter.Meta.Illegal The app guid parameter is invalid. The error message returned because the specified App parameters are 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.

For a list of error codes, visit the API Error Center.