本接口用于搜索视频点播生产的视频、音频和图片等媒资信息,调用本接口配合媒资搜索协议可实现在视频点播中进行指定返回字段、精确匹配、模糊匹配、多值查询、范围查询、排序字段等多方式多维度的搜索查询。
接口说明
对于支持精确匹配和模糊查询的字段,采用其他查询手段时,其返回的结果都将遵循该字段所支持的查询方式,例如,如果一个字段仅支持模糊查询,则通过多值查询方法获取的结果也是基于模糊匹配返回的。
获取命中数据条数限制说明如下:
-
方法一:分页遍历
对于命中的搜索结果,您可以通过设置分页参数“PageNo”(页码)和“PageSize”(每页显示的记录数)来逐步遍历最多 5000 条数据。如果搜索结果超出了 5000 条,为了保证有效地遍历数据,请调整搜索条件以缩小结果范围。需要注意的是,此方法无法遍历完整数据集。若要遍历更多数据,请参考方法二。
-
方法二:全量遍历(限音视频搜索)
此方法适用于视频和音频内容的搜索,支持遍历最多 200 万条的全部搜索结果。如果搜索结果数量超过 200 万条,您应该通过增加更多筛选条件来减少结果数量。使用此方法时,除了“PageNo”和“PageSize”,您还需使用“ScrollToken”参数实现分页。请注意,每次仅支持向后遍历最多 100 条记录。 使用“PageSize”为 20 为例,以下是分页逻辑:
若“PageNo”为 1,您可以查询接下来的最多 5 页数据。
若“PageNo”为 2,您可以查询接下来的最多 6 页数据。
请确保在搜索时合理设置分页参数,并根据结果集大小选择适当的遍历方法。若您翻页的数据将大于 1000 条时,为了您的查询更方便快捷我们推荐您使用方法 2 来进行数据处理。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息
操作 |
访问级别 |
资源类型 |
条件关键字 |
关联操作 |
vod:SearchMedia |
list |
*全部资源
|
无 | 无 |
请求参数
名称 |
类型 |
必填 |
描述 |
示例值 |
SearchType |
string |
否 |
搜索媒资数据类型。取值范围:
说明
当本参数取值为 video 或 audio,且需要遍历搜索条件命中的所有数据时,必须设置 ScrollToken 参数。 |
video |
Fields |
string |
否 |
搜索结果中返回的媒资字段。 默认只返回基本媒资字段,可指定返回更多媒资字段,请参见使用示例。 |
Title,CoverURL |
Match |
string |
否 |
过滤条件。语法规则,请参见搜索协议语法。 |
field = value |
SortBy |
string |
否 |
排序字段和排序顺序。多个使用半角逗号(,)分隔。取值:
说明
|
CreationTime:Desc |
PageNo |
integer |
否 |
当前页码。默认值为 1。 说明
当本参数取值超过 200 时,建议同时设置 ScrollToken 参数。 |
1 |
PageSize |
integer |
否 |
每页返回的数据条数。默认值为 10,最大值为 100。 |
10 |
ScrollToken |
string |
否 |
翻页标识。长度为 32 个字符。 第一次执行搜索请求时不用设置本参数。搜索请求命中数据时,服务端会返回该参数值,用于记录当前搜索数据的位置地址。请记录返回的参数值,下一次搜索时按下述要求或建议设置本参数:
|
24e0fba7188fae707e146esa54**** |
返回参数
名称 |
类型 |
描述 |
示例值 |
object |
返回结果。 |
||
RequestId |
string |
请求 ID。 |
3E0CEF83-FB09-4E34-BA1451814B03**** |
Total |
integer |
满足搜索条件的媒资信息总条数。 |
10 |
ScrollToken |
string |
翻页标识。 |
24e0fba7188fae707e146esa54**** |
MediaList |
array<object> |
媒资信息列表。 |
|
object |
媒资信息详情。 |
||
CreationTime |
string |
媒体创建时间。格式为:yyyy-MM-ddTHH:mm:ssZ(UTC 时间)。 |
2018-07-19T03:45:25Z |
MediaType |
string |
媒体类型。取值范围:
|
video |
MediaId |
string |
媒体 ID。 |
a82a2cd7d4e147bbed6c1ee372**** |
Video |
object |
视频信息。 |
|
Status |
string |
状态。取值:
|
UploadSucc |
CreationTime |
string |
视频信息创建时间。格式为:yyyy-MM-ddTHH:mm:ssZ(UTC 时间)。 |
2018-07-19T03:45:25Z |
StorageLocation |
string |
存储区域。 |
outin-bfefbb90a47c******163e1c7426.oss-cn-shanghai.aliyuncs.com |
CateId |
integer |
分类 ID。 |
10000123 |
Tags |
string |
视频标签。 |
tag1 |
ModificationTime |
string |
视频信息更新时间。格式为:yyyy-MM-ddTHH:mm:ssZ(UTC 时间)。 |
2018-07-19T03:48:25Z |
MediaSource |
string |
来源。取值:
|
general |
Description |
string |
视频描述。 |
视频测试 |
AppId |
string |
应用 ID。 |
app-**** |
CoverURL |
string |
封面图片。 |
https://example.aliyundoc.com/image01.png |
VideoId |
string |
视频 ID。 |
a82a2asdasqadaf3faa0ed6c1ee372**** |
DownloadSwitch |
string |
下载开关。只有状态开启时才允许离线下载。取值范围:
|
on |
CateName |
string |
分类名称。 |
video1 |
TranscodeMode |
string |
转码模式。取值:
|
FastTranscode |
PreprocessStatus |
string |
预处理状态 。取值:
|
Preprocessing |
RestoreExpiration |
string |
媒资解冻有效期。 |
2023-03-30T10:14:14Z |
RestoreStatus |
string |
媒资解冻状态。取值:
|
Success |
StorageClass |
string |
媒资存储类型。取值:
|
Standard |
Size |
integer |
视频大小。 |
123 |
Duration |
number |
视频时长。单位:秒。 |
123 |
Title |
string |
视频标题。 |
ceshi |
SpriteSnapshots |
array |
雪碧图列表。 |
|
string |
雪碧图列表。 |
{“http://example.aliyundoc.com/image02.jpg”} |
|
Snapshots |
array |
自动截图列表。 |
|
string |
自动截图列表。 |
{“http://example.aliyundoc.com/image03.jpg”} |
|
Audio |
object |
音频信息。 |
|
Status |
string |
状态。取值:
|
Normal |
CreationTime |
string |
创建时间。格式为:yyyy-MM-ddTHH:mm:ssZ(UTC 时间)。 |
2018-07-19T03:45:25Z |
StorageLocation |
string |
存储区域。 |
outin-aaa*****aa.oss-cn-shanghai.aliyuncs.com |
CateId |
integer |
分类 ID。 |
10000123 |
Tags |
string |
标签。 |
tag1,tag2 |
ModificationTime |
string |
更新时间。格式为:yyyy-MM-ddTHH:mm:ssZ(UTC 时间)。 |
2018-07-19T03:48:25Z |
MediaSource |
string |
来源。取值: |
general |
Description |
string |
描述。 |
音频描述 |
AppId |
string |
应用 ID。 |
app-**** |
CoverURL |
string |
封面图片。 |
http://example.com/image04.jpg |
AudioId |
string |
音频 ID。 |
a82a2cd7d4e147bbed6c1ee372**** |
DownloadSwitch |
string |
下载开关。只有状态开启时才允许离线下载。取值:
|
on |
CateName |
string |
分类名称。 |
ceshi |
TranscodeMode |
string |
转码模式。取值范围:
|
FastTranscode |
PreprocessStatus |
string |
预处理状态,预处理完成后的视频才可用于直播导播。取值:
|
UnPreprocess |
RestoreExpiration |
string |
媒资解冻有效期。 |
2023-03-30T10:14:14Z |
RestoreStatus |
string |
媒资解冻状态。取值:
|
Success |
StorageClass |
string |
媒资存储类型。取值:
|
Standard |
Size |
integer |
大小。 |
123 |
Duration |
number |
时长。 |
123 |
Title |
string |
标题。 |
音频 |
SpriteSnapshots |
array |
雪碧图列表。 |
|
string |
雪碧图列表。 |
{“http://example.aliyundoc.com/image02.jpg”} |
|
Snapshots |
array |
自动截图列表。 |
|
string |
自动截图列表。 |
{“http://example.aliyundoc.com/image03.jpg”} |
|
Image |
object |
图片信息。 |
|
StorageLocation |
string |
存储地域。 |
outin-bfefbb90a47c******163e1c7426.oss-cn-shanghai.aliyuncs.com |
CreationTime |
string |
创建时间。格式为:yyyy-MM-ddTHH:mm:ssZ(UTC 时间)。 |
2018-07-19T03:45:25Z |
Status |
string |
图片状态。
|
Uploading |
CateId |
integer |
分类 ID。 |
1000123 |
Tags |
string |
标签。 |
tag1 |
ModificationTime |
string |
更新时间。格式为:yyyy-MM-ddTHH:mm:ssZ(UTC 时间)。 |
2018-07-19T03:48:25Z |
CateName |
string |
分类名称。 |
美图1 |
Description |
string |
描述。 |
图片测试 |
AppId |
string |
应用 ID。 |
app-**** |
URL |
string |
图片 URL。 |
https://example.com/****.png |
Title |
string |
标题。 |
image1 |
ImageId |
string |
图片 ID。 |
11130843741se99wqmoes**** |
AttachedMedia |
object |
|
|
CreationTime |
string |
创建时间。格式为:yyyy-MM-ddTHH:mm:ssZ(UTC 时间)。 |
2018-07-19T03:45:25Z |
Status |
string |
状态。取值:
|
Normal |
StorageLocation |
string |
存储区域。 |
outin-bfefbb90a47c11*****7426.oss-cn-shanghai.aliyuncs.com |
Tags |
string |
标签。 |
测试 |
ModificationTime |
string |
更新时间。格式为:yyyy-MM-ddTHH:mm:ssZ(UTC 时间)。 |
2018-07-19T03:48:25Z |
MediaId |
string |
辅助媒资 ID。 |
a82a2cd7d4e147ba0ed6c1ee372**** |
BusinessType |
string |
业务类型。取值:
|
watermark |
Description |
string |
描述。 |
测试 |
AppId |
string |
应用 ID。 |
app-**** |
URL |
string |
辅助媒资 URL。 |
https://example.com/****.png |
Title |
string |
标题。 |
测试 |
Categories |
array<object> |
分类 ID 列表。 |
|
object |
分类详情。 |
||
ParentId |
integer |
父节点 ID。 |
-1 |
CateName |
string |
分类名称。 |
测试 |
CateId |
integer |
分类 ID。 |
10027394 |
Level |
integer |
分类层级。 |
1 |
AiData |
object |
AI 详细信息。 |
|
AiLabelInfo |
array<object> |
AI 标签信息列表。 |
|
object |
AI 标签信息。 |
||
Category |
string |
分类。 |
交通工具 |
LabelName |
string |
实体名称。 |
车 |
LabelId |
string |
实体 ID。 |
10310250338 |
Occurrences |
array<object> |
片段列表。 |
|
object |
片段。 |
||
Score |
number |
打分。 |
0.75287705 |
From |
number |
片段起始时间。 |
1.4 |
To |
number |
片段结束时间。 |
2.5 |
OcrInfo |
array<object> |
字幕信息列表。 |
|
object |
字幕信息。 |
||
From |
number |
片段起始时间。 |
1.4 |
To |
number |
片段结束时间。 |
2.5 |
Content |
string |
文本内容。 |
我是皮皮 |
AiRoughData |
object |
AI 简介数据。 |
|
SaveType |
string |
保存类型。 |
TEXT |
Status |
string |
数据状态。 |
SaveSuccess |
AiJobId |
string |
AI 任务 ID。 |
cd35b0b0025f71edbfcb472190a9xxxx |
AiCategory |
string |
视频 AI 分类。 |
电视剧 |
示例
正常返回示例
JSON
格式
{
"RequestId": "3E0CEF83-FB09-4E34-BA1451814B03****",
"Total": 10,
"ScrollToken": "24e0fba7188fae707e146esa54****",
"MediaList": [
{
"CreationTime": "2018-07-19T03:45:25Z",
"MediaType": "video",
"MediaId": "a82a2cd7d4e147bbed6c1ee372****",
"Video": {
"Status": "UploadSucc",
"CreationTime": "2018-07-19T03:45:25Z",
"StorageLocation": "outin-bfefbb90a47c******163e1c7426.oss-cn-shanghai.aliyuncs.com",
"CateId": 10000123,
"Tags": "tag1",
"ModificationTime": "2018-07-19T03:48:25Z",
"MediaSource": "general",
"Description": "视频测试",
"AppId": "app-****",
"CoverURL": "https://example.aliyundoc.com/image01.png",
"VideoId": "a82a2asdasqadaf3faa0ed6c1ee372****",
"DownloadSwitch": "on",
"CateName": "video1",
"TranscodeMode": "FastTranscode",
"PreprocessStatus": "Preprocessing",
"RestoreExpiration": "2023-03-30T10:14:14Z",
"RestoreStatus": "Success",
"StorageClass": "Standard",
"Size": 123,
"Duration": 123,
"Title": "ceshi",
"SpriteSnapshots": [
"{“http://example.aliyundoc.com/image02.jpg”}"
],
"Snapshots": [
"{“http://example.aliyundoc.com/image03.jpg”}"
]
},
"Audio": {
"Status": "Normal",
"CreationTime": "2018-07-19T03:45:25Z",
"StorageLocation": "outin-aaa*****aa.oss-cn-shanghai.aliyuncs.com",
"CateId": 10000123,
"Tags": "tag1,tag2",
"ModificationTime": "2018-07-19T03:48:25Z",
"MediaSource": "general",
"Description": "音频描述",
"AppId": "app-****",
"CoverURL": "http://example.com/image04.jpg",
"AudioId": "a82a2cd7d4e147bbed6c1ee372****",
"DownloadSwitch": "on",
"CateName": "ceshi",
"TranscodeMode": "FastTranscode",
"PreprocessStatus": "UnPreprocess",
"RestoreExpiration": "2023-03-30T10:14:14Z",
"RestoreStatus": "Success",
"StorageClass": "Standard",
"Size": 123,
"Duration": 123,
"Title": "音频",
"SpriteSnapshots": [
"{“http://example.aliyundoc.com/image02.jpg”}"
],
"Snapshots": [
"{“http://example.aliyundoc.com/image03.jpg”}"
]
},
"Image": {
"StorageLocation": "outin-bfefbb90a47c******163e1c7426.oss-cn-shanghai.aliyuncs.com",
"CreationTime": "2018-07-19T03:45:25Z",
"Status": "Uploading",
"CateId": 1000123,
"Tags": "tag1",
"ModificationTime": "2018-07-19T03:48:25Z",
"CateName": "美图1",
"Description": "图片测试",
"AppId": "app-****",
"URL": "https://example.com/****.png",
"Title": "image1",
"ImageId": "11130843741se99wqmoes****"
},
"AttachedMedia": {
"CreationTime": "2018-07-19T03:45:25Z",
"Status": "Normal",
"StorageLocation": "outin-bfefbb90a47c11*****7426.oss-cn-shanghai.aliyuncs.com",
"Tags": "测试",
"ModificationTime": "2018-07-19T03:48:25Z",
"MediaId": "a82a2cd7d4e147ba0ed6c1ee372****",
"BusinessType": "watermark",
"Description": "测试",
"AppId": "app-****",
"URL": "https://example.com/****.png",
"Title": "测试",
"Categories": [
{
"ParentId": -1,
"CateName": "测试",
"CateId": 10027394,
"Level": 1
}
]
},
"AiData": {
"AiLabelInfo": [
{
"Category": "交通工具",
"LabelName": "车",
"LabelId": "10310250338",
"Occurrences": [
{
"Score": 0.75287705,
"From": 1.4,
"To": 2.5
}
]
}
],
"OcrInfo": [
{
"From": 1.4,
"To": 2.5,
"Content": "我是皮皮\n"
}
]
},
"AiRoughData": {
"SaveType": "TEXT\n",
"Status": "SaveSuccess",
"AiJobId": "cd35b0b0025f71edbfcb472190a9xxxx",
"AiCategory": "电视剧\n"
}
}
]
}
错误码
访问错误中心查看更多错误码。
变更历史
更多信息,参考变更详情。