Query Live Transcoding Data with DescribeLiveDomainStreamTranscodeData - ApsaraVideo Live - Alibaba Cloud - ApsaraVideo Live

Queries the transcoding usage data of a domain name by calling DescribeLiveDomainStreamTranscodeData.

Operation description

You can use this operation to query network bandwidth data for each time interval.
Batch domain name queries are supported. Separate multiple domain names with commas (,).
You can query data from the last 90 days.
The data time granularity is hour or day.
For the billing tiers that correspond to different transcoding types and transcoding resolutions, see the billing tier description for different instance specifications in Live stream transcoding billing.

QPS limit

The single-user QPS limit for this operation is 20 calls per second. If the limit is exceeded, API calls are throttled, which may affect your business. Invoke this operation appropriately.

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 of the streamer to query. You can query a single domain name or multiple domain names at a time. Separate multiple domain names with commas (,). If this parameter is left empty, the merged data of all live streaming domain names is returned by default. When you specify DomainName, make sure that the specified domain name is a live streaming domain name and that the user calling this operation has the permissions to operate on the specified domain name.	example.com
StartTime	string	Yes	The beginning of the time range to query. Specify the time in the yyyy-MM-ddTHH:mm:ssZ format in UTC. The minimum data time granularity is 1 hour. If this parameter is left empty, data from the last 24 hours is read by default.	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 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. Valid values: sec : in seconds. min : in minutes.	min
Interval	string	No	The time granularity of the query. Unit: seconds. Valid values: 3600: by hour. 86400: by day. Note If this parameter is left empty, the default granularity is by hour. Valid values: 3600 : by hour. 86400 : by day.	3600
Split	string	No	The grouping key. Valid values: domain: domain name. If the Split (grouping key) parameter is set to domain, the Domain response parameter takes effect. region: live center region. If the Split (grouping key) parameter is set to region, the Region response parameter takes effect. transcode_type: transcoding type. If the Split (grouping key) parameter is set to transcode_type, the TanscodeType response parameter takes effect. resolution: resolution. If the Split (grouping key) parameter is set to resolution, the Resolution response parameter takes effect. fps: frame rate. If the Split (grouping key) parameter is set to fps, the Fps response parameter takes effect. You can specify one or more values. Separate multiple values with commas (,). Default value: `domain,region,transcode_type,resolution,fps`, which means all grouping keys are applied.	domain

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	3C6CCEC4-6B88-4D4A-93E4-D47B******
TranscodeDataList	object
TranscodeData	array<object>	The network bandwidth data for each time interval.
	object
TanscodeType	string	The transcoding type. Valid values: Note This response parameter takes effect only when the Split request parameter is set to transcode_type. H264NBHD: H.264 Narrowband HD™ transcoding. H265NBHD: H.265 Narrowband HD™ transcoding. AUDIO: audio transcoding.	H264STD
Domain	string	The streamer streaming domain. Note This response parameter takes effect only when the Split request parameter is set to domain.	example.com
Region	string	The region to which the domain name belongs. Valid values: Note This response parameter takes effect only when the Split request parameter is set 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 beginning of the time interval. The time is in the yyyy-MM-ddTHH:mm:ssZ format in UTC.	2017-12-10T20:00:00Z
Fps	string	The frame rate. Note This response parameter takes effect only when the Split request parameter is set to fps.	normal
Resolution	string	The resolution. Valid values: Note This response parameter takes effect only when the Split request parameter is set to resolution. 2K 4K LD: low definition. SD: standard definition. HD: high definition. def: audio.	HD

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.