All Products
Search
Document Center

DataWorks:GetMetaTableListByCategory

Last Updated:Oct 17, 2024

Queries metatables in a specified category.

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

There is currently no authorization information disclosed in the API.

Request parameters

ParameterTypeRequiredDescriptionExample
PageNumberintegerNo

The number of the page to return.

1
PageSizeintegerNo

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

10
CategoryIdlongYes

The category ID. You can call the GetMetaCategory operation to obtain 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.

23

Response parameters

ParameterTypeDescriptionExample
object

The returned result.

HttpStatusCodeinteger

The HTTP status code returned.

200
ErrorMessagestring

The error message returned.

The connection does not exist.
RequestIdstring

The ID of the request.

0bc1ec92159376
Successboolean

Indicates whether the request was successful.

true
ErrorCodestring

The error code returned.

Invalid.Tenant.ConnectionNotExists
Dataobject

The business data returned.

PageNumberinteger

The page number of the returned page.

1
PageSizeinteger

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

10
TotalCountlong

The total number of metatables.

20
TableGuidListarray

The returned result.

TableGuidListstring

The list of metatables.

odps.engine_name.table_name

Examples

Sample success responses

JSONformat

{
  "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

HTTP status codeError codeError messageDescription
400Invalid.Meta.CategoryIllegalDepthA category can contain a maximum of 4 levels.A category can contain a maximum of 4 levels.
400Invalid.Meta.CategoryNameDuplicateThe category name is duplicated at this level.The category name is duplicated at this level.
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.-
403Forbidden.Meta.NoTenantThe user is not the owner of any tenants.The user is not the owner of any tenants.
403Invalid.Meta.CategoryForbiddenFailed to delete the category. The current category is associated with a table and cannot be operated.Failed to delete the category because the table associated with the category does not exist.
403Invalid.Meta.CategoryIllegalTenantThe tenant ID is different in the parent and child categories.The tenant ID is different in the parent and child categories.
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.UserId.MissingAn internal system error occurred. Try again later.-
500InternalError.Meta.NoCalcEngineAn error occurred while retrieving the compute engine based on the MaxCompute project.Incorrect project entered by user
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.
500Invalid.Meta.CategoryRelationDuplicate"The table is already bound to the category.The table is already bound to the category.

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

Change history

Change timeSummary of changesOperation
No change history

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