Queries metatables in a specified category.

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 GetMetaTableListByCategory

The operation that you want to perform. Set the value to GetMetaTableListByCategory.

PageNumber Integer No 1

The number of the page to return.

PageSize Integer No 10

The number of entries to return on each page. Default value: 10. Maximum value: 100.

CategoryId Long Yes 23

The ID of the category. You can call the GetMetaCategory operation to query the ID of the category. Categories allow you to efficiently organize and manage tables by category. You can search for the desired table by category.

Response parameters

Parameter Type Example Description
HttpStatusCode Integer 200

The HTTP status code returned.

ErrorMessage String The connection does not exist.

The error message returned.

RequestId String 0bc1ec92159376

The ID of the request.

Success Boolean true

Indicates whether the request was successful.

ErrorCode String Invalid.Tenant.ConnectionNotExists

The error code returned.

Data Object

The business data returned.

PageNumber Integer 1

The page number of the returned page.

PageSize Integer 10

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

TotalCount Long 20

The total number of metatables.

TableGuidList Array of String odps.engine_name.table_name

The list of metatables.

Examples

Sample requests

http(s)://[Endpoint]/?Action=GetMetaTableListByCategory
&PageNumber=1
&PageSize=10
&CategoryId=23
&Common request parameters

Sample success responses

XML format

HTTP/1.1 200 OK
Content-Type:application/xml

<GetMetaTableListByCategoryResponse>
    <HttpStatusCode>200</HttpStatusCode>
    <ErrorMessage>The connection does not exist.</ErrorMessage>
    <RequestId>0bc1ec92159376</RequestId>
    <Success>true</Success>
    <ErrorCode>Invalid.Tenant.ConnectionNotExists</ErrorCode>
    <Data>
        <PageNumber>1</PageNumber>
        <PageSize>10</PageSize>
        <TotalCount>20</TotalCount>
        <TableGuidList>odps.engine_name.table_name</TableGuidList>
    </Data>
</GetMetaTableListByCategoryResponse>

JSON format

HTTP/1.1 200 OK
Content-Type:application/json

{
  "HttpStatusCode" : 200,
  "ErrorMessage" : "The connection does not exist.",
  "RequestId" : "0bc1ec92159376",
  "Success" : true,
  "ErrorCode" : "Invalid.Tenant.ConnectionNotExists",
  "Data" : {
    "PageNumber" : 1,
    "PageSize" : 10,
    "TotalCount" : 20,
    "TableGuidList" : "odps.engine_name.table_name"
  }
}

Error codes

HttpCode Error code Error message Description
400 Invalid.Meta.CategoryIllegalDepth A category can contain a maximum of 4 levels. The error message returned because the number of category levels exceeds four.
400 Invalid.Meta.CategoryNameDuplicate The category name is duplicated at this level. The error message returned because the specified category name already exists at the same category level.
400 Invalid.Meta.TableNotExist The table does not exist. The error message returned because the metatable does not exist.
400 InvalidParameter.Meta.CommonError The specified parameter is invalid. The error message returned because the values specified for one or more request parameters are invalid.
400 InvalidParameter.Meta.Illegal The app guid parameter is invalid. The error message returned because the values specified for one or more parameters of the application are invalid.
400 InvalidParameter.Meta.IllegalDate The date format is invalid. The error message returned because the date format is invalid.
400 InvalidParameter.Meta.IllegalPageError The parameter for paging is invalid. The error message returned because the value of the parameter for paging is invalid.
400 InvalidParameter.Meta.NotExist The object does not exist. The error message returned because the object you query does not exist.
403 Forbidden.Meta.NoTenant The user is not the owner of any tenants. The error message returned because the current user is not a tenant owner.
403 Invalid.Meta.CategoryForbidden Failed to delete the category. The current category is associated with a table and cannot be operated. The error message returned because the category failed to be deleted. The category is associated with a table and cannot be deleted.
403 Invalid.Meta.CategoryIllegalTenant The tenant ID is different in the parent and child categories. The error message returned because the tenant IDs of the parent and child categories are different.
429 Throttling.Api The request for this resource has exceeded your available limit. The error message returned because the number of requests for the resource has exceeded the upper limit.
429 Throttling.Api.Risk The request for this resource has exceeded your daily available limit. The error message returned because the number of requests per day for the resource has exceeded the upper limit.
429 Throttling.System The DataWorks system is busy. Try again later. The error message returned because the DataWorks system is busy. Try again later.
429 Throttling.User Your request is too frequent. Try again later. The error message returned because excessive requests have been submitted within a short period of time. Try again later.
500 InternalError.System An internal system error occurred. Try again later. The error message returned because an internal error has occurred. Try again later.
500 InternalError.UserId.Missing An internal system error occurred. Try again later. The error message returned because an internal error has occurred. Try again later.
500 InternalError.Meta.NoCalcEngine An error occurred while retrieving the compute engine based on the MaxCompute project. The error message returned because the system has failed to obtain information about a compute engine instance based on the specified MaxCompute project.
500 InternalError.Meta.TenantTimeOut Failed to connect to the interface network. The error message returned because the network cannot be connected.
500 InternalError.Meta.Unknown An unknown error occurred while processing your request. The error message returned because an unknown error has occurred.
500 Invalid.Meta.CategoryRelationDuplicate" The table is already bound to the category. The error message returned because the category is already associated with the table.

For a list of error codes, see Service error codes.

For more information about the example on how to use the GetMetaTableListByCategory operation, see Examples of DataWorks API operations.