文档

GetCategories - 获取分类及其子分类信息

更新时间:

调用GetCategories按ID或类型来筛选查询指定的分类信息,及其子分类(即下一级分类)的列表。

调试

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

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
vod:GetCategoriesList
  • 全部资源
    *

请求参数

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

分类 ID,传入此参数,则可查询指定 ID 的分类。仅支持传入单个分类 ID。可通过以下方式获取:

49339****
PageNolong

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

1
PageSizelong

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

10
SortBystring

查询结果排序。取值:

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

分类类型,传入此参数,则可筛选查询指定类型的分类。取值:

  • default:音视频/图片分类。
  • material:短视频素材分类。
default

返回参数

名称类型描述示例值
object

返回结果。

SubTotallong

子分类总数。

2
RequestIdstring

请求 ID。

25818875-5F78-4AF6-D7393642CA58****
Categoryobject

分类的详细信息。

Typestring

分类类型。取值:

  • default:音视频/图片分类。
  • material:短视频素材分类。
default
ParentIdlong

父分类 ID。

100012****
CateNamestring

分类名称。

电影
CateIdlong

分类 ID。

100
Levellong

分类层级。取值:

  • 0:一级分类。
  • 1:二级分类。
  • 2:三级分类。
0
SubCategoriesobject []

子分类的详细信息。

Typestring

子分类的类型。取值:

  • default:音视频/图片分类。
  • material:短视频素材分类。
default
CateNamestring

分类名称。

电影
ParentIdlong

父分类 ID。

10020****
CateIdlong

分类 ID。

100
SubTotallong

子分类总数。

1
Levellong

分类层级。取值:

  • 0:一级分类。
  • 1:二级分类。
  • 2:三级分类。
1

示例

正常返回示例

JSON格式

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

错误码

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

接口错误码

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

错误代码错误信息HTTP 状态码说明
InvalidCateId.NotFoundThe CateId not exist.404分类 ID 不存在。
  • 本页导读 (1)