All Products
Search

This Product

    ApsaraVideo Live:DescribeLiveStreamTranscodeMetricData

    Document Center

    ApsaraVideo Live:DescribeLiveStreamTranscodeMetricData

    Last Updated:Jun 16, 2026

    Queries transcoding data for a specified domain name at the app and stream granularity.

    Operation description

    • Maximum query span: 24 hours.

    • Minimum query granularity: 5 minutes.

    • Maximum query range: data from the last 31 days.

    QPS limit

    The single-user QPS limit for this API is 10 calls per second. If this 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:DescribeLiveStreamTranscodeMetricData

    get

    *Domain

    acs:cdn:*:{#accountId}:domain/{#DomainName}

    		 None None

    Request parameters

    Parameter

    Type

    Required

    Description

    Example
    RegionId

    string

    No

    The region ID.

    cn-shanghai
    DomainName

    string

    Yes

    The domain name. Only a single domain name can be queried at a time.

    example.com
    StartTime

    string

    Yes

    The start time. Format: yyyy-MM-ddTHH:mm:ssZ (UTC).

    2023-06-11T02:46:40Z
    EndTime

    string

    Yes

    The end time. The end time must be later than the start time. Format: yyyy-MM-ddTHH:mm:ssZ (UTC).

    2023-06-11T03:46:40Z
    AppName

    string

    No

    The application name.

    app
    StreamName

    string

    No

    The stream name.

    stream
    NextPageToken

    string

    No

    The paged query token. Each query returns a maximum of 5,000 rows of data. If the data to be queried exceeds 5,000 rows, the response provides the start index for the next query.

    Pass this token in the request to continue querying data from the row after the last row returned in the previous query. This token is used for paging.

    UjsM9x3aVcJi9a0-ArwJUTTC67C***37C0=

    Response elements

    Element

    Type

    Description

    Example

    object

    The response parameters.

    DomainName

    string

    The domain name.

    example.com
    EndTime

    string

    The end time. Format: yyyy-MM-ddTHH:mm:ssZ (UTC).

    2023-06-11T02:46:40Z
    NextPageToken

    string

    The paged query token. Each query returns a maximum of 5,000 rows of data. If the data to be queried exceeds 5,000 rows, the response provides the start index for the next query.

    Pass this token in the request to continue querying data from the row after the last row returned in the previous query. This token is used for paging.

    UjsM9x3aVcJi9a0-ArwJUTTC67C***37C0=
    PageSize

    integer

    The number of returned data rows.

    5000
    RequestId

    string

    The request ID.

    16A96B9A-F203-4EC5-8E43-CB92E68F4CD8
    StartTime

    string

    The start time. Format: yyyy-MM-ddTHH:mm:ssZ (UTC).

    2023-06-11T03:46:40Z

    StreamDetailData

    object

    StreamData

    array<object>

    The returned data set.

    object

    The stream data.

    AppName

    string

    The application name.

    app
    Duration

    integer

    The duration. Unit: seconds.

    300
    Fps

    string

    The frame rate.

    Valid values:

    • normal :

      normal

    • high :

      high

    • def :

      def

    high
    Region

    string

    The region.

    cn-shanghai
    Resolution

    string

    The resolution. Valid values:

    • 2K: 2K.

    • 4K: 4K.

    • LD: low definition.

    • SD: standard definition.

    • HD: high definition.

    • def: audio.

    Valid values:

    • SD :

      SD

    • def :

      def

    • 4K :

      4K

    • LD :

      LD

    • 2K :

      2K

    • HD :

      HD

    4K
    StreamName

    string

    The stream name.

    stream
    TimeStamp

    string

    The start time of the time slice.

    2023-06-11T02:45:00Z
    TranscodeType

    string

    The transcoding type. Valid values:

    • H264STD: H.264 standard transcoding.

    • H264NBHD: H.264 Narrowband HD transcoding.

    • H265STD: H.265 standard transcoding.

    • AUDIO: audio transcoding.

    Valid values:

    • H264NBHD :

      H264NBHD

    • AUDIO :

      AUDIO

    • H264STD :

      H264STD

    • H265STD :

      H265STD

    H264STD

    Examples

    Success response

    JSON format

    {
  "DomainName": "example.com",
  "EndTime": "2023-06-11T02:46:40Z",
  "NextPageToken": "UjsM9x3aVcJi9a0-ArwJUTTC67C***37C0=",
  "PageSize": 5000,
  "RequestId": "16A96B9A-F203-4EC5-8E43-CB92E68F4CD8",
  "StartTime": "2023-06-11T03:46:40Z\n",
  "StreamDetailData": {
    "StreamData": [
      {
        "AppName": "app",
        "Duration": 300,
        "Fps": "high",
        "Region": "cn-shanghai",
        "Resolution": "4K",
        "StreamName": "stream",
        "TimeStamp": "2023-06-11T02:45:00Z",
        "TranscodeType": "H264STD"
      }
    ]
  }
}

    Error codes

    HTTP status code

    Error code

    Error message

    Description
    400 InvalidStartTime.Malformed Specified StartTime is malformed.
    400 InvalidEndTime.Malformed Specified EndTime is malformed.
    400 InvalidTime.Malformed Specified StartTime or EndTime is malformed.
    400 InvalidEndTime.Mismatch Specified end time does not math the specified start time. The end time does not match the start time. Make sure that the start and end times match.
    400 InvalidTimeSpan The time span exceeds the limit. The time span exceeds the limit. Please refer to the API documentation to specify a reasonable time span.
    400 InvalidPageToken The token of page is invalid. The specified paging token is incorrect. Specify the correct token returned by the last query and confirm that your request parameters are not modified.
    400 InvalidAppName.Mismatch The AppName param must be passed. The AppName parameter does not match. Make sure that you specify the correct AppName.
    400 InvalidStreamProtocol.NotSupport The specified stream protocol is not support.
    400 InvalidStreamName.LengthTooLong The specified stream name is too long.
    400 InvalidAppName.LengthTooLong The specified app name is too long.
    400 InvalidTime.ValueNotSupported Specified Time is malformed. The specified time is invalid.

    See Error Codes for a complete list.

    Release notes

    See Release Notes for a complete list.