搜索视频
更新时间 2026-04-10 10:43:27
最近更新时间: 2026-04-10 10:43:27
通过本接口查询媒体库的视频条目。
接口功能介绍
用户可通过本接口查询媒体库的视频条目。
接口约束
本接口的单用户QPS限制为20次/秒。超过限制,API调用会被限流,这可能会影响您的业务,请合理调用。
URI
POST /video/search
请求体body参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| name | 否 | String | 视频的名称,模糊匹配。 | "" | |
| regionCode | 否 | Array of Strings | 区域编码列表,需要查询的视频的区域,不传则为全部区域。该字段仅适用于2026年3月13日前开通的存量客户。在此之后开通的新客户,请勿使用此参数。 | ["xs-cn-shanghai-1"] | |
| instanceId | 否 | Integer | 视频存储的实例ID。对于主账号,当不填写时在全部实例内检索,当填写正确的实例ID时,在指定实例内检索。对于子账号,该入参无需使用,云点播后台会根据子账号分配的实例范围检索。 | 4546077670 | |
| categoryId | 否 | Integer | 视频所属分类ID。 | 1000000600035 | |
| pageSize | 否 | Integer | 每页的数量,当 pageSize 与 pageIndex 为空时,表示不分页。 | 10 | |
| pageIndex | 否 | Integer | 页码,由0开始,当 pageSize 与 pageIndex 为空时,表示不分页。 | 0 |
响应参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| code | 是 | String | 本次请求的结果码。 | "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 |
| instance | 是 | Object | 点播实例信息 | -- | instance |
| 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 |
表instance
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| id | 是 | String | 点播实例ID | 306456816628 | |
| name | 是 | String | 点播实例名称 | 主实例 |
表metaData
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| 略 | 否 | String | 视频具体的metadata信息 | 以实际输出为准,此处略。 |
请求示例
{
"name": "",
"instanceId": 4546077670,
"categoryId":10000612,
"pageSize": 10,
"pageIndex": 0
}
响应示例
{
"code": "0",
"data": [
{
"category": {
"child": {
"child": {
"id": 100000077934,
"name": "故事片",
"parentId": 100000077933
},
"id": 100000077933,
"name": "2024",
"parentId": 100000077932
},
"id": 100000077932,
"name": "国产",
"parentId": 0
},
"coverUrl": "https://default-data.oss.xstore.ctyun.cn/default-cover.png",
"createTime": "2026-04-09 14:45:19",
"instance": {
"id": "306456816628",
"name": "主实例"
},
"metaData": {
"format": {
"bit_rate": "1279457",
"duration": "5.000000",
"format_long_name": "QuickTime / MOV",
"format_name": "mov,mp4,m4a,3gp,3g2,mj2",
"nb_programs": 0,
"nb_stream_groups": 0,
"nb_streams": 2,
"probe_score": 100,
"size": "799661",
"start_time": "0.000000",
"tags": {
"compatible_brands": "isomiso2avc1mp41",
"encoder": "Lavf58.20.100",
"major_brand": "isom",
"minor_version": "512"
}
},
"streams": [
{
"avg_frame_rate": "25/1",
"bit_rate": "1140995",
"bits_per_raw_sample": "8",
"chroma_location": "left",
"closed_captions": 0,
"codec_long_name": "H.264 / AVC / MPEG-4 AVC / MPEG-4 part 10",
"codec_name": "h264",
"codec_tag": "0x31637661",
"codec_tag_string": "avc1",
"codec_type": "video",
"coded_height": 720,
"coded_width": 1280,
"display_aspect_ratio": "16:9",
"disposition": {
"attached_pic": 0,
"captions": 0,
"clean_effects": 0,
"comment": 0,
"default": 1,
"dependent": 0,
"descriptions": 0,
"dub": 0,
"forced": 0,
"hearing_impaired": 0,
"karaoke": 0,
"lyrics": 0,
"metadata": 0,
"multilayer": 0,
"non_diegetic": 0,
"original": 0,
"still_image": 0,
"timed_thumbnails": 0,
"visual_impaired": 0
},
"duration": "5.000000",
"duration_ts": 64000,
"extradata_size": 43,
"field_order": "progressive",
"film_grain": 0,
"has_b_frames": 2,
"height": 720,
"id": "0x1",
"index": 0,
"is_avc": "true",
"level": 31,
"nal_length_size": "4",
"nb_frames": "125",
"pix_fmt": "yuv420p",
"profile": "High",
"r_frame_rate": "25/1",
"refs": 1,
"sample_aspect_ratio": "1:1",
"start_pts": 0,
"start_time": "0.000000",
"tags": {
"handler_name": "VideoHandler",
"language": "eng",
"vendor_id": "[0][0][0][0]"
},
"time_base": "1/12800",
"width": 1280
},
{
"avg_frame_rate": "0/0",
"bit_rate": "129188",
"bits_per_sample": 0,
"channel_layout": "stereo",
"channels": 2,
"codec_long_name": "AAC (Advanced Audio Coding)",
"codec_name": "aac",
"codec_tag": "0x6134706d",
"codec_tag_string": "mp4a",
"codec_type": "audio",
"disposition": {
"attached_pic": 0,
"captions": 0,
"clean_effects": 0,
"comment": 0,
"default": 1,
"dependent": 0,
"descriptions": 0,
"dub": 0,
"forced": 0,
"hearing_impaired": 0,
"karaoke": 0,
"lyrics": 0,
"metadata": 0,
"multilayer": 0,
"non_diegetic": 0,
"original": 0,
"still_image": 0,
"timed_thumbnails": 0,
"visual_impaired": 0
},
"duration": "5.000000",
"duration_ts": 220500,
"extradata_size": 5,
"id": "0x2",
"index": 1,
"initial_padding": 0,
"nb_frames": "217",
"profile": "LC",
"r_frame_rate": "0/0",
"sample_fmt": "fltp",
"sample_rate": "44100",
"start_pts": 0,
"start_time": "0.000000",
"tags": {
"handler_name": "SoundHandler",
"language": "und",
"vendor_id": "[0][0][0][0]"
},
"time_base": "1/44100"
}
]
},
"name": "720p_fast_start-1.mp4",
"remark": "",
"status": "UNAUDITED",
"tags": [""],
"uploadStatus": "UPLOAD_SUCCESS",
"videoId": "7708530b3fc547fa9cc2a9cfbeb159ee",
"videoUrl": "https://vod-origin-cy25.oss.ctyun.store:10003/7708530b3fc547fa9cc2a9cfbeb159ee.mp4"
}
],
"message": ""
}
状态码
| Http 状态码 | 状态码信息 | 状态码描述 |
|---|---|---|
| 0 | 表示业务成功 | 表示业务成功 |
| 400 | 请求参数有误 | 请求参数有误 |
| 403 | 用户鉴权失败,用户无操作权限 | 用户鉴权失败,用户无操作权限 |
| 404 | 请求的资源不存在,输入错误的URL | 请求的资源不存在,输入错误的URL |
| 500 | 业务执行异常 | 业务执行异常 |
错误码
OpenAPI错误码请参考 错误码说明。