Queries the information about all live streams in a specified domain name or for an application in a specified domain name.

Note This operation can be called up to 15 times per second.

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 www.yourdomain.com

The main streaming domain.

AppName String No testApp

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

StreamName String No myStream

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

LiveStreamOnlineInfo
DomainName String www.yourdomain.com

The main streaming domain.

AppName String testApp

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

StreamName String StreamName

The name of the live stream.

PublishTime String 2015-12-02T06:58:04Z

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

PublishUrl String rtmp://play.aliyunlive.com/AppName/StreamName

The complete URL that was used to push the live stream.

PublishDomain String push.aliyunlive.com

The pushing domain. If live center pushing is used, the main streaming domain can be returned.

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 10

The total number of live streams that meet the specified conditions.

TotalPage Integer 100

The total number of pages returned.

Examples

Sample requests

http(s)://live.aliyuncs.com?Action=DescribeLiveStreamsOnlineList
&DomainName=play.yourdomain.com
&<Common request parameters>

Sample success responses

XML format

<DescribeLiveStreamsOnlineListResponse>
      <OnlineInfo>
            <LiveStreamOnlineInfo>
                  <AppName>testApp</AppName>
                  <DomainName>test101.cdnpe.com</DomainName>
                  <PublishTime>2015-12-02T06:58:04Z</PublishTime>
                  <PublishUrl>rtmp://test101.cdnpe.com/xchen</PublishUrl>
                  <StreamName>testxchen</StreamName>
            </LiveStreamOnlineInfo>
      </OnlineInfo>
      <PageNum>2</PageNum>
      <PageSize>10</PageSize>
      <RequestId>0D70427D-91E4-4349-AAD3-5511A5BB823B</RequestId>
      <TotalNum>11</TotalNum>
      <TotalPage>2</TotalPage>
</DescribeLiveStreamsOnlineListResponse>

JSON format

{
    "OnlineInfo":{
        "LiveStreamOnlineInfo":[{
            "AppName":"testApp",
            "DomainName":"test101.cdnpe.com",
            "PublishTime":"2015-12-02T06:58:04Z",
            "PublishUrl":"rtmp://test101.cdnpe.com/xchen",
            "StreamName":"testxchen"
        }]
    },
    "PageNum":2,
    "PageSize":10,
    "RequestId":"0D70427D-91E4-4349-AAD3-5511A5BB823B",
    "TotalNum":11,
    "TotalPage":2
}

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.