DescribeLiveDomainOnlineUserNum - ApsaraVideo Live - Alibaba Cloud Documentation Center

Retrieves the number of online viewers for all live streams on a specified domain.

Operation description

This API only supports viewer counts for FLV, RTS, and RTMP streams. HLS streams are not supported. The data collection has a delay. For accuracy, query for data that is at least 5 minutes old.

Note

This API replaces the deprecated DescribeLiveStreamOnlineUserNum endpoint.

QPS limits

You can call this operation up to 200 times per minute per account. Requests that exceed this limit are dropped and you may experience service interruptions.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

live:DescribeLiveDomainOnlineUserNum

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	No	The region ID.	cn-shanghai
DomainName	string	Yes	The streaming domain.	example.com
QueryTime	string	No	The point of time to query. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC.	2018-12-27T13:09:21Z

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	3A3A8C3D-F8B2-4FBF-9319-771A11B855FA
UserCount	integer	The total number of online users at the specified point in time on the specified domain.	1
StreamCount	integer	The number of streams.	1
OnlineUserInfo	object
LiveStreamOnlineUserNumInfo	array<object>	The information about the streams.
	array<object>
StreamName	string	The stream name.	rtmp://example.com/test/liveStream****_3_1
Infos	object
Info	array<object>	The stream statistics.
	object
UserNumber	integer	The number of viewers watching the transcoded stream or the original stream.	1
TranscodeTemplate	string	The transcoding template. A value of origin indicates that the stream is an original, non-transcoded stream.	origin

Examples

Success response

JSON format

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

Error codes

HTTP status code	Error code	Error message	Description
400	InternalError	The request processing has failed due to backend service exception.
400	InvalidQueryTime.Exceed	QueryTime exceed three month.	The query time is more than three months from the current time.
400	InvalidQueryTime.Malformed	Specified QueryTime is malformed.	The specified query time is invalid.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.