DescribeLiveStreamHistoryUserNum - ApsaraVideo Live - Alibaba Cloud Documentation Center

Operation description

The data returned by this operation is delayed for an average of 2 to 5 minutes.
This operation queries the number of historical online users for only Flash Video (FLV) and Real-Time Messaging Protocol (RTMP) streams.
This operation does not query the number of viewers that are watching transcoded streams.

QPS limit

You can call this operation up to 30 times per second 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.

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:DescribeLiveStreamHistoryUserNum

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
DomainName	string	Yes	The streaming domain.	example.com
AppName	string	Yes	The name of the application to which the live stream belongs. You can view the application name on the Stream Management page of the ApsaraVideo Live console.	liveApp****
StreamName	string	Yes	The name of the live stream. You can view the stream name on the Stream Management page of the ApsaraVideo Live console.	liveStream****
StartTime	string	Yes	The beginning of the time range to query. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC. Note You can query data in the last 30 days.	2017-12-21T08:00:00Z
EndTime	string	Yes	The end of the time range to query. The end time must be later than the start time. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC. Note The time range specified by the StartTime and EndTime parameters cannot exceed one day. The end time must not be later than the current time.	2017-12-22T08:00:00Z

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	16A96B9A-F203-4EC5-8E43-CB92E68F5FF8
LiveStreamUserNumInfos	object
LiveStreamUserNumInfo	array<object>	The number of historical online users for the live stream.
	object
UserNum	string	The number of users at the current point in time.	1
StreamTime	string	The time when the stream started. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.	2017-10-20T06:20:00Z

Examples

Success response

JSON format

{
  "RequestId": "16A96B9A-F203-4EC5-8E43-CB92E68F5FF8",
  "LiveStreamUserNumInfos": {
    "LiveStreamUserNumInfo": [
      {
        "UserNum": "1",
        "StreamTime": "2017-10-20T06:20:00Z"
      }
    ]
  }
}

Error codes

HTTP status code	Error code	Error message
400	InvalidStartTime.Malformed	Specified StartTime is malformed.
400	InvalidEndTime.Malformed	Specified EndTime is malformed.
400	InvalidEndTime.Mismatch	Specified end time does not math the specified start time or current time.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.