All Products
Search

This Product

    ApsaraVideo Live:DescribeLiveUserStreamMetricData

    Document Center

    ApsaraVideo Live:DescribeLiveUserStreamMetricData

    Last Updated:Dec 09, 2025

    Queries batch data at the stream level for a specified accelerated domain name. This operation supports multiple protocols.

    Operation description

    Note

    You cannot query the number of new connections for the HTTP Live Streaming (HLS) protocol. The number of concurrent connections for HLS is calculated based on requests in the default format. To use a special format, you must submit a ticket for configuration. The default format is as follows:

    • M3U8 request example: http(s)://example.aliyundoc.com/AppName/StreamName.m3u8

    • TS request example: http(s)://example.aliyundoc.com/AppName/StreamName/153xxxxxxxx_137xxxxx.ts

    Usage notes

    • Query limit: A single query can return a maximum of 5,000 rows of data.

    • Domain name limit: You can query data for only one domain name at a time. If you specify multiple domain names, an error is returned.

    • Time span limit: The maximum time span for a query is 24 hours.

    • Time granularity limit: The minimum time granularity for a query is 1 minute.

    • Query range limit: You can query data generated within the last 31 days.

    • Call frequency limit: A single user can make up to 10 calls per second.

    • Special parameter combination: If the DomainName parameter is specified and both the AppName and StreamName parameters are set to all, the operation returns the aggregate data for the accelerated domain name.

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

    none

    *All Resource

    *

    		 None None

    Request parameters

    Parameter

    Type

    Required

    Description

    Example
    DomainName

    string

    No

    The accelerated domain name to query.

    Note

    You can query data for only one domain name at a time. An error is returned if you specify multiple domain names. If you leave this parameter empty, the aggregate data for all accelerated domain names under your account is queried. If you do not specify AppName and StreamName, the operation returns data for all streams at the domain name level.

    test.com
    StartTime

    string

    Yes

    The start of the time range to query. Specify the time in the ISO 8601 format: YYYY-MM-DDThh:mm:ssZ. The time must be in UTC.

    2015-12-10T20:00:00Z
    EndTime

    string

    Yes

    The end of the time range to query. The end time must be later than the start time. The time span cannot exceed 24 hours. Specify the time in the ISO 8601 format: YYYY-MM-DDThh:mm:ssZ. The time must be in UTC.

    2015-12-10T21:00:00Z
    AppName

    string

    No

    The application name. If you specify an application name, the operation queries data for streams in that application. You must specify AppName if you specify StreamName.

    app
    StreamName

    string

    No

    The stream name. If you specify a StreamName, the operation returns data for that specific stream in the specified AppName. You must specify AppName if you specify StreamName.

    test.flv
    Protocol

    string

    No

    The stream protocol. Specify a protocol to query data for that protocol. Supported protocols include flv, hls, rtmp, rts, and p2p. You can query data for multiple protocols. Separate protocols with a comma (,). Data for multiple protocols is not aggregated and is output at the stream level.

    Note

    The rts option lets you query Real-Time Streaming (RTS) streams that use the Alibaba Real-Time Communication (ARTC) protocol.

    • When you use RTS, you may need to collect statistics for transcoded streams that have the _AliRTS-opus suffix. This is because when you play an RTS stream on a web client, a transcoded stream is automatically generated by appending the _AliRTS-opus suffix to the stream name. This process generates transcoding data. For more information, see RTS sub-second latency automatic transcoding.

    flv
    PageNumber

    integer

    Yes

    The current page number.

    1
    PageSize

    integer

    Yes

    The number of data entries to return on each page. The maximum value is 5,000.

    10

    Response elements

    Element

    Type

    Description

    Example

    object

    The response schema.

    DomainName

    string

    The accelerated domain name.

    test.com
    EndTime

    string

    The end of the time range. The time is in the YYYY-MM-DDThh:mm:ssZ format.

    2015-12-10T21:00:00Z
    PageSize

    integer

    The number of entries displayed on each page.

    10
    RequestId

    string

    The request ID.

    16A96B9A-F203-4EC5-8E43-CB92E68F****
    StartTime

    string

    The start of the time range. The time is in the ISO 8601 standard in the YYYY-MM-DDThh:mm:ssZ format. The time is in UTC.

    2015-12-10T20:00:00Z
    StreamDetailData

    array<object>

    The traffic data for each time interval.

    object

    The data group that is returned.

    AppName

    string

    The application name. This value is returned regardless of whether you specify it in the request.

    app
    Bps

    number

    The total bandwidth of the stream per minute, in bps.

    423304182.66
    Count

    integer

    The total number of concurrent connections for the stream per minute.

    Note

    Concurrent Connections: The number of connections to client processes for the same stream within a unit of time.

    423304182
    FlvBps

    number

    The bandwidth for the FLV protocol, in bps. This parameter is returned only if the specified protocol is FLV.

    454
    FlvCount

    integer

    The number of concurrent connections for the FLV protocol. This parameter is returned only if the specified protocol is FLV.

    32
    FlvTraffic

    number

    The traffic for the FLV protocol, in bytes. This parameter is returned only if the specified protocol is FLV.

    1254
    HlsBps

    number

    The bandwidth for the HLS protocol, in bps. This parameter is returned only if the specified protocol is HLS.

    4456
    HlsCount

    integer

    The number of concurrent connections for the HLS protocol. This parameter is returned only if the specified protocol is HLS.

    56
    HlsTraffic

    number

    The traffic for the HLS protocol, in bytes. This parameter is returned only if the specified protocol is HLS.

    568
    NewConns

    integer

    The number of new connections to the stream per minute.

    450
    P2pBps

    number

    The bandwidth for the P2P protocol, in bps. This parameter is returned only if the specified protocol is P2P.

    6845
    P2pCount

    integer

    The number of concurrent connections for the P2P protocol. This parameter is returned only if the specified protocol is P2P.

    78
    P2pTraffic

    number

    The traffic for the P2P protocol, in bytes. This parameter is returned only if the specified protocol is P2P.

    4102
    RtmpBps

    number

    The bandwidth for the RTMP protocol, in bps. This parameter is returned only if the specified protocol is RTMP.

    3323
    RtmpCount

    integer

    The number of concurrent connections for the RTMP protocol. This parameter is returned only if the specified protocol is RTMP.

    63
    RtmpTraffic

    number

    The traffic for the RTMP protocol, in bytes. This parameter is returned only if the specified protocol is RTMP.

    5568
    RtsBps

    number

    The bandwidth for the RTS protocol, in bps. This parameter is returned only if the specified protocol is RTS.

    2361
    RtsCount

    integer

    The number of concurrent connections for the RTS protocol. This parameter is returned only if the specified protocol is RTS.

    89
    RtsTraffic

    number

    The traffic for the RTS protocol, in bytes. This parameter is returned only if the specified protocol is RTS.

    2322
    StreamName

    string

    The stream name. This value is returned regardless of whether you specify it in the request.

    test.flv
    TimeStamp

    string

    The start time of the time slice.

    2015-12-10T20:00:00Z
    Traffic

    number

    The total traffic of the stream per minute, in bytes.

    423304182
    TotalCount

    integer

    The total number of entries.

    50
    PageNumber

    integer

    The page number.

    1

    Examples

    Success response

    JSON format

    {
  "DomainName": "test.com",
  "EndTime": "2015-12-10T21:00:00Z",
  "PageSize": 10,
  "RequestId": "16A96B9A-F203-4EC5-8E43-CB92E68F****",
  "StartTime": "2015-12-10T20:00:00Z",
  "StreamDetailData": [
    {
      "AppName": "app",
      "Bps": 423304182.66,
      "Count": 423304182,
      "FlvBps": 454,
      "FlvCount": 32,
      "FlvTraffic": 1254,
      "HlsBps": 4456,
      "HlsCount": 56,
      "HlsTraffic": 568,
      "NewConns": 450,
      "P2pBps": 6845,
      "P2pCount": 78,
      "P2pTraffic": 4102,
      "RtmpBps": 3323,
      "RtmpCount": 63,
      "RtmpTraffic": 5568,
      "RtsBps": 2361,
      "RtsCount": 89,
      "RtsTraffic": 2322,
      "StreamName": "test.flv",
      "TimeStamp": "2015-12-10T20:00:00Z",
      "Traffic": 423304182
    }
  ],
  "TotalCount": 50,
  "PageNumber": 1
}

    Error codes

    HTTP status code

    Error code

    Error message

    Description
    400 Meter.ParamError Param Error:%s,Please Check Again.
    500 Meter.ServerInternalError The Request Processing Has Failed Due To Some Unknown Error.
    500 Meter.DataSourceQueryError Data Source Error:%s,Please Try Again.
    403 Meter.AuthError Authentication Failed,Please Try Again.
    502 Meter.ReadyTsError Get ReadyTs Failed,Please Try Again.

    See Error Codes for a complete list.

    Release notes

    See Release Notes for a complete list.