DescribeLiveProducerUsageData - ApsaraVideo Live - Alibaba Cloud Documentation Center

Call DescribeLiveProducerUsageData to query usage data for a production studio.

Operation description

The minimum time granularity for a query is 1 hour. The maximum time span for a query is 31 days. You can query data generated within the last 90 days.

QPS Limits

The queries per second (QPS) limit for a single user is 5. If you exceed this limit, API calls are throttled. Throttling may impact your business. We recommend that you 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:DescribeLiveProducerUsageData

get

*Domain

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

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	No	The region ID.	cn-shanghai
Region	string	No	The region where the domain name is located. If you leave this parameter empty, the data for all regions is returned. You can query multiple regions at a time. Separate multiple region IDs with commas (,).	cn-shanghai
DomainName	string	No	The streaming domain name for the production studio. You can query one or more domain names. To query multiple domain names, separate them with commas (,). If you leave this parameter empty, the data for all streaming domain names is returned.	example.com
Instance	string	No	The instance to query. You can query multiple instances at a time. Separate multiple instance IDs with commas (,). Note If you leave this parameter empty, the data for all instances is returned.	a17d0184-462d-4630-b2a6-8c26dde2****
Type	string	No	The type of the production studio. You can query multiple types at a time. Separate multiple types with commas (,). Valid values: slidelive: playlist mode. universal: universal mode. Note If you leave this parameter empty, the data for all types of production studios is returned.	slidelive
SplitBy	string	No	The key to group data by. You can specify one or more of the following values: domain, region, instance, and type. Separate multiple values with commas (,). The data is grouped by the specified keys. Note If you leave this parameter empty, only the aggregated data is returned.	type
StartTime	string	No	The start 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.	2018-09-30T16:00:00Z
EndTime	string	No	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. Note The end time must be later than the start time.	2018-10-31T15:59:59Z
Interval	string	No	The time granularity of the data to query. Valid values: 3600 (1 hour) and 86400 (1 day). Unit: seconds.	3600
app	string	No	The name of the application to which the stream belongs.	liveApp****

Response parameters

Parameter	Type	Description	Example
	object
BillProducerData	object
BillProducerDataItem	array<object>	The usage data of the production studio.
	object
DomainName	string	The domain name for which the usage is queried. This parameter is returned when you set SplitBy to domain.	example.com
Instance	string	The instance for which the usage is queried. This parameter is returned when you set SplitBy to instance.	a17d0184-462d-4630-b2a6-8c26dde2****
OutputHdDuration	integer	The duration of high definition (HD) output. Unit: minutes.	6000
OutputLdDuration	integer	The duration of low definition (LD) output. Unit: minutes.	1001
OutputSdDuration	integer	The duration of standard definition (SD) output. Unit: minutes.	500
Region	string	The region for which the usage is queried. This parameter is returned when you set SplitBy to region.	cn-shanghai
TimeStamp	string	The start of the time slice.	2018-09-30T00:00:00Z
TranHdDuration	integer	The duration of HD transcoding. Unit: minutes.	6777
TranLdDuration	integer	The duration of LD transcoding. Unit: minutes.	111
TranSdDuration	integer	The duration of SD transcoding. Unit: minutes.	666
Type	string	The type of the production studio. This parameter is returned when you set SplitBy to type.	slidelive
EndTime	string	The end of the time range.	2018-09-30T16:00:00Z
RequestId	string	The request ID.	C370DAF1-C838-4288-A1A0-9A87633D248E
StartTime	string	The start of the time range.	2018-10-31T15:59:59Z

Examples

Success response

JSON format

{
  "BillProducerData": {
    "BillProducerDataItem": [
      {
        "DomainName": "example.com",
        "Instance": "a17d0184-462d-4630-b2a6-8c26dde2****",
        "OutputHdDuration": 6000,
        "OutputLdDuration": 1001,
        "OutputSdDuration": 500,
        "Region": "cn-shanghai",
        "TimeStamp": "2018-09-30T00:00:00Z",
        "TranHdDuration": 6777,
        "TranLdDuration": 111,
        "TranSdDuration": 666,
        "Type": "slidelive"
      }
    ]
  },
  "EndTime": "2018-09-30T16:00:00Z",
  "RequestId": "C370DAF1-C838-4288-A1A0-9A87633D248E",
  "StartTime": "2018-10-31T15:59:59Z"
}

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	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.