接口功能介绍
用户可在点播模式下通过本接口查询媒体库的视频条目。
接口约束
本接口的单用户QPS限制为20次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。
URI
POST /video/search
请求体body参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| name | 否 | String | 视频的名称，模糊匹配。 | "" | |
| regionCode | 否 | Array of Strings | 区域编码列表，需要查询的视频的区域，不传则为全部区域。 | ["xs-cn-shanghai-1"] | |
| categoryId | 否 | Integer | 视频所属分类ID | 1000000600035 | |
| pageSize | 否 | Integer | 每页的数量，当 pageSize 与 pageIndex 为空时，表示不分页。 | 10 | |
| pageIndex | 否 | Integer | 页码，由0开始，当 pageSize 与 pageIndex 为空时，表示不分页。 | 0 |
响应参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| code | 是 | Integer | 本次请求的结果码。 | 0 | |
| message | 是 | String | 错误文本信息，执行成功时，为空字符串。 | "" | |
| data | 是 | Array of Objects | 视频信息列表，即使返回的是一个视频，均会放入列表中。 | -- | data |
表data
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| videoId | 是 | String | 视频ID | 34c71dba-f280-4f5e-a05f-f4daed837fef | |
| name | 是 | String | 视频名称 | 平凡的世界 | |
| remark | 是 | String | 视频简介 | 讲述了在面对现实压力和人生抉择时，兄弟俩依旧坚守最初梦想和对爱情执着的追求的故事 | |
| tags | 是 | Array of Strings | 视频标签 | 励志片 | |
| category | 是 | Object | 视频分类信息。 | -- | category |
| region | 是 | Object | 区域信息 | -- | region |
| videoUrl | 是 | String | 源视频url | https://example.gdoss.xstore.ctyun.cn/xxx/xxx.mp4 | |
| status | 是 | String | 视频审核结果：UNAUDITED(未审核)/PASSED(审核通过)/NOT_PASSED(审核不通过)。 | UNAUDITED | |
| uploadStatus | 是 | String | 视频上传状态：UPLOAD_SUCCESS(上传成功)/UPLOADING(上传中)/UPLOAD_FAILED(上传失败)。 | UPLOAD_SUCCESS | |
| coverUrl | 是 | String | 封面地址，可能为空。 | https://example.gdoss.xstore.ctyun.cn/xxx/xxx.jpg | |
| metaData | 是 | 视频的元数据信息 | -- | metaData | |
| createTime | 是 | String | 视频创建时间 | 2019-06-10 14:30:50 |
表 category
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| id | 是 | Integer | 分类ID。 | 1000600001 | |
| name | 是 | String | 分类名称。 | 国产电影 | |
| parentId | 是 | Integer | 关联的parentId，如为0代表未分类，如为非0则代表本条目为parentId管理视频条目的子条目。 | 1000600001 | |
| child | 否 | Object | 下级视频分类条目，支持嵌套。目前同一视频条目仅支持最多三级分类，即父-子-子。 | -- | child |
表 child
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| id | 是 | Integer | 分类ID。 | 1000600001 | |
| name | 是 | String | 分类名称。 | 国产电影 | |
| parentId | 是 | Integer | 关联的parentId，如为0代表未分类，如为非0则代表本条目为parentId管理视频条目的子条目。 | 1000600001 | |
| child | 否 | Object | 下级视频分类条目，支持嵌套。目前同一视频条目仅支持最多三级分类，即父-子-子。 | -- | child |
表 region
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| name | 是 | String | 资源池名称 | 上海资源池1区 | |
| code | 是 | String | 资源池编码 | xs-cn-shanghai-1 |
表metaData
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| 略 | 否 | String | 视频具体的metadata信息 | 以实际输出为准，因数据较长，此处略。 |
请求示例
{
"name": "",
"regionCode": ["xs-cn-guangzhou-1", "xs-cn-shanghai-1"],
"categoryId"：10000612,
"pageSize": 10,
"pageIndex": 0
}
响应示例
{
"code": 0,
"message": "",
"data": [
{
"videoId": "34c71dba-f280-4f5e-a05f-f4daed837fef",
"name": "我的电影",
"remark": "",
"tags": ["爱情片", "动作片"],
"category":{
"id":1000600045,
"name":"电影",
"parentId":0,
"child":{
"id":1000676,
"name":"武侠",
"parentId":1000600045
"child":{
"id":100060091,
"name":"成龙",
"parentId":1000676
}
}
},
"region": {
"name": "华南1",
"code": "xs-cn-guangzhou-1"
},
"videoUrl": "",
"status": "UNAUDITED",
"uploadStatus": "UPLOAD_SUCCESS",
"coverUrl": "",
"metaData": {
"(此处略)"
},
"createTime": "2019-06-10 14:30:50"
},
]
}
状态码
| Http 状态码 | 状态码信息 | 状态码描述 |
|---|---|---|
| 0 | 表示业务成功 | 表示业务成功 |
| 400 | 请求参数有误 | 请求参数有误 |
| 403 | 用户鉴权失败，用户无操作权限 | 用户鉴权失败，用户无操作权限 |
| 404 | 请求的资源不存在，输入错误的URL | 请求的资源不存在，输入错误的URL |
| 500 | 业务执行异常 | 业务执行异常 |
错误码
OpenAPI错误码请参考 错误码说明。
