GetAllStreamPullInfoAPI - 获取直播拉流地址--企业直播-火山引擎

文档中心

立即注册

导航

企业直播

GetAllStreamPullInfoAPI - 获取直播拉流地址

最近更新时间：2025.03.24 16:51:44首次发布时间：2022.09.29 17:29:32

获取直播间拉流地址。

注意

请联系技术支持，申请获取直播拉流地址的权限。
不支持在配置了直播时移或直播字幕功能的直播间获取拉流地址。

请求说明

接口名称：GetAllStreamPullInfoAPI
请求方式：GET
接口地址：http://livesaas.volcengineapi.com/?Action=GetAllStreamPullInfoAPI&Version=2020-06-01
请求频率：单用户请求频率限制为 120 次/分钟。
前提条件：确保您拥有火山引擎主账号或具备直播间的直播控制 > 仅查看或可编辑权限的子账号。有关如何添加子账号，详见子账号管理。

请求参数

以下请求参数列表仅列出了该接口的部分公共参数，完整公共参数列表见公共请求参数。

Query

参数	类型	是否必选	描述
Action	String	是	接口名称
Version	String	是	接口版本。直播当前 API 的版本为 2020-06-01
ActivityId	Long	是	直播间 ID。您可以通过 ListActivityAPI 接口查询 ID。说明使用子账号调用接口时，确保该直播间对子账号可见。有关如何配置子账号的可见范围，详见子账号管理。

返回参数

参数	类型	描述
LineName	String	线路名称
Main	Array of StreamMsg	主线路拉流地址列表
Backup	Array of StreamMsg	备线路拉流地址列表。说明需要开启主备流功能，才可显示备线路拉流地址。

StreamMsg

参数	类型	描述
VCodec	String	编码方式。例如：h264
Size	String	清晰度。包含 hd、uhd、sd、ld、origin
Url	Array of UrlMsg	拉流地址

UrlMsg

参数	类型	描述
FlvUrl	String	flv 协议的拉流地址。该返回值不包括协议头，若使用该拉流地址，需自行补充 `http` 或 `https` 协议头。
HlsUrl	String	hls 协议的拉流地址。该返回值不包括协议头，若使用该拉流地址，需自行补充 `http` 或 `https` 协议头。
RtmpUrl	String	rtmp 协议的拉流地址。
LLSUrl	String	超低延时直播的拉流地址。只在超低延时直播才会显示该参数，您可以通过调用 CreateActivityAPIV2 接口创建超低延时直播。

示例

请求示例

Get http://livesaas.volcengineapi.com/?Action=GetAllStreamPullInfoAPI&Version=2020-06-01&ActivityId=17398984603166

正常返回示例

{
    "ResponseMetadata": {
        "RequestId": "2022062820372601021***",
        "Action": "GetAllStreamPullInfoAPI",
        "Version": "2020-06-01",
        "Service": "livesaas",
        "Region": "cn-north-1",
        "SystemTime": 1656419846
    },
    "Result": [
        {
            "LineName": "线路名称1",
            "Main": [
                {
                    "VCodec": "h264", 
                    "Size": "uhd", 
                    "Url": {
                        "FlvUrl": "//pull-flv-l1-act.xxxx.com/activity/stream-1123079194_uhd",
                        "HlsUrl": "//pull-hls-l1-act.xxxx.com/activity/stream-111200799194_uhd",
                        "RtmpUrl": "rtmp://pull-rtmp-l1-act.xxxx.com/activity/stream-1193079172694_uhd",
                        "LLSUrl": ""
                    }
                }
            ],
            "Backup": [ 
            {
                    "VCodec": "h264", 
                    "Size": "uhd", 
                    "Url": {
                        "FlvUrl": "//pull-flv-l1-act.xxxx.com/activity/stream-6893363899_uhd",
                        "HlsUrl": "//pull-hls-l1-act.xxxx.com/activity/stream-198230079917_uhd", 
                        "RtmpUrl": "rtmp://pull-rtmp-l1-act.xxxx.com/activity/stream-1119823007991",
                        "LLSUrl": ""
                    }
                }
            ]
        }
		]
}

异常返回示例

{
  	"ResponseMetadata":{
        "RequestId":"201806041104200100***",
        "Action":"GetAllStreamPullInfoAPI",
        "Version":"2020-06-01",
        "Service":"livesaas",
        "Region":"cn-north-1",
        "SystemTime":1656067132,
        "Error":{
            "Code":"200000",
            "Message":"参数异常" 
        }
		}
}

错误码

访问公共错误码获取详细信息。