查询指定分类信息 - ListCategoryInfo
功能介绍
查询指定分类信息,及其子分类(即下一级分类)的列表。
调试
您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限,具体权限要求请参见权限和授权项。
URI
GET /v2/{project_id}/asset/categories
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
项目ID,获取方法请参考获取项目ID |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
id |
是 |
Array of integers |
视频分类ID,最多支持10个,传0表示查询所有一级分类 |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
X-Auth-Token |
否 |
String |
用户Token,使用Token鉴权方式时必选。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 |
|
Authorization |
否 |
String |
使用AK/SK方式认证时必选,携带的鉴权信息。 |
|
X-Sdk-Date |
否 |
String |
使用AK/SK方式认证时必选,请求的发生时间。 |
响应参数
状态码:200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
[数组元素] |
Array of QueryCategoryInfoRsp objects |
分类返回值 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
id |
Integer |
查询的分类ID,-1表示默认的其他分类 |
|
name |
String |
查询的分类名称 |
|
sub_categories |
Array of CategoryInfo objects |
子层分类信息 |
状态码:400
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
错误码。 |
|
error_msg |
String |
错误描述。 |
请求示例
查询指定分类信息
GET https://{endpoint}/v2/{project_id}/asset/categories
响应示例
状态码:200
处理成功返回
[ {
"id" : 0,
"name" : "",
"sub_categories" : [ {
"id" : 123,
"name" : ""
}, {
"id" : 124,
"name" : ""
} ]
}, {
"id" : 1,
"name" : "",
"sub_categories" : [ {
"id" : 234,
"name" : ""
}, {
"id" : 235,
"name" : ""
} ]
} ]
状态码:400
处理失败返回。
{
"error_code" : "VOD.10053",
"error_msg" : "The request parameter is illegal, illegal field: {xx}."
}
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
处理成功返回 |
|
400 |
处理失败返回。 |
错误码
请参见错误码。