Queries the number of historical online users for a live stream.
Operation description
- The data returned after you call this operation is delayed for an average of 2 to 5 minutes.
- This operation only queries the number of historical online users for 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. For more information, see QPS limit on an API operation in ApsaraVideo Live.
Debugging
Authorization information
The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:
- Operation: the value that you can use in the Action element to specify the operation on a resource.
- Access level: the access level of each operation. The levels are read, write, and list.
- Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level,
All Resourcesis used in the Resource type column of the operation.
- Condition Key: the condition key that is defined by the cloud service.
- Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
| Operation | Access level | Resource type | Condition key | Associated operation |
|---|---|---|---|---|
| live:DescribeLiveStreamHistoryUserNum | get | *All Resources * |
| 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. | liveApp**** |
| StreamName | string | Yes | The name of the live stream. | 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 over 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 time specified by the EndTime parameter must be earlier than the current time.
| 2017-12-22T08:00:00Z |
Response parameters
Examples
Sample success responses
JSONformat
{
"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. |
For a list of error codes, visit the Service error codes.