Queries the monitoring data of streams for a specified domain name. Up to 5,000 rows of data can be returned per call.
Operation description
If you call this operation to query the monitoring data of streams under a domain name for the first time, you must submit a ticket for backend configuration. Provide the following information in the ticket:
- The domain name that you want to query
- The maximum number of concurrent streams under the domain name
- The maximum number of concurrent online users in each stream
Usage limits
- By default, statistics on the number of viewers who watch streams over the HTTP Live Streaming (HLS) protocol cannot be collected.
- You can specify only one domain name in each call.
- The maximum time range to query is 24 hours.
- The minimum data granularity to query is 1 minute.
- You can query data in the last 31 days.
QPS limit
You can call this operation up to 10 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:DescribeLiveStreamMetricDetailData | none | *Domain acs:cdn:*:{#accountId}:domain/{#DomainName} |
| none |
Request parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| DomainName | string | No | The accelerated domain name. You can specify only one domain name. If you specify multiple domain names, errors occur. If you do not specify the AppName and StreamName parameters, monitoring data of all streams for the domain name is returned. | example.com |
| StartTime | string | Yes | 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. | 2015-12-10T20:00:00Z |
| EndTime | string | Yes | The end of the time range to query. The end time must be later than the start time, and the maximum time range that can be specified is one day. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC. | 2015-12-10T21:00:00Z |
| AppName | string | No | The name of the application for which you want to query the monitoring data of streams. Note
If you specify the StreamName parameter, you must also specify the AppName parameter.
| liveApp**** |
| StreamName | string | No | The name of the stream. The stream must belong to the application that is specified by the AppName parameter. Note
If you specify the StreamName parameter, you must also specify the AppName parameter.
| liveStream**** |
| Protocol | string | No | The streaming protocol. Valid values: flv, hls, rtmp, rts, and p2p. You can specify multiple protocols. Separate multiple protocols with commas (,). However, data over multiple protocols is not aggregated and is returned based on the stream. | flv |
| NextPageToken | string | No | The token used to query data by page. Up to 5,000 rows of data can be returned per query. If the number of rows exceeds 5,000, a token that determines the start point of the next query is provided in the response. If you specify this parameter, data continues to be obtained from the end of the previous query. | UjsM9x3aVcJi9a0-ArwJUTTC67CIBKLw***** |
Response parameters
Examples
Sample success responses
JSONformat
{
"DomainName": "example.com",
"EndTime": "2015-12-10T21:00:00Z",
"NextPageToken": "UjsM9x3aVcJi9a0-ArwJUTTC67C***37C0=",
"PageSize": 5000,
"RequestId": "B955107D-E658-4E77-B913-E0AC3D31693E",
"StartTime": "2015-12-10T20:00:00Z",
"StreamDetailData": {
"StreamData": [
{
"AppName": "app",
"Bps": 423304182.66,
"Count": 423304182,
"FlvBps": 454,
"FlvCount": 32,
"FlvTraffic": 1254,
"HlsBps": 4456,
"HlsCount": 56,
"HlsTraffic": 568,
"NewConns": "450",
"P2pBps": 6845,
"P2pCount": 78,
"P2pTraffic": 4102,
"RtmpBps": 3323,
"RtmpCount": 63,
"RtmpTraffic": 5568,
"RtsBps": 2361,
"RtsCount": 89,
"RtsTraffic": 2322,
"StreamName": "test.flv",
"TimeStamp": "2015-12-10T20:00:00Z",
"Traffic": 423304182
}
]
}
}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 | 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 | InvalidPageToken | The token of page is invalid. | The specified paging token is incorrect. Specify the correct token returned by the last query and confirm that your request parameters are not modified. |
| 400 | InvalidAppName.Mismatch | The AppName param must be passed. | The AppName parameter does not match. Make sure that you specify the correct AppName. |
| 400 | InvalidStreamProtocol.NotSupport | The specified stream protocol is not support. | - |
| 400 | InvalidStreamName.LengthTooLong | The specified stream name is too long. | - |
| 400 | InvalidAppName.LengthTooLong | The specified app name is too long. | - |
| 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 |
|---|---|---|
| 2023-12-21 | The API operation is not deprecated.. The Error code has changed. The response structure of the API has changed | View Change Details |
| 2023-03-14 | The Error code has changed | View Change Details |