Queries the stream delay usage data.
Operation description
- You can call this operation to query your stream delay usage data. The default time granularity is 1 hour.
- The maximum time range for a query is 31 days.
- The minimum time granularity for a query is 1 hour.
- You can query the data in the last 31 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:DescribeLiveDelayedStreamingUsage | get | *Domain acs:cdn:*:{#accountId}:domain/{#DomainName} |
| none |
Request parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| DomainName | string | No | The main streaming domain to query.
| example.com |
| 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. By default, data in the last seven days is returned. | 2022-10-10T20: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. The end time must be later than the start time. We recommend that you specify a time range that is less than or equal to 10 hours. | 2022-10-10T21:00:00Z |
| StreamName | string | No | The name of the stream. Separate multiple stream names with commas (,). By default, data of all streams is aggregated and returned. | liveStream**** |
| Region | string | No | The ID of the region. Separate multiple region IDs with commas (,). Valid values:
If you leave this parameter empty, data of all regions is aggregated and returned by default. | cn-shanghai |
| SplitBy | string | No | The key that is used to group data. If you leave this parameter empty, data is aggregated and returned. Valid values:
Note
This parameter takes effect only if the parameter corresponding to the value of this parameter is not left empty. Otherwise, an error is returned. For example, you cannot set this parameter to domain if the DomainName parameter is left empty.
| domain |
| Interval | string | No | The time granularity of the query. Unit: seconds. Valid values:
If you specify an invalid value or do not specify this parameter, the default value 3600 is used. | 3600 |
Response parameters
Examples
Sample success responses
JSONformat
{
"DelayData": {
"DelayDataItem": [
{
"DomainName": "example.com",
"Duration": 84,
"Region": "cn-shanghai",
"StreamName": "liveStream****",
"TimeStamp": "2022-10-10T20:00:00Z"
}
]
},
"EndTime": "2022-10-10T21:00:00Z",
"RequestId": "4B460F8B-993C-4F48-B98A-910811DEBFEB",
"StartTime": "2022-10-10T20:00:00Z"
}Error codes
| HTTP status code | Error code | Error message | Description |
|---|---|---|---|
| 400 | InvalidParameter | InvalidParameter. | - |
| 400 | InvalidStartTime.Malformed | The specified StartTime parameter is invalid. | - |
| 400 | InvalidEndTime.Malformed | The specified EndTime is invalid. | - |
| 400 | InvalidStartTime.ValueNotSupported | The StartTime cannot exceed 31 days before the current time. | - |
| 400 | InvalidParameter | The specified parameter is invalid. | - |
| 400 | InvalidTime.Malformed | Specified Time is malformed. | Invalid time. Check whether the time that you specified is correct. |
| 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 | LiveServiceNotFound | %s | - |
For a list of error codes, visit the Service error codes.
Change history
| Change time | Summary of changes | Operation |
|---|