DataWorks:GetMetaCategory - DataWorks - Alibaba Cloud - - Alibaba Cloud ドキュメントセンター

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	GetMetaCategory	The operation that you want to perform. Set the value to GetMetaCategory.
ParentCategoryId	Long	Yes	333	The category tree ID.
PageNum	Integer	No	1	The page number.
PageSize	Integer	No	10	The number of entries per page. Valid values: 1 to 100. Default value: 10.

Response parameters

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

Examples

Sample requests

http(s)://[Endpoint]/?Action=GetMetaCategory
&ParentCategoryId=333
&PageNum=1
&PageSize=10
&<Common request parameters>

Sample success responses

XML format

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

<GetMetaCategoryResponse>
    <HttpStatusCode>200</HttpStatusCode>
    <ErrorMessage>The connection does not exist.</ErrorMessage>
    <RequestId>0bc1ec92159376</RequestId>
    <Success>true</Success>
    <ErrorCode>Invalid.Tenant.ConnectionNotExists</ErrorCode>
    <Data>
        <PageNum>1</PageNum>
        <PageSize>10</PageSize>
        <TotalCount>10</TotalCount>
        <DataEntityList>
            <Depth>1</Depth>
            <Comment>category 1</Comment>
            <ModifiedTime>1541576644000</ModifiedTime>
            <CreateTime>1541576644000</CreateTime>
            <CategoryId>133</CategoryId>
            <LastOperatorId>12345</LastOperatorId>
            <Name>category 1</Name>
            <ParentCategoryId>12</ParentCategoryId>
            <OwnerId>123</OwnerId>
        </DataEntityList>
    </Data>
</GetMetaCategoryResponse>

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" : {
    "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.	The number of category levels exceeds four.
400	Invalid.Meta.CategoryNameDuplicate	The category name is duplicated at this level.	The specified category name already exists at the same category level.
400	Invalid.Meta.TableNotExist	The table does not exist.	The metatable is not found.
400	InvalidParameter.Meta.CommonError	The specified parameter is invalid.	The values specified for one or more request parameters are invalid.
400	InvalidParameter.Meta.Illegal	The app guid parameter is invalid.	The values specified for one or more parameters of the application are 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 value of the parameter for paging is invalid.
403	Forbidden.Meta.NoTenant	The user is not the owner of any tenants.	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.	Failed to delete the category. 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 tenant IDs of the parent and child categories are different.
403	Forbidden.Access	Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.	No permissions.
429	Throttling.Api	The request for this resource has exceeded your available limit.	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 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 DataWorks system is busy. Try again later.
429	Throttling.User	Your request is too frequent. Try again later.	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.	An internal error occurred. Try again later.
500	InternalError.UserId.Missing	An internal system error occurred. Try again later.	An internal error occurred. Try again later.
500	InternalError.Meta.NoCalcEngine	An error occurred while retrieving the compute engine based on the MaxCompute project.	The project specified by the user is invalid.
500	InternalError.Meta.TenantTimeOut	Failed to connect to the interface network.	The network cannot be connected.
500	InternalError.Meta.Unknown	An unknown error occurred while processing your request.	An unknown error occurred.
500	Invalid.Meta.CategoryRelationDuplicate"	The table is already bound to the category.	The category is already associated with the table.

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

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