Queries the number of online users at a specified point in time for all live streams under a specified domain name.
Operation description
Usage notes
You can call this operation to collect statistics on the number of online users for only Flash Video (FLV), Real-Time Streaming (RTS), and Real-Time Messaging Protocol (RTMP) streams, but not HTTP Live Streaming (HLS) streams. A delay exists in data collection and statistics. We recommend that you query the data of more than 5 minutes ago.
QPS limit
You can call this operation up to 200 times per minute 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 limits.
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:DescribeLiveDomainOnlineUserNum | get | *All Resources * |
| none |
Request parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| DomainName | string | Yes | The main 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 parameters
Examples
Sample success responses
JSONformat
{
"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. |
For a list of error codes, visit the Service error codes.