You need to enable JavaScript to run this app.
导航
企业直播
  • 文档首页
    • /企业直播/API 参考/直播间管理/获取推流直播和拉流直播信息
获取推流直播和拉流直播信息
最近更新时间：2024.02.29 11:51:13首次发布时间：2022.03.29 22:10:12
我的收藏

获取直播间内各直播频道的推流直播和拉流直播信息。

注意事项

请求频率：单用户请求频率限制为 120 次/分钟。

请求说明

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

请求参数

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

Query

参数类型是否必选示例值描述
ActionString是GetStreamsAPI接口名称。当前 API 的名称为 GetStreamsAPI。
VersionString是2020-06-01接口版本。当前 API 的版本为 2020-06-01。
ActivityIdLong是1783674001300直播间 ID。您可以通过 ListActivityAPI 接口查询 ID。

返回参数

参数类型示例值描述
LineDetailsArray of LineDetails-直播频道的推流直播和拉流直播信息列表。

LineDetails

参数类型示例值描述
LineIdLong3606624直播频道 ID。
LineNameStringDefault直播频道名称。
MainPushInfoArray of MainPushInfo-推流直播的主流地址信息。
BackPushInfoArray of BackPushInfo-推流直播的备流地址信息。
RatioString1280x720直播频道的分辨率。

ForwardInfo

Array of ForwardInfo

-

拉流直播的主流地址信息。

说明

开始拉流后，拉流任务的有效时间为 48 小时。

BackupForwardInfo

Array of BackupForwardInfo

-

拉流直播的备流地址信息。

说明

开始拉流后，拉流任务的有效时间为 48 小时。

ExpireTimeLong1697167355推流地址的过期时间。Unix 时间戳，单位为秒。

MainPushInfo

参数类型示例值描述
PushPathStringrtmp://push-rtmp-l6-act.pstatp.com/activity/推流服务器地址。
PushUrlStringrtmp://push-rtmp-l6-act.pstatp.com/activity/stream-402918918124208216?keeptime=0013c680&wsSecret=3933d232d0560f8979fb4825843bf32c&wsTime=65ddaf57推流地址。
StreamingCodeStringstream-402918918124208216?keeptime=0013c680&wsSecret=3933d232d0560f8979fb4825843bf32c&wsTime=65ddaf57推流密钥。

BackPushInfo

参数类型示例值描述
PushPathStringrtmp://push-rtmp-l6-act.pstatp.com/activity/推流服务器地址。
PushUrlStringrtmp://push-rtmp-l6-act.pstatp.com/activity/stream-402918918124208216?k=3a221d196a806cbf&t=1710323159推流地址。
StreamingCodeStringstream-402918918124208216?k=3a221d196a806cbf&t=1710323159推流秘钥。

ForwardInfo

参数类型示例值描述
PullStreamUrlStringhttps://example/livesaas?key=example拉流直播的主流地址。

PullStreamStatus

String

0

拉流直播任务状态。支持以下取值：

  • 0：拉流任务初始化中
  • 1：拉流任务运行中
  • 2：拉流任务已结束

PullStreamCheckStatus

String

0

拉流检测状态。支持以下取值：

  • 0：检测中
  • 1：源流未推流
  • 2：正常拉流
  • 3：拉流结束
  • 4：拉流异常

BackupForwardInfo

参数类型示例值描述
PullStreamUrlStringhttps://example2/livesaas?key=example拉流直播的备流地址。

PullStreamStatus

String

0

拉流直播任务状态。支持以下取值：

  • 0：拉流任务初始化中
  • 1：拉流任务运行中
  • 2：拉流任务已结束

PullStreamCheckStatus

String

0

拉流检测状态。支持以下取值：

  • 0：检测中
  • 1：源流未推流
  • 2：正常拉流
  • 3：拉流结束
  • 4：拉流异常

示例

请求示例

GET https://livesaas.volcengineapi.com/?Action=GetStreamsAPI&Version=2020-06-01&ActivityId=1783674001300

返回示例

{
  "ResponseMetadata": {
    "RequestId": "202310131019011A649D65514456C6D597",
    "Action": "GetStreamsAPI",
    "Version": "2020-06-01",
    "Service": "livesaas",
    "Region": "cn-north-1",
    "SystemTime": 1697163541
  },
  "Result": {
    "LineDetails": [
      {
        "LineId": 3606624,
        "ExpireTime": 1697167355,
        "MainPushInfo": {
          "PushUrl": "rtmp://push-rtmp-l6-act.pstatp.com/activity/stream-402918918124208216?keeptime=0013c680&wsSecret=3933d232d0560f8979fb4825843bf32c&wsTime=65ddaf57",
          "PushPath": "rtmp://push-rtmp-l6-act.pstatp.com/activity/",
          "StreamingCode": "stream-402918918124208216?keeptime=0013c680&wsSecret=3933d232d0560f8979fb4825843bf32c&wsTime=65ddaf57"
        },
        "BackPushInfo": {
          "PushPath": "rtmp://push-rtmp-l6-act.pstatp.com/activity/",
          "StreamingCode": "stream-402918918124208216?k=3a221d196a806cbf&t=1710323159",
          "PushUrl": "rtmp://push-rtmp-l6-act.pstatp.com/activity/stream-402918918124208216?k=3a221d196a806cbf&t=1710323159"
        },
        "ForwardInfo": {
          "PullStreamUrl": "https://example/livesaas?key=example",
          "PullStreamStatus": 0,
          "PullStreamCheckStatus": 0
        },
        "LineName": "Default",
        "BackupForwardInfo": {
          "PullStreamUrl": "https://example2/livesaas?key=example",
          "PullStreamStatus": 0,
          "PullStreamCheckStatus": 0
        },
        "Ratio": "1280x720"
      }
    ]
  }
}

错误码

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