1. 接口描述
接口请求域名： ivld.tencentcloudapi.com 。
描述媒资文件信息，包括媒资状态，分辨率，帧率等。
如果媒资文件未完成导入，本接口将仅输出媒资文件的状态信息；导入完成后，本接口还将输出媒资文件的其他元信息。
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：DescribeMedia。 |
| Version | 是 | String | 公共参数，本接口取值：2021-09-03。 |
| Region | 是 | String | 公共参数，详见产品支持的 地域列表。 |
| MediaId | 是 | String | 导入媒资返回的媒资ID 示例值："media-2aHsU6sj" |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| MediaInfo | MediaInfo | 媒资信息 注意：此字段可能返回 null，表示取不到有效值。 |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 导入完成，返回媒资视频元信息
输入示例
POST / HTTP/1.1
Host: ivld.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeMedia
<公共请求参数>
{
"MediaId": "media-ly5qgk6j"
}输出示例
{
"Response": {
"MediaInfo": {
"DownLoadURL": "https://ai-media-1256936300.cos.ap-guangzhou.myqcloud.com/ai-media/test/test-beijingninzao-6mins.mp4",
"FailedReason": "",
"MediaId": "media-ly5qgk6j",
"Metadata": {
"BitRate": 1420,
"Duration": 356.024,
"FPS": 25,
"FileSize": 63195585,
"Height": 720,
"MD5": "b67489b0f5ca7822c94f4b6102ac7d13",
"NumFrames": 8900,
"Width": 1280
},
"Name": "demo-video-0",
"Progress": 0,
"Label": "",
"Status": 8,
"CallbackURL": "http://example.com/api/callback",
"MediaType": 1,
"AudioMetadata": null,
"ImageMetadata": null,
"TextMetadata": null
},
"RequestId": "d4c8bf8e-43ba-482a-a257-b6ac7a6296ec"
}
}示例2 导入中(正在进行转码)，此时返回的视频元信息没有意义
输入示例
POST / HTTP/1.1
Host: ivld.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeMedia
<公共请求参数>
{
"MediaId": "media-ly5qgk6j"
}输出示例
{
"Response": {
"MediaInfo": {
"DownLoadURL": "https://ai-media-1256936300.cos.ap-guangzhou.myqcloud.com/ai-media/test/test-beijingninzao-6mins.mp4",
"FailedReason": "",
"MediaId": "media-ly5qgk6j",
"Metadata": {
"BitRate": 1420,
"Duration": 356.024,
"FPS": 25,
"FileSize": 63195585,
"Height": 720,
"MD5": "b67489b0f5ca7822c94f4b6102ac7d13",
"NumFrames": 8900,
"Width": 1280
},
"Name": "demo-video-0",
"Progress": 0,
"Label": "",
"Status": 8,
"CallbackURL": "http://example.com/api/callback",
"MediaType": 1,
"AudioMetadata": null,
"ImageMetadata": null,
"TextMetadata": null
},
"RequestId": "d4c8bf8e-43ba-482a-a257-b6ac7a6296ec"
}
}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. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| AuthFailure.UserInvalidStatus | 用户状态异常。 |
| AuthFailure.UserNotFound | 用户无权限。 |
| AuthFailure.UserStopArrear | 用户已欠费停服。 |
| FailedOperation.DownloadFailed | 媒资文件下载失败。 |
| FailedOperation.MD5Mismatch | MD5不匹配。 |
| FailedOperation.MediaExpired | 媒资文件已经过期。 |
| FailedOperation.MediaNotReady | 媒体文件未就绪。 |
| FailedOperation.TranscodeFailed | 转码失败。 |
| InternalError.InnerError | 内部错误。 |
| InvalidParameter.InvalidMediaId | 媒体ID不合法。 |
| ResourceNotFound.MediaNotFound | 媒资文件不存在。 |
| UnauthorizedOperation.UnauthorizedProduct | 用户未激活该产品。 |
