You need to enable JavaScript to run this app.
导航
更新直播间拉流配置
最近更新时间:2024.01.08 17:13:51首次发布时间:2022.03.29 22:10:12

更新直播间的拉流配置信息。

注意事项

请求频率:单用户请求频率限制为 120 次/秒

请求说明

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

请求参数

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

Query

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

Body

参数类型是否必选示例值描述
ActivityIdLong1772441830705直播间 ID。您可以通过 ListActivityAPI 接口查询 ID。

LineId

Long

123

直播频道 ID。您可以通过 GetStreamsAPI 接口查询 ID。
如果您配置了多个直播频道,则默认为第一个直播频道。有关如何配置直播频道,详见直播频道管理

PullStreamUrlStringhttps://example-livesaas.com新拉流直播的拉流 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
  }
}

错误码

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