SearchMedia

Description

The maximum number of data records that you can query is limited based on the method used to query the data. You can use the following methods to query data:

• Method 1: You must use the PageNo and PageSize parameters for the first 5,000 data records that meet the specified filter criteria. This allows you to traverse data page by page. If the number of data records that meet the specified filter criteria exceeds 5,000, use Method 2.
• Method 2: This method applies only to the data of video and audio files. To traverse all the data records that meet the specified filter criteria, you must set the PageNo, PageSize, and ScrollToken parameters to traverse data page by page. The total number of data records from the current page to the desired page cannot exceed 1,200. Assume that the PageSize parameter is set to 20:
  • When the PageNo parameter is set to 1, you can scroll forward to traverse data records from page 1 to page 60 at most.
  • When the PageNo parameter is set to 2, you can scroll forward to traverse data records from page 2 to page 61 at most.
  • When the PageNo parameter is set to 61, you can scroll backward to traverse data records from page 61 to page 2 at most or scroll forward to traverse data records from page 61 to page 120 at most.

QPS limit

You can call this operation up to 50 times per second per account. Requests that exceed this limit are dropped and you will experience service interruptions. We recommend that you take note of this limit when you call this operation. For more information, see QPS limits on API operations in ApsaraVideo VOD.

Request parameters

Response parameters

Examples

Sample requests

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****
&Common request parameters

Sample success responses

XML format

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>Video test</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>Audio 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>Audio</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>Beautification image 1</CateName>
            <Description>Image test</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>Test</Tags>
            <ModificationTime>2018-07-19T03:48:25Z</ModificationTime>
            <MediaId>a82a2cd7d4e147ba0ed6c1ee372****</MediaId>
            <BusinessType>watermark</BusinessType>
            <Description>Test</Description>
            <AppId>app-****</AppId>
            <URL>https://example.com/****.png</URL>
            <Title>Test</Title>
            <Categories>
                <ParentId>-1</ParentId>
                <CateName>Test</CateName>
                <CateId>10027394</CateId>
                <Level>1</Level>
            </Categories>
        </AttachedMedia>
    </MediaList>
</SearchMediaResponse>

JSON format

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" : "Video test",
      "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" : "Audio description",
      "AppId" : "app-****",
      "CoverURL" : "http://example.com/image04.jpg",
      "AudioId" : "a82a2cd7d4e147bbed6c1ee372****",
      "DownloadSwitch" : "on",
      "CateName" : "ceshi",
      "TranscodeMode" : "FastTranscode",
      "PreprocessStatus" : "UnPreprocess",
      "Size" : 123,
      "Duration" : 123,
      "Title" : "Audio",
      "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" : "Beautification image 1",
      "Description" : "Image test",
      "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" : "Test",
      "ModificationTime" : "2018-07-19T03:48:25Z",
      "MediaId" : "a82a2cd7d4e147ba0ed6c1ee372****",
      "BusinessType" : "watermark",
      "Description": "Test",
      "AppId" : "app-****",
      "URL" : "https://example.com/****.png",
      "Title" : "Test",
      "Categories" : [ {
        "ParentId" : -1,
        "CateName": "Test",
        "CateId" : 10027394,
        "Level" : 1
      } ]
    }
  } ]
}

Error codes

For a list of error codes, visit the API Error Center.

Common errors

The following table describes the common errors that this operation can return.

Sample code of SDKs for various languages

We recommend that you use a server-side SDK to call this operation. For more information about the sample code that is used to call this operation in various languages, see the following topics:

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