GetMetaCategory - DataWorks - Alibaba Cloud Documentation Center

Queries the information about a category tree.

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.

Debug

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

Parameter	Type	Required	Description	Example
ParentCategoryId	long	Yes	The category tree ID.	333
PageNum	integer	No	The number of the page to return.	1
PageSize	integer	No	The number of entries to return on each page. Default value: 10. Maximum value: 100.	10

Response parameters

Parameter	Type	Description	Example
	object	The response parameters.
HttpStatusCode	integer	The HTTP status code.	200
ErrorMessage	string	The error message.	The connection does not exist.
RequestId	string	The request ID.	0bc1ec92159376
Success	boolean	Indicates whether the request was successful.	true
ErrorCode	string	The error code.	Invalid.Tenant.ConnectionNotExists
Data	object	The business data.
PageNum	integer	The page number.	1
PageSize	integer	The number of entries per page. Default value: 10. Maximum value: 100.	10
TotalCount	long	The total number of categories returned.	10
DataEntityList	array<object>	The information about the category tree.
DataEntityList	object
Depth	integer	The number of category levels.	1
Comment	string	The remarks of the category.	category 1
ModifiedTime	long	The time when the category was last modified.	1541576644000
CreateTime	long	The time when the category was created.	1541576644000
CategoryId	long	The category ID.	133
LastOperatorId	string	The ID of the user that performed the last operation.	12345
Name	string	The name of the category.	category 1
ParentCategoryId	long	The parent category ID.	12
OwnerId	string	The category owner ID.	123

Examples

Sample success responses

JSONformat

{
  "HttpStatusCode": 200,
  "ErrorMessage": "The connection does not exist.",
  "RequestId": "0bc1ec92159376",
  "Success": true,
  "ErrorCode": "Invalid.Tenant.ConnectionNotExists",
  "Data": {
    "PageNum": 1,
    "PageSize": 10,
    "TotalCount": 10,
    "DataEntityList": [
      {
        "Depth": 1,
        "Comment": "category 1",
        "ModifiedTime": 1541576644000,
        "CreateTime": 1541576644000,
        "CategoryId": 133,
        "LastOperatorId": "12345",
        "Name": "category 1",
        "ParentCategoryId": 12,
        "OwnerId": "123"
      }
    ]
  }
}

Error codes

HTTP status code	Error code	Error message	Description
400	Invalid.Meta.CategoryIllegalDepth	A category can contain a maximum of 4 levels.	A category can contain a maximum of 4 levels.
400	Invalid.Meta.CategoryNameDuplicate	The category name is duplicated at this level.	The category name is duplicated at this level.
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.	-
403	Forbidden.Meta.NoTenant	The user is not the owner of any tenants.	The user is not the owner of any tenants.
403	Invalid.Meta.CategoryForbidden	Failed 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.
403	Invalid.Meta.CategoryIllegalTenant	The tenant ID is different in the parent and child categories.	The tenant ID is different in the parent and child categories.
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.UserId.Missing	An internal system error occurred. Try again later.	-
500	InternalError.Meta.NoCalcEngine	An error occurred while retrieving the compute engine based on the MaxCompute project.	Incorrect project entered by user
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.
500	Invalid.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 time	Summary of changes	Operation

No change history

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