Queries the production studio usage data.
Operation description
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 in 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.
Debugging
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 Resourcesis 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:DescribeLiveProducerUsageData | get | *Domain acs:cdn:*:{#accountId}:domain/{#DomainName} |
| none |
Request parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| Region | string | No | The region in which the domain name resides. If you leave this parameter empty, the data of all regions is returned. You can specify multiple regions by separating them with commas (,). | cn-shanghai |
| DomainName | string | No | The streaming domain of the production studio.
| example.com |
| Instance | string | No | 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**** |
| Type | string | No | The type of the production studio. You can specify one or more production studio types. Separate multiple types with commas (,). Valid values:
Note
If you do not set this parameter, the usage data of all types of production studios is returned.
| slidelive |
| SplitBy | string | No | 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 |
| StartTime | string | No | 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 |
| 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 for a query. Valid values: 3600 and 86400. Unit: seconds. | 3600 |
| app | string | No | The name of the application to which the live stream belongs. | liveApp**** |
Response parameters
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 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. |
For a list of error codes, visit the Service error codes.
Change history
| Change time | Summary of changes | Operation |
|---|