All Products
Search
Document Center

ApsaraVideo Live:DescribeLiveProducerUsageData

Last Updated:Sep 27, 2024

Queries the production studio usage data.

Operation description

Usage notes

The minimum time granularity for a query is 1 hour. The maximum time range for a query is 31 days. You can query the production studio usage data over the last 90 days.

QPS limit

You can call this operation up to 5 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. For more information, see QPS limits.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

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.
OperationAccess levelResource typeCondition keyAssociated operation
live:DescribeLiveProducerUsageDataget
  • Domain
    acs:cdn:*:{#accountId}:domain/{#DomainName}
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
RegionstringNo

The ID of the region where the domain name resides.

cn-shanghai
DomainNamestringNo

The streaming domain of the production studio. Separate multiple domain names with commas (,).

example.com
InstancestringNo

The production studio instance that you want to query. You can specify one or more production studio instances. Separate multiple instances with commas (,).

Note If you do not set this parameter, the usage data of all production studio instances is returned.
a17d0184-462d-4630-b2a6-8c26dde2****
TypestringNo

The type of the production studio. You can specify one or more production studio types. Separate multiple types with commas (,). Valid values:

  • slidelive: playlist-mode studio.
  • universal: general studio.
Note If you do not set this parameter, the usage data of all types of production studios is returned.
slidelive
SplitBystringNo

The key that is used to group data. You can specify one or more keys. Separate multiple keys with commas (,). Valid values: domain, region, instance, and type. The data for a key that you specify by using the SplitBy parameter is returned by group.

Note If you do not set this parameter, the aggregated data is returned.
type
StartTimestringNo

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.

2018-09-30T16:00:00Z
EndTimestringNo

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
IntervalstringNo

The time granularity for a query. Valid values: 3600 and 86400. Unit: seconds.

3600
appstringNo

The name of the application to which the live stream belongs.

liveApp****

Response parameters

ParameterTypeDescriptionExample
object
BillProducerDataarray<object>

The production studio usage data.

BillProducerDataItemobject
DomainNamestring

The domain name. If domain is specified by the SplitBy parameter, the usage data is returned based on different domain names.

example.com
Instancestring

The production studio instance. If instance is specified by the SplitBy parameter, the usage data is returned based on different production studio instances.

a17d0184-462d-4630-b2a6-8c26dde2****
OutputHdDurationlong

The duration of high definition streaming. Unit: minutes.

6000
OutputLdDurationlong

The duration of low definition streaming. Unit: minutes.

1001
OutputSdDurationlong

The duration of standard definition streaming. Unit: minutes.

500
Regionstring

The region. If region is specified by the SplitBy parameter, the usage data is returned based on different regions.

cn-shanghai
TimeStampstring

The timestamp of the returned data.

2018-09-30T00:00:00Z
TranHdDurationlong

The duration of high definition transcoding. Unit: minutes.

6777
TranLdDurationlong

The duration of low definition transcoding. Unit: minutes.

111
TranSdDurationlong

The duration of standard definition transcoding. Unit: minutes.

666
Typestring

The type of the production studio. If type is specified by the SplitBy parameter, the usage data is returned based on different types of production studios.

slidelive
EndTimestring

The end of the time range during which data was queried.

2018-09-30T16:00:00Z
RequestIdstring

The ID of the request.

C370DAF1-C838-4288-A1A0-9A87633D248E
StartTimestring

The start of the time range for which the data was queried.

2018-10-31T15:59:59Z

Examples

Sample success responses

JSONformat

{
  "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 codeError codeError messageDescription
400InvalidStartTime.MalformedSpecified StartTime is malformed.-
400InvalidEndTime.MalformedSpecified EndTime is malformed.-
400InvalidTime.MalformedSpecified StartTime or EndTime is malformed.-
400InvalidEndTime.MismatchSpecified 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.
400InvalidTimeSpanThe time span exceeds the limit.The time span exceeds the limit. Please refer to the API documentation to specify a reasonable time span.
400InvalidTime.ValueNotSupportedSpecified Time is malformed.The specified time is invalid.

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

Change history

Change timeSummary of changesOperation
No change history