SearchMetaTables - DataWorks - Alibaba Cloud Documentation Center

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

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Debug

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

Parameter	Type	Required	Description	Example
PageNumber	integer	No	The page number.	1
PageSize	integer	No	The number of entries per page. Default value: 10. Maximum value: 100.	10
AppGuid	string	Yes	The GUID of the workspace where the metatables reside.	odps.engine_name
Keyword	string	Yes	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
EntityType	integer	No	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
ClusterId	string	No	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
DataSourceType	string	Yes	The type of the data source. Valid values: odps and emr.	emr
Schema	string	No	The schema information of the table. You must configure this parameter if you enable the three-layer model of MaxCompute.	default

Response parameters

Parameter	Type	Description	Example
	object	The response parameters.
HttpStatusCode	integer	The HTTP status code.	200
ErrorMessage	string	The error message.	The specified parameters are invalid.
RequestId	string	The request ID.	0bc1ec92159376****
Success	boolean	Indicates whether the request was successful.	true
ErrorCode	string	The error code.	1031203110005
Data	object	The search results.
PageNumber	integer	The page number.	1
PageSize	integer	The number of entries per page.	10
TotalCount	long	The total number of metatables.	100
DataEntityList	array<object>	The list of metatables.
	object
TableName	string	The name of the metatable.	test_name
DatabaseName	string	The name of the metadatabase.	abc
EntityType	integer	The type of the metatable. Valid values: 0: table 1: view	0
ProjectName	string	The name of the workspace.	test
ProjectId	long	The ID of the workspace.	323
TableGuid	string	The GUID of the metatable.	odps.engine_name.test_name
OwnerId	string	The ID of the Alibaba Cloud account used by the workspace owner.	123
ClusterId	string	The ID of the EMR cluster.	abc
EnvType	integer	The type of the environment. Valid values: 1: production environment 0: development environment	1
TenantId	long	The tenant ID.	12345
Schema	string	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 code	Error code	Error message	Description
400	Invalid.Meta.TableNotExist	The table does not exist.	The table does not exist.
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.UserId.Missing	An internal system error occurred. Try again later.	-
400	InternalError.Meta.NoCalcEngine	An error occurred while retrieving the compute engine based on the MaxCompute project.	Incorrect project entered by user
403	ResourceNotAuthorized.Api	You are not authorized to access the resources.	-
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.	-
500	InternalError.System	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.

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

Change history

Change time	Summary of changes	Operation

No change history