调用GetCategories获取指定的分类信息,及其子分类(即下一级分类)的列表。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
请求参数
名称 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | GetCategories |
系统规定参数。取值:GetCategories。 |
CateId | Long | 否 | 49339 |
分类ID。默认为根节点分类ID,即-1。 |
PageNo | Long | 否 | 1 |
子分类列表页号。默认值为1。 |
PageSize | Long | 否 | 10 |
子分类列表页大小。默认值为10,最大值为100。 |
SortBy | String | 否 | CreationTime:Desc |
结果排序。取值:
|
Type | String | 否 | default |
分类类型。取值:
|
返回数据
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
RequestId | String | 25818875-5F78-4A*****F6-D7393642CA58 |
请求ID。 |
SubTotal | Long | 3795 |
子分类总数。 |
Category | Struct |
指定分类的信息。 |
|
CateId | Long | 100 |
视频分类ID。 |
CateName | String | 电影 |
分类名称。
|
Level | Long | 0 |
分类层级。一级分类层级为0。 |
ParentId | Long | -1 |
父分类ID。一级分类父ID为-1。 |
Type | String | default |
分类类型。取值:
|
SubCategories | Array of Category |
子分类列表。 |
|
Category | |||
CateId | Long | 100 |
视频分类ID。 |
CateName | String | 电影 |
分类名称。
|
Level | Long | 0 |
分类层级。一级分类层级为0。 |
ParentId | Long | -1 |
父分类ID。一级分类父ID为-1。 |
SubTotal | Long | 1 |
子分类总数。 |
Type | String | default |
分类类型。取值:
|
示例
请求示例
https://vod.aliyuncs.com/?Action=GetCategories
&<公共请求参数>
正常返回示例
XML
格式
<GetCategoriesResponse>
<Category>
<ParentId>-1</ParentId>
<Type>default</Type>
<Level>0</Level>
<CateName>电影</CateName>
<CateId>100</CateId>
</Category>
<RequestId>25818875-5F78-4A*****F6-D7393642CA58</RequestId>
<SubTotal>1</SubTotal>
<SubCategories>
<Category>
<ParentId>-1</ParentId>
<Type>default</Type>
<Level>0</Level>
<CateName>电影</CateName>
<CateId>100</CateId>
<SubTotal>1</SubTotal>
</Category>
</SubCategories>
</GetCategoriesResponse>
JSON
格式
{
"Category": {
"ParentId": "-1",
"Type": "default",
"Level": "0",
"CateName": "电影",
"CateId": "100"
},
"RequestId": "25818875-5F78-4A*****F6-D7393642CA58",
"SubTotal": "1",
"SubCategories": {
"Category": [{
"ParentId": "-1",
"Type": "default",
"Level": "0",
"CateName": "电影",
"CateId": "100",
"SubTotal": "1"
}]
}
}
错误码
访问错误中心查看更多错误码。
接口错误码
下表列举了本接口特有的错误码。
错误代码 |
错误信息 |
HTTP 状态码 |
说明 |
---|---|---|---|
InvalidCateId.NotFound |
The CateId not exist. |
404 |
分类ID不存在。 |
SDK示例
建议使用服务端SDK来调用API,此API各语言调用的示例代码,请参见:
在文档使用中是否遇到以下问题
更多建议
匿名提交