UpdatePullToPushAPI - 更新直播间拉流状态--企业直播-火山引擎

文档中心

立即注册

导航

企业直播

UpdatePullToPushAPI - 更新直播间拉流状态

最近更新时间：2025.03.21 16:48:04首次发布时间：2022.03.29 22:10:12

更新直播间的拉流状态。

注意事项

请求频率：单用户请求频率限制为 120 次/秒。
前提条件：确保您拥有火山引擎主账号或具备直播间的直播控制 > 可编辑权限的子账号。有关如何添加子账号，详见子账号管理。

请求说明

请求方式：POST
请求地址：https://livesaas.volcengineapi.com/?Action=UpdatePullToPushAPI&Version=2020-06-01

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息详见公共参数。

Query

参数	类型	是否必选	示例值	描述
Action	String	是	`UpdatePullToPushAPI`	接口名称。当前 API 的名称为 `UpdatePullToPushAPI`。
Version	String	是	`2020-06-01`	接口版本。当前 API 的版本为 `2020-06-01`。

Body

参数	类型	是否必选	示例值	描述
ActivityId	Long	是	`1772441830705`	直播间 ID。您可以通过 ListActivityAPI 接口查询 ID。说明使用子账号调用接口时，确保该直播间对子账号可见。有关如何配置子账号的可见范围，详见子账号管理。
LineId	Long	否	`123`	直播频道 ID。您可以通过 GetStreamsAPI 接口查询 ID。如果您配置了多个直播频道，则默认为第一个直播频道。有关如何配置直播频道，详见直播频道管理。
PullStreamUrl	String	是	`https://example-livesaas.com`	拉流直播的拉流 URL。您可以通过 GetStreamsAPI 接口查询拉流 URL。
PullStreamStatus	Integer	是	`1`	拉流状态。支持以下取值： `1`：开始拉流 `2`：结束拉流
PullStreamMode	Integer	否	`0`	更新主流还是备流的拉流状态。支持以下取值，默认取值为 `0`。 `0`：主流 `1`：备流

返回参数

本接口无特有的返回参数。

请求示例

POST https://livesaas.volcengineapi.com/?Action=UpdatePullToPushAPI&Version=2020-06-01
{
    "ActivityId": 1772441830705,
    "PullStreamUrl": "https://example-livesaas.com",
    "PullStreamStatus": 1
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "201806041104200100100232280022D30",
        "Action": "UpdatePullToPushAPI",
        "Version": "2020-06-01",
        "Service": "livesaas",
        "Region": "cn-north-1",
        "SystemTime": 1656067132
    }
}

错误码

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