DescribeLiveStreamsOnlineList

Queries the information about all active streams under a specified domain name or a specified application under a domain name.

Operation description

This operation supports the following stream types:

all: Queries all streams.
raw: Queries raw streams.
trans: Queries transcoded streams.

QPS limit

The QPS limit for a single user is 10,000 calls per minute. If the limit is exceeded, the API calls are throttled, which may affect your business. Call this operation at a reasonable frequency.

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

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 of the streamer. Note When you specify DomainName, make sure that the domain name is a live streaming domain name and that you have the permissions to manage the domain name.	example.com
AppName	string	No	The name of the application to which the stream belongs. You can view the AppName on the Stream Management page.	liveApp****
StreamName	string	No	The stream name. Only a single StreamName can be specified. You can view the StreamName on the Stream Management page.	liveStream****
OnlyStream	string	No	Specifies whether to return only specified fields. Valid values: yes: Only the DomainName, AppName, StreamName, and PublishTime fields are returned. no (default): All fields are returned.	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 stream type. Valid values: all (default): all streams. raw: raw streams. trans: transcoded streams. Valid values: all : all streams. raw : raw streams. trans : transcoded streams.	all
QueryType	string	No	Specifies whether to use fuzzy match for the stream name. Valid values: fuzzy (default): fuzzy match. strict: exact match. Valid values: strict : exact match. fuzzy : fuzzy match.	fuzzy

Response elements

Element	Type	Description	Example
	object	The active stream information.
RequestId	string	The request ID.	5c6a2a0df228-4a64- af62-20e91b9676b3
TotalPage	integer	The total number of pages.	2
PageNum	integer	The page number.	1
PageSize	integer	The number of entries per page.	10
TotalNum	integer	The total number of entries that meet the specified conditions.	11
OnlineInfo	object
LiveStreamOnlineInfo	array<object>	The information about the streams that are being ingested.
	object	The information about the streams that are being ingested.
AudioDataRate	integer	The audio bitrate. Unit: Kbps. Note This parameter can only be returned after you submit a ticket for whitelist configuration.	600
FrameRate	integer	The frame rate. Unit: frames per second (fps).	15
PublishUrl	string	The complete ingest URL.	rtmp://demo.aliyundoc.com/live/test****
StreamName	string	The stream name.	liveStream****
AudioCodecId	integer	The audio codec ID.	10
Height	integer	The height of the video resolution. Unit: pixel.	720
VideoDataRate	integer	The video bitrate. Unit: Kbps. Note This parameter can only be returned after you submit a ticket for whitelist configuration.	600
DomainName	string	The streaming domain.	example.com
PublishDomain	string	The ingest domain. If live center ingest was used, the streaming domain is returned.	demo.aliyundoc.com
PublishTime	string	The start time of stream ingest. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.	2021-08-09T02:37:59Z
AppName	string	The name of the application to which the stream belongs.	liveApp****
PublishType	string	The ingest type. Valid values: edge: edge ingest. center: live center ingest.	edge
VideoCodecId	integer	The video codec ID.	7
Transcoded	string	Indicates whether the stream is a transcoded stream. Valid values: yes no	no
Width	integer	The width of the video resolution. Unit: pixel.	1280
ClientIp	string	The IP address of the client for stream ingest.	106.11.XX.XX
ServerIp	string	The IP address of the ingest node.	120.221.XX.XX

Examples

Success response

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.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.