Queries the stream ingest data of a specified domain name at the application level and the stream level.
Operation description
Usage notes
- You can query data of a single domain name in each request. If you specify multiple domain names, an error is returned.
- 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.
- This operation is used to monitor data. The data returned by this operation cannot be used as a reference to calculate resource usage for billing.
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. For more information, see QPS limits.
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:DescribeLiveStreamPushMetricDetailData | *Domain acs:cdn:*:{#accountId}:domain/{#DomainName} |
| none |
Request parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| DomainName | string | Yes |
| 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. | 2022-09-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. | 2022-09-10T21:00:00Z |
| AppName | string | No | The name of the application to which the live stream belongs. The stream-level data of this application is returned. | app |
| StreamName | string | No | The name of the live stream. The data of the stream in the specified application is returned. If the StreamName parameter is specified, the AppName parameter must also be specified. | test |
| NextPageToken | string | No | A pagination token. When you call this operation, up to 5,000 rows of data can be returned per query. If the number of rows exceeds 5,000, the response includes a pagination token that is used in the next request to retrieve a new page of results. When you specify the token in the next query, data continues to be obtained from the end of the previous query. | UjsM9x3aVcJi9a0-ArwJUTTC67C***37C0= |
Response parameters
Examples
Sample success responses
JSONformat
{
"DomainName": "example.com",
"EndTime": "2022-09-10T21:00:00Z",
"NextPageToken": "UjsM9x3aVcJi9a0-ArwJUTTC67C***37C0=",
"PageSize": 5000,
"RequestId": "5EBF2AC3-4B73-40A5-8B32-83F49D5F035E",
"StartTime": "2022-09-10T20:00:00Z",
"StreamDetailData": {
"StreamData": [
{
"AppName": "app",
"ReqBps": 423304182,
"ReqTraffic": 423304182.66,
"StreamName": "test.flv",
"TimeStamp": "2022-09-10T20:00:00Z"
}
]
}
}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 | 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 |
|---|