DescribeLiveStreamTranscodeMetricData - ApsaraVideo Live

Queries transcoding metrics for a specified domain name at the application and stream levels.

Operation description

Maximum query time span: 24 hours.
Minimum time granularity: 5 minutes.
Maximum query range: data from the past 31 days.

QPS limit

The queries per second (QPS) limit for a single user is 10 calls per second. If you exceed this limit, API calls are throttled, which may affect your business. Call this API within the recommended limit.

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

*Domain

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

None

Request parameters

Parameter	Type	Required	Description	Example
DomainName	string	Yes		example.com
StartTime	string	Yes	The domain name. You can specify only one domain name.	2023-06-11T02:46:40Z
EndTime	string	Yes	The start time in UTC. The time must be in the yyyy-MM-ddTHH:mm:ssZ format.	2023-06-11T03:46:40Z
AppName	string	No	The end of the time range to query, in the yyyy-MM-ddTHH:mm:ssZ format (UTC). The end time must be later than the start time.	app
StreamName	string	No	The name of the application.	stream
NextPageToken	string	No	The name of the stream.	UjsM9x3aVcJi9a0-ArwJUTTC67C***37C0=

Response elements

Element	Type	Description	Example
	object	The response parameters.
DomainName	string	The domain name.	example.com
EndTime	string	The end of the time range. The time is in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC.	2023-06-11T02:46:40Z
NextPageToken	string	The token for a paged query. Each query returns a maximum of 5,000 data entries. If more data exists, this token is returned. Include this token in your next request to retrieve the next page of results.	UjsM9x3aVcJi9a0-ArwJUTTC67C***37C0=
PageSize	integer	The number of data entries returned.	5000
RequestId	string	The request ID.	16A96B9A-F203-4EC5-8E43-CB92E68F4CD8
StartTime	string	The start of the time range. The time is in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC.	2023-06-11T03:46:40Z
StreamDetailData	object
StreamData	array<object>	The returned data.
	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: Standard H.264 transcoding. H264NBHD: Narrowband HD H.264 transcoding. H265STD: Standard H.265 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.