跳到内容

StreamPackage API Reference ​

更新时间

StreamPackage 的 API 服务代码为 mdp,API 版本为 2020-05-27。基本顺序是:创建频道 → 确认输入 → 创建端点 → 确认播放 → 对接 CDN。

调用规格 ​

项目值
EndpointPOST https://mdp.tencentcloudapi.com
Action参见下方 API 列表
请求签名使用官方 SDK / TCCLI 的 Tencent Cloud API 3.0 签名

基本信息 ​

项目值
API 服务代码mdp
API 版本2020-05-27
认证Tencent Cloud API 3.0 / TC3-HMAC-SHA256
调用工具Tencent Cloud SDK / TCCLI

执行前准备 ​

配置 TCCLI 认证与权限。示例地域为 ap-seoul,以 REPLACE_ 开头的值请替换为实际值。JSON 文件中的布尔值请使用 true 与 false。

API 列表与请求参数 ​

Action动作
CreateStreamPackageChannel创建
DescribeStreamPackageChannel查询
CreateStreamPackageChannelEndpoint创建
BindNewLVBDomainWithChannel变更配置

响应与执行流程 ​

请保存创建响应中返回的资源 ID,并通过查询 API 确认状态。创建请求成功与实际的输入接收、输出传输成功是两回事,需加以区分。请在确认该资源的状态之后再执行下一步。

错误与调用限制 ​

连接确认 ​

症状优先确认项
Unknown option该 Action 是否存在该字段,以及 TCCLI 版本
JSON字符串引号、数组 / 对象结构、小写布尔值
端点 403IP 放通列表、AuthKey 请求头、CDN 回源请求
仅在 CDN 上需确认结果DNS、TLS、CDN 证书与回源访问策略
列表能打开但不前进输入是否持续、缓存响应、分片更新

请记录 Action、地域、RequestId、响应码与发生时刻。并从共享日志中移除 URL 签名 / 密码 / 认证密钥。

请求示例 ​

1. 创建 / 查询频道 ​

bash
tccli mdp CreateStreamPackageChannel --region ap-seoul --Name demo_package --Protocol HLS

确认创建响应中的频道 ID。

bash
tccli mdp DescribeStreamPackageChannel --region ap-seoul --Id REPLACE_CHANNEL_ID

在查询响应中确认输入地址与端点。基础创建请求只需包含必填项。

2. 创建 HLS 端点 ​

将下面的 JSON 保存为 package-endpoint.json。其中的 IP 是文档示例地址,请替换为实际要放通的请求来源。如果通过 CDN 访问,则必须先确认 CDN 的回源请求来源与访问控制设计。

json
{
  "Id": "REPLACE_CHANNEL_ID",
  "Name": "demo_hls",
  "Protocol": "HLS",
  "Manifest": "main",
  "AuthInfo": {
    "WhiteIpList": [
      "203.0.113.10/32"
    ],
    "BlackIpList": ,
    "AuthKey": ""
  },
  "TimeShiftEnable": false
}
bash
tccli mdp CreateStreamPackageChannelEndpoint --region ap-seoul --cli-input-json file://package-endpoint.json

本示例使用基于放通 IP 的访问控制。AuthKey 方式应用在请求的 X-TENCENT-PACKAGE 请求头上,而输入 HTTP 认证需单独配置。

生成的 URL 可从 API 响应或频道详情查询中获取。时移 / CMAF / DRM 请先在 端点配置 中确认支持条件后再添加。

3. 播放验证 ​

从 StreamLive 或推流系统向频道发送信号后,确认端点的播放列表是否在更新。还需确认子播放列表与分片请求、以及视频 / 音频播放,基础对接才算完成。

4. 对接 CDN ​

请在完成 CSS 开通、服务间权限、播放域名准备之后再执行。play.example.com 请替换为你实际持有并已配置的域名。

bash
tccli mdp BindNewLVBDomainWithChannel --region ap-seoul \
  --ChannelId REPLACE_CHANNEL_ID --LVBDomain play.example.com

对接成功之后,仍需确认 CNAME、HTTPS 证书、回源访问控制,以及播放列表 / 分片的播放。详细顺序请参考 CSS CDN 对接。

结果与资源管理 ​

变更 / 删除 API ​

用途Action注意事项
修改频道ModifyStreamPackageChannel先查询当前配置
修改端点ModifyStreamPackageChannelEndpoint指定准确的频道 ID 与端点 URL,并保留既有认证配置
变更输入认证ModifyStreamPackageChannelInputAuthInfo需与推流侧的认证信息一并变更
解除 CDN 对接UnbindCdnDomainWithChannel确认对生产域名播放的影响
删除端点DeleteStreamPackageChannelEndpoints确认是否为正在使用的播放 URL
删除频道DeleteStreamPackageChannels先清理已关联的端点

请先查询当前的认证配置,再应用要修改的项。创建 / 变更认证 / 删除都应逐步确认各阶段的结果后再推进。

SSAI 与 Harvest 的区分 ​

SSAI 是包含 ADS、广告标记、会话、广告素材投放路径的独立配置。请先确认普通 HLS 播放,再按相应的 SSAI 配置方式选择 API。

Harvest Job 是将已保存的历史片段存储为 COS 的任务。请先确认对象 / 时间范围 / COS 权限,并遵循 Harvest Job 的流程。

引擎目录与相关文档 ​

参考文档 ​

基于 VitePress 构建 · 部署于腾讯云 EdgeOne Pages