1. 接口描述
接口请求域名: cme.tencentcloudapi.com 。
根据媒体 Id 批量获取媒体详情。
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:DescribeMaterials。 |
Version | 是 | String | 公共参数,本接口取值:2019-10-29。 |
Region | 否 | String | 公共参数,本接口不需要传递此参数。 |
Platform | 是 | String | 平台 Id,指定访问的平台。关于平台概念,请参见文档 平台。 示例值:test |
MaterialIds.N | 是 | Array of String | 媒体 ID 列表,一次最多可拉取20个媒体的信息。 示例值:["5fd8ad3d628dc30001bd0895"] |
Sort | 否 | SortBy | 列表排序,支持下列排序字段: |
Operator | 否 | String | 操作者。如不填,默认为 cmeid_system ,表示平台管理员操作,可以获取任意媒体的信息。如果指定操作者,则操作者必须对媒体有读权限。示例值:60097a8a8ea83d00017b484b |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
MaterialInfoSet | Array of MaterialInfo | 媒体列表信息。 |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 获取图片媒体详情
输入示例
https://cme.tencentcloudapi.com/?Action=DescribeMaterials
&Platform=test
&MaterialIds.0=5fd8ad3d628dc30001bd08894
&Operator=user_id4114428941bd0420
&<公共请求参数>
输出示例
{
"Response": {
"MaterialInfoSet": [
{
"AudioMaterial": null,
"BasicInfo": {
"ClassPath": "",
"CreateTime": "2019-10-28T12:10:25Z",
"MaterialId": "5fd8ad3d628dc30001bd08894",
"MaterialType": "IMAGE",
"Name": "dzq1.png",
"Owner": {
"Id": "03ce2cd6-a889-4e4d-95a7-876e44f21831",
"Type": "PERSON"
},
"PreviewUrl": "https://1810000002.vod2.myqcloud.com/b64e98aevodcq1810000002/0d014fa85285890795320102944/j5dCbqBV72QA.png",
"TagSet": [],
"TagInfoSet": [],
"PresetTagSet": [],
"UpdateTime": "2019-10-28T12:10:25Z"
},
"ImageMaterial": {
"Height": 153,
"MaterialUrl": "https://1810000002.vod2.myqcloud.com/b64e98aevodcq1810000002/0d014fa85285890795320102944/j5dCbqBV72QA.png",
"Size": 52421,
"Width": 213
},
"LinkMaterial": null,
"VideoMaterial": null,
"VideoEditTemplateMaterial": null,
"OtherMaterial": null
}
],
"RequestId": "964aae95-7344-4200-8962-92a44ff7a2aa"
}
}
示例2 获取视频媒体详情
视频媒体
输入示例
https://cme.tencentcloudapi.com/?Action=DescribeMaterials
&Platform=test
&MaterialIds.0=5fd8ad3d628dc30001bd0895
&Operator=user_id4114428941bd0420
&<公共请求参数>
输出示例
{
"Response": {
"MaterialInfoSet": [
{
"BasicInfo": {
"MaterialId": "5fd8ad3d628dc30001bd0895",
"MaterialType": "VIDEO",
"Name": "9Qvacao2r7EA",
"CreateTime": "2019-12-31T03:59:14Z",
"UpdateTime": "2019-12-31T03:59:14Z",
"ClassPath": "/",
"TagSet": [],
"TagInfoSet": [],
"PresetTagSet": [],
"PreviewUrl": "http://1810000002.vod2.myqcloud.com/8d388656vodtranscq1810000002/accfa04c5285890797261730431/coverBySnapshot/1577764755_4069421039.100_0.jpg",
"Owner": {
"Type": "PERSON",
"Id": "6b6ef043-85f3-4614-b735-768bb466ae5b"
}
},
"ImageMaterial": null,
"LinkMaterial": null,
"AudioMaterial": null,
"VideoEditTemplateMaterial": null,
"OtherMaterial": null,
"VideoMaterial": {
"MaterialStatus": {
"EditorUsableStatus": "NORMAL"
},
"MetaData": {
"Size": 2148950,
"Container": "mov,mp4,m4a,3gp,3g2,mj2",
"Bitrate": 242237,
"Height": 270,
"Width": 480,
"Duration": 69.4729995727539,
"Rotate": 0,
"VideoStreamInfoSet": [
{
"Bitrate": 209241,
"Height": 270,
"Width": 480,
"Codec": "h264",
"Fps": 24
}
],
"AudioStreamInfoSet": [
{
"Bitrate": 32996,
"SamplingRate": 48000,
"Codec": "aac"
}
]
},
"ImageSpriteInfo": {
"Height": 80,
"Width": 142,
"TotalCount": 70,
"ImageUrlSet": [
"http://1810000002.vod2.myqcloud.com/8d388656vodtranscq1810000002/accfa04c5285890797261730431/imageSprite/1577764755_3800596325.100_0.jpg"
],
"WebVttUrl": "http://1810000002.vod2.myqcloud.com/8d388656vodtranscq1810000002/accfa04c5285890797261730431/imageSprite/1577764755.vtt"
},
"MaterialUrl": "https://1810000002.vod2.myqcloud.com/8d388656vodtranscq1810000002/accfa04c5285890797261730431/v.f50000.m3u8?t=5e572824&sign=f3a588b4c37d047bd2df6b02ecf11ed8",
"CoverUrl": "http://1810000002.vod2.myqcloud.com/8d388656vodtranscq1810000002/accfa04c5285890797261730431/coverBySnapshot/1577764755_4069421039.100_0.jpg",
"Resolution": "SD"
}
}
],
"RequestId": "85b8cdac-8e18-430a-aeae-08076ac26a11"
}
}
示例3 获取音频媒体详情
音频媒体
输入示例
https://cme.tencentcloudapi.com/?Action=DescribeMaterials
&Platform=test
&MaterialIds.0=5fd8ad3d628dc30001bd08893
&Operator=user_id4114428941bd0420
&<公共请求参数>
输出示例
{
"Response": {
"MaterialInfoSet": [
{
"AudioMaterial": {
"CoverUrl": "",
"MaterialStatus": {
"EditorUsableStatus": "NORMAL"
},
"MaterialUrl": "https://1810000002.vod2.myqcloud.com/b64e98aevodcq1810000002/6df9fb785285890795345485561/FOMbrvcsytgA.mp3?t=5eaa3d36&sign=72576faefb2863396f2775bd45259a44",
"MetaData": {
"AudioStreamInfoSet": [
{
"Bitrate": 320000,
"Codec": "mp3",
"SamplingRate": 44100
}
],
"Bitrate": 320047,
"Container": "mp3",
"Duration": 221.04815673828,
"Height": 0,
"Rotate": 0,
"Size": 8843241,
"VideoStreamInfoSet": [],
"Width": 0
}
},
"BasicInfo": {
"ClassPath": "",
"CreateTime": "2019-10-29T09:36:33Z",
"MaterialId": "5fd8ad3d628dc30001bd08893",
"MaterialType": "AUDIO",
"Name": "Fgi.mp3",
"Owner": {
"Id": "03ce2cd6-a889-4e4d-95a7-876e44f21831",
"Type": "PERSON"
},
"PreviewUrl": "",
"TagSet": [],
"TagInfoSet": [],
"PresetTagSet": [],
"UpdateTime": "2019-10-29T09:37:29Z"
},
"ImageMaterial": null,
"LinkMaterial": null,
"VideoMaterial": null,
"VideoEditTemplateMaterial": null,
"OtherMaterial": null
}
],
"RequestId": "964aae95-7344-4200-8962-92a44ff7a2ac"
}
}
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
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
InternalError | 内部错误。 |
InvalidParameterValue | 参数取值错误。 |
InvalidParameterValue.Platform | 平台参数取值错误。 |
OperationDenied.PermissionDeny | 权限不足,请检查对应操作者的权限。 |
ResourceNotFound | 资源不存在。 |
ResourceNotFound.Platform | 平台不存在。 |
UnauthorizedOperation | 未授权操作。 |