Queries the information about all active streams for a specified domain name or the active streams of an application under a specified domain name.

Usage notes

You can call this operation to query the following types of streams.

  • all: all streams.
  • raw: source streams.
  • trans: transcoded streams.

QPS limit

You can call this operation up to 10,000 times per minute per account. Requests that exceed this limit are dropped and you will experience service interruptions. We recommend that you take note of this limit when you call this operation. For more information, 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

ParameterTypeRequiredExampleDescription
ActionStringYesDescribeLiveStreamsOnlineList

The operation that you want to perform. Set the value to DescribeLiveStreamsOnlineList.

DomainNameStringYesexample.com

The main streaming domain.

AppNameStringNoliveApp****

The name of the application to which the live stream belongs.

StreamNameStringNoliveStream****

The name of the live stream. You can specify only one live stream.

OnlyStreamStringNono

Specifies whether to return only specific parameters. Valid values:

  • yes: returns only the DomainName, AppName, StreamName, and PublishTime parameters.
  • no: returns all parameters. This is the default value.
PageSizeIntegerNo1500

The number of entries to return on each page. Valid values: 1 to 3000. Default value: 2000.

PageNumIntegerNo1

The number of the page to return. Default value: 1.

StreamTypeStringNoall

The type of the streams to query. Valid values:

  • all: all streams. This is the default value.
  • raw: source streams.
  • trans: transcoded streams.
QueryTypeStringNofuzzy

The mode in which stream names are matched. Valid values:

  • fuzzy: fuzzy match. This is the default value.
  • strict: exact match.

Response parameters

ParameterTypeExampleDescription
TotalPageInteger2

The total number of pages returned.

PageNumInteger1

The page number of the returned page.

PageSizeInteger10

The number of entries returned per page.

RequestIdString5c6a2a0df228-4a64- af62-20e91b9676b3

The ID of the request.

TotalNumInteger11

The total number of streams that meet the specified conditions.

OnlineInfoArray of LiveStreamOnlineInfo

The information about the live streams that are being ingested.

LiveStreamOnlineInfo
FrameRateInteger15

The frame rate. Unit: FPS.

PublishUrlStringrtmp://demo.aliyundoc.com/live/test****

The complete URL that was used to ingest the stream.

StreamNameStringliveStream****

The name of the live stream.

AudioCodecIdInteger10

The ID of the audio codec.

HeightInteger720

The height of the video resolution. Unit: pixel.

DomainNameStringexample.com

The main streaming domain.

PublishDomainStringdemo.aliyundoc.com

The ingest domain. If live center ingest was used, the streaming domain is returned.

PublishTimeString2021-08-09T02:37:59Z

The time when the stream started to be ingested. The time is in the yyyy-MM-ddTHH:mm:ssZ format and is displayed in UTC.

AppNameStringliveApp****

The name of the application to which the live stream belongs.

PublishTypeStringedge

The ingest type. Valid values:

  • edge: edge node ingest.
  • center: live center ingest.
VideoCodecIdInteger7

The ID of the video codec.

TranscodedStringno

Indicates whether the stream was transcoded. Valid values:

  • yes
  • no
WidthInteger1280

The width of the video resolution. Unit: pixel.

ClientIpString106.11.XX.XX

The IP address of the client for stream ingest.

ServerIpString120.221.XX.XX

The IP address of the ingest node.

Examples

Sample requests

http(s)://live.aliyuncs.com/?Action=DescribeLiveStreamsOnlineList
&DomainName=example.com
&AppName=liveApp****
&StreamName=liveStream****
&OnlyStream=no
&PageSize=1500
&PageNum=1
&StreamType=all
&QueryType=fuzzy
&<Common request parameters>

Sample success responses

XML format

HTTP/1.1 200 OK
Content-Type:application/xml

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

JSON format

HTTP/1.1 200 OK
Content-Type:application/json

{
  "TotalPage" : 2,
  "PageNum" : 1,
  "PageSize" : 10,
  "RequestId" : "5c6a2a0df228-4a64- af62-20e91b9676b3",
  "TotalNum" : 11,
  "OnlineInfo" : [ {
    "FrameRate" : 15,
    "PublishUrl" : "rtmp://demo.aliyundoc.com/live/test****",
    "StreamName" : "liveStream****",
    "AudioCodecId" : 10,
    "Height" : 720,
    "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"
  } ]
}

Error codes

HTTP status codeError codeError messageDescription
400InvalidStartTime.MalformedSpecified 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.
400InvalidEndTime.MalformedSpecified 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, see Service error codes.