该接口用于查询类目树。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
|
操作 |
访问级别 |
资源类型 |
条件关键字 |
关联操作 |
|
dataworks:* |
get |
*全部资源
|
无 | 无 |
请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| ParentCategoryId |
integer |
否 |
类目树的 ID。 |
333 |
| PageNum |
integer |
否 |
请求的数据页数,用于翻页。 |
1 |
| PageSize |
integer |
否 |
每页显示的条数,默认为 10 条,最大 100 条。 |
10 |
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
返回数据。 |
||
| HttpStatusCode |
integer |
HTTP 状态码。 |
200 |
| ErrorMessage |
string |
错误信息。 |
The connection does not exist. |
| RequestId |
string |
请求 ID。 |
0bc1ec92159376 |
| Success |
boolean |
请求是否成功。 |
true |
| ErrorCode |
string |
错误码。 |
Invalid.Tenant.ConnectionNotExists |
| Data |
object |
业务数据。 |
|
| PageNum |
integer |
请求的数据页数,用于翻页。 |
1 |
| PageSize |
integer |
每页显示的条数,默认为 10 条,最大 100 条。 |
10 |
| TotalCount |
integer |
类目的总数。 |
10 |
| DataEntityList |
array<object> |
Data 实例列表。 |
|
|
object |
类目详情。 |
||
| Depth |
integer |
类目的层数。 |
1 |
| Comment |
string |
类目的备注信息。 |
category 1 |
| ModifiedTime |
integer |
修改类目的时间。 格式示例为 13 位数字,例如 |
1541576644000 |
| CreateTime |
integer |
创建类目的时间。 格式示例为 13 位数字,例如 |
1541576644000 |
| CategoryId |
integer |
类目的 ID。 |
133 |
| LastOperatorId |
string |
上一次操作的用户 ID。 |
12345 |
| Name |
string |
类目的名称。 |
category 1 |
| ParentCategoryId |
integer |
父类目的 ID。 |
12 |
| OwnerId |
string |
类目所有者的 ID。 |
123 |
示例
正常返回示例
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"
}
]
}
}
错误码
|
HTTP status code |
错误码 |
错误信息 |
描述 |
|---|---|---|---|
| 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. | 分页信息错误。 |
| 400 | InvalidParameter.Meta.NotExist | The object does not exist. | |
| 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. | |
| 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. | |
| 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. | |
| 429 | Throttling.User | Your request is too frequent. Try again later. |
访问错误中心查看更多错误码。
变更历史
更多信息,参考变更详情。