DescribeLiveStreamsOnlineList - API Reference| Alibaba Cloud Documentation Center

Usage note

This interface currently supports the following stream types:

all: Query all streams.
raw: Query the original streams.
trans: Query the transcoded streams.

QPS limit

A single user can perform a maximum of 10000 queries per minute (QPS). Throttling is triggered when the number of calls per second exceeds the QPS limit. The throttling may affect your business. Thus, we recommend that you observe the QPS limit on this operation. For more information about what a single user means and the QPS details, see QPS limit on an API operation in ApsaraVideo Live.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters


Parameter	Type	Required	Example	Description
Action	String	Yes	DescribeLiveStreamsOnlineList	The operation that you want to perform. Set the value to DescribeLiveStreamsOnlineList.
DomainName	String	Yes	example.com	The main streaming domain.
AppName	String	No	liveApp****	The name of the application to which the live stream belongs.
StreamName	String	No	liveStream****	The name of the live stream.
PageSize	Integer	No	1500	The number of entries to return on each page. Valid values: 1 to 3000. Default value: 2000.
PageNum	Integer	No	1	The number of the page to return. Default value: 1.
StreamType	String	No	all	The type of the streams to query. Valid values: all: all streams. This is the default value. raw: original streams. trans: transcoded streams.
QueryType	String	No	fuzzy	The mode in which stream names are matched. Valid values: fuzzy: fuzzy match. This is the default value. strict: exact match.

Response parameters


Parameter	Type	Example	Description
OnlineInfo	Array of LiveStreamOnlineInfo		The information about the live streams being ingested.
LiveStreamOnlineInfo
DomainName	String	example.com	The main streaming domain.
AppName	String	liveApp****	The name of the application to which the live stream belongs.
StreamName	String	liveStream****	The name of the live stream.
PublishTime	String	2021-08-09T02:37:59Z	The time when the stream was ingested. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC.
PublishUrl	String	rtmp:// push.example.com/live/test****	The complete URL that was used to ingest the stream.
AudioCodecId	Integer	10	The ID of the audio codec.
ClientIp	String	106.11.XX.XX	The IP address of the client that ingests the stream.
FrameRate	Integer	15	The bitrate.
Height	Integer	720	The height of the video resolution.
PublishDomain	String	demo.aliyundoc.com	The ingest domain. If live center ingest is used, the streaming domain can be returned.
PublishType	String	edge	The ingest type. Valid values: edge: edge ingest. center: live center ingest.
ServerIp	String	120.221.XX.XX	The IP address of the ingest node.
Transcoded	String	no	Indicates whether the stream was transcoded. Valid values: yes no
VideoCodecId	Integer	7	The ID of the video codec.
Width	Integer	1280	The width of the video resolution.
PageNum	Integer	1	The page number of the returned page.
PageSize	Integer	10	The number of entries returned per page.
RequestId	String	40A4F36D-A7CC-473A-88E7-154F92242566	The ID of the request.
TotalNum	Integer	11	The total number of active ingest endpoints that meet the specified conditions.
TotalPage	Integer	2	The total number of pages returned.

Examples

Sample requests

http(s)://live.aliyuncs.com/?Action=DescribeLiveStreamsOnlineList
&AppName=liveApp****
&<Common request parameters>

Sample success responses

XML format

<DescribeLiveStreamsOnlineListResponse>
  <TotalNum>11</TotalNum>
  <TotalPage>2</TotalPage>
  <PageSize>10</PageSize>
  <PageNum>1</PageNum>
  <RequestId>40A4F36D-A7CC-473A-88E7-154F92242566</RequestId>
  <OnlineInfo>
        <LiveStreamOnlineInfo>
              <PublishUrl>rtmp://demo.aliyundoc.com/live/test****</PublishUrl>
              <FrameRate>15</FrameRate>
              <DomainName>example.com</DomainName>
              <ServerIp>120.221.XX.XX</ServerIp>
              <ClientIp>106.11.XX.XX</ClientIp>
              <PublishType>edge</PublishType>
              <AppName>liveApp****</AppName>
              <StreamName>liveStream****</StreamName>
              <PublishDomain>demo.aliyundoc.com</PublishDomain>
              <Transcoded>no</Transcoded>
              <Height>720</Height>
              <PublishTime>2021-08-09T02:37:59Z</PublishTime>
              <AudioCodecId>10</AudioCodecId>
              <Width>1280</Width>
              <VideoCodecId>7</VideoCodecId>
        </LiveStreamOnlineInfo>
  </OnlineInfo>
</DescribeLiveStreamsOnlineListResponse>

JSON format

{
    "DescribeLiveStreamsOnlineListResponse": {
        "TotalNum": 11,
        "TotalPage": 2,
        "PageSize": 10,
        "PageNum": 1,
        "RequestId": "40A4F36D-A7CC-473A-88E7-154F92242566",
        "OnlineInfo": {
            "LiveStreamOnlineInfo": {
                "PublishUrl": "rtmp://demo.aliyundoc.com/live/test****",
                "FrameRate": 15,
                "DomainName": "example.com",
                "ServerIp": "120.221.XX.XX",
                "ClientIp": "106.11.XX.XX",
                "PublishType": "edge",
                "AppName": "liveApp****",
                "StreamName": "liveStream****",
                "PublishDomain": "demo.aliyundoc.com",
                "Transcoded": "no",
                "Height": 720,
                "PublishTime": "2021-08-09T02:37:59Z",
                "AudioCodecId": 10,
                "Width": 1280,
                "VideoCodecId": 7
            }
        }
    }
}

Error codes


HttpCode	Error code	Error message	Description
400	InvalidStartTime.Malformed	Specified StartTime is malformed.	The error message returned because the format of the start time is invalid. Check whether the value of the StartTime parameter is valid.
400	InvalidEndTime.Malformed	Specified EndTime is malformed.	The error message returned because the format of the end time is invalid. Check whether the value of the EndTime parameter is valid.

For a list of error codes, visit the API Error Center.