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

使用说明

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

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

QPS限制

本接口的单用户QPS限制为50次/秒。超过限制,API调用会被限流,这可能会影响您的业务,请合理调用。更多信息,请参见QPS限制

调试

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

请求参数

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

系统规定参数。取值:SearchMedia

SearchType String video

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

  • video(默认值):视频。
  • audio:音频。
  • image:图片。
  • attached:辅助媒资。
说明 当本参数取值为videoaudio,且需要遍历搜索条件命中的所有数据时,必须设置ScrollToken参数。
Fields String Title,CoverURL

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

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

Match String field = value

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

SortBy String CreationTime:Desc

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

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

当前页码。默认值为1

说明 当本参数取值超过200时,建议同时设置ScrollToken参数。
PageSize Integer 10

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

ScrollToken String 24e0fba7188fae707e146esa54****

翻页标识。32字段。

第一次执行搜索请求时不用设置本参数。搜索请求命中数据时,服务端会返回该参数值,用于记录当前搜索数据的位置地址。请记录返回的参数值,下一次搜索时按下述要求或建议设置本参数:

  • 当SearchType参数取值为videoaudio,且需要遍历搜索条件命中的所有数据时,本参数必须设置。
  • 当PageNo参数取值超过200时,建议设置本参数优化搜索性能。

返回数据

名称 类型 示例值 描述
RequestId String 3E0CEF83-FB09-4E34-BA1451814B03****

请求ID。

Total Long 10

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

ScrollToken String 24e0fba7188fae707e146esa54****

翻页标识。

MediaList Array of Media

媒资信息列表。

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

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

MediaType String video

媒体类型。取值范围:

  • video:视频。
  • audio:音频。
  • image:图片。
  • attached:辅助媒资。
MediaId String a82a2cd7d4e147bbed6c1ee372****

媒体ID。

Video Object

视频信息

Status String UploadSucc

状态。取值:

  • Uploading:上传中。
  • UploadFail:上传失败。
  • UploadSucc:上传完成。
  • Transcoding:转码中。
  • TranscodeFail:转码失败。
  • Blocked:屏蔽。
  • Normal:正常。
CreationTime String 2018-07-19T03:45:25Z

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

StorageLocation String outin-bfefbb90a47c******163e1c7426.oss-cn-shanghai.aliyuncs.com

存储区域。

CateId Long 10000123

分类ID。

Tags String tag1

视频标签。

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

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

MediaSource String general

来源。取值:

  • general:点播上传。
  • short_video:短视频SDK。
  • editing:剪辑合成。
  • live:直播录制。
Description String 视频测试

视频描述。

AppId String app-****

应用ID。

CoverURL String https://example.aliyundoc.com/image01.png

封面图片。

VideoId String a82a2asdasqadaf3faa0ed6c1ee372****

视频ID。

DownloadSwitch String on

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

  • on(开启):初始状态,允许离线下载。
  • off(禁用):禁用离线下载。
CateName String video1

分类名称。

TranscodeMode String FastTranscode

转码模式。取值:

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

预处理状态 。取值:

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

视频大小。

Duration Float 123

视频时长。单位:秒。

Title String ceshi

视频标题。

SpriteSnapshots Array of String {“http://example.aliyundoc.com/image02.jpg”}

雪碧图列表。

Snapshots Array of String {“http://example.aliyundoc.com/image03.jpg”}

自动截图列表。

Audio Object

音频信息

Status String Normal

状态。取值:

  • Uploading:上传中。
  • Normal:正常。
  • UploadFail:失败。
  • Deleted:删除。
CreationTime String 2018-07-19T03:45:25Z

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

StorageLocation String outin-aaa*****aa.oss-cn-shanghai.aliyuncs.com

存储区域。

CateId Long 10000123

分类ID。

Tags String tag1,tag2

标签。

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

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

MediaSource String general

来源。取值:

  • general(点播上传):普通上传。
  • short_video(短视频SDK): 通过短视频SDK上传文件至点播,详细内容请参见短视频SDK
  • editing(剪辑合成):通过云剪辑合成上传文件至点播,详细内容请参见视频合成
  • live(直播录制):通过直播录制上传文件至点播。
Description String 音频描述

描述。

AppId String app-****

应用ID。

CoverURL String http://example.com/image04.jpg

封面图片。

AudioId String a82a2cd7d4e147bbed6c1ee372****

音频ID。

DownloadSwitch String on

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

  • on(开启):初始状态,允许离线下载。
  • off(禁用):禁用离线下载。
CateName String ceshi

分类名称。

TranscodeMode String FastTranscode

转码模式。取值范围:

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

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

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

大小。

Duration Float 123

时长。

Title String 音频

标题。

SpriteSnapshots Array of String {“http://example.aliyundoc.com/image02.jpg”}

雪碧图列表。

Snapshots Array of String {“http://example.aliyundoc.com/image03.jpg”}

自动截图列表。

Image Object

图片信息

StorageLocation String outin-bfefbb90a47c******163e1c7426.oss-cn-shanghai.aliyuncs.com

存储地域。

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

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

Status String Uploading

图片状态。

  • Uploading(上传中):初始状态,表示图片正在上传。
  • Normal(正常):图片上传成功。
  • UploadFail(失败):图片上传失败。
CateId Long 1000123

分类ID。

Tags String tag1

标签。

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

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

CateName String 美图1

分类名称。

Description String 图片测试

描述。

AppId String app-****

应用ID。

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

图片URL。

Title String image1

标题。

ImageId String 11130843741se99wqmoes****

图片ID。

AttachedMedia Object

辅助媒资信息

CreationTime String 2018-07-19T03:45: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 测试

标签。

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

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

MediaId String a82a2cd7d4e147ba0ed6c1ee372****

辅助媒资ID。

BusinessType String watermark

业务类型。取值:

  • watermark:水印。
  • subtitle:字幕。
  • material:素材。
Description String 测试

描述。

AppId String app-****

应用ID。

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

辅助媒资URL。

Title String 测试

标题。

Categories Array of Category

分类ID列表。

ParentId Long -1

父节点ID。

CateName String 测试

分类名称。

CateId Long 10027394

分类ID。

Level Long 1

分类层级。

示例

请求示例

http(s)://vod.cn-shanghai.aliyuncs.com/?Action=SearchMedia
&SearchType=video
&Fields=Title,CoverURL
&Match=field = value
&SortBy=CreationTime:Desc
&PageNo=1
&PageSize=10
&ScrollToken=24e0fba7188fae707e146esa54****
&公共请求参数

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<SearchMediaResponse>
    <RequestId>3E0CEF83-FB09-4E34-BA1451814B03****</RequestId>
    <Total>10</Total>
    <ScrollToken>24e0fba7188fae707e146esa54****</ScrollToken>
    <MediaList>
        <CreationTime>2018-07-19T03:45:25Z</CreationTime>
        <MediaType>video</MediaType>
        <MediaId>a82a2cd7d4e147bbed6c1ee372****</MediaId>
        <Video>
            <Status>UploadSucc</Status>
            <CreationTime>2018-07-19T03:45:25Z</CreationTime>
            <StorageLocation>outin-bfefbb90a47c******163e1c7426.oss-cn-shanghai.aliyuncs.com</StorageLocation>
            <CateId>10000123</CateId>
            <Tags>tag1</Tags>
            <ModificationTime>2018-07-19T03:48:25Z</ModificationTime>
            <MediaSource>general</MediaSource>
            <Description>视频测试</Description>
            <AppId>app-****</AppId>
            <CoverURL>https://example.aliyundoc.com/image01.png</CoverURL>
            <VideoId>a82a2asdasqadaf3faa0ed6c1ee372****</VideoId>
            <DownloadSwitch>on</DownloadSwitch>
            <CateName>video1</CateName>
            <TranscodeMode>FastTranscode</TranscodeMode>
            <PreprocessStatus>Preprocessing</PreprocessStatus>
            <Size>123</Size>
            <Duration>123</Duration>
            <Title>ceshi</Title>
            <SpriteSnapshots>{“http://example.aliyundoc.com/image02.jpg”}</SpriteSnapshots>
            <Snapshots>{“http://example.aliyundoc.com/image03.jpg”}</Snapshots>
        </Video>
        <Audio>
            <Status>Normal</Status>
            <CreationTime>2018-07-19T03:45:25Z</CreationTime>
            <StorageLocation>outin-aaa*****aa.oss-cn-shanghai.aliyuncs.com</StorageLocation>
            <CateId>10000123</CateId>
            <Tags>tag1,tag2</Tags>
            <ModificationTime>2018-07-19T03:48:25Z</ModificationTime>
            <MediaSource>general</MediaSource>
            <Description>音频描述</Description>
            <AppId>app-****</AppId>
            <CoverURL>http://example.com/image04.jpg</CoverURL>
            <AudioId>a82a2cd7d4e147bbed6c1ee372****</AudioId>
            <DownloadSwitch>on</DownloadSwitch>
            <CateName>ceshi</CateName>
            <TranscodeMode>FastTranscode</TranscodeMode>
            <PreprocessStatus>UnPreprocess</PreprocessStatus>
            <Size>123</Size>
            <Duration>123</Duration>
            <Title>音频</Title>
            <SpriteSnapshots>{“http://example.aliyundoc.com/image02.jpg”}</SpriteSnapshots>
            <Snapshots>{“http://example.aliyundoc.com/image03.jpg”}</Snapshots>
        </Audio>
        <Image>
            <StorageLocation>outin-bfefbb90a47c******163e1c7426.oss-cn-shanghai.aliyuncs.com</StorageLocation>
            <CreationTime>2018-07-19T03:45:25Z</CreationTime>
            <Status>Uploading</Status>
            <CateId>1000123</CateId>
            <Tags>tag1</Tags>
            <ModificationTime>2018-07-19T03:48:25Z</ModificationTime>
            <CateName>美图1</CateName>
            <Description>图片测试</Description>
            <AppId>app-****</AppId>
            <URL>https://example.com/****.png</URL>
            <Title>image1</Title>
            <ImageId>11130843741se99wqmoes****</ImageId>
        </Image>
        <AttachedMedia>
            <CreationTime>2018-07-19T03:45:25Z</CreationTime>
            <Status>Normal</Status>
            <StorageLocation>outin-bfefbb90a47c11*****7426.oss-cn-shanghai.aliyuncs.com</StorageLocation>
            <Tags>测试</Tags>
            <ModificationTime>2018-07-19T03:48:25Z</ModificationTime>
            <MediaId>a82a2cd7d4e147ba0ed6c1ee372****</MediaId>
            <BusinessType>watermark</BusinessType>
            <Description>测试</Description>
            <AppId>app-****</AppId>
            <URL>https://example.com/****.png</URL>
            <Title>测试</Title>
            <Categories>
                <ParentId>-1</ParentId>
                <CateName>测试</CateName>
                <CateId>10027394</CateId>
                <Level>1</Level>
            </Categories>
        </AttachedMedia>
    </MediaList>
</SearchMediaResponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/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",
      "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",
      "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
      } ]
    }
  } ]
}

错误码

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

接口错误码

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

错误代码

错误信息

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各语言调用的示例代码,请参见: