Queries the number of online users of all live streams under a main streaming domain.

Usage note

This operation can only query the number of users that use HTTP-FLV, RTS or RTMP to play live streams. That means users who use HLS to play live streams are not included in the response. Due to the known latency of data collection, we recommend that you query the data generated at least 5 minutes ago.

QPS limit

A single user can perform a maximum of 200 queries per minute. 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 DescribeLiveDomainOnlineUserNum

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

DomainName String Yes example.com

The main streaming domain.
RegionId String No cn-shanghai

The ID of the region where the main streaming domain resides.
QueryTime String No 2018-12-27T13:09:21Z

The time to implement the query. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC.

Response parameters

Parameter Type Example Description
OnlineUserInfo Array of LiveStreamOnlineUserNumInfo

The numbers of online users of the live streams that were queried.
LiveStreamOnlineUserNumInfo
Infos Array of Info

The information about a live stream.
Info
TranscodeTemplate String origin

The name of the transcoding template. A value of origin indicates that the live stream is not transcoded.

UserNumber Long 1

The number of online users of the live stream.
StreamName String rtmp://example.com/test/liveStream****_3_1

The name of the live stream.
RequestId String 3A3A8C3D-F8B2-4FBF-9319-771A11B855FA

The ID of the request.
StreamCount Integer 1

The number of live streams that were queried.
UserCount Integer 1

The total number of online users of all the live streams under the main streaming domain at the specified point in time.

Examples

Sample requests

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

Sample success responses

XML format 

<DescribeLiveDomainOnlineUserNumResponse>
  <StreamCount>1</StreamCount>
  <OnlineUserInfo>
        <LiveStreamOnlineUserNumInfo>
              <StreamName>rtmp://example.com/test/liveStream****_3_1</StreamName>
              <Infos>
                    <Info>
                          <TranscodeTemplate>origin</TranscodeTemplate>
                          <UserNumber>1</UserNumber>
                    </Info>
              </Infos>
        </LiveStreamOnlineUserNumInfo>
  </OnlineUserInfo>
  <RequestId>3A3A8C3D-F8B2-4FBF-9319-771A11B855FA</RequestId>
  <UserCount>1</UserCount>
</DescribeLiveDomainOnlineUserNumResponse>

JSON format 

{
    "DescribeLiveDomainOnlineUserNumResponse": {
        "StreamCount": 1,
        "OnlineUserInfo": {
            "LiveStreamOnlineUserNumInfo": {
                "StreamName": "rtmp://example.com/test/liveStream****_3_1",
                "Infos": {
                    "Info": {
                        "TranscodeTemplate": "origin",
                        "UserNumber": 1
                    }
                }
            }
        },
        "RequestId": "3A3A8C3D-F8B2-4FBF-9319-771A11B855FA",
        "UserCount": 1
    }
}

Error codes

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