DescribeLiveStreamsOnlineList - 查询域名在线流列表_视频直播(LIVE)-阿里云帮助中心

查询指定域名或者指定域名下某个应用的所有在线流信息。

接口说明

本接口目前支持以下几种流类型：

all：查询所有流。
raw：查询原始流。
trans：查询转码流。

QPS 限制

本接口的单用户 QPS 限制为 10000 次/分钟。超过限制，API 调用会被限流，这可能会影响您的业务，请合理调用。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作	访问级别	资源类型	条件关键字	关联操作
live:DescribeLiveStreamsOnlineList	get	全部资源 ``	无	无

请求参数

名称	类型	必填	描述	示例值
DomainName	string	是	主播流域名。	example.com
AppName	string	否	播流所属应用名称。您可在流管理页面查看 AppName。	liveApp****
StreamName	string	否	播流名称，仅支持输入单个 StreamName。您可在流管理页面查看 StreamName。	liveStream****
OnlyStream	string	否	是否只返回指定字段。取值： yes：结果只返回 DomainName，AppName，StreamName，PublishTime 字段。 no（默认值）：结果返回全部字段。	no
PageSize	integer	否	每页大小。取值范围：1~3000，默认值为 2000。	1500
PageNum	integer	否	当前页码。默认值为 1。	1
StreamType	string	否	流类型。取值： all（默认值）：查询所有流。 raw：查询原始流。 trans：查询转码流。	all
QueryType	string	否	指定是否模糊匹配流名称。取值： fuzzy（默认值）：模糊匹配。 strict：精准匹配。	fuzzy

返回参数

名称	类型	描述	示例值
	object	在线流信息。
RequestId	string	请求 ID。	5c6a2a0df228-4a64- af62-20e91b9676b3
TotalPage	integer	总页数。	2
PageNum	integer	分页的页码。	1
PageSize	integer	每页显示的条数。	10
TotalNum	integer	符合条件的总个数。	11
OnlineInfo	array<object>	正在推送流的信息。
LiveStreamOnlineInfo	object	正在推送流的信息。
AudioDataRate	integer	直播流的音频码率。单位：Kbps。说明此参数需提交工单添加白名单配置后开启，关于如何提交工单，请参见联系我们。	600
FrameRate	integer	帧率。单位：FPS。	15
PublishUrl	string	推流完整 URL 地址。	rtmp://demo.aliyundoc.com/live/test****
StreamName	string	播流名称。	liveStream****
AudioCodecId	integer	音频 Codec ID。	10
Height	integer	视频分辨率高度。单位：pixel。	720
VideoDataRate	integer	直播流的视频码率。单位：Kbps。说明此参数需提交工单添加白名单配置后开启，关于如何提交工单，请参见联系我们。	600
DomainName	string	主播流域名。	example.com
PublishDomain	string	推流域名，使用中心推流的可直接填写播流域名。	demo.aliyundoc.com
PublishTime	string	开始推流时间。格式为：yyyy-MM-ddTHH:mm:ssZ（UTC 时间）。	2021-08-09T02:37:59Z
AppName	string	播流所属应用名称。	liveApp****
PublishType	string	推流类型，取值： edge：边缘推流。 center：中心推流。	edge
VideoCodecId	integer	视频 Codec ID。	7
Transcoded	string	是否是转码流。取值： yes：是。 no：否。	no
Width	integer	视频分辨率宽度。单位：pixel。	1280
ClientIp	string	推流客户端 IP。	106.11.XX.XX
ServerIp	string	推流节点 IP。	120.221.XX.XX

示例

正常返回示例

JSON格式

{
  "RequestId": "5c6a2a0df228-4a64- af62-20e91b9676b3",
  "TotalPage": 2,
  "PageNum": 1,
  "PageSize": 10,
  "TotalNum": 11,
  "OnlineInfo": {
    "LiveStreamOnlineInfo": [
      {
        "AudioDataRate": 600,
        "FrameRate": 15,
        "PublishUrl": "rtmp://demo.aliyundoc.com/live/test****",
        "StreamName": "liveStream****",
        "AudioCodecId": 10,
        "Height": 720,
        "VideoDataRate": 600,
        "DomainName": "example.com",
        "PublishDomain": "demo.aliyundoc.com",
        "PublishTime": "2021-08-09T02:37:59Z",
        "AppName": "liveApp****",
        "PublishType": "edge",
        "VideoCodecId": 7,
        "Transcoded": "no",
        "Width": 1280,
        "ClientIp": "106.11.XX.XX",
        "ServerIp": "120.221.XX.XX"
      }
    ]
  }
}

错误码

HTTP status code	错误码	错误信息	描述
400	QpsOverLimit	Qps is over limit for this domainName.	-
400	InvalidStartTime.Malformed	Specified StartTime is malformed.	StartTime参数错误，请您确认该StartTime参数是否正确。
400	InvalidEndTime.Malformed	Specified EndTime is malformed.	结束时间错误，请您确认结束时间是否正确。
400	InvalidEndTime.Mismatch	Specified end time does not match the specified start time.	-
400	Duration.Exceed	Duration between StartTime and EndTime is too long.	-

访问错误中心查看更多错误码。

变更历史

变更时间	变更内容概要	操作
2024-08-01	OpenAPI 错误码发生变更、OpenAPI 入参发生变更、OpenAPI 返回结构发生变更	查看变更详情
2024-07-11	OpenAPI 描述信息更新、OpenAPI 错误码发生变更、OpenAPI 入参发生变更、OpenAPI 返回结构发生变更	查看变更详情
2024-01-26	OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更	查看变更详情