Queries tables based on specified conditions.
Debugging
Request parameters
Parameter | Type | Required | Example | Description |
---|---|---|---|---|
Action | String | Yes | SearchMetaTables |
The operation that you want to perform. |
AppGuid | String | Yes | odps.engine_name |
The identifier of the workspace in which the table resides. |
DataSourceType | String | Yes | emr |
The data type. Valid values: maxcompute and emr. |
Keyword | String | Yes | test |
The keyword to specify. |
RegionId | String | Yes | cn-shanghai |
The ID of the region. |
PageNumber | Integer | No | 1 |
The page number to be queried. |
PageSize | Integer | No | 10 |
The number of entries to return on each page. Default value: 10. Maximum value: 100. |
EntityType | Integer | No | 0 |
The type of the table. Valid values: 0 for table, and 1 for view. If you do not set this parameter, all fields are searched by default. |
ClusterId | String | No | abc |
The ID of the e-MapReduce cluster. |
Response parameters
Parameter | Type | Example | Description |
---|---|---|---|
Data | Struct |
Business data. |
|
DataEntityList | Array of DataEntityList |
The request body. |
|
ClusterId | String | abc |
The id of the e-MapReduce cluster. |
DatabaseName | String | abc |
The name of the database. |
EntityType | Integer | 0 |
The type of the table. Valid values: 0 for table, and 1 for view. |
EnvType | Integer | 1 |
Environment type: the value 1 indicates the production environment, and the value 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 page number to be queried. |
PageSize | Integer | 10 |
The number of entries to return on each page. |
TotalCount | Long | 100 |
The total number of tables. |
ErrorCode | String | 1031203110005 |
The error code. |
ErrorMessage | String | The specified parameters are invalid. |
The error message of the failure. |
HttpStatusCode | Integer | 200 |
The HTTP status code. |
RequestId | String | 0bc1ec92159376**** |
The ID of the request. |
Success | Boolean | true |
Indicates whether the request is successful. |
Examples
Sample request
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>1031203110005</ErrorCode> <ErrorMessage>The specified parameters are invalid. </ErrorMessage> <Success>true</Success>
JSON
{ "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": 1031203110005, "ErrorMessage": "The specified parameters are invalid.", "Success": true }
Error codes
HttpCode | Error code | Error message | Description |
---|---|---|---|
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.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. |
403 | Forbidden.Access | Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition. | You have restricted access. Please activate DataWorks Enterprise Edition or above. |
For more information about error codes, see error center.