搜索媒体

最近更新时间：2024-04-03 11:14:23

我的收藏

本页目录：

1. 接口描述

接口请求域名： cme.tencentcloudapi.com 。

根据检索条件搜索媒体，返回媒体的基本信息。

默认接口请求频率限制：20次/秒。

推荐使用 API Explorer

点击调试

API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见公共请求参数。

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：SearchMaterial。
Version	是	String	公共参数，本接口取值：2019-10-29。
Region	否	String	公共参数，本接口不需要传递此参数。
Platform	是	String	平台 Id，指定访问的平台。关于平台概念，请参见文档平台。示例值：test
SearchScopes.N	是	Array of SearchScope	指定搜索空间，数组长度不得超过5。
MaterialTypes.N	否	Array of String	媒体类型，可取值有： AUDIO：音频； VIDEO：视频； IMAGE：图片； VIDEO_EDIT_TEMPLATE：剪辑模板。
Text	否	String	搜索文本，模糊匹配媒体名称或描述信息，匹配项越多，匹配度越高，排序越优先。长度限制：15个字符。示例值：综艺
Resolution	否	String	按画质检索，取值为：LD/SD/HD/FHD/2K/4K。
DurationRange	否	IntegerRange	按媒体时长检索，单位s。
CreateTimeRange	否	TimeRange	按照媒体创建时间检索。
Tags.N	否	Array of String	按标签检索，填入检索的标签名。
Sort	否	SortBy	排序方式。Sort.Field 可选值：CreateTime。指定 Text 搜索时，将根据匹配度排序，该字段无效。
Offset	否	Integer	偏移量。默认值：0。示例值：0
Limit	否	Integer	返回记录条数，默认值：50。示例值：10
Operator	否	String	操作者。如不填，默认为 `cmeid_system`，表示平台管理员操作，可以搜索任意媒体的信息。如果指定操作者，则操作者必须对媒体有读权限。示例值：user_id

3. 输出参数

参数名称	类型	描述
TotalCount	Integer	符合记录总条数。示例值：1
MaterialInfoSet	Array of MaterialInfo	媒体信息，仅返回基础信息。
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 根据关键字检索媒体

检索某搜索空间下包含关键字的媒体。

输入示例

https://cme.tencentcloudapi.com/?Action=SearchMaterial
&Platform=test
&SearchScopes.0.Owner.Id=3bfd339c-4e0d-4742-933e-eb71abde0965
&SearchScopes.0.Owner.Type=PERSON
&SearchScopes.0.ClassPath=/a/b
&Text=滨海
&<公共请求参数>

输出示例

{
    "Response": {
        "TotalCount": 1,
        "MaterialInfoSet": [
            {
                "BasicInfo": {
                    "MaterialId": "5feb08c4b4e0960001ed96a5",
                    "MaterialType": "VIDEO",
                    "Name": "腾讯滨海大厦",
                    "CreateTime": "2019-12-31T03:59:14Z",
                    "UpdateTime": "2019-12-31T03:59:14Z",
                    "ClassPath": "/a/b",
                    "TagSet": [],
                    "TagInfoSet": [],
                    "PresetTagSet": [],
                    "PreviewUrl": "http://1810000002.vod2.myqcloud.com/8d388656vodtranscq1810000002/accfa04c5285890797261730431/coverBySnapshot/1577764755_4069421039.100_0.jpg",
                    "Owner": {
                        "Type": "PERSON",
                        "Id": "3bfd339c-4e0d-4742-933e-eb71abde0965"
                    }
                },
                "ImageMaterial": null,
                "LinkMaterial": null,
                "AudioMaterial": null,
                "VideoMaterial": null,
                "VideoEditTemplateMaterial": null,
                "OtherMaterial": null
            }
        ],
        "RequestId": "7bf08361-4455-4cbd-afd6-423b62c54a05"
    }
}

示例2 根据媒体类型检索媒体

检索某搜索空间下媒体类型为VIDEO的媒体。

输入示例

https://cme.tencentcloudapi.com/?Action=SearchMaterial
&Platform=test
&SearchScopes.0.Owner.Id=3bfd339c-4e0d-4742-933e-eb71abde0965
&SearchScopes.0.Owner.Type=PERSON
&SearchScopes.0.ClassPath=/a/b
&MaterialTypes.0=VIDEO
&<公共请求参数>

输出示例

{
    "Response": {
        "TotalCount": 1,
        "MaterialInfoSet": [
            {
                "BasicInfo": {
                    "MaterialId": "5feb08c4b4e0960001ed96a4",
                    "MaterialType": "VIDEO",
                    "Name": "9Qvacao2r7EA",
                    "CreateTime": "2019-12-31T03:59:14Z",
                    "UpdateTime": "2019-12-31T03:59:14Z",
                    "ClassPath": "/a/b",
                    "TagSet": [],
                    "TagInfoSet": [],
                    "PresetTagSet": [],
                    "PreviewUrl": "http://1810000002.vod2.myqcloud.com/8d388656vodtranscq1810000002/accfa04c5285890797261730431/coverBySnapshot/1577764755_4069421039.100_0.jpg",
                    "Owner": {
                        "Type": "PERSON",
                        "Id": "3bfd339c-4e0d-4742-933e-eb71abde0965"
                    }
                },
                "ImageMaterial": null,
                "LinkMaterial": null,
                "AudioMaterial": null,
                "VideoMaterial": null,
                "VideoEditTemplateMaterial": null,
                "OtherMaterial": null
            }
        ],
        "RequestId": "7bf08361-4455-4cbd-afd6-423b62c54a05"
    }
}

示例3 根据搜索空间检索媒体

检索某搜索空间下的媒体。

输入示例

https://cme.tencentcloudapi.com/?Action=SearchMaterial
&Platform=test
&SearchScopes.0.Owner.Id=3bfd339c-4e0d-4742-933e-eb71abde0965
&SearchScopes.0.Owner.Type=PERSON
&SearchScopes.0.ClassPath=/a/b
&<公共请求参数>

输出示例

{
    "Response": {
        "TotalCount": 1,
        "MaterialInfoSet": [
            {
                "BasicInfo": {
                    "MaterialId": "5feb08c4b4e0960001ed96a4",
                    "MaterialType": "VIDEO",
                    "Name": "9Qvacao2r7EA",
                    "CreateTime": "2019-12-31T03:59:14Z",
                    "UpdateTime": "2019-12-31T03:59:14Z",
                    "ClassPath": "/a/b",
                    "TagSet": [],
                    "TagInfoSet": [],
                    "PresetTagSet": [],
                    "PreviewUrl": "http://1810000002.vod2.myqcloud.com/8d388656vodtranscq1810000002/accfa04c5285890797261730431/coverBySnapshot/1577764755_4069421039.100_0.jpg",
                    "Owner": {
                        "Type": "PERSON",
                        "Id": "3bfd339c-4e0d-4742-933e-eb71abde0965"
                    }
                },
                "ImageMaterial": null,
                "LinkMaterial": null,
                "AudioMaterial": null,
                "VideoMaterial": null,
                "VideoEditTemplateMaterial": null,
                "OtherMaterial": null
            }
        ],
        "RequestId": "7bf08361-4455-4cbd-afd6-423b62c54a05"
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台，方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况，并自动生成各语言版本的 API 代码，也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集（SDK），支持多种编程语言，能更方便的调用 API。

Tencent Cloud SDK 3.0 for Python: GitHub Gitee
Tencent Cloud SDK 3.0 for Java: GitHub Gitee
Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
Tencent Cloud SDK 3.0 for Go: GitHub Gitee
Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
Tencent Cloud SDK 3.0 for C++: GitHub Gitee
Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee

命令行工具

Tencent Cloud CLI 3.0

6. 错误码

以下仅列出了接口业务逻辑相关的错误码，其他错误码详见公共错误码。

错误码	描述
InternalError	内部错误。
InvalidParameterValue	参数取值错误。
InvalidParameterValue.ClassPath	分类路径不合法。
InvalidParameterValue.DataNotFoundInDB	查询不到数据。
InvalidParameterValue.OwnerId	归属者 ID 不合法。
InvalidParameterValue.OwnerType	归属者类型不合法。
InvalidParameterValue.Platform	平台参数取值错误。
OperationDenied.PermissionDeny	权限不足，请检查对应操作者的权限。
ResourceNotFound.Platform	平台不存在。
UnauthorizedOperation	未授权操作。

上一篇: 平铺浏览媒体下一篇: 修改媒体信息