接口功能介绍
通过本接口可在点播模式下查询全部分类。请注意,每个视频条目仅允许创建一组不超过三级的视频分类。未创建视频分类的视频会自动归属于【未分类】的分类条目。创建、修改、删除分类仅影响视频分类的归属,不会影响视频条目的主体数据(封面、截图、视频等)。
接口约束
本接口的单用户QPS限制为20次/秒。超过限制,API调用会被限流,这可能会影响您的业务,请合理调用。
URI
GET /video/category
响应参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
code | 是 | Integer | 接口业务响应码:0-查询成功;非0-查询失败。 | 0 | -- |
message | 是 | String | 查询失败时为具体失败信息;成功时为""。 | "" | -- |
data | 是 | Object | 返回数据集,当数据集为空时直接显示 “未分类”。 | -- | data |
表data
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
id | 是 | Integer | 分类ID。 | 1000600001 | -- |
name | 是 | String | 分类名称。 | 国产电影 | -- |
parentId | 是 | Integer | 关联的parentId,如为0代表未分类,如为非0则代表本条目为parentId管理视频条目的子条目。 | 1000600001 | -- |
children | 否 | Object | 下级视频分类条目,支持嵌套。目前同一视频条目仅支持最多三级分类,即父-子-子。 | -- | children |
表children
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
id | 是 | Integer | 分类ID。 | 1000600001 | -- |
name | 是 | String | 分类名称。 | 2022年 | -- |
parentId | 是 | Integer | 关联的parentId,如为0代表未分类,如为非0则代表本条目为parentId管理视频条目的子条目。 | 1000600001 | -- |
children | 否 | Object | 下级视频分类条目,支持嵌套。目前同一视频条目仅支持最多三级分类,即父-子-子。 | -- | children |
请求示例
无
响应示例
{
"code":"0",
"message":"",
"data":[{
"id":1000600001,
"name":"电影",
"parentId":0,
"children":[{
"id":1000600013,
"name":"动作片",
"parentId":1000600001,
"children":[{
"id":100060020,
"name":"拳击",
"parentId":1000600013
}]
}]
}]
}
状态码
Http 状态码 | 状态码信息 | 状态码描述 |
---|---|---|
0 | 表示业务成功 | 表示业务成功 |
400 | 请求参数有误 | 请求参数有误 |
403 | 用户鉴权失败,用户无操作权限 | 用户鉴权失败,用户无操作权限 |
404 | 请求的资源不存在,输入错误的URL | 请求的资源不存在,输入错误的URL |
500 | 业务执行异常 | 业务执行异常 |
错误码
OpenAPI错误码请参考 错误码说明。