All Products
Search
Document Center

ApsaraVideo Live:DescribeLiveStreamCount

Last Updated:Nov 14, 2024

Queries the number of online original streams and transcoded streams among live streams.

Operation description

This operation is applicable to the main streaming domains.

QPS limit

A single user can perform a maximum of 1 queries per second. Throttling is triggered when the number of calls per second exceeds the QPS limit. The throttling may affect your business. Thus, we recommend that you observe the QPS limit on this operation. For more information about what a single user means and the QPS details, see QPS limit on an API operation in ApsaraVideo Live.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

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.
OperationAccess levelResource typeCondition keyAssociated operation
live:DescribeLiveStreamCountget
*All Resources
*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
DomainNamestringYes

The main streaming domain.

example.com

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The ID of the request.

FCFFE4A4-F34F-4EEF-B401-36A01689AFBC
StreamCountInfosarray<object>

The statistics of the live streams.

StreamCountInfoobject
Typestring

The type of the live stream. Valid values:

  • raw: an original stream.
  • trans: a transcoded stream.
raw
Countlong

The number of online streams.

3
Limitlong

The maximum number of concurrent ingest streams. This parameter is available only for users in the whitelist.

10
StreamCountDetailsarray<object>

The information about the live streams.

StreamCountDetailobject
VideoDataRatelong

The video bitrate. This parameter is available only for transcoded streams.

390
Formatstring

The video encoding format. Valid values:

  • h264
  • h265
h264
Countlong

The number of online streams.

2

Examples

Sample success responses

JSONformat

{
  "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 codeError codeError message
400InternalErrorThe request processing has failed due to backend service exception.

For a list of error codes, visit the Service error codes.