1. 接口描述
接口请求域名: vod.tencentcloudapi.com 。
该 API 已经不再维护,新版播放器签名不再使用播放器配置模板,详细请参考 播放器签名。
查询播放器配置,支持根据条件,分页查询。
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:DescribeSuperPlayerConfigs。 |
Version | 是 | String | 公共参数,本接口取值:2018-07-17。 |
Region | 否 | String | 公共参数,此参数为可选参数。 |
SubAppId | 否 | Integer | 点播应用 ID。从2023年12月25日起开通点播的客户,如访问点播应用中的资源(无论是默认应用还是新创建的应用),必须将该字段填写为应用 ID。 示例值:1490012345 |
Names.N | 否 | Array of String | 播放器配置名字过滤条件,数组长度限制:100。 示例值:["test\r\n"] |
Offset | 否 | Integer | 分页偏移量,默认值:0。 示例值:0 |
Limit | 否 | Integer | 返回记录条数,默认值:10,最大值:100。 示例值:1 |
Type | 否 | String | 播放器配置类型过滤条件,可选值: 示例值:Custom |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
TotalCount | Integer | 符合过滤条件的记录总数。 示例值:1 |
PlayerConfigSet | Array of PlayerConfig | 播放器配置数组。 |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 获取播放器配置列表
输入示例
POST / HTTP/1.1
Host: vod.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeSuperPlayerConfigs
<公共请求参数>
{
"Names": [
"test"
]
}
输出示例
{
"Response": {
"TotalCount": 1,
"PlayerConfigSet": [
{
"Name": "test",
"Type": "Custom",
"DrmSwitch": "OFF",
"AdaptiveDynamicStreamingDefinition": 10,
"ImageSpriteDefinition": 10,
"ResolutionNameSet": [
{
"MinEdgeLength": 480,
"Name": "标清"
},
{
"MinEdgeLength": 1440,
"Name": "2K"
}
],
"TranscodeDefinition": 0,
"AudioVideoType": "AdaptiveDynamicStream",
"Domain": "xxx.vod2.myqcloud.com",
"Scheme": "HTTPS",
"Comment": "",
"DrmStreamingsInfo": {
"FairPlayDefinition": 0,
"SimpleAesDefinition": 0,
"WidevineDefinition": 0
},
"CreateTime": "2019-10-11T10:00:00Z",
"UpdateTime": "2019-10-11T10:00:00Z"
}
],
"RequestId": "12ae8d8e-dce3-4151-9d4b-4594145287e1"
}
}
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. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
FailedOperation | 操作失败。 |
FailedOperation.InvalidVodUser | 没有开通点播业务。 |
InternalError | 内部错误。 |
InvalidParameterValue | 参数取值错误。 |
UnauthorizedOperation | 未授权操作。 |