GetMetaCategory - 查询类目树

该接口用于查询类目树。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

当前API暂无授权信息透出。

请求参数

名称类型必填描述示例值
ParentCategoryIdlong

类目树的 ID。

333
PageNuminteger

请求的数据页数,用于翻页。

1
PageSizeinteger

每页显示的条数,默认为 10 条,最大 100 条。

10

返回参数

名称类型描述示例值
object

返回数据。

HttpStatusCodeinteger

HTTP 状态码。

200
ErrorMessagestring

错误信息。

The connection does not exist.
RequestIdstring

请求 ID。

0bc1ec92159376
Successboolean

请求是否成功。

true
ErrorCodestring

错误码。

Invalid.Tenant.ConnectionNotExists
Dataobject

业务数据。

PageNuminteger

请求的数据页数,用于翻页。

1
PageSizeinteger

每页显示的条数,默认为 10 条,最大 100 条。

10
TotalCountlong

类目的总数。

10
DataEntityListarray<object>

Data 实例列表。

DataEntityListobject

类目详情。

Depthinteger

类目的层数。

1
Commentstring

类目的备注信息。

category 1
ModifiedTimelong

修改类目的时间。

1541576644000
CreateTimelong

创建类目的时间。

1541576644000
CategoryIdlong

类目的 ID。

133
LastOperatorIdstring

上一次操作的用户 ID。

12345
Namestring

类目的名称。

category 1
ParentCategoryIdlong

父类目的 ID。

12
OwnerIdstring

类目所有者的 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错误码错误信息描述
400Invalid.Meta.CategoryIllegalDepthA category can contain a maximum of 4 levels.类目层级超过4级。
400Invalid.Meta.CategoryNameDuplicateThe category name is duplicated at this level.同一层级下,类目名称重复。
400Invalid.Meta.TableNotExistThe table does not exist.表不存在。
400InvalidParameter.Meta.CommonErrorThe specified parameter is invalid.请求参数错误。
400InvalidParameter.Meta.IllegalThe app guid parameter is invalid.App参数错误。
400InvalidParameter.Meta.IllegalDateThe date format is invalid.日期格式错误。
400InvalidParameter.Meta.IllegalPageErrorThe parameter for paging is invalid.分页信息错误。
400InvalidParameter.Meta.NotExistThe object does not exist.-
403Forbidden.Meta.NoTenantThe 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.类目删除失败,当前类目存在关联表,不能进行操作。
403Invalid.Meta.CategoryIllegalTenantThe tenant ID is different in the parent and child categories.父子类目的租户ID不一致。
403Forbidden.AccessAccess is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.没有权限,请授权
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.DataWorks系统繁忙,请稍后再试。
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.用户输入的 project 不正确
500InternalError.Meta.TenantTimeOutFailed to connect to the interface network.接口网络不通。
500InternalError.Meta.UnknownAn unknown error occurred while processing your request.未知错误。
500Invalid.Meta.CategoryRelationDuplicate"The table is already bound to the category.类目已经关联该表。

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
暂无变更历史

GetMetaCategory 接口的使用示例 Demo 请参见DataWorks OpenAPI 示例