文档

GetCategories - 获取分类及子分类

更新时间:

调用GetCategories获取指定的分类信息,及其子分类(即下一级分类)的列表。

接口说明

支持按分类 ID 和分类类型来查询分类及其子分类的信息。

调试

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

授权信息

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

请求参数

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

分类 ID。可通过以下方式获取:

  • 登录 IMS 控制台,选择 媒资管理 > 分类管理查看分类 ID。
  • 通过创建分类接口创建分类时,分类 ID 为返回参数 CateId 的值。
  • 通过获取分类接口查询分类时,为请求后返回参数 CateId 的值。
33
PageNolong

分页的页码。默认值:1。

1
PageSizelong

分页大小,最小值为 10,最大值为 100

10
SortBystring

结果排序方式。取值范围:

-CreationTime:Desc(默认值):按创建时间倒序。

-CreationTime:Asc:按创建时间升序。

CreationTime:Desc
Typestring

分类类型。取值:default(默认值):音视频/图片分类。 material:短视频素材分类。

default

返回参数

名称类型描述示例值
object
SubTotallong

子分类总数。

100
RequestIdstring

请求 ID

******3B-0E1A-586A-AC29-742247******
Categoryobject

媒资分类信息。

Typestring

分类类型。取值:

  • default(默认值):音视频/图片分类。
  • material:短视频素材分类。
default
CateNamestring

分类名称。

一级分类
ParentIdlong

父分类 ID。

-1
CateIdlong

分类 ID。

46
Levellong

分类层级。一级分类层级为 0,二级分类层级为 1,三级分类层级为 2

0
SubCategoriesobject []

子分类列表。

Typestring

分类类型。取值:

  • default(默认值):音视频/图片分类。
  • material:短视频素材分类。
default
CateNamestring

分类名称。

  • 最多支持 64 个字节。
  • UTF-8 编码。
二级子分类
ParentIdlong

父分类 ID。

46
CateIdlong

分类 ID。

129
SubTotallong

子分类总数。

100
Levellong

分类层级。一级分类层级为 0,二级分类层级为 1,三级分类层级为 2

1

示例

正常返回示例

JSON格式

{
  "SubTotal": 100,
  "RequestId": "******3B-0E1A-586A-AC29-742247******",
  "Category": {
    "Type": "default",
    "CateName": "一级分类",
    "ParentId": -1,
    "CateId": 46,
    "Level": 0
  },
  "SubCategories": {
    "Category": [
      {
        "Type": "default",
        "CateName": "二级子分类",
        "ParentId": 46,
        "CateId": 129,
        "SubTotal": 100,
        "Level": 1
      }
    ]
  }
}

错误码

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

变更历史

变更时间变更内容概要操作
暂无变更历史
  • 本页导读 (1)
文档反馈