搜索媒体信息

使用说明

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

• 方法一：遍历搜索条件命中的前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限制。

请求参数

返回数据

示例

请求示例

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
      } ]
    }
  } ]
}

错误码

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

接口错误码

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

SDK示例

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

• Java
• Python
• PHP
• .NET
• Node.js
• Go
• C/C++