DescribeOverviewL7Data
1. API Description
Domain name for API request: teo.tencentcloudapi.com.
This API is used to query the time sequence traffic data of the monitoring category in L7. This API is to be discarded. Please use the API DescribeTimingL7AnalysisData.
A maximum of 100 requests can be initiated per second for this API.
2. Input Parameters
The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.
Parameter Name | Required | Type | Description |
---|---|---|---|
Action | Yes | String | Common Params. The value used for this API: DescribeOverviewL7Data. |
Version | Yes | String | Common Params. The value used for this API: 2022-09-01. |
Region | No | String | Common Params. This parameter is not required. |
StartTime | Yes | Timestamp ISO8601 | The start time. |
EndTime | Yes | Timestamp ISO8601 | The end time. |
MetricNames.N | Yes | Array of String | The metric to query. Values:l7Flow_outFlux : Traffic used for EdegOne responsesl7Flow_inFlux : Traffic used for EdegOne requestsl7Flow_outBandwidth : Bandwidth used for EdegOne responsesl7Flow_inBandwidth : Bandwidth used for EdegOne requestsl7Flow_hit_outFlux : Traffic used for cache hitl7Flow_request : Access requestsl7Flow_flux : Upstream and downstream traffic used for client accessl7Flow_bandwidth : Upstream and downstream bandwidth used for client access |
ZoneIds.N | No | Array of String | ZoneId set. This parameter is required. |
Domains.N | No | Array of String | Queried domain name set. This parameter has been discarded. |
Protocol | No | String | The protocol type. Values:http : HTTP protocol;https : HTTPS protocol;http2 : HTTP2 protocol;all : All protocols. all is used. This parameter is not yet available now. |
Interval | No | String | The query granularity. Values:min : 1 minute;5min : 5 minutes;hour : 1 hour;day : One dayPeriod <= 1 hour: min ; 1 hour < Period <= 2 days: 5min ; 2 days < period <= 7 days: hour ; Period > 7 days: day . |
Filters.N | No | Array of QueryCondition | Filtering condition. The detailed filtering condition key values are as follows: HTTP: HTTP protocol; HTTPS: HTTPS protocol; QUIC: QUIC protocol. |
Area | No | String | Geolocation scope. Values:overseas : Regions outside the Chinese mainlandmainland : Chinese mainlandglobal : Globalglobal is used. |
3. Output Parameters
Parameter Name | Type | Description |
---|---|---|
TotalCount | Integer | Total number of query results. |
Data | Array of TimingDataRecord | Note: This field may return 'null', which indicates a failure to obtain a valid value. |
RequestId | String | The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem. |
4. Example
Example1 Querying Time Sequence Traffic Data based on the Tag
Obtain the indicator for the number of requests based on the filtering conditions of tags.
Input Example
POST / HTTP/1.1
Host: teo.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeOverviewL7Data
<Common request parameters>
{
"EndTime": "2022-08-29T19:17:59+08:00",
"Interval": "day",
"Area": "mainland",
"StartTime": "2022-07-31T00:00:00+08:00",
"MetricNames": [
"l7Flow_request"
],
"Filters": [
{
"Key": "tagKey",
"Operator": "equals",
"Value": [
"test1"
]
},
{
"Key": "tagValue",
"Operator": "equals",
"Value": [
"a.com",
"b.com"
]
}
],
"ZoneIds": [
"zone-2mzegj4vln5f"
]
}
Output Example
{
"Response": {
"RequestId": "6cc74d08-c174-413a-976b-abe7b851e0121",
"Data": [
{
"TypeKey": "251227260",
"TypeValue": [
{
"Avg": 1564,
"Detail": [
{
"Timestamp": 1659139200,
"Value": 100
},
{
"Timestamp": 1659225600,
"Value": 34
}
],
"Max": 8037,
"MetricName": "l7Flow_request",
"Sum": 48511
}
]
}
],
"TotalCount": 1
}
}
Example2 Querying L7 Monitoring Time Sequence Traffic Data
Indicator for the number of L7 monitoring data query requests
Input Example
POST / HTTP/1.1
Host: teo.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeOverviewL7Data
<Common request parameters>
{
"EndTime": "2022-08-29T19:17:59+08:00",
"Interval": "day",
"Area": "mainland",
"StartTime": "2022-07-31T00:00:00+08:00",
"MetricNames": [
"l7Flow_request"
],
"ZoneIds": [
"zone-2mzegj4vln5f"
]
}
Output Example
{
"Response": {
"RequestId": "6cc74d08-c174-413a-976b-abe7b851e010",
"Data": [
{
"TypeKey": "251227260",
"TypeValue": [
{
"Avg": 1564,
"Detail": [
{
"Timestamp": 1659139200,
"Value": 0
},
{
"Timestamp": 1659225600,
"Value": 0
}
],
"Max": 8037,
"MetricName": "l7Flow_request",
"Sum": 48511
}
]
}
],
"TotalCount": 1
}
}
5. Developer Resources
SDK
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
- Tencent Cloud SDK 3.0 for Python
- Tencent Cloud SDK 3.0 for Java
- Tencent Cloud SDK 3.0 for PHP
- Tencent Cloud SDK 3.0 for Go
- Tencent Cloud SDK 3.0 for Node.js
- Tencent Cloud SDK 3.0 for .NET
- Tencent Cloud SDK 3.0 for C++
Command Line Interface
6. Error Code
The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.
Error Code | Description |
---|---|
FailedOperation | Operation failed. |
InternalError.RouteError | The backend routing address is incorrect. |
InvalidParameter | Parameter error. |
InvalidParameterValue | Invalid parameter value. |
LimitExceeded.QueryTimeLimitExceeded | Query time limit exceeded. |
ResourceNotFound | The resource doesn’t exist. |
ResourceUnavailable | The resource is unavailable. |
UnauthorizedOperation.CamUnauthorized | CAM is not authorized. |