DescribeLiveStreamCount - ApsaraVideo Live - Alibaba Cloud Documentation Center

Retrieves the real-time count of active original and transcoded streams for a specified streaming domain.

Operation description

Before you call this operation, obtain the streaming domain name in the console. The returned stream count includes streams encoded in H.264 and H.265 formats.

QPS limit

You can call this operation only one time per second per account. Requests that exceed this limit are dropped and you may experience service interruptions.

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

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. Note Make sure that the domain name is added to ApsaraVideo Live and that you have the permissions to operate on it.	example.com

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	FCFFE4A4-F34F-4EEF-B401-36A01689AFBC
StreamCountInfos	object
StreamCountInfo	array<object>	The stream statistics.
	array<object>
Type	string	The type of the active stream. Valid values: raw: original stream. trans: transcoded stream.	raw
Count	integer	The number of active streams.	3
Limit	integer	The limit on the number of concurrent ingested streams. This parameter is returned only for users on the whitelist.	10
StreamCountDetails	object
StreamCountDetail	array<object>	The stream details.
	object
VideoDataRate	integer	The video bitrate. This parameter is returned only when statistics for transcoded streams are queried.	390
Format	string	The video codec. Valid values: h264. h265.	h264
Count	integer	The number of active streams.	2

Examples

Success response

JSON format

{
  "RequestId": "FCFFE4A4-F34F-4EEF-B401-36A01689AFBC",
  "StreamCountInfos": {
    "StreamCountInfo": [
      {
        "Type": "raw",
        "Count": 3,
        "Limit": 10,
        "StreamCountDetails": {
          "StreamCountDetail": [
            {
              "VideoDataRate": 390,
              "Format": "h264",
              "Count": 2
            }
          ]
        }
      }
    ]
  }
}

Error codes

HTTP status code	Error code	Error message	Description
400	InternalError	The request processing has failed due to backend service exception.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.