调用GetMetaCategory接口查询类目树。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
请求参数
名称 |
类型 |
是否必选 |
示例值 |
描述 |
Action | String | 是 | GetMetaCategory | 系统规定参数。取值:GetMetaCategory。 |
ParentCategoryId | Long | 是 | 333 | 类目树的ID。 |
PageNum | Integer | 否 | 1 | 请求的数据页数,用于翻页。 |
PageSize | Integer | 否 | 10 | 每页显示的条数,默认为10条,最大100条。 |
返回数据
名称 |
类型 |
示例值 |
描述 |
HttpStatusCode | Integer | 200 | HTTP状态码。 |
ErrorMessage | String | The connection does not exist. | 错误信息。 |
RequestId | String | 0bc1ec92159376 | 请求ID。 |
Success | Boolean | true | 请求是否成功。 |
ErrorCode | String | Invalid.Tenant.ConnectionNotExists | 错误码。 |
Data | Object | 业务数据。 |
|
PageNum | Integer | 1 | 请求的数据页数,用于翻页。 |
PageSize | Integer | 10 | 每页显示的条数,默认为10条,最大100条。 |
TotalCount | Long | 10 | 类目的总数。 |
DataEntityList | Array of DataEntityList | Data实例列表。 |
|
Depth | Integer | 1 | 类目的层数。 |
Comment | String | category 1 | 类目的备注信息。 |
ModifiedTime | Long | 1541576644000 | 修改类目的时间。 |
CreateTime | Long | 1541576644000 | 创建类目的时间。 |
CategoryId | Long | 133 | 类目的ID。 |
LastOperatorId | String | 12345 | 上一次操作的用户ID。 |
Name | String | category 1 | 类目的名称。 |
ParentCategoryId | Long | 12 | 父类目的ID。 |
OwnerId | String | 123 | 类目所有者的ID。 |
示例
请求示例
http(s)://[Endpoint]/?Action=GetMetaCategory
&ParentCategoryId=333
&PageNum=1
&PageSize=10
&公共请求参数
正常返回示例
XML
格式
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
格式
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"
} ]
}
}
错误码
HttpCode |
错误码 |
错误信息 |
描述 |
400 | Invalid.Meta.CategoryIllegalDepth | A category can contain a maximum of 4 levels. | 类目层级超过4级。 |
400 | Invalid.Meta.CategoryNameDuplicate | The category name is duplicated at this level. | 同一层级下,类目名称重复。 |
400 | Invalid.Meta.TableNotExist | The table does not exist. | 表不存在。 |
400 | InvalidParameter.Meta.CommonError | The specified parameter is invalid. | 请求参数错误。 |
400 | InvalidParameter.Meta.Illegal | The app guid parameter is invalid. | App参数错误。 |
400 | InvalidParameter.Meta.IllegalDate | The date format is invalid. | 日期格式错误。 |
400 | InvalidParameter.Meta.IllegalPageError | The parameter for paging is invalid. | 分页信息错误。 |
403 | Forbidden.Meta.NoTenant | 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. | 类目删除失败,当前类目存在关联表,不能进行操作。 |
403 | Invalid.Meta.CategoryIllegalTenant | The tenant ID is different in the parent and child categories. | 父子类目的租户ID不一致。 |
403 | Forbidden.Access | Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition. | 没有权限,请授权 |
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. | DataWorks系统繁忙,请稍后再试。 |
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. | 用户输入的 project 不正确 |
500 | InternalError.Meta.TenantTimeOut | Failed to connect to the interface network. | 接口网络不通。 |
500 | InternalError.Meta.Unknown | An unknown error occurred while processing your request. | 未知错误。 |
500 | Invalid.Meta.CategoryRelationDuplicate" | The table is already bound to the category. | 类目已经关联该表。 |
访问错误中心查看更多错误码。
GetMetaCategory接口的使用示例Demo请参见DataWorks OpenAPI示例。
反馈
- 本页导读 (1)
文档反馈