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

使用说明

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

QPS限制

本接口的单用户QPS限制为50次/秒。超过限制,API调用会被限流,这可能会影响您的业务,请合理调用。更多信息,请参见QPS限制

调试

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

请求参数

名称 类型 是否必选 示例值 描述
Action String GetCategories

系统规定参数。取值:GetCategories

CateId Long 49339****

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

  • 登录点播控制台,选择配置管理 > 媒资管理配置 > 分类管理查看分类ID。
  • 通过创建分类接口创建分类时,分类ID为返回参数CateId的值。
PageNo Long 1

子分类列表页号。默认值为1

PageSize Long 10

子分类列表页大小。默认值为10,最大值为100

SortBy String CreationTime:Desc

查询结果排序。取值:

  • CreationTime:Desc(默认值):按创建时间倒序。
  • CreationTime:Asc:按创建时间升序。
Type String default

分类类型。取值:

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

返回数据

名称 类型 示例值 描述
SubTotal Long 3795

子分类总数。

RequestId String 25818875-5F78-4AF6-D7393642CA58****

请求ID。

Category Object

指定分类的信息。

Type String default

分类类型。取值:

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

父分类ID。

CateName String 电影

分类名称。

  • 最多支持64个字节。
  • UTF-8编码。
CateId Long 100

分类ID。

Level Long 0

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

SubCategories Array of Category

子分类列表。

Category
Type String default

分类类型。取值:

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

分类名称。

  • 最多支持64个字节。
  • UTF-8编码。
ParentId Long 10020****

父分类ID。

CateId Long 100

分类ID。

SubTotal Long 1

子分类总数。

Level Long 1

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

示例

请求示例

http(s)://vod.cn-shanghai.aliyuncs.com/?Action=GetCategories
&CateId=49339****
&PageNo=1
&PageSize=10
&SortBy=CreationTime:Desc
&Type=default
&公共请求参数

正常返回示例

XML格式

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

<GetCategoriesResponse>
    <SubTotal>3795</SubTotal>
    <RequestId>25818875-5F78-4AF6-D7393642CA58****</RequestId>
    <Category>
        <Type>default</Type>
        <ParentId>100012****</ParentId>
        <CateName>电影</CateName>
        <CateId>100</CateId>
        <Level>0</Level>
    </Category>
    <SubCategories>
        <Type>default</Type>
        <CateName>电影</CateName>
        <ParentId>10020****</ParentId>
        <CateId>100</CateId>
        <SubTotal>1</SubTotal>
        <Level>1</Level>
    </SubCategories>
</GetCategoriesResponse>

JSON格式

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

{
  "SubTotal" : 3795,
  "RequestId" : "25818875-5F78-4AF6-D7393642CA58****",
  "Category" : {
    "Type" : "default",
    "ParentId" : "100012****",
    "CateName" : "电影",
    "CateId" : 100,
    "Level" : 0
  },
  "SubCategories" : {
    "Type" : "default",
    "CateName" : "电影",
    "ParentId" : "10020****",
    "CateId" : 100,
    "SubTotal" : 1,
    "Level" : 1
  }
}

错误码

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

接口错误码

下表列举了本接口特有的错误码。

错误代码

错误信息

HTTP 状态码

说明

InvalidCateId.NotFound

The CateId not exist.

404

分类ID不存在。

SDK示例

建议使用服务端SDK来调用API,此API各语言调用的示例代码,请参见: