Queries the information about all active streams under a specified domain name or the active streams of an application under a specified domain name.
Operation description
You can call this operation to query the following types of streams.
- all: all streams.
- raw: source streams.
- trans: transcoded streams.
QPS limit
You can call this operation up to 10,000 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.
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 Resources
is 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:DescribeLiveStreamsOnlineList | get | *All Resources * |
| none |
Request parameters
Parameter | Type | Required | Description | Example |
---|---|---|---|---|
DomainName | string | Yes | The main streaming domain. | example.com |
AppName | string | No | 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 | No | The name of the live stream. You can specify only one live stream. You can view the stream name on the Stream Management page of the ApsaraVideo Live console. | liveStream**** |
OnlyStream | string | No | Specifies whether to return only specific parameters. Valid values:
| no |
PageSize | integer | No | The number of entries per page. Valid values: 1 to 3000. Default value: 2000. | 1500 |
PageNum | integer | No | The page number. Default value: 1. | 1 |
StreamType | string | No | The type of the streams to query. Valid values:
| all |
QueryType | string | No | The mode in which stream names are matched. Valid values:
| fuzzy |
Response parameters
Examples
Sample success responses
JSON
format
{
"RequestId": "5c6a2a0df228-4a64- af62-20e91b9676b3",
"TotalPage": 2,
"PageNum": 1,
"PageSize": 10,
"TotalNum": 11,
"OnlineInfo": {
"LiveStreamOnlineInfo": [
{
"AudioDataRate": 600,
"FrameRate": 15,
"PublishUrl": "rtmp://demo.aliyundoc.com/live/test****",
"StreamName": "liveStream****",
"AudioCodecId": 10,
"Height": 720,
"VideoDataRate": 600,
"DomainName": "example.com",
"PublishDomain": "demo.aliyundoc.com",
"PublishTime": "2021-08-09T02:37:59Z",
"AppName": "liveApp****",
"PublishType": "edge",
"VideoCodecId": 7,
"Transcoded": "no",
"Width": 1280,
"ClientIp": "106.11.XX.XX",
"ServerIp": "120.221.XX.XX"
}
]
}
}
Error codes
HTTP status code | Error code | Error message |
---|---|---|
400 | QpsOverLimit | Qps is over limit for this domainName. |
400 | InvalidStartTime.Malformed | Specified StartTime is malformed. |
400 | InvalidEndTime.Malformed | Specified EndTime is malformed. |
400 | InvalidEndTime.Mismatch | Specified end time does not match the specified start time. |
400 | Duration.Exceed | Duration between StartTime and EndTime is too long. |
For a list of error codes, visit the Service error codes.
Change history
Change time | Summary of changes | Operation |
---|---|---|
2024-08-01 | The Error code has changed. The request parameters of the API has changed. The response structure of the API has changed | View Change Details |
2024-07-11 | API Description Update. The Error code has changed. The request parameters of the API has changed. The response structure of the API has changed | View Change Details |
2024-01-26 | The Error code has changed. The response structure of the API has changed | View Change Details |