DescribeLiveDomainStreamTranscodeData - ApsaraVideo Live

Operation description

This operation queries transcoding usage data for specified time intervals.
You can query data for multiple domain names in a single call by separating the domain names with commas (,).
You can query data for the last 90 days.
The data is available at a time granularity of one hour or one day.
For more information about the billing tiers for different transcoding types and resolutions, see Live stream transcoding billing.

QPS limit

The queries per second (QPS) limit for this operation is 20 for each user. If the number of calls per second exceeds this limit, throttling is triggered. This may affect your business. We recommend that you plan your calls accordingly.

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

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	No	The region ID.	cn-shanghai
DomainName	string	No	The streaming domain name to query. You can query a single domain name or multiple domain names. To query multiple domain names, separate them with commas (,). If you leave this parameter empty, the merged data for all live streaming domains is returned. If you specify this parameter, make sure that the domain name is a live streaming domain and that you have the required permissions to operate on it.	example.com
StartTime	string	Yes	The start of the time range to query. Specify the time in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC. The minimum time granularity is 1 hour. If you do not specify this parameter, data from the last 24 hours is queried.	2017-12-10T20:00:00Z
EndTime	string	Yes	The end of the time range to query. Specify the time 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): The data is returned in minutes. sec: The data is returned in seconds.	min
Interval	string	No	The time granularity of the query. Unit: seconds. Valid values: 3600: by hour. 86400: by day. Note If you do not specify this parameter, the data is returned by hour by default.	3600
Split	string	No	The key to group data by. Valid values: domain: domain name. If you set the Split parameter to domain, the Domain parameter is returned. region: live center region. If you set the Split parameter to region, the Region parameter is returned. transcode_type: transcoding type. If you set the Split parameter to transcode_type, the TanscodeType parameter is returned. resolution: resolution. If you set the Split parameter to resolution, the Resolution parameter is returned. fps: frame rate. If you set the Split parameter to fps, the Fps parameter is returned. You can specify one or more keys. Separate multiple keys with commas (,). The default value is `domain,region,transcode_type,resolution,fps`, which groups data by all keys.	domain

Response parameters

Parameter	Type	Description	Example
	object
RequestId	string	The request ID.	3C6CCEC4-6B88-4D4A-93E4-D47B******
TranscodeDataList	object
TranscodeData	array<object>	The transcoding data for each time interval.
	object
TanscodeType	string	The transcoding type. Valid values: Note This parameter is returned only when you set the Split parameter to transcode_type. H264NBHD: H.264 Narrowband HD transcoding. H265NBHD: H.265 Narrowband HD transcoding. AUDIO: audio transcoding.	H264STD
Domain	string	The streaming domain name. Note This parameter is returned only when you set the Split parameter to domain.	example.com
Region	string	The region where the domain name is located. Valid values: Note This parameter is returned only when you set the Split parameter to region. cn-beijing: Beijing. cn-shanghai: Shanghai. cn-qingdao: Qingdao. cn-shenzhen: Shenzhen. ap-northeast-1: Japan. ap-southeast-1: Singapore. ap-southeast-5: Indonesia. eu-central-1: Germany.	cn-beijing
Duration	integer	The duration. Unit: minutes.	2000
TimeStamp	string	The start time of the time slice.	2017-12-10T20:00:00Z
Fps	string	The frame rate. Note This parameter is returned only when you set the Split parameter to fps.	normal
Resolution	string	The resolution. Valid values: Note This parameter is returned only when you set the Split parameter to resolution. 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 request rate exceeded the limit. | | InvalidDomain.NotFound | The domain provided does not belong to you. | 404 | The specified domain name does not exist or does not belong to your Alibaba Cloud account. |

Examples

Success response

JSON format

{
  "RequestId": "3C6CCEC4-6B88-4D4A-93E4-D47B******",
  "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.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.