最近更新时间:2023.09.25 21:10:01
首次发布时间:2022.09.27 17:56:43
调用接口生成拉流地址。
说明
该接口数据历史版本 API,我们计划于 2023 年 12 月 25 日停止对其进行维护,并于 2024 年 3 月 25 日下线文档,建议您使用新版生成拉流地址接口。
请求频率:单用户请求频率限制为 25 次/秒。
下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。
参数 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | GeneratePlayURL | 接口名称。当前 API 的名称为 GeneratePlayURL 。 |
Version | String | 是 | 2020-08-01 | 接口版本。当前 API 的版本为 2020-08-01 。 |
参数 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
App | String | 是 | live | 应用名称,默认为所有应用名称,由 1 到 30 位数字、字母、下划线及"-"和"."组成。 |
Domain | String | 是 | pull.example.com | 拉流域名 |
Stream | String | 是 | stream001 | 流名称 |
Type | String | 否 |
| CDN 类型,默认值为 fcdn,支持如下取值。
|
Suffix | String | 否 | hd | 转码流后缀,不传默认为空,可通过调用 ListVhostTransCodePreset 接口查询。 |
ValidDuration | Integer | 否 |
| 有效时长,拉流地址的有效时间,过期后需要重新生成。单位为秒,取值 ﹥0,缺省情况下表示 7 天。 说明 如果同时设置 |
ExpiredTime | String | 否 |
| 过期时间,拉流地址的有效时间,过期后需要重新生成。RFC3339 格式的 UTC 时间,精度为秒,缺省情况下表示 7 天。 说明 如果同时设置 |
下表仅列出本接口特有的返回参数。更多信息请见返回结构。
参数 | 类型 | 示例值 | 描述 |
---|---|---|---|
URLList | Array of URLList | - | 拉流地址信息列表 |
参数 | 类型 | 示例值 | 描述 |
---|---|---|---|
URL | String | http://pull.example.com/live/stream001.sdp | 生成的拉流地址 |
Type | String |
| 地址类型,可能的值为:
|
CDN | String |
| CDN 类型。
|
Protocol | String | hls | 协议类型,包括 hls、flv 和 rtmp |
POST https://live.volcengineapi.com?Action=GeneratePlayURL&Version=2020-08-01 { "Domain": "pull.example.com", "App": "live", "Stream": "stream001", "ExpiredTime": "2022-08-19T16:07:25+08:00" }
{ "ResponseMetadata": { "RequestId": "2022081915573801022524312506B8B2EA", "Action": "GeneratePlayURL", "Version": "2020-08-01", "Service": "live", "Region": "cn-north-1" }, "Result": { "URLList": [ { "CDN": "fcdn", "Protocol": "hls", "Type": "pull", "URL": "http://pull.example.com/live/stream001.sdp" } ] } }
访问公共错误码获取详细信息。