Queries the information about all active ingest endpoints in a specified domain name or the active ingest endpoints of an application in a specified domain name.

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 pull.example.com

The main streaming domain.

AppName String No live

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

StreamName String No test

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 pull.example.com

The main streaming domain.

AppName String live

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

StreamName String test

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 push.example.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
&DomainName=pull.example.com
&<Common request parameters>

Sample success responses

XML format

<OnlineInfo>
    <LiveStreamOnlineInfo>
        <PublishUrl>rtmp:// push.example.com/live/test</PublishUrl>
        <FrameRate>15</FrameRate>
        <DomainName>pull.example.com</DomainName>
        <ServerIp>120.221.XX.XX</ServerIp>
        <ClientIp>106.11.XX.XX</ClientIp>
        <PublishType>edge</PublishType>
        <AppName>live</AppName>
        <StreamName>test</StreamName>
        <PublishDomain>push.example.com</PublishDomain>
        <Transcoded>no</Transcoded>
        <PublishTime>2021-08-09T02:37:59Z</PublishTime>
        <Height>720</Height>
        <AudioCodecId>10</AudioCodecId>
        <Width>1280</Width>
        <VideoCodecId>7</VideoCodecId>
    </LiveStreamOnlineInfo>
</OnlineInfo>
<PageNum>2</PageNum>
<PageSize>10</PageSize>
<RequestId>0D70427D-91E4-4349-AAD3-5511A5BB823B</RequestId>
<TotalNum>11</TotalNum>
<TotalPage>2</TotalPage>

JSON format

{
    "OnlineInfo":{
        "LiveStreamOnlineInfo":[
            {
           "PublishUrl": "rtmp:// push.example.com/live/test",
        "FrameRate": 15,
        "DomainName": "pull.example.com",
        "ServerIp": "120.221.XX.XX",
        "ClientIp": "106.11.XX.XX",
        "PublishType": "edge",
        "AppName": "live",
        "StreamName": "test",
        "PublishDomain": "push.example.com",
        "Transcoded": "no",
        "PublishTime": "2021-08-09T02:37:59Z",
        "Height": 720,
        "AudioCodecId": 10,
        "Width": 1280,
        "VideoCodecId": 7
        }]
    },
    "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.