有奖捉虫:办公协同&微信生态&物联网文档专题 HOT

1. 接口描述

接口请求域名: ivld.tencentcloudapi.com 。

依照输入条件,描述命中的媒资文件信息,包括媒资状态,分辨率,帧率等。

请注意,本接口最多支持同时描述50个媒资文件

如果媒资文件未完成导入,本接口将仅输出媒资文件的状态信息;导入完成后,本接口还将输出媒资文件的其他元信息。

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeMedias。
Version String 公共参数,本接口取值:2021-09-03。
Region String 公共参数,详见产品支持的 地域列表
PageNumber Integer 分页序号,从1开始
示例值:1
PageSize Integer 每个分页所包含的元素数量,最大为50
示例值:15
MediaFilter MediaFilter 列举过滤条件,相关限制相见MediaFilter
SortBy SortBy 返回结果排序信息,By字段只支持CreateTime

3. 输出参数

参数名称 类型 描述
TotalCount Integer 满足过滤条件的媒资视频总数量
示例值:100
MediaInfoSet Array of MediaInfo 满足过滤条件的媒资信息
注意:此字段可能返回 null,表示取不到有效值。
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 列举前2个成功完成的媒资文件

输入示例

POST / HTTP/1.1
Host: ivld.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeMedias
<公共请求参数>

{
    "MediaFilter": {
        "StatusSet": [
            8
        ]
    },
    "PageNumber": 1,
    "PageSize": 2
}

输出示例

{
    "Response": {
        "MediaInfoSet": [
            {
                "DownLoadURL": "https://ai-media-1256936300.cos.ap-guangzhou.myqcloud.com/ai-media/test-news.mov",
                "FailedReason": "",
                "MediaId": "media-es88zd2m",
                "Metadata": {
                    "BitRate": 258778,
                    "Duration": 43.211,
                    "FPS": 30,
                    "FileSize": 1397761,
                    "Height": 480,
                    "MD5": "6348474d783a56de32b4b2ac42e74d79",
                    "NumFrames": 0,
                    "Width": 848
                },
                "Name": "demo-video-1",
                "Progress": 0,
                "Status": 8
            },
            {
                "DownLoadURL": "https://ai-media-1256936300.cos.ap-guangzhou.myqcloud.com/ai-media/test-news-1.mov",
                "FailedReason": "",
                "MediaId": "media-t9Igr9jf",
                "Metadata": {
                    "BitRate": 258778,
                    "Duration": 43.211,
                    "FPS": 30,
                    "FileSize": 1397761,
                    "Height": 480,
                    "MD5": "6348474d783a56de32b4b2ac42e74d79",
                    "NumFrames": 0,
                    "Width": 848
                },
                "Name": "demo-video-3.mov",
                "Progress": 0,
                "Status": 8
            }
        ],
        "RequestId": "d56d17ca-fa6f-4040-8627-328a08e7a857",
        "TotalCount": 11
    }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

命令行工具

6. 错误码

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

错误码 描述
AuthFailure.UserInvalidStatus 用户状态异常。
AuthFailure.UserNotFound 用户无权限。
AuthFailure.UserStopArrear 用户已欠费停服。
FailedOperation.MediaAlreadyExist 媒资文件已经存在。
InternalError.DBOperationError 内部DB操作错误。
InternalError.InnerError 内部错误。
InvalidParameter.InvalidMD5 MD5不合法。
InvalidParameter.InvalidMediaId 媒体ID不合法。
InvalidParameter.InvalidMediaName 媒体名称非法。
InvalidParameter.InvalidMediaStatus 媒资状态不合法。
InvalidParameter.InvalidMediaType MediaType无效。
InvalidParameter.InvalidName 名称不合法。
InvalidParameter.InvalidPageNumber 分页序号不合法。
InvalidParameter.InvalidPageSize 分页大小不合法。
InvalidParameter.InvalidSortBy 排序字段不合法。
InvalidParameter.InvalidSortOrder 排序方式不合法。
InvalidParameter.InvalidURL URL不合法。
InvalidParameter.InvalidUin 用户Uin无效。
InvalidParameter.NameTooLong 名称超过长度限制。
InvalidParameter.UnsupportURL 不支持的URL类型。
UnauthorizedOperation.UnauthorizedProduct 用户未激活该产品。