Domain name for API request: vod.intl.tencentcloudapi.com.
This API is used to search media information with conditional filtering, sort and filter returned results, and other features. This includes:
-Specify the file ID collection FileIds to return media matching any ID in the collection.
-Perform fuzzy search by multiple media file names (Names) or descriptions (Descriptions).
-Search by multiple filename prefixes NamePrefixes.
-Specify the category collection ClassIds (see input parameters), and media that meet any category in the collection will be returned. For example, media categories include movie, TV series, and variety show. The movie category has subcategories such as historical film, action film, and romance film. If ClassIds specifies movie and TV series, all subcategories under movie and TV series will be returned. If ClassIds specifies historical film and action film, only media under these two subcategories will be returned.
-The above parameters can be combined in any way for search. For example, filter media with a creation time between 2018-12-01 12:00:00 and 2018-12-08 12:00:00, categorized as movie or TV series, and tagged with palace intrigue and suspense. Note that for any parameter that supports array input, the search logic between its elements is OR. The logical relationship between all parameters is AND.
-Allow sorting results by creation time and return in pages. Use Offset and Limit (see input parameters) to control pagination.
-Offset and Limit impact the number of results per pagination query. Special attention: when both values are omitted, this interface returns up to 10 query results only.
-Supports up to 5000 search results. Excess results are no longer queryable. If the search result volume is too large, use more granular criteria to reduce the results.
Not recommended conditional filtering:
-(Not recommended: use Names, NamePrefixes, or Descriptions instead) Specify a single Text to do fuzzy search on media file Names or Descriptions.
-(Not recommended: use SourceTypes instead) Specify a single media file source SourceType for search.
-(Not recommended: use StreamIds instead) Specify a single push stream live code StreamId to search.
-(Not recommended: use CreateTime instead) Specify a single start creation time StartTime to search.
-(Not recommended: use CreateTime instead) Specify a single end time EndTime for search.
A maximum of 100 requests can be initiated per second for this API.
The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| Action | Yes | String | Common Params. The value used for this API: SearchMedia. |
| Version | Yes | String | Common Params. The value used for this API: 2018-07-17. |
| Region | No | String | Common Params. This parameter is not required. |
| SubAppId | No | Integer | Video-on-demand (VOD) application ID. For customers who activate VOD services on or after December 25, 2023, this field must be set to the app ID when accessing resources in VOD applications, whether in the default application or a newly created application. |
| FileIds.N | No | Array of String | File ID collection. Match any element in the collection. |
| Names.N | No | Array of String | File name collection, fuzzy match media file names. The higher the matching degree, the higher priority in sorting. |
| NamePrefixes.N | No | Array of String | File name prefix, which is used to match media files by file name prefix. |
| Descriptions.N | No | Array of String | File description set. Fuzzy match media file descriptions. The higher the matching degree, the higher priority in sorting. |
| ClassIds.N | No | Array of Integer | Category ID collection. Match the category with the specified ID in the collection and all its subclasses. |
| Tags.N | No | Array of String | Tag set. Match any element in the collection. |
| Categories.N | No | Array of String | File type. Match any element in the collection: |
| SourceTypes.N | No | Array of String | Media file source collection. For source values, see SourceType. |
| StreamIds.N | No | Array of String | Push stream live code collection. Match any element in the collection. |
| CreateTime | No | TimeRange | Files whose creation time matches this time period. |
| ExpireTime | No | TimeRange | Files whose expiration time falls within this period cannot be retrieved. |
| StorageRegions.N | No | Array of String | Media file storage region, for example, ap-chongqing. For details, see Region List. |
| StorageClasses.N | No | Array of String | Storage type array. Optional values: |
| MediaTypes.N | No | Array of String | Media file packaging format collection. Match any element in the collection. |
| Status.N | No | Array of String | Media file status. Match any element in the collection. |
| ReviewResults.N | No | Array of String | Media file review result, match any element in the collection. |
| TrtcSdkAppIds.N | No | Array of Integer | TRTC application ID collection. Match any element in the collection. |
| TrtcRoomIds.N | No | Array of String | TRTC room ID collection. Match any element in the collection. |
| Filters.N | No | Array of String | Information to be returned for all specified media files. Multiple information can be specified simultaneously. N starts incrementing from 0. If this field is not filled in, all information is returned by default. Options: |
| Sort | No | SortBy | Sorting method. |
| Offset | No | Integer | Starting offset amount for pagination return. Default value: 0. It will return entries from Offset to Offset+Limit-1. |
| Limit | No | Integer | Number of records returned in pages. Default value: 10. Records from Offset to Offset+Limit-1 will be returned. |
| Text | No | String | (Not recommended: use Names, NamePrefixes, or Descriptions instead) |
| SourceType | No | String | (Not recommended: use SourceTypes instead) |
| StreamId | No | String | (Not recommended: use StreamIds instead) |
| StartTime | No | String | (Not recommended: use CreateTime instead) |
| EndTime | No | String | (Not recommended: use CreateTime instead) |
| Vids.N | No | Array of String | This field is invalid. |
| Vid | No | String | This field is invalid. |
| StreamDomains.N | No | Array of String | Live push Domain, valid when the media asset source is live recording. |
| StreamPaths.N | No | Array of String | Live push Path. Valid when the media asset source is live recording. |
| KnowledgeBases.N | No | Array of String | Knowledge base ID, match any element in the collection. |
| Parameter Name | Type | Description |
|---|---|---|
| TotalCount | Integer | Total records that meet the search criteria. |
| MediaInfoSet | Array of MediaInfo | Media file information list. |
| RequestId | String | The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem. |
Search for image files with ClassId 123 and creation time between 2020-12-10T07:25:52Z and 2020-12-13T07:25:52Z, sort in descending order by creation time, and return only the basic information of the files.
POST / HTTP/1.1
Host: vod.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: SearchMedia
<Common request parameters>
{
"Sort": {
"Field": "CreateTime",
"Order": "Desc"
},
"Filters": [
"basicInfo"
],
"Categories": [
"Image"
],
"ClassIds": [
123
],
"CreateTime": {
"After": "2020-12-10T07:25:52Z",
"Before": "2020-12-13T07:25:52Z"
}
}{
"Response": {
"RequestId": "6ca31e3a-6b8e-4b4e-9256-fdc700064ef3",
"TotalCount": 2,
"MediaInfoSet": [
{
"FileId": "5285890811175706012",
"BasicInfo": {
"Name": "Fog",
"Description": "",
"CreateTime": "2020-12-11T07:02:36Z",
"UpdateTime": "2020-12-11T07:02:37Z",
"ExpireTime": "9999-12-31T23:59:59Z",
"ClassId": 123,
"ClassName": "Icon",
"ClassPath": "icon",
"CoverUrl": "",
"Type": "png",
"MediaUrl": "http://example.com/Tmf3xphxGoUA.png",
"TagSet": [],
"StorageRegion": "ap-shanghai",
"StoragePath": "/Tmf3xphxGoUA.png",
"SourceInfo": {
"SourceType": "Upload",
"SourceContext": "",
"TrtcRecordInfo": {
"SdkAppId": 1,
"RoomId": "RoomId",
"TaskId": "TaskId",
"UserIds": [
"UserId"
]
},
"WebPageRecordInfo": null,
"LiveRecordInfo": null
},
"Vid": "5285890811175706012",
"Category": "Image",
"Status": "Normal",
"StorageClass": "STANDARD"
},
"SubtitleInfo": {
"SubtitleSet": [
{
"Url": "url",
"Format": "vtt",
"Name": "name",
"Language": "cn",
"Id": "id",
"Source": "UserUploaded"
}
]
},
"ReviewInfo": null,
"MetaData": null,
"TranscodeInfo": null,
"AnimatedGraphicsInfo": null,
"SampleSnapshotInfo": null,
"ImageSpriteInfo": null,
"SnapshotByTimeOffsetInfo": null,
"KeyFrameDescInfo": null,
"AdaptiveDynamicStreamingInfo": null,
"MiniProgramReviewInfo": null
},
{
"FileId": "5285890811175698692",
"BasicInfo": {
"Name": "Multi-cloud"
"Description": "",
"CreateTime": "2020-12-11T07:02:35Z",
"UpdateTime": "2020-12-11T07:02:36Z",
"ExpireTime": "9999-12-31T23:59:59Z",
"ClassId": 737598,
"ClassName": "Icon",
"ClassPath": "icon",
"CoverUrl": "",
"Type": "png",
"MediaUrl": "http://xxx/uAgVpElena0A.png",
"TagSet": [],
"StorageRegion": "ap-shanghai",
"StoragePath": "/uAgVpElena0A.png",
"SourceInfo": {
"SourceType": "Upload",
"SourceContext": "",
"TrtcRecordInfo": {
"SdkAppId": 1,
"RoomId": "RoomId",
"TaskId": "TaskId",
"UserIds": [
"UserId"
]
},
"WebPageRecordInfo": null,
"LiveRecordInfo": null
},
"Vid": "5285890811175698692",
"Category": "Image",
"Status": "Normal",
"StorageClass": "STANDARD"
},
"SubtitleInfo": {
"SubtitleSet": [
{
"Url": "url",
"Format": "vtt",
"Name": "name",
"Language": "cn",
"Id": "id",
"Source": "UserUploaded"
}
]
},
"ReviewInfo": null,
"MetaData": null,
"TranscodeInfo": null,
"AnimatedGraphicsInfo": null,
"SampleSnapshotInfo": null,
"ImageSpriteInfo": null,
"SnapshotByTimeOffsetInfo": null,
"KeyFrameDescInfo": null,
"AdaptiveDynamicStreamingInfo": null,
"MiniProgramReviewInfo": null
}
]
}
}Search for recording files with live stream codes StreamId_test1 and StreamId_test2 and creation time between 2020-12-10T07:25:52Z and 2020-12-13T07:25:52Z, sort in descending order by creation time, and only return the first eligible file.
POST / HTTP/1.1
Host: vod.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: SearchMedia
<Common request parameters>
{
"Sort": {
"Field": "CreateTime",
"Order": "Desc"
},
"StreamIds": [
"StreamId_test2",
"StreamId_test1"
],
"Limit": 1,
"SourceTypes": [
"Record"
],
"Offset": 0,
"CreateTime": {
"After": "2020-12-10T07:25:52Z",
"Before": "2020-12-13T07:25:52Z"
}
}{
"Response": {
"RequestId": "6ca31e3a-6b8e-4b4e-9256-fdc700064ef3",
"TotalCount": 1,
"MediaInfoSet": [
{
"FileId": "5285485487985271487",
"BasicInfo": {
"Name": "Sport file",
"Description": "",
"CreateTime": "2020-12-11T07:25:52Z",
"UpdateTime": "2020-12-11T07:25:52Z",
"ExpireTime": "9999-12-31T23:59:59Z",
"ClassId": 123,
"ClassName": "Audio/Video Recorded Broadcast",
"ClassPath": "Audio and video recorded broadcast"
"CoverUrl": "http://example.com/xxxxxxxx/shotup/f0.100_0.jpg",
"Type": "mp4",
"MediaUrl": "http://example.com/xxx/xx/f0.mp4",
"TagSet": [
"tag1",
"tag2"
],
"SourceInfo": {
"SourceType": "Record",
"SourceContext": "",
"TrtcRecordInfo": {
"SdkAppId": 1,
"RoomId": "RoomId",
"TaskId": "TaskId",
"UserIds": [
"UserId"
]
},
"WebPageRecordInfo": null,
"LiveRecordInfo": null
},
"StorageRegion": "ap-chongqing",
"StoragePath": "/xxx/xx/f0.mp4",
"Category": "Image",
"Vid": "5285485487985271487",
"Status": "Normal",
"StorageClass": "STANDARD"
},
"MetaData": {
"Size": 10556,
"Container": "m4a",
"Duration": 3601,
"Bitrate": 246035,
"Height": 480,
"Width": 640,
"Rotate": 0,
"VideoDuration": 3601,
"AudioDuration": 3601,
"Md5": "b3ae6ed07d9bf4efeeb94ed2d37ff3e3",
"VideoStreamSet": [
{
"Bitrate": 246000,
"Height": 480,
"Width": 640,
"Codec": "h264",
"CodecTag": "avc1",
"Fps": 222,
"DynamicRangeInfo": {
"Type": "HDR",
"HDRType": "hdr10"
}
}
],
"AudioStreamSet": [
{
"Codec": "aac",
"SamplingRate": 44100,
"Bitrate": 35
}
]
},
"TranscodeInfo": {
"TranscodeSet": [
{
"Url": "http://example.com/xx/xx/f0.mp4",
"Definition": 0,
"Bitrate": 563477,
"Height": 378,
"Width": 672,
"Container": "m4a",
"Duration": 3601,
"Size": 10502,
"Md5": "b3ae6ed07d9bf4efeeb94ed2d37ff3e3",
"VideoStreamSet": [
{
"Bitrate": 246000,
"Height": 480,
"Width": 640,
"Codec": "h264",
"CodecTag": "avc1",
"Fps": 222,
"DynamicRangeInfo": {
"Type": "HDR",
"HDRType": "hdr10"
}
}
],
"AudioStreamSet": [
{
"Codec": "aac",
"SamplingRate": 44100,
"Bitrate": 35
}
],
"DigitalWatermarkType": "None",
"CopyRightWatermarkText": "None"
},
{
"Url": "http://example.com/xx/xx/f0.f210.m3u8",
"Definition": 211,
"Bitrate": 563477,
"Height": 378,
"Width": 672,
"Container": "mov",
"Duration": 3601,
"Size": 10502,
"Md5": "b3ae6ed07d9bf4efeeb94ed2d37ff3e3",
"VideoStreamSet": [
{
"Bitrate": 246000,
"Height": 480,
"Width": 640,
"Codec": "h264",
"CodecTag": "avc1",
"Fps": 222,
"DynamicRangeInfo": {
"Type": "HDR",
"HDRType": "hdr10"
}
}
],
"AudioStreamSet": [
{
"Codec": "aac",
"SamplingRate": 44100,
"Bitrate": 35
}
],
"DigitalWatermarkType": "None",
"CopyRightWatermarkText": "None"
},
{
"Url": "http://example.com/xx/xx/master_playlist.m3u8",
"Definition": 10000,
"Duration": 145,
"Size": 265,
"Bitrate": 2840055,
"Height": 1080,
"Width": 1920,
"Container": "hls,applehttp",
"Md5": "bfcf7c6f154b18890661f9e80b0731d0",
"VideoStreamSet": [
{
"Bitrate": 2794233,
"Height": 1080,
"Width": 1920,
"Codec": "h264",
"CodecTag": "avc1",
"Fps": 24,
"DynamicRangeInfo": {
"Type": "HDR",
"HDRType": "hdr10"
}
}
],
"AudioStreamSet": [
{
"SamplingRate": 44100,
"Bitrate": 45822,
"Codec": "aac"
}
],
"DigitalWatermarkType": "None",
"CopyRightWatermarkText": "None"
}
]
},
"AnimatedGraphicsInfo": {
"AnimatedGraphicsSet": [
{
"Url": "http://example.com/xx/xx/f20000.gif",
"Definition": 20000,
"Container": "gif",
"Height": 480,
"Width": 640,
"Bitrate": 1000000,
"Size": 600000,
"Md5": "bfcf7c6f154b1842a661f9e80b07a1d0",
"StartTimeOffset": 10,
"EndTimeOffset": 15
}
]
},
"SampleSnapshotInfo": {
"SampleSnapshotSet": [
{
"Definition": 10,
"SampleType": "percent",
"WaterMarkDefinition": [
0
],
"Interval": 10,
"ImageUrlSet": [
"http://example.com/xx/xx/shotup/xx1.png",
"http://example.com/xx/xx/shotup/xx2.png",
"http://example.com/xx/xx/shotup/xx3.png",
"http://example.com/xx/xx/shotup/xx4.png",
"http://example.com/xx/xx/shotup/xx5.png",
"http://example.com/xx/xx/shotup/xx6.png",
"http://example.com/xx/xx/shotup/xx7.png",
"http://example.com/xx/xx/shotup/xx8.png",
"http://example.com/xx/xx/shotup/xx9.png",
"http://example.com/xx/xx/shotup/xx10.png"
]
}
]
},
"ImageSpriteInfo": {
"ImageSpriteSet": [
{
"Definition": 10,
"Height": 576,
"Width": 1024,
"TotalCount": 100,
"ImageUrlSet": [
"http://example.com/xx/xx/imageSprite/xx.100_0.jpg"
],
"WebVttUrl": "http://example.com/xxxx/xxxx/imageSprite/xx.vtt"
}
]
},
"SnapshotByTimeOffsetInfo": {
"SnapshotByTimeOffsetSet": [
{
"Definition": 10,
"PicInfoSet": [
{
"TimeOffset": 0,
"Url": "http://example.com/xx/xx/snapshotByTime/xx1.jpg",
"WaterMarkDefinition": []
},
{
"TimeOffset": 1000,
"Url": "http://example.com/xx/xx/snapshotByTime/xx2.jpg",
"WaterMarkDefinition": []
}
]
}
]
},
"KeyFrameDescInfo": {
"KeyFrameDescSet": [
{
"TimeOffset": 1,
"Content": "Timestamp content"
},
{
"TimeOffset": 100,
"Content": "def"
}
]
},
"MiniProgramReviewInfo": {
"MiniProgramReviewList": [
{
"Url": "url",
"Definition": 0,
"ReviewResult": "Pass",
"ReviewSummary": [
{
"Confidence": 0,
"Type": "Porn",
"Suggestion": "pass"
}
],
"MetaData": {
"Rotate": 0,
"Container": "mp4",
"AudioDuration": 0,
"Md5": "md5",
"VideoStreamSet": [
{
"Width": 0,
"Codec": "h264",
"CodecTag": "avc1",
"Bitrate": 0,
"Fps": 0,
"Height": 0,
"DynamicRangeInfo": {
"Type": "HDR",
"HDRType": "hdr10"
}
}
],
"Height": 0,
"VideoDuration": 0,
"Width": 0,
"Duration": 0,
"Size": 0,
"Bitrate": 0,
"AudioStreamSet": [
{
"SamplingRate": 0,
"Codec": "h264",
"Bitrate": 0
}
]
}
}
]
},
"AdaptiveDynamicStreamingInfo": {
"AdaptiveDynamicStreamingSet": [
{
"Size": 10556,
"DrmType": "drm",
"Definition": 0,
"Url": "url",
"Package": "HLS",
"SubStreamSet": [],
"DigitalWatermarkType": "NONE",
"CopyRightWatermarkText": "NONE",
"StorageClass": "STANDARD"
}
]
},
"SubtitleInfo": {
"SubtitleSet": [
{
"Url": "url",
"Format": "vtt",
"Name": "name",
"Language": "cn",
"Id": "id",
"Source": "UserUploaded"
}
]
},
"ReviewInfo": null
}
]
}
}Search for files whose filename prefix is Sport and whose creation time is between 2020-12-10T07:25:52Z and 2020-12-13T07:25:52Z, and sort them in descending order by creation time.
POST / HTTP/1.1
Host: vod.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: SearchMedia
<Common request parameters>
{
"Sort": {
"Field": "CreateTime",
"Order": "Desc"
},
"NamePrefixes": [
"Sport"
],
"CreateTime": {
"After": "2020-12-10T07:25:52Z",
"Before": "2020-12-13T07:25:52Z"
}
}{
"Response": {
"RequestId": "6ca31e3a-6b8e-4b4e-9256-fdc700064ef3",
"TotalCount": 1,
"MediaInfoSet": [
{
"FileId": "5285485487985271487",
"BasicInfo": {
"Name": "Sport file",
"Description": "",
"CreateTime": "2020-12-11T07:25:52Z",
"UpdateTime": "2020-12-11T07:25:52Z",
"ExpireTime": "9999-12-31T23:59:59Z",
"ClassId": 123,
"ClassName": "Audio/Video Recording for Playback",
"ClassPath": "Audio and video recorded",
"CoverUrl": "http://example.com/xxxxxxxx/shotup/f0.100_0.jpg",
"Type": "mp4",
"MediaUrl": "http://example.com/xxx/xx/f0.mp4",
"TagSet": [],
"SourceInfo": {
"SourceType": "Record",
"SourceContext": "",
"TrtcRecordInfo": {
"SdkAppId": 1,
"RoomId": "RoomId",
"TaskId": "TaskId",
"UserIds": [
"UserId"
]
},
"WebPageRecordInfo": null,
"LiveRecordInfo": null
},
"StorageRegion": "ap-chongqing",
"StoragePath": "/xxx/xx/f0.mp4",
"Category": "Video",
"Vid": "5285485487985271487",
"Status": "Normal",
"StorageClass": "STANDARD"
},
"MetaData": {
"Size": 10556,
"Container": "m4a",
"Duration": 3601,
"Bitrate": 246035,
"Height": 480,
"Width": 640,
"Rotate": 0,
"VideoDuration": 3601,
"AudioDuration": 3601,
"Md5": "b3ae6ed07d9bf4efeeb94ed2d37ff3e3",
"VideoStreamSet": [
{
"Bitrate": 246000,
"Height": 480,
"Width": 640,
"Codec": "h264",
"CodecTag": "avc1",
"Fps": 222,
"DynamicRangeInfo": {
"Type": "HDR",
"HDRType": "hdr10"
}
}
],
"AudioStreamSet": [
{
"Codec": "aac",
"SamplingRate": 44100,
"Bitrate": 35
}
]
},
"TranscodeInfo": {
"TranscodeSet": [
{
"Url": "http://example.com/xx/xx/f0.mp4",
"Definition": 0,
"Bitrate": 563477,
"Height": 378,
"Width": 672,
"Container": "m4a",
"Duration": 3601,
"Size": 10502,
"Md5": "b3ae6ed07d9bf4efeeb94ed2d37ff3e3",
"VideoStreamSet": [
{
"Bitrate": 246000,
"Height": 480,
"Width": 640,
"Codec": "h264",
"CodecTag": "avc1",
"Fps": 222,
"DynamicRangeInfo": {
"Type": "HDR",
"HDRType": "hdr10"
}
}
],
"AudioStreamSet": [
{
"Codec": "aac",
"SamplingRate": 44100,
"Bitrate": 35
}
],
"DigitalWatermarkType": "None",
"CopyRightWatermarkText": "None"
},
{
"Url": "http://example.com/xx/xx/f0.f210.m3u8",
"Definition": 211,
"Bitrate": 563477,
"Height": 378,
"Width": 672,
"Container": "mov",
"Duration": 3601,
"Size": 10502,
"Md5": "b3ae6ed07d9bf4efeeb94ed2d37ff3e3",
"VideoStreamSet": [
{
"Bitrate": 246000,
"Height": 480,
"Width": 640,
"Codec": "h264",
"CodecTag": "avc1",
"Fps": 222,
"DynamicRangeInfo": {
"Type": "HDR",
"HDRType": "hdr10"
}
}
],
"AudioStreamSet": [
{
"Codec": "aac",
"SamplingRate": 44100,
"Bitrate": 35
}
],
"DigitalWatermarkType": "None",
"CopyRightWatermarkText": "None"
},
{
"Url": "http://example.com/xx/xx/master_playlist.m3u8",
"Definition": 10000,
"Duration": 145,
"Size": 265,
"Bitrate": 2840055,
"Height": 1080,
"Width": 1920,
"Container": "hls,applehttp",
"Md5": "bfcf7c6f154b18890661f9e80b0731d0",
"VideoStreamSet": [
{
"Bitrate": 2794233,
"Height": 1080,
"Width": 1920,
"Codec": "h264",
"CodecTag": "avc1",
"Fps": 24,
"DynamicRangeInfo": {
"Type": "HDR",
"HDRType": "hdr10"
}
}
],
"AudioStreamSet": [
{
"SamplingRate": 44100,
"Bitrate": 45822,
"Codec": "aac"
}
],
"DigitalWatermarkType": "None",
"CopyRightWatermarkText": "None"
}
]
},
"AnimatedGraphicsInfo": {
"AnimatedGraphicsSet": [
{
"Url": "http://example.com/xx/xx/f20000.gif",
"Definition": 20000,
"Container": "gif",
"Height": 480,
"Width": 640,
"Bitrate": 1000000,
"Size": 600000,
"Md5": "bfcf7c6f154b1842a661f9e80b07a1d0",
"StartTimeOffset": 10,
"EndTimeOffset": 15
}
]
},
"SampleSnapshotInfo": {
"SampleSnapshotSet": [
{
"Definition": 10,
"SampleType": "percent",
"WaterMarkDefinition": [
0
],
"Interval": 10,
"ImageUrlSet": [
"http://example.com/xx/xx/shotup/xx1.png",
"http://example.com/xx/xx/shotup/xx2.png",
"http://example.com/xx/xx/shotup/xx3.png",
"http://example.com/xx/xx/shotup/xx4.png",
"http://example.com/xx/xx/shotup/xx5.png",
"http://example.com/xx/xx/shotup/xx6.png",
"http://example.com/xx/xx/shotup/xx7.png",
"http://example.com/xx/xx/shotup/xx8.png",
"http://example.com/xx/xx/shotup/xx9.png",
"http://example.com/xx/xx/shotup/xx10.png"
]
}
]
},
"ImageSpriteInfo": {
"ImageSpriteSet": [
{
"Definition": 10,
"Height": 576,
"Width": 1024,
"TotalCount": 100,
"ImageUrlSet": [
"http://example.com/xx/xx/imageSprite/xx.100_0.jpg"
],
"WebVttUrl": "http://example.com/xxxx/xxxx/imageSprite/xx.vtt"
}
]
},
"SnapshotByTimeOffsetInfo": {
"SnapshotByTimeOffsetSet": [
{
"Definition": 10,
"PicInfoSet": [
{
"TimeOffset": 0,
"Url": "http://example.com/xx/xx/snapshotByTime/xx1.jpg",
"WaterMarkDefinition": []
},
{
"TimeOffset": 1000,
"Url": "http://example.com/xx/xx/snapshotByTime/xx2.jpg",
"WaterMarkDefinition": []
}
]
}
]
},
"KeyFrameDescInfo": {
"KeyFrameDescSet": [
{
"TimeOffset": 1,
"Content": "Timestamp content"
},
{
"TimeOffset": 100,
"Content": "def"
}
]
},
"MiniProgramReviewInfo": {
"MiniProgramReviewList": [
{
"Url": "url",
"Definition": 0,
"ReviewResult": "Pass",
"ReviewSummary": [
{
"Confidence": 0,
"Type": "Porn",
"Suggestion": "pass"
}
],
"MetaData": {
"Rotate": 0,
"Container": "mp4",
"AudioDuration": 0,
"Md5": "md5",
"VideoStreamSet": [
{
"Width": 0,
"Codec": "h264",
"CodecTag": "avc1",
"Bitrate": 0,
"Fps": 0,
"Height": 0,
"DynamicRangeInfo": {
"Type": "HDR",
"HDRType": "hdr10"
}
}
],
"Height": 0,
"VideoDuration": 0,
"Width": 0,
"Duration": 0,
"Size": 0,
"Bitrate": 0,
"AudioStreamSet": [
{
"SamplingRate": 0,
"Codec": "h264",
"Bitrate": 0
}
]
}
}
]
},
"AdaptiveDynamicStreamingInfo": {
"AdaptiveDynamicStreamingSet": [
{
"Size": 10556,
"DrmType": "drm",
"Definition": 0,
"Url": "url",
"Package": "HLS",
"SubStreamSet": [],
"DigitalWatermarkType": "NONE",
"CopyRightWatermarkText": "NONE"
}
]
},
"SubtitleInfo": {
"SubtitleSet": [
{
"Url": "url",
"Format": "vtt",
"Name": "name",
"Language": "cn",
"Id": "id",
"Source": "UserUploaded"
}
]
},
"ReviewInfo": null
}
]
}
}Search for files whose names match the keyword Sport and whose creation time is between 2020-12-10T07:25:52Z and 2020-12-13T07:25:52Z, and sort them in descending order by creation time.
POST / HTTP/1.1
Host: vod.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: SearchMedia
<Common request parameters>
{
"Sort": {
"Field": "CreateTime",
"Order": "Desc"
},
"Names": [
"Sport"
],
"CreateTime": {
"After": "2020-12-10T07:25:52Z",
"Before": "2020-12-13T07:25:52Z"
}
}{
"Response": {
"RequestId": "6ca31e3a-6b8e-4b4e-9256-fdc700064ef3",
"TotalCount": 1,
"MediaInfoSet": [
{
"FileId": "5285485487985271487",
"BasicInfo": {
"Name": "Sport file",
"Description": "",
"CreateTime": "2020-12-11T07:25:52Z",
"UpdateTime": "2020-12-11T07:25:52Z",
"ExpireTime": "9999-12-31T23:59:59Z",
"ClassId": 123,
"ClassName": "Audio/Video Recording for Playback",
"ClassPath": "Audio and video recorded",
"CoverUrl": "http://example.com/xxxxxxxx/shotup/f0.100_0.jpg",
"Type": "mp4",
"MediaUrl": "http://example.com/xxx/xx/f0.mp4",
"TagSet": [],
"SourceInfo": {
"SourceType": "Record",
"SourceContext": "",
"TrtcRecordInfo": {
"SdkAppId": 1,
"RoomId": "RoomId",
"TaskId": "TaskId",
"UserIds": [
"UserId"
]
},
"WebPageRecordInfo": null,
"LiveRecordInfo": null
},
"StorageRegion": "ap-chongqing",
"StoragePath": "/xxx/xx/f0.mp4",
"Category": "Video",
"Vid": "5285485487985271487",
"Status": "Normal",
"StorageClass": "STANDARD"
},
"MetaData": {
"Size": 10556,
"Container": "m4a",
"Duration": 3601,
"Bitrate": 246035,
"Height": 480,
"Width": 640,
"Rotate": 0,
"VideoDuration": 3601,
"AudioDuration": 3601,
"Md5": "b3ae6ed07d9bf4efeeb94ed2d37ff3e3",
"VideoStreamSet": [
{
"Bitrate": 246000,
"Height": 480,
"Width": 640,
"Codec": "h264",
"CodecTag": "avc1",
"Fps": 222,
"DynamicRangeInfo": {
"Type": "HDR",
"HDRType": "hdr10"
}
}
],
"AudioStreamSet": [
{
"Codec": "aac",
"SamplingRate": 44100,
"Bitrate": 35
}
]
},
"TranscodeInfo": {
"TranscodeSet": [
{
"Url": "http://example.com/xx/xx/f0.mp4",
"Definition": 0,
"Bitrate": 563477,
"Height": 378,
"Width": 672,
"Container": "m4a",
"Duration": 3601,
"Size": 10502,
"Md5": "b3ae6ed07d9bf4efeeb94ed2d37ff3e3",
"VideoStreamSet": [
{
"Bitrate": 246000,
"Height": 480,
"Width": 640,
"Codec": "h264",
"CodecTag": "avc1",
"Fps": 222,
"DynamicRangeInfo": {
"Type": "HDR",
"HDRType": "hdr10"
}
}
],
"AudioStreamSet": [
{
"Codec": "aac",
"SamplingRate": 44100,
"Bitrate": 35
}
],
"DigitalWatermarkType": "None",
"CopyRightWatermarkText": "None"
},
{
"Url": "http://example.com/xx/xx/f0.f210.m3u8",
"Definition": 211,
"Bitrate": 563477,
"Height": 378,
"Width": 672,
"Container": "mov",
"Duration": 3601,
"Size": 10502,
"Md5": "b3ae6ed07d9bf4efeeb94ed2d37ff3e3",
"VideoStreamSet": [
{
"Bitrate": 246000,
"Height": 480,
"Width": 640,
"Codec": "h264",
"CodecTag": "avc1",
"Fps": 222,
"DynamicRangeInfo": {
"Type": "HDR",
"HDRType": "hdr10"
}
}
],
"AudioStreamSet": [
{
"Codec": "aac",
"SamplingRate": 44100,
"Bitrate": 35
}
],
"DigitalWatermarkType": "None",
"CopyRightWatermarkText": "None"
},
{
"Url": "http://example.com/xx/xx/master_playlist.m3u8",
"Definition": 10000,
"Duration": 145,
"Size": 265,
"Bitrate": 2840055,
"Height": 1080,
"Width": 1920,
"Container": "hls,applehttp",
"Md5": "bfcf7c6f154b18890661f9e80b0731d0",
"VideoStreamSet": [
{
"Bitrate": 2794233,
"Height": 1080,
"Width": 1920,
"Codec": "h264",
"CodecTag": "avc1",
"Fps": 24,
"DynamicRangeInfo": {
"Type": "HDR",
"HDRType": "hdr10"
}
}
],
"AudioStreamSet": [
{
"SamplingRate": 44100,
"Bitrate": 45822,
"Codec": "aac"
}
],
"DigitalWatermarkType": "None",
"CopyRightWatermarkText": "None"
}
]
},
"AnimatedGraphicsInfo": {
"AnimatedGraphicsSet": [
{
"Url": "http://example.com/xx/xx/f20000.gif",
"Definition": 20000,
"Container": "gif",
"Height": 480,
"Width": 640,
"Bitrate": 1000000,
"Size": 600000,
"Md5": "bfcf7c6f154b1842a661f9e80b07a1d0",
"StartTimeOffset": 10,
"EndTimeOffset": 15
}
]
},
"SampleSnapshotInfo": {
"SampleSnapshotSet": [
{
"Definition": 10,
"SampleType": "percent",
"WaterMarkDefinition": [
0
],
"Interval": 10,
"ImageUrlSet": [
"http://example.com/xx/xx/shotup/xx1.png",
"http://example.com/xx/xx/shotup/xx2.png",
"http://example.com/xx/xx/shotup/xx3.png",
"http://example.com/xx/xx/shotup/xx4.png",
"http://example.com/xx/xx/shotup/xx5.png",
"http://example.com/xx/xx/shotup/xx6.png",
"http://example.com/xx/xx/shotup/xx7.png",
"http://example.com/xx/xx/shotup/xx8.png",
"http://example.com/xx/xx/shotup/xx9.png",
"http://example.com/xx/xx/shotup/xx10.png"
]
}
]
},
"ImageSpriteInfo": {
"ImageSpriteSet": [
{
"Definition": 10,
"Height": 576,
"Width": 1024,
"TotalCount": 100,
"ImageUrlSet": [
"http://example.com/xx/xx/imageSprite/xx.100_0.jpg"
],
"WebVttUrl": "http://example.com/xxxx/xxxx/imageSprite/xx.vtt"
}
]
},
"SnapshotByTimeOffsetInfo": {
"SnapshotByTimeOffsetSet": [
{
"Definition": 10,
"PicInfoSet": [
{
"TimeOffset": 0,
"Url": "http://example.com/xx/xx/snapshotByTime/xx1.jpg",
"WaterMarkDefinition": []
},
{
"TimeOffset": 1000,
"Url": "http://example.com/xx/xx/snapshotByTime/xx2.jpg",
"WaterMarkDefinition": []
}
]
}
]
},
"KeyFrameDescInfo": {
"KeyFrameDescSet": [
{
"TimeOffset": 1,
"Content": "Timestamp content"
},
{
"TimeOffset": 100,
"Content": "def"
}
]
},
"MiniProgramReviewInfo": {
"MiniProgramReviewList": [
{
"Url": "url",
"Definition": 0,
"ReviewResult": "Pass",
"ReviewSummary": [
{
"Confidence": 0,
"Type": "Porn",
"Suggestion": "pass"
}
],
"MetaData": {
"Rotate": 0,
"Container": "mp4",
"AudioDuration": 0,
"Md5": "md5",
"VideoStreamSet": [
{
"Width": 0,
"Codec": "h264",
"CodecTag": "avc1",
"Bitrate": 0,
"Fps": 0,
"Height": 0,
"DynamicRangeInfo": {
"Type": "HDR",
"HDRType": "hdr10"
}
}
],
"Height": 0,
"VideoDuration": 0,
"Width": 0,
"Duration": 0,
"Size": 0,
"Bitrate": 0,
"AudioStreamSet": [
{
"SamplingRate": 0,
"Codec": "h264",
"Bitrate": 0
}
]
}
}
]
},
"AdaptiveDynamicStreamingInfo": {
"AdaptiveDynamicStreamingSet": [
{
"Size": 10556,
"DrmType": "drm",
"Definition": 0,
"Url": "url",
"Package": "HLS",
"SubStreamSet": [],
"DigitalWatermarkType": "NONE",
"CopyRightWatermarkText": "NONE"
}
]
},
"SubtitleInfo": {
"SubtitleSet": [
{
"Url": "url",
"Format": "vtt",
"Name": "name",
"Language": "cn",
"Id": "id",
"Source": "UserUploaded"
}
]
},
"ReviewInfo": null
}
]
}
}Search for files with tags tag1 and tag2, creation time between 2020-12-10T07:25:52Z and 2020-12-13T07:25:52Z, and file source Upload, then sort them by creation time in descending order.
POST / HTTP/1.1
Host: vod.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: SearchMedia
<Common request parameters>
{
"Sort": {
"Field": "CreateTime",
"Order": "Desc"
},
"CreateTime": {
"After": "2020-12-10T07:25:52Z",
"Before": "2020-12-13T07:25:52Z"
},
"SourceTypes": [
"Upload"
],
"Tags": [
"tag2",
"tag1"
]
}{
"Response": {
"RequestId": "6ca31e3a-6b8e-4b4e-9256-fdc700064ef3",
"TotalCount": 1,
"MediaInfoSet": [
{
"FileId": "5285485487985271487",
"BasicInfo": {
"Name": "Sport file",
"Description": "",
"CreateTime": "2020-12-11T07:25:52Z",
"UpdateTime": "2020-12-11T07:25:52Z",
"ExpireTime": "9999-12-31T23:59:59Z",
"ClassId": 123,
"ClassName": "Audio/Video Recording for Playback",
"ClassPath": "Audio and video recorded broadcast",
"CoverUrl": "http://example.com/xxxxxxxx/shotup/f0.100_0.jpg",
"Type": "mp4",
"MediaUrl": "http://example.com/xxx/xx/f0.mp4",
"TagSet": [
"tag1",
"tag2"
],
"SourceInfo": {
"SourceType": "Record",
"SourceContext": "",
"TrtcRecordInfo": {
"SdkAppId": 1,
"RoomId": "RoomId",
"TaskId": "TaskId",
"UserIds": [
"UserId"
]
},
"WebPageRecordInfo": null,
"LiveRecordInfo": null
},
"StorageRegion": "ap-chongqing",
"StoragePath": "/xxx/xx/f0.mp4",
"Category": "Image",
"Vid": "5285485487985271487",
"Status": "Normal",
"StorageClass": "STANDARD"
},
"MetaData": {
"Size": 10556,
"Container": "m4a",
"Duration": 3601,
"Bitrate": 246035,
"Height": 480,
"Width": 640,
"Rotate": 0,
"VideoDuration": 3601,
"AudioDuration": 3601,
"Md5": "b3ae6ed07d9bf4efeeb94ed2d37ff3e3",
"VideoStreamSet": [
{
"Bitrate": 246000,
"Height": 480,
"Width": 640,
"Codec": "h264",
"CodecTag": "avc1",
"Fps": 222,
"DynamicRangeInfo": {
"Type": "HDR",
"HDRType": "hdr10"
}
}
],
"AudioStreamSet": [
{
"Codec": "aac",
"SamplingRate": 44100,
"Bitrate": 35
}
]
},
"TranscodeInfo": {
"TranscodeSet": [
{
"Url": "http://example.com/xx/xx/f0.mp4",
"Definition": 0,
"Bitrate": 563477,
"Height": 378,
"Width": 672,
"Container": "m4a",
"Duration": 3601,
"Size": 10502,
"Md5": "b3ae6ed07d9bf4efeeb94ed2d37ff3e3",
"VideoStreamSet": [
{
"Bitrate": 246000,
"Height": 480,
"Width": 640,
"Codec": "h264",
"CodecTag": "avc1",
"Fps": 222,
"DynamicRangeInfo": {
"Type": "HDR",
"HDRType": "hdr10"
}
}
],
"AudioStreamSet": [
{
"Codec": "aac",
"SamplingRate": 44100,
"Bitrate": 35
}
],
"DigitalWatermarkType": "None",
"CopyRightWatermarkText": "None"
},
{
"Url": "http://example.com/xx/xx/f0.f210.m3u8",
"Definition": 211,
"Bitrate": 563477,
"Height": 378,
"Width": 672,
"Container": "mov",
"Duration": 3601,
"Size": 10502,
"Md5": "b3ae6ed07d9bf4efeeb94ed2d37ff3e3",
"VideoStreamSet": [
{
"Bitrate": 246000,
"Height": 480,
"Width": 640,
"Codec": "h264",
"CodecTag": "avc1",
"Fps": 222,
"DynamicRangeInfo": {
"Type": "HDR",
"HDRType": "hdr10"
}
}
],
"AudioStreamSet": [
{
"Codec": "aac",
"SamplingRate": 44100,
"Bitrate": 35
}
],
"DigitalWatermarkType": "None",
"CopyRightWatermarkText": "None"
},
{
"Url": "http://example.com/xx/xx/master_playlist.m3u8",
"Definition": 10000,
"Duration": 145,
"Size": 265,
"Bitrate": 2840055,
"Height": 1080,
"Width": 1920,
"Container": "hls,applehttp",
"Md5": "bfcf7c6f154b18890661f9e80b0731d0",
"VideoStreamSet": [
{
"Bitrate": 2794233,
"Height": 1080,
"Width": 1920,
"Codec": "h264",
"CodecTag": "avc1",
"Fps": 24,
"DynamicRangeInfo": {
"Type": "HDR",
"HDRType": "hdr10"
}
}
],
"AudioStreamSet": [
{
"SamplingRate": 44100,
"Bitrate": 45822,
"Codec": "aac"
}
],
"DigitalWatermarkType": "None",
"CopyRightWatermarkText": "None"
}
]
},
"AnimatedGraphicsInfo": {
"AnimatedGraphicsSet": [
{
"Url": "http://example.com/xx/xx/f20000.gif",
"Definition": 20000,
"Container": "gif",
"Height": 480,
"Width": 640,
"Bitrate": 1000000,
"Size": 600000,
"Md5": "bfcf7c6f154b1842a661f9e80b07a1d0",
"StartTimeOffset": 10,
"EndTimeOffset": 15
}
]
},
"SampleSnapshotInfo": {
"SampleSnapshotSet": [
{
"Definition": 10,
"SampleType": "percent",
"WaterMarkDefinition": [
0
],
"Interval": 10,
"ImageUrlSet": [
"http://example.com/xx/xx/shotup/xx1.png",
"http://example.com/xx/xx/shotup/xx2.png",
"http://example.com/xx/xx/shotup/xx3.png",
"http://example.com/xx/xx/shotup/xx4.png",
"http://example.com/xx/xx/shotup/xx5.png",
"http://example.com/xx/xx/shotup/xx6.png",
"http://example.com/xx/xx/shotup/xx7.png",
"http://example.com/xx/xx/shotup/xx8.png",
"http://example.com/xx/xx/shotup/xx9.png",
"http://example.com/xx/xx/shotup/xx10.png"
]
}
]
},
"ImageSpriteInfo": {
"ImageSpriteSet": [
{
"Definition": 10,
"Height": 576,
"Width": 1024,
"TotalCount": 100,
"ImageUrlSet": [
"http://example.com/xx/xx/imageSprite/xx.100_0.jpg"
],
"WebVttUrl": "http://example.com/xxxx/xxxx/imageSprite/xx.vtt"
}
]
},
"SnapshotByTimeOffsetInfo": {
"SnapshotByTimeOffsetSet": [
{
"Definition": 10,
"PicInfoSet": [
{
"TimeOffset": 0,
"Url": "http://example.com/xx/xx/snapshotByTime/xx1.jpg",
"WaterMarkDefinition": []
},
{
"TimeOffset": 1000,
"Url": "http://example.com/xx/xx/snapshotByTime/xx2.jpg",
"WaterMarkDefinition": []
}
]
}
]
},
"KeyFrameDescInfo": {
"KeyFrameDescSet": [
{
"TimeOffset": 1,
"Content": "Timestamp content"
},
{
"TimeOffset": 100,
"Content": "def"
}
]
},
"MiniProgramReviewInfo": {
"MiniProgramReviewList": [
{
"Url": "url",
"Definition": 0,
"ReviewResult": "Pass",
"ReviewSummary": [
{
"Confidence": 0,
"Type": "Porn",
"Suggestion": "pass"
}
],
"MetaData": {
"Rotate": 0,
"Container": "mp4",
"AudioDuration": 0,
"Md5": "md5",
"VideoStreamSet": [
{
"Width": 0,
"Codec": "h264",
"CodecTag": "avc1",
"Bitrate": 0,
"Fps": 0,
"Height": 0,
"DynamicRangeInfo": {
"Type": "HDR",
"HDRType": "hdr10"
}
}
],
"Height": 0,
"VideoDuration": 0,
"Width": 0,
"Duration": 0,
"Size": 0,
"Bitrate": 0,
"AudioStreamSet": [
{
"SamplingRate": 0,
"Codec": "h264",
"Bitrate": 0
}
]
}
}
]
},
"AdaptiveDynamicStreamingInfo": {
"AdaptiveDynamicStreamingSet": [
{
"Size": 10556,
"DrmType": "drm",
"Definition": 0,
"Url": "url",
"Package": "HLS",
"SubStreamSet": [],
"DigitalWatermarkType": "NONE",
"CopyRightWatermarkText": "NONE"
}
]
},
"SubtitleInfo": {
"SubtitleSet": [
{
"Url": "url",
"Format": "vtt",
"Name": "name",
"Language": "cn",
"Id": "id",
"Source": "UserUploaded"
}
]
},
"ReviewInfo": null
}
]
}
}TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.
| Error Code | Description |
|---|---|
| FailedOperation | Operation failed. |
| FailedOperation.InvalidVodUser | The VOD service is not activated. |
| InternalError | Internal error. |
| InternalError.GetMediaListError | Internal error: media list error. |
| InvalidParameterValue.Categories | Invalid file type. |
| InvalidParameterValue.ClassIds | Parameter value error: ClassIds is invalid. |
| InvalidParameterValue.EndTime | Parameter value error: EndTime is invalid. |
| InvalidParameterValue.FileIds | FileIds parameter error. |
| InvalidParameterValue.NamePrefixes | Invalid file name prefix. |
| InvalidParameterValue.Names | Too many elements in the Names array. |
| InvalidParameterValue.Offset | Parameter value error. Offset is invalid. |
| InvalidParameterValue.Sort | Parameter value error: Sort is invalid. |
| InvalidParameterValue.SourceType | Parameter value error: SourceType is invalid. |
| InvalidParameterValue.SourceTypes | Unknown media file source. |
| InvalidParameterValue.StartTime | Parameter value error: StartTime is invalid. |
| InvalidParameterValue.StorageRegions | Parameter value error. StorageRegions is invalid. |
| InvalidParameterValue.StreamIds | Invalid stream ID parameter. |
| InvalidParameterValue.SubAppId | Parameter value error: app ID. |
| InvalidParameterValue.Tags | Parameter value error: Tags is invalid. |
| InvalidParameterValue.Text | Parameter value error: search text. |
| InvalidParameterValue.Types | Invalid Types parameter. |
| InvalidParameterValue.Vids | Invalid Vids parameter. |
| LimitExceeded | The quota limit is exceeded. |
| UnauthorizedOperation | Unauthorized operation. |
文档反馈