All Products
Search
Document Center

ApsaraVideo Live:DescribeLiveStreamsOnlineList

Last Updated:Mar 01, 2024

Queries the information about all active streams under 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 limits.

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. You can specify only one live stream.

OnlyStream

String

No

no

Specifies whether to return only specific parameters. Valid values:

  • yes: returns only the DomainName, AppName, StreamName, and PublishTime parameters.

  • no (default): returns all parameters.

PageSize

Integer

No

1500

The number of entries per page. Valid values: 1 to 3000. Default value: 2000.

PageNum

Integer

No

1

The page number. Default value: 1.

StreamType

String

No

all

The type of the streams to query. Valid values:

  • all (default): all streams

  • raw: source streams

  • trans: transcoded streams

QueryType

String

No

fuzzy

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

  • fuzzy (default): fuzzy match

  • strict: exact match

Response parameters

Parameter

Type

Example

Description

TotalPage

Integer

2

The total number of pages returned.

PageNum

Integer

1

The page number.

PageSize

Integer

10

The number of entries per page.

RequestId

String

5c6a2a0df228-4a64- af62-20e91b9676b3

The request ID.

TotalNum

Integer

11

The total number of streams that meet the specified conditions.

OnlineInfo

Array of LiveStreamOnlineInfo

The information about the live streams that are being ingested.

LiveStreamOnlineInfo

AudioDataRate

Integer

600

The audio bitrate of the live stream. Unit: Kbit/s.

FrameRate

Integer

15

The frame rate. Unit: FPS.

PublishUrl

String

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

The complete URL that was used to ingest the stream.

StreamName

String

liveStream****

The name of the live stream.

AudioCodecId

Integer

10

The ID of the audio codec.

Height

Integer

720

The height of the video resolution. Unit: pixels.

VideoDataRate

Integer

600

The video bitrate of the live stream. Unit: Kbit/s.

DomainName

String

example.com

The main streaming domain.

PublishDomain

String

demo.aliyundoc.com

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

PublishTime

String

2021-08-09T02:37:59Z

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

AppName

String

liveApp****

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

PublishType

String

edge

The ingest type. Valid values:

  • edge: edge ingest

  • center: live center ingest

VideoCodecId

Integer

7

The ID of the video codec.

Transcoded

String

no

Indicates whether the stream was a transcoded stream. Valid values:

  • yes

  • no

Width

Integer

1280

The width of the video resolution. Unit: pixels.

ClientIp

String

106.11.XX.XX

The IP address of the client for stream ingest.

ServerIp

String

120.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>
        <AudioDataRate>600</AudioDataRate>
        <FrameRate>15</FrameRate>
        <PublishUrl>rtmp://demo.aliyundoc.com/live/test****</PublishUrl>
        <StreamName>liveStream****</StreamName>
        <AudioCodecId>10</AudioCodecId>
        <Height>720</Height>
        <VideoDataRate>600</VideoDataRate>
        <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" : {
    "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"
  }
}

Error codes

HTTP status code

Error code

Error message

Description

400

InvalidStartTime.Malformed

Specified StartTime is malformed.

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 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.