1. 接口描述
接口请求域名: mps.tencentcloudapi.com 。
获取直播录制模板
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:DescribeLiveRecordTemplates。 |
Version | 是 | String | 公共参数,本接口取值:2019-06-12。 |
Region | 否 | String | 公共参数,本接口不需要传递此参数。 |
Definitions.N | 否 | Array of Integer | 录制模板唯一标识过滤条件,数组长度限制:100。 示例值:[20001] |
Offset | 否 | Integer | 分页偏移量,默认值:0。 示例值:0 |
Limit | 否 | Integer | 返回记录条数,默认值:10,最大值:100。 示例值:10 |
Type | 否 | String | 模板类型过滤条件,不填则返回所有,可选值: * Preset:系统预置模板; * Custom:用户自定义模板。 示例值:"" |
Name | 否 | String | 录制模板标识过滤条件,长度限制:64 个字符。 示例值:"" |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
TotalCount | Integer | 符合过滤条件的记录总数。 示例值:1 |
LiveRecordTemplateSet | Array of LiveRecordTemplate | 录制模板详情列表。 |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 获取直播录制模板
获取直播录制模板
输入示例
POST / HTTP/1.1
Host: mps.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeLiveRecordTemplates
<公共请求参数>
{
"Definitions": [
20001
]
}
输出示例
{
"Response": {
"TotalCount": 1,
"LiveRecordTemplateSet": [
{
"Definition": 20001,
"HLSConfigure": {
"ItemDuration": 10,
"Interval": 3600
},
"Name": "模板1",
"Comment": "",
"Type": "Preset",
"CreateTime": "2023-05-04T10:00:00Z",
"UpdateTime": "2023-05-04T10:00:00Z"
}
],
"RequestId": "12ae8d8e-dce3-4151-9d4b-5594145287e1"
}
}
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 | 内部错误。 |
InternalError.AccessDBError | 数据错误。 |
InvalidParameterValue | 参数取值错误。 |
InvalidParameterValue.Limit | 参数错误:Limit。 |