GetCategories - 获取分类及子分类-分类-gt-lt-视频点播-阿里云

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

接口说明

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

QPS限制

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

调试

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

调试

授权信息

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

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

操作	访问级别	资源类型	条件关键字	关联操作
vod:GetCategories	List	VOD acs:vod::{#accountId}:/*	无	无

请求参数

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

返回参数

名称	类型	描述	示例值
	object	返回结果。
SubTotal	Long	子分类总数。	3795
RequestId	string	请求ID。	25818875-5F78-4AF6-D7393642CA58****
Category	object	指定分类的信息。
Type	string	分类类型。取值： default（默认值）：音视频/图片分类。 material：短视频素材分类。	default
ParentId	Long	父分类ID。	100012****
CateName	string	分类名称。最多支持64个字节。 UTF-8编码。	电影
CateId	Long	分类ID。	100
Level	Long	分类层级。一级分类层级为0，二级分类层级为1，三级分类层级为2。	0
SubCategories	array	子分类列表。
	object	子分类详情。
Type	string	分类类型。取值： default（默认值）：音视频/图片分类。 material：短视频素材分类。	default
CateName	string	分类名称。最多支持64个字节。 UTF-8编码。	电影
ParentId	Long	父分类ID。	10020****
CateId	Long	分类ID。	100
SubTotal	Long	子分类总数。	1
Level	Long	分类层级。一级分类层级为0，二级分类层级为1，三级分类层级为2。	1

示例

请求示例

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

正常返回示例

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
    }
}

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>

错误码

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

接口错误码

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

错误代码	错误信息	HTTP 状态码	说明
InvalidCateId.NotFound	The CateId not exist.	404	分类ID不存在。