SearchMedia

1. API Description

Domain name for API request: vod.tencentcloudapi.com.

This API is used to search for media information and supports filtering and sorting the returned results in many ways. It can:

• Fuzzily search by media file name or description.
• Retrieve media files by category and tag.
  • Specify the ClassIds category set (please see the input parameters) and return the media files in any category in the set. For example, assuming that there are categories of Movies, TV Series, and Variety Shows, and there are subcategories of History, Action, and Romance in the category of Movies, if Movies and TV Series are specified in ClassIds, then all the subcategories under Movies and TV Series will be returned; however, if History and Action are specified in ClassIds, only the media files in those two subcategories will be returned.
  • Specify the Tags tag set (please see the input parameters) and return the media files with any tag in the set. For example, assuming that there are tags of ACG, Drama, and YTPMV, if ACG and YTPMV are specified in Tags, then any media files with either tag will be retrieved.
• Filter media files from a specified source (Source) (please see the input parameters).
• Filter LVB recording media files by LVB push code and Vid (please see the input parameters).
• Filter media files by the creation time range.
• Mix and match any filters above to retrieve the media files that meet all the specified criteria. For example, you can filter the media files with the tag of "Drama" in the category of "Movies" created between December 1, 2018 and December 8, 2018.
• Sort the results and return them in multiple pages by specifying Offset and Limit (please see the input parameters).

A maximum of 100 requests can be initiated per second for this API.

2. Input Parameters

The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.

3. Output Parameters

4. Example

Example1 Searching for media information

Input Example

https://vod.tencentcloudapi.com/?Action=SearchMedia
&Text=Test
&ClassIds.0=1
&ClassIds.1=2
&StartTime=2018-09-20T10:00:00Z
&EndTime=2018-10-02T10:00:00Z
&Sort.Field=CreatTime
&Sort.Order=Desc
&<Common request parameters>

Output Example

{
  "Response": {
    "MediaInfoSet": [
      {
        "FileId": "123",
        "BasicInfo": {
          "ClassId": 1,
          "ClassName": "Test",
          "ClassPath": "Test",
          "CoverUrl": "http://xx.vod2.myqcloud.com/xxxxxxxx/shotup/f0.100_0.jpg",
          "CreateTime": "2018-10-01T10:00:00Z",
          "Description": "",
          "ExpireTime": "2018-12-01T13:00:00Z",
          "Name": "test file",
          "MediaUrl": "http://xx.vod2.myqcloud.com/xx/xx/f0.mp4",
          "Type": "mp4",
          "TagSet": [],
          "StorageRegion": "ap-chongqing",
          "SourceInfo": {
            "SourceType": "Record",
            "SourceContext": "xxxxxxxx"
          },
          "Vid": "200025104_21313e19584d4b2a82af7c826581536c",
          "UpdateTime": "2018-10-01T13:10:03Z"
        }
      },
      {
        "FileId": "256",
        "BasicInfo": {
          "ClassId": 1,
          "ClassName": "Test",
          "ClassPath": "Test - Sports",
          "CoverUrl": "http://xx.vod2.myqcloud.com/xxxxxxxx/shotup/f0.100_0.jpg",
          "CreateTime": "2018-09-21T14:00:03Z",
          "Description": "",
          "ExpireTime": "2018-11-21T14:00:03",
          "Name": "test file2",
          "MediaUrl": "http://xx.vod2.myqcloud.com/xx/xx/f0.mp4",
          "Type": "mp4",
          "TagSet": [],
          "StorageRegion": "ap-chongqing",
          "SourceInfo": {
            "SourceType": "Record",
            "SourceContext": "xxxxxxxxx"
          },
          "Vid": "1251883823_e247f6b09c5c4f168052355ce1e9c343",
          "UpdateTime": "2018-09-22T16:12:16Z"
        }
      }
    ],
    "RequestId": "requestId",
    "TotalCount": 2
  }
}

5. Developer Resources

API Explorer

This tool allows online call, signature authentication, SDK code generation and quick search of APIs to greatly improve the efficiency of using TencentCloud APIs.

• API 3.0 Explorer

SDK

TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

• Tencent Cloud SDK 3.0 for Python
• Tencent Cloud SDK 3.0 for Java
• Tencent Cloud SDK 3.0 for PHP
• Tencent Cloud SDK 3.0 for Go
• Tencent Cloud SDK 3.0 for NodeJS
• Tencent Cloud SDK 3.0 for .NET

Command Line Interface

• Tencent Cloud CLI 3.0

6. Error Code

The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.