GetCategories - 获取分类及子分类 - 智能媒体服务

调用GetCategories获取指定的分类信息，及其子分类（即下一级分类）的列表。

接口说明

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

调试

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

调试

授权信息

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

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

ice:GetCategories

*全部资源

*

无

请求参数

名称	类型	必填	描述	示例值
CateId	integer	否	分类 ID。可通过以下方式获取：登录 IMS 控制台，选择媒资管理 > 分类管理查看分类 ID。通过创建分类接口创建分类时，分类 ID 为返回参数 CateId 的值。通过获取分类接口查询分类时，为请求后返回参数 CateId 的值。	33
PageNo	integer	否	分页的页码。默认值：1。	1
PageSize	integer	否	分页大小，最小值为 10，最大值为 100	10
SortBy	string	否	结果排序方式。取值范围： CreationTime:Desc（默认值）：按创建时间倒序。 CreationTime:Asc：按创建时间升序。	CreationTime:Desc
Type	string	否	分类类型。取值： default（默认值）：音视频/图片分类。 material：短视频素材分类。	default

返回参数

名称	类型	描述	示例值
	object
SubTotal	integer	子分类总数。	100
RequestId	string	请求 ID	****3B-0E1A-586A-AC29-742247****
Category	object	媒资分类信息。
Type	string	分类类型。取值： default（默认值）：音视频/图片分类。 material：短视频素材分类。	default
CateName	string	分类名称。	First-level category
ParentId	integer	父分类 ID。	-1
CateId	integer	分类 ID。	46
Level	integer	分类层级。一级分类层级为 0，二级分类层级为 1，三级分类层级为 2。	0
SubCategories	object
Category	array<object>	子分类列表。
	object	子分类列表。
Type	string	分类类型。取值： default（默认值）：音视频/图片分类。 material：短视频素材分类。	default
CateName	string	分类名称。最多支持 64 个字节。 UTF-8 编码。	Second-level subcategory
ParentId	integer	父分类 ID。	46
CateId	integer	分类 ID。	129
SubTotal	integer	子分类总数。	100
Level	integer	分类层级。一级分类层级为 0。二级分类层级为 1。三级分类层级为 2。	1

示例

正常返回示例

JSON格式

{
  "SubTotal": 100,
  "RequestId": "******3B-0E1A-586A-AC29-742247******",
  "Category": {
    "Type": "default",
    "CateName": "First-level category",
    "ParentId": -1,
    "CateId": 46,
    "Level": 0
  },
  "SubCategories": {
    "Category": [
      {
        "Type": "default",
        "CateName": "Second-level subcategory",
        "ParentId": 46,
        "CateId": 129,
        "SubTotal": 100,
        "Level": 1
      }
    ]
  }
}

错误码

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

变更历史

更多信息，参考变更详情。