StreamLink API Reference
StreamLink 的 API 服务代码为 mdc,API 版本为 2020-08-28。以下示例说明将首尔地域的 RTMP 输入传递到 StreamLive 的基本配置。
调用规范
| 项目 | 值 |
|---|---|
| Endpoint | POST https://mdc.tencentcloudapi.com |
| Action | 参考下方 API 列表 |
| 请求签名 | 使用官方 SDK / TCCLI 的 Tencent Cloud API 3.0 签名 |
基本信息
| 项目 | 值 |
|---|---|
| API 服务代码 | mdc |
| API 版本 | 2020-08-28 |
| 认证 | Tencent Cloud API 3.0 / TC3-HMAC-SHA256 |
| 调用工具 | Tencent Cloud SDK / TCCLI |
执行前确认
- 安全配置 TCCLI 认证,并确认对相应资源的创建 / 查询 / 启动 / 停止权限。
- 以
REPLACE_开头的值需替换为实际资源值。 203.0.113.10/32是文档用 IP。请替换为实际推流设备的公网 IP。- 创建命令会新建资源。重复执行同一命令前,请先查询已有的创建结果。
API 列表与请求参数
| Action | 动作 |
|---|---|
CreateStreamLinkFlow | 创建 |
CreateStreamLinkInput | 创建 |
DescribeStreamLinkFlow | 查询 |
CreateStreamLinkOutputInfo | 创建 |
StartStreamLinkFlow | 启动 |
StopStreamLinkFlow | 停止 |
响应与执行流程
请保存创建响应中返回的资源 ID,并通过查询 API 确认状态。需区分创建请求成功与实际的输入接收、输出传输成功。确认相应资源的状态后再执行下一步。
错误与调用限制
连接确认
| 现象 | 确认事项 |
|---|---|
InvalidParameter.MaxBandwidth | bps 单位与允许值 |
| Flow ID 解析结果确认 | 原始 HTTP 与 CLI 响应的封装差异、Info.FlowId 位置 |
| 创建请求后结果不明 | 重复同一创建请求前先进行列表与详情查询 |
| 输入连接结果确认 | 允许的 IP、输入地址、AppName / Stream Key |
| 输入正常但输出 — | 输出类型 / 目标地址、接收端状态、输出连接日志 |
提交咨询请求时,请提供 Action、地域、响应码、RequestId 和发生时间。认证值请另行保存。
请求示例
1. Flow 创建
tccli mdc CreateStreamLinkFlow --region ap-seoul \
--FlowName demo_flow \
--MaxBandwidth 20000000MaxBandwidth 是 bps 单位的必填值。官方 API 的允许值为 10,000,000 / 20,000,000 / 50,000,000。若要关联 Event,请将相应的 Event ID 指定为 EventId。
官方原始 HTTP 响应的标识符路径为 Response.Info.FlowId。以下是用于说明结构的响应。
{
"Response": {
"Info": {
"FlowId": "REPLACE_FLOW_ID",
"FlowName": "demo_flow",
"MaxBandwidth": 20000000,
"State": "IDLE",
"InputGroup": ,
"OutputGroup":
},
"RequestId": "REPLACE_REQUEST_ID"
}
}TCCLI 输出可能会去掉 Response 封装,因此请确认实际输出结构。
2. 添加输入
tccli mdc CreateStreamLinkInput --region ap-seoul \
--FlowId REPLACE_FLOW_ID \
--InputGroup '[{"InputName":"demo_input","Protocol":"RTMP","AllowIpList":["203.0.113.10/32"]}]'API 的 RTMP 为输入类型。请确认控制台 RTMP_PUSH 与连接方向,并将推流 IP 加入允许列表。
创建后请在详情查询中确认输入地址与 RTMP 设置。
tccli mdc DescribeStreamLinkFlow --region ap-seoul --FlowId REPLACE_FLOW_IDRTMP 推流 URL 使用输入响应中的 IP / 端口 / AppName / StreamKey。若程序分别接收服务器 URL 与 Stream Key,请分开填写。
3. 添加发送到 StreamLive 的输出
将以下 JSON 保存为 link-output.json。Flow ID、目标 URL、Stream Key 请替换为实际的 StreamLive 输入信息。
{
"FlowId": "REPLACE_FLOW_ID",
"Output": {
"OutputName": "demo_to_live",
"Protocol": "RTMP",
"OutputRegion": "ap-seoul",
"RTMPSettings": {
"Destinations": [
{
"Url": "rtmp://REPLACE_INPUT_HOST/REPLACE_APP_NAME",
"StreamKey": "REPLACE_STREAM_KEY"
}
]
}
}
}tccli mdc CreateStreamLinkOutputInfo --region ap-seoul --cli-input-json file://link-output.json此 API 用于为 FlowId 指定的 Flow 创建输出。创建后请在详情查询中确认 OutputGroup 中是否包含目标地址。
4. 启动与确认
tccli mdc StartStreamLinkFlow --region ap-seoul --FlowId REPLACE_FLOW_ID按顺序确认 Flow 运行状态、输入码率、输出码率、StreamLive 输入接收情况。控制 API 的成功响应与媒体传输成功不同。
5. 结束
测试结束后,请确认目标 Flow 并将其停止。
tccli mdc StopStreamLinkFlow --region ap-seoul --FlowId REPLACE_FLOW_ID输入 / 输出节点的运行与传输可能产生费用。