StreamLive API 参考
StreamLive 的 API 服务代码为 mdl,API 版本为 2020-03-26。按安全组 → 输入 → 频道的顺序创建,启动频道后确认实际接收与播放情况。
调用规范
| 项目 | 值 |
|---|---|
| Endpoint | POST https://mdl.tencentcloudapi.com |
| Action | 参见下方 API 列表 |
| 请求签名 | 使用官方 SDK / TCCLI 的 Tencent Cloud API 3.0 签名 |
基本信息
| 项目 | 值 |
|---|---|
| API 服务代码 | mdl |
| API 版本 | 2020-03-26 |
| 认证 | Tencent Cloud API 3.0 / TC3-HMAC-SHA256 |
| 调用工具 | Tencent Cloud SDK / TCCLI |
执行前准备
配置 TCCLI 的认证与权限。示例地域为 ap-seoul,REPLACE_ 标识符与文档用 IP 203.0.113.10/32 需替换为实际值。重新执行创建命令前,请确认已有的创建结果。
API 列表与请求参数
| Action | 操作 |
|---|---|
CreateStreamLiveInputSecurityGroup | 创建 |
DescribeStreamLiveInputSecurityGroups | 查询 |
CreateStreamLiveInput | 创建 |
DescribeStreamLiveInput | 查询 |
CreateStreamLiveChannel | 创建 |
DescribeStreamLiveChannel | 查询 |
StartStreamLiveChannel | 启动 |
StopStreamLiveChannel | 停止 |
响应与执行流程
请保存创建响应中返回的资源 ID,并通过查询 API 确认状态。创建请求成功与实际输入接收、输出传输成功需区分开来。确认该资源的状态后再执行下一步。
错误与调用限制
连接确认
| 现象 | 确认事项 |
|---|---|
| CLI Action | 确认 Action 名称与 TCCLI 版本是否准确 |
| 输入信号 — | 推流地址、AppName / StreamName、输入安全组 |
| 模板名称 | 英文 / 数字 1~20 位 |
| 仅输出一种画质 | Outputs 与各模板的绑定、实际主播放列表 |
| 频道修改 | 确认操作对象与所需的频道状态 |
提交请求类咨询时,请提供 Action、地域、响应码、RequestId 与发生时间。测试结束后清理传输 / 存储 / 分发资源。
请求示例
1. 输入安全组
安全组创建 API 为 CreateStreamLiveInputSecurityGroup。
tccli mdl CreateStreamLiveInputSecurityGroup --region ap-seoul \
--Name demo_source_allowlist --Whitelist '["203.0.113.10/32"]'需允许实际推流方的公网 IP。若前置使用了 StreamLink,需确认的是 StreamLink 发起连接所用的推流侧地址,而不是观众或操作 PC 的 IP。
| 操作 | Action |
|---|---|
| 创建 | CreateStreamLiveInputSecurityGroup |
| 列表查询 | DescribeStreamLiveInputSecurityGroups |
| 详情查询 | DescribeStreamLiveInputSecurityGroup |
| 修改 | ModifyStreamLiveInputSecurityGroup |
| 删除 | DeleteStreamLiveInputSecurityGroup |
tccli mdl DescribeStreamLiveInputSecurityGroups --region ap-seoul在创建或查询响应中确认要使用的安全组 ID。该输入安全组是与普通 CVM/VPC 安全组不同的 StreamLive 资源。
2. 创建 RTMP 输入
tccli mdl CreateStreamLiveInput --region ap-seoul \
--Name demo_input --Type RTMP_PUSH \
--SecurityGroupIds '["REPLACE_SECURITY_GROUP_ID"]' \
--InputSettings '[{"AppName":"demo","StreamName":"source"}]'上述配置为 RTMP_PUSH 示例。Pull 类型需确认源 URL,SRT 类型需确认相应的 SRT 配置。一个输入只能关联一个安全组。
tccli mdl DescribeStreamLiveInput --region ap-seoul --Id REPLACE_INPUT_ID使用查询响应或控制台中显示的推流地址。
3. 创建频道
将 频道配置 中的 JSON 保存为 channel.json,并替换输入 ID 与 StreamPackage 频道 ID。
tccli mdl CreateStreamLiveChannel --region ap-seoul --cli-input-json file://channel.json| 配置 | 作用 |
|---|---|
AttachedInputs | 要连接的输入 |
AVTemplates | 视频 / 音频合并型模板 |
AudioTemplates, VideoTemplates | 分离型音频 / 视频模板 |
OutputGroups | 输出方式、按画质输出、目的地 |
在合并型示例中,每个按画质划分的 Output 各关联一个模板。
4. 查询 / 启动
tccli mdl DescribeStreamLiveChannel --region ap-seoul --Id REPLACE_CHANNEL_ID
tccli mdl StartStreamLiveChannel --region ap-seoul --Id REPLACE_CHANNEL_ID执行后确认频道状态、输入信号、输出列表、打包器接收情况以及播放器播放情况。
5. 停止与变更
tccli mdl StopStreamLiveChannel --region ap-seoul --Id REPLACE_CHANNEL_ID需要停止频道的变更,请在维护时段或准备好备用路径后,于 IDLE 状态下应用。