全部产品
云市场

搜索媒资信息

更新时间:2019-08-06 17:32:16

描述

搜索媒资信息(视频、音频、图片、辅助媒资等),同时配合 媒资搜索协议 使用,使用示例请参考 使用示例

获取命中数据条数限制说明

  • 方式一:遍历搜索条件命中的前5000条数据,需要使用PageNo和PageSize参数翻页遍历。当搜索条件命中的数据条数超过5000条时,使用该方式无法遍历所有数据,需使用方式二。
  • 方式二:仅视频、音频搜索支持,遍历搜索条件命中的所有数据,需要使用PageNo、PageSize和ScrollToken参数翻页遍历,且目标翻页位置与当前翻页位置之间不能超过1200条数据。以PageSize=20为例:
    • 当前翻页位置PageNo=1,目标翻页位置向后最多可查询PageNo=60。
    • 当前翻页位置PageNo=2,目标翻页位置向后最多可查询PageNo=61。
    • 当前翻页位置PageNo=61,目标翻页位置向前最多可查询PageNo=2,目标翻页位置向后最多可查询PageNo=120。

请求参数

名称 类型是否必需描述
ActionString系统规定参数。取值:SearchMedia
SearchType String搜索媒资数据类型。取值范围:
  • video(视频,默认值)
  • audio(音频)
  • image(图片)
  • attached(辅助媒资)
FieldsString搜索结果中返回的媒资字段。
默认只返回基本媒资字段,可指定返回更多媒资字段。使用示例
Match String过滤条件。语法规则参考 搜索协议语法
ScrollToken String翻页标识。仅视频、音频搜索下发该字段,为32位字符,遍历所有数据时必须指定。第一次搜索请求时没有该参数,每次搜索请求命中数据时会返回该参数值,用于记录当前搜索数据的位置。
SortBy String排序字段和排序顺序,多个用逗号分隔。按创建时间排序。
取值范围:
  • CreationTime:Desc
  • CreationTime:Asc
排序字段示例 排序字段
  • 获取搜索条件命中的前5000条数据时,最多支持三个排序字段。
  • 获取搜索条件命中的所有数据时,仅支持一个排序字段。
PageNo Long页号。
默认值:1
PageSize Long每页返回的数据条数。
默认值:10。最大值:100

返回参数

名称类型描述
RequestIdString 请求ID
ScrollTokenString 翻页标识
MediaListMedia[] 媒资信息列表
TotalLong 搜索条件命中的媒资信息总条数

API示例

请求示例

  1. http://vod.cn-shanghai.aliyuncs.com/?Action=SearchMedia&SearchType=video&Fields=VideoId,Title,Status,CoverURL,CreationTime,ModificationTime&Match=Title='测试' and Status in ('Normal')&PageNo=1&PageSize=10&ScrollToken=3de9654f6169e31d7aa2987244d0d6c7&SortBy=CreationTime:Desc&Version=2017-03-21&Format=JSON&<公共参数>

注意:示例中的“公共参数”参见 公共参数说明文档

返回示例

JSON格式

  1. {
  2. MediaList: [{
  3. CreationTime: "2018-07-20T04:29:04Z",
  4. MediaType: "video",
  5. MediaId: "afab53f582cf422f87689e1cf0425815",
  6. Video: {
  7. CoverURL: "http://sample.aliyun.com/cover01.jpg",
  8. CreationTime: "2018-07-20T04:29:04Z",
  9. Status: "Normal",
  10. ModificationTime: "2018-07-20T06:14:29Z",
  11. VideoId: "afab53f582cf422f87689e1cf0425815",
  12. Title: "测试标题01"
  13. }
  14. },
  15. {
  16. CreationTime: "2018-07-19T03:45:25Z",
  17. MediaType: "video",
  18. MediaId: "a82a2cd7d4e147bb96faa0ed6c1ee372",
  19. Video:{
  20. CoverURL: "http://sample.aliyun.com/cover02.jpg",
  21. CreationTime: "2018-07-19T03:45:25Z",
  22. Status: "Normal",
  23. ModificationTime: "2018-07-20T06:45:53Z",
  24. VideoId: "a82a2cd7d4e147bb96faa0ed6c1ee372",
  25. Title: "测试标题02"
  26. }
  27. },
  28. {
  29. CreationTime: "2018-07-05T02:43:55Z",
  30. MediaType: "video",
  31. MediaId: "62da1c9832e440b79fdc4dce0eac3d2a",
  32. Video: {
  33. CoverURL: "http://sample.aliyun.com/cover03.jpg",
  34. CreationTime: "2018-07-05T02:43:55Z",
  35. Status: "Normal",
  36. ModificationTime: "2018-07-05T05:41:29Z",
  37. VideoId: "62da1c9832e440b79fdc4dce0eac3d2a",
  38. Title: "测试标题03"
  39. }
  40. }...],
  41. RequestId: "3E0CEF83-FB09-4E47-8134-BA1451814B03",
  42. ScrollToken: "24e0fba7188fa01e880e707e146esa54",
  43. Total: 10
  44. }

错误码

下表列举了本接口特有的错误码。视频点播通用的错误码信息,参见 错误码列表

错误代码错误信息HTTP 状态码说明
SortByExceededMaxThe SortBy parameter only supports one sort field when traversing all data.400遍历所有数据时,仅支持一个排序字段。
ErrorMatchSyntaxThe parameter Match.%s has an error syntax, please check it.400Match参数语法错误,请检查后重试。
InvalidScrollToken.ExpiredThe ScrollToken is expired,please refresh it.400翻页标识过期,请从第一页重新获取数据。

SDK示例

建议使用 服务端SDK 来调用API,此API各语言调用的示例代码,请参考如下: