调用SearchMedia搜索媒资信息,包括视频、音频、图片、辅助媒资等。

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

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

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

名称 类型 是否必选 示例值 描述
Action String SearchMedia

系统规定参数。取值:SearchMedia

SearchType String video

搜索媒资数据类型。取值:

  • video(默认值):视频。
  • audio:音频。
  • image:图片。
  • attached:辅助媒资。
Fields String Title,CoverURL

搜索结果中返回的媒资字段。

默认只返回基本媒资字段,可指定返回更多媒资字段,请参见使用示例

Match String field = value

过滤条件。语法规则,请参见搜索协议语法

SortBy String CreationTime:Desc

排序字段和排序顺序。多个使用英文逗号(,)分隔。取值:

  • CreationTime:Desc(默认值):按创建时间倒序。
  • CreationTime:Asc:按创建时间升序。
说明
  • 排序字段示例:排序字段
  • 获取搜索条件是前5000条的数据时,最多支持三个排序字段。
  • 获取搜索条件是所有数据时,仅支持一个排序字段。
PageNo Integer 1

当前页码。默认值为1

PageSize Integer 10

每页返回的数据条数。默认值为10,最大值为100

ScrollToken String vfdvbf454

翻页标识。

说明 仅视频、音频搜索下发该字段,为32位字符,遍历所有数据时必须指定。第一次搜索请求时没有该参数,每次搜索请求命中数据时会返回该参数值,用于记录当前搜索数据的位置。

返回数据

名称 类型 示例值 描述
MediaList Array of Media

媒资信息列表。

AttachedMedia Struct

辅助媒资信息

AppId String app-****

应用ID。

BusinessType String watermark

业务类型。取值:

  • watermark:水印。
  • subtitle:字幕。
  • material:素材。
Categories Array of Category

分类ID列表。

CateId Long 10027394

分类ID。

CateName String 测试

分类名称。

Level Long 1

分类层级。

ParentId Long -1

父节点ID。

CreationTime String 2018-07-19T03:45:25Z

创建时间。格式为:yyyy-MM-ddTHH:mm:ssZ(UTC时间)。

Description String 测试

描述。

MediaId String a82a2cd7d4e147b*****a0ed6c1ee372

辅助媒资ID。

ModificationTime String 2018-07-19T03:48:25Z

更新时间。格式为:yyyy-MM-ddTHH:mm:ssZ(UTC时间)。

Status String Normal

状态。取值:

  • Uploading(上传中): 初始状态,表示辅助媒资正在上传。
  • Normal(正常):辅助媒资上传成功。
  • UploadFail(失败):辅助媒资上传失败。
StorageLocation String outin-bfefbb90a47c11*****7426.oss-cn-shanghai.aliyuncs.com

存储区域。

Tags String 测试

标签。

Title String 测试

标题。

URL String https://examp.com/****.png

辅助媒资URL。

Audio Struct

音频信息

AppId String app-****

应用ID。

AudioId String a82a2cd7d4e147bb*****ed6c1ee372

音频ID。

CateId Long 10000123

分类ID。

CateName String ceshi

分类名称。

CoverURL String http://example.com/atest****.jpg

封面图片。

CreationTime String 2018-07-19T03:45:25Z

创建时间。格式为:yyyy-MM-ddTHH:mm:ssZ(UTC时间)。

Description String 音频描述

描述。

DownloadSwitch String on

下载开关。只有状态开启时才允许离线下载。取值:

  • on(开启):初始状态,允许离线下载。
  • off(禁用):禁用离线下载。
Duration Float 123

时长。

MediaSource String general

来源。取值:

  • general(点播上传):普通上传。
  • short_video(短视频SDK): 通过短视频SDK上传文件至点播,详见短视频SDK。
  • editing(剪辑合成):通过云剪辑合成上传文件至点播,详见视频合成
  • live(直播录制):通过直播录制上传文件至点播。
ModificationTime String 2018-07-19T03:48:25Z

更新时间。格式为:yyyy-MM-ddTHH:mm:ssZ(UTC时间)。

PreprocessStatus String UnPreprocess

预处理状态,预处理完成后的视频才可用于直播导播。取值:

  • UnPreprocess:未进行预处理。
  • Preprocessing:预处理中。
  • PreprocessSucceed:预处理完成。
  • PreprocessFailed:预处理失败。
Size Long 123

大小。

Snapshots List {“http://sample.aliyun.com/cover02.jpg”}

自动截图列表。

SpriteSnapshots List {“http://sample.aliyun.com/cover02.jpg”}

雪碧图列表。

Status String Normal

状态。取值:

  • Uploading:上传中。
  • Normal:正常。
  • UploadFail:失败。
  • Deleted:删除。
StorageLocation String outin-aaa*****aa.oss-cn-shanghai.aliyuncs.com

存储区域。

Tags String tag1,tag2

标签。

Title String 音频

标题。

TranscodeMode String FastTranscode

转码模式。取值:

  • FastTranscode(普通转码,默认值):上传完成即开始转码,且转码完成才能播放。
  • NoTranscode(不转码即分发):上传完成不转码,且立即能播放。
  • AsyncTranscode(上传即分发并转码):上传完成即能播放,同时异步进行转码。
CreationTime String 2018-07-19T03:45:25Z

媒体创建时间。格式为:yyyy-MM-ddTHH:mm:ssZ(UTC时间)。

Image Struct

图片信息

AppId String app-****

应用ID。

CateId Long 1000123

分类ID。

CateName String 美图1

分类名称。

CreationTime String 2018-07-19T03:45:25Z

创建时间。格式为:yyyy-MM-ddTHH:mm:ssZ(UTC时间)。

Description String 图片测试

描述。

ImageId String 11130843741*****se99wqmoes

图片ID。

ModificationTime String 2018-07-19T03:48:25Z

更新时间。格式为:yyyy-MM-ddTHH:mm:ssZ(UTC时间)。

Status String Uploading

图片状态。

  • Uploading(上传中):初始状态,表示图片正在上传。
  • Normal(正常):图片上传成功。
  • UploadFail(失败):图片上传失败。
StorageLocation String outin-bfefbb90a47c******163e1c7426.oss-cn-shanghai.aliyuncs.com

存储地域。

Tags String tag1

标签。

Title String image1

标题。

URL String https://examle.com/****.png

图片URL。

MediaId String a82a2cd7d4e147bb*****ed6c1ee372

媒体ID。

MediaType String video

媒体类型。取值:

  • video:视频。
  • audio:音频。
  • image:图片。
  • attached:辅助媒资。
Video Struct

视频信息

AppId String app-****

应用ID。

CateId Long 10000123

分类ID。

CateName String video1

分类名称。

CoverURL String aaa.com/a.png

封面图片。

CreationTime String 2018-07-19T03:45:25Z

视频信息创建时间。格式为:yyyy-MM-ddTHH:mm:ssZ(UTC时间)。

Description String 视频测试

视频描述。

DownloadSwitch String on

下载开关。只有状态开启时才允许离线下载。取值:

  • on(开启):初始状态,允许离线下载。
  • off(禁用):禁用离线下载。
Duration Float 123

视频时长。单位:秒。

MediaSource String general

来源。取值:

  • general:点播上传。
  • short_video:短视频SDK。
  • editing:剪辑合成。
  • live:直播录制。
ModificationTime String 2018-07-19T03:48:25Z

视频信息更新时间。格式为:yyyy-MM-ddTHH:mm:ssZ(UTC时间)。

PreprocessStatus String Preprocessing

预处理状态 。取值:

  • UnPreprocess:未进行预处理。
  • Preprocessing:预处理中。
  • PreprocessSucceed:预处理完成。
  • PreprocessFailed:预处理失败。
Size Long 123

视频大小。

Snapshots List {“http://sample.aliyun.com/cover02.jpg”}

自动截图列表。

SpriteSnapshots List {“http://sample.aliyun.com/cover02.jpg”}

雪碧图列表。

Status String UploadSucc

状态。取值:

  • Uploading:上传中。
  • UploadFail:上传失败。
  • UploadSucc:上传完成。
  • Transcoding:转码中。
  • TranscodeFail:转码失败。
  • Blocked:屏蔽。
  • Normal:正常。
StorageLocation String outin-bfefbb90a47c******163e1c7426.oss-cn-shanghai.aliyuncs.com

存储区域。

Tags String tag1

视频标签。

Title String ceshi

视频标题。

TranscodeMode String FastTranscode

转码模式。取值:

  • FastTranscode(普通转码):默认模式,上传完成即开始转码,且转码完成才能播放。
  • NoTranscode(不转码即分发):上传完成不转码,且立即能播放。
  • AsyncTranscode(上传即分发并转码) :上传完成即能播放,同时异步进行转码。
VideoId String a82a2asdasqadaf3*****faa0ed6c1ee372

视频ID。

RequestId String 3E0CEF83-FB09-4E*****34-BA1451814B03

请求ID。

ScrollToken String 24e0fba7188fa*****e707e146esa54

翻页标识。

Total Long 10

满足搜索条件的媒资信息总条数。

示例

请求示例

https://vod.aliyuncs.com/?Action=SearchMedia
&<公共请求参数>

正常返回示例

XML格式

<SearchMediaResponse>
      <MediaList>
            <CreationTime>2018-07-20T04:29:04Z</CreationTime>
            <MediaType>video</MediaType>
            <MediaId>afab53f582cf422f8*****1cf0425815</MediaId>
            <Video>
                  <CoverURL>http://sample.aliyun.com/cover01.jpg</CoverURL>
                  <CreationTime>2018-07-20T04:29:04Z</CreationTime>
                  <Status>Normal</Status>
                  <ModificationTime>2018-07-20T06:14:29Z</ModificationTime>
                  <VideoId>afab53f582cf422f8*****1cf0425815</VideoId>
                  <Title>测试标题01</Title>
            </Video>
      </MediaList>
      <MediaList>
            <CreationTime>2018-07-19T03:45:25Z</CreationTime>
            <MediaType>video</MediaType>
            <MediaId>a82a2cd7d4e147b*****ed6c1ee372</MediaId>
            <Video>
                  <CoverURL>http://sample.aliyun.com/cover02.jpg</CoverURL>
                  <CreationTime>2018-07-19T03:45:25Z</CreationTime>
                  <Status>Normal</Status>
                  <ModificationTime>2018-07-20T06:45:53Z</ModificationTime>
                  <VideoId>a82a2cd7d4e147b*****ed6c1ee372</VideoId>
                  <Title>测试标题02</Title>
            </Video>
      </MediaList>
      <MediaList>
            <CreationTime>2018-07-05T02:43:55Z</CreationTime>
            <MediaType>video</MediaType>
            <MediaId>62da1c9832e4*****4dce0eac3d2a</MediaId>
            <Video>
                  <CoverURL>http://sample.aliyun.com/cover03.jpg</CoverURL>
                  <CreationTime>2018-07-05T02:43:55Z</CreationTime>
                  <Status>Normal</Status>
                  <ModificationTime>2018-07-05T05:41:29Z</ModificationTime>
                  <VideoId>62da1c9832e4*****4dce0eac3d2a</VideoId>
                  <Title>测试标题03</Title>
            </Video>
      </MediaList>
      <RequestId>3E0CEF83-FB09-4E*****34-BA1451814B03</RequestId>
      <ScrollToken>24e0fba7188*****e707e146esa54</ScrollToken>
      <Total>10</Total>
</SearchMediaResponse>

JSON格式

{
    "MediaList": [{
        "CreationTime": "2018-07-20T04:29:04Z",
        "MediaType": "video",
        "MediaId": "afab53f582cf422f8*****1cf0425815",
        "Video": {
            "CoverURL": "http://sample.aliyun.com/cover01.jpg",
            "CreationTime": "2018-07-20T04:29:04Z",
            "Status": "Normal",
            "ModificationTime": "2018-07-20T06:14:29Z",
            "VideoId": "afab53f582cf422f8*****1cf0425815",
            "Title": "测试标题01"
        }
    },
    {
        "CreationTime": "2018-07-19T03:45:25Z",
        "MediaType": "video",
        "MediaId": "a82a2cd7d4e147b*****ed6c1ee372",
        "Video":{
            "CoverURL": "http://sample.aliyun.com/cover02.jpg",
            "CreationTime": "2018-07-19T03:45:25Z",
            "Status": "Normal",
            "ModificationTime": "2018-07-20T06:45:53Z",
            "VideoId": "a82a2cd7d4e147b*****ed6c1ee372",
            "Title": "测试标题02"
        }
    },
    {
        "CreationTime": "2018-07-05T02:43:55Z",
        "MediaType": "video",
        "MediaId": "62da1c9832e4*****4dce0eac3d2a",
        "Video": {
            "CoverURL": "http://sample.aliyun.com/cover03.jpg",
            "CreationTime": "2018-07-05T02:43:55Z",
            "Status": "Normal",
            "ModificationTime": "2018-07-05T05:41:29Z",
            "VideoId": "62da1c9832e4*****4dce0eac3d2a",
            "Title": "测试标题03"
        }
    }],
    "RequestId": "3E0CEF83-FB09-4E*****34-BA1451814B03",
    "ScrollToken": "24e0fba7188*****e707e146esa54",
    "Total": 10
}

错误码

访问错误中心查看更多错误码。

接口错误码

下表列举了本接口特有的错误码。

错误代码

错误信息

HTTP 状态码

说明

SortByExceededMax

The SortBy parameter only supports one sort field when traversing all data.

400

遍历所有数据时,仅支持一个排序字段。

ErrorMatchSyntax

The parameter Match.%s has an error syntax, please check it.

400

Match参数语法错误,请检查后重试。

InvalidScrollToken.Expired

The ScrollToken is expired,please refresh it.

400

翻页标识过期,请从第一页重新获取数据。

SDK示例

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