DescribeLiveDomainStreamTranscodeData - ApsaraVideo Live

Queries the transcoding length for one or more domain names.

Operation description

You can call this operation to collect the transcoding usage data at each time interval.
You can specify multiple domain names by separating them with commas (,).
You can query data in the last 90 days.
The time granularity of data is 1 hour or 1 day.
For information about the billing of different transcoding types and transcoding resolutions, see the description about billing of different transcoding specifications in transcoding bills in the Billing of live stream transcoding section of the ApsaraVideo Live pricing page.

QPS limit

You can call this operation up to 20 times per second per account. Requests that exceed this limit are dropped and you will experience service interruptions. We recommend that you take note of this limit when you call this operation.

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.

Debug

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.

Operation	Access level	Resource type	Condition key	Associated operation
live:DescribeLiveDomainStreamTranscodeData	get	All Resources ``	none	none

Request parameters

Parameter	Type	Required	Description	Example
DomainName	string	No	The main streaming domain to query. You can query one or more domain names. If you specify multiple domain names, separate them with commas (,). If you leave this parameter empty, the data of all domain names within your Alibaba Cloud account is returned.	example.com
StartTime	string	Yes	The beginning of the time range to query. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC. The minimum query interval is 1 hour. If you do not set this parameter, the transcoding length for the last 24 hours is returned.	2017-12-10T20:00:00Z
EndTime	string	Yes	The end of the time range to query. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC.	2017-12-10T22:00:00Z
Precision	string	No	The time precision of the query. Valid values: min (default): in minutes. sec: in seconds.	min
Interval	string	No	The time granularity of the query. Unit: seconds. Valid values: 3600: 1 hour 86400: 1 day Note If you do not specify this parameter, the time granularity of 1 hour is used by default.	3600
Split	string	No	The key that is used to group data. Valid values: domain: The DomainName parameter is available in the response only if Split is set to domain. region: The Region parameter is available in the response only if Split is set to region. transcode_type: The TanscodeType parameter is available in the response only if Split is set to transcode_type. resolution: The Resolution parameter is available in the response only if Split is set to resolution. fps: The Fps parameter is available in the response only if Split is set to fps. You can specify one or more keys. If you specify multiple keys, separate them with commas (,). Default value: `domain,region,transcode_type,resolution,fps`.	domain

Response parameters

Parameter	Type	Description	Example
	object
RequestId	string	The ID of the request.	3C6CCEC4-6B88-4D4A-93E4-D47B3D92CF8F
TranscodeDataList	array<object>	The bandwidth data that was collected at each interval.
TranscodeData	object
TanscodeType	string	The transcoding type. This parameter is returned only when you add the transcode_type key to the value of the Split parameter. Valid values: H264STD: standard transcoding based on H.264 H264NBHD: Narrowband HD™ transcoding based on H.264 H265STD: standard transcoding based on H.265 AUDIO: audio transcoding	H264STD
Domain	string	The main streaming domain. This parameter is returned only when you add the domain key to the value of the Split parameter.	example.com
Region	string	The region in which the domain name resides. Valid values: Note This parameter takes effect only when you set Split to region. cn-beijing: China (Beijing) cn-shanghai: China (Shanghai) cn-qingdao: China (Qingdao) cn-shenzhen: China (Shenzhen) ap-northeast-1: Japan (Tokyo) ap-southeast-1: Singapore ap-southeast-5: Indonesia (Jakarta) eu-central-1: Germany (Frankfurt)	cn-beijing
Duration	integer	The transcoding length. Unit: minutes.	2000
TimeStamp	string	The timestamp of the data entry.	2017-12-10T20:00:00Z
Fps	string	The frame rate of the transcoded stream. This parameter is returned only when you add the fps key to the value of the Split parameter.	normal
Resolution	string	The resolution of the transcoded stream. This parameter is returned only when you add the resolution key to the value of the Split parameter. Valid values: 2K 4K LD: low definition SD: standard definition HD: high definition def: audio	HD

Special error codes

Error code	Error message	HTTP status code	Description
Throttling	Request was denied due to request throttling.	503	The error message returned because the request was denied due to throttling.
InvalidDomain.NotFound	The domain provided does not belong to you.	404	The error message returned because the domain name does not exist or does not belong to your Alibaba Cloud account.

Examples

Sample success responses

JSONformat

{
  "RequestId": "3C6CCEC4-6B88-4D4A-93E4-D47B3D92CF8F",
  "TranscodeDataList": {
    "TranscodeData": [
      {
        "TanscodeType": "H264STD",
        "Domain": "example.com",
        "Region": "cn-beijing",
        "Duration": 2000,
        "TimeStamp": "2017-12-10T20:00:00Z",
        "Fps": "normal",
        "Resolution": "HD"
      }
    ]
  }
}

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	InvalidParamPrecision	The parameter Precision is invalid, please check StartTime and EndTime or Precision.	The Precision parameter is invalid. Check the value of the StartTime, EndTime, or Precision parameter.
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	InvalidStartTime.ValueNotSupported	The specified value of parameter StartTime is not supported.	The value specified for the StartTime parameter is invalid.

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

Change history

Change time	Summary of changes	Operation
2024-09-29	API Description Update. The Error code has changed	View Change Details