1. 接口描述
接口请求域名: teo.tencentcloudapi.com 。
本接口(DescribeTimingL7AnalysisData)查询七层数据分析类时序数据。
默认接口请求频率限制:100次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:DescribeTimingL7AnalysisData。 |
Version | 是 | String | 公共参数,本接口取值:2022-09-01。 |
Region | 否 | String | 公共参数,此参数为可选参数。 |
StartTime | 是 | Timestamp ISO8601 | 开始时间。 |
EndTime | 是 | Timestamp ISO8601 | 结束时间。 |
MetricNames.N | 是 | Array of String | 指标列表,取值有: |
ZoneIds.N | 否 | Array of String | 站点 ID 集合, 此参数必填。 |
Interval | 否 | String | 查询时间粒度,取值有: |
Filters.N | 否 | Array of QueryCondition | 过滤条件,详细的过滤条件Key值如下: 按照【国家/地区】进行过滤,国家/地区遵循 ISO 3166 规范。 按照【省份】进行过滤,此参数只支持服务区域为中国大陆。 按照【运营商】进行过滤,此参数只支持服务区域为中国大陆。 对应的Value可选项如下: 2:中国电信; 26:中国联通; 1046:中国移动; 3947:中国铁通; 38:教育网; 43:长城宽带; 0:其他运营商。 按照【子域名】进行过滤,子域名形如: test.example.com。 按照【URL Path】进行过滤,URL Path形如:/content或/content/test.jpg。 若只填写url参数,则最多可查询近30天的数据; 若同时填写url+Zonelds参数,则支持的查询数据范围为套餐支持的数据分析最大查询范围与30天两者中的较小值。 按照【Referer头信息】进行过滤, Referer形如:example.com。 若只填写referer参数,则最多可查询近30天的数据; 若同时填写referer+Zonelds参数,则支持的查询数据范围为套餐支持的数据分析最大查询范围与30天两者中的较小值。 按照【资源类型】进行过滤,资源类型一般是文件后缀,形如: .jpg, .css。 若只填写resourceType参数,则最多可查询近30天的数据; 若同时填写resourceType+Zonelds参数,则支持的查询数据范围为套餐支持的数据分析最大查询范围与30天两者中的较小值。 按照【HTTP协议版本】进行过滤。 对应的Value可选项如下: HTTP/1.0:HTTP 1.0; HTTP/1.1:HTTP 1.1; HTTP/2.0:HTTP 2.0; HTTP/3.0:HTTP 3.0; WebSocket:WebSocket。 按照【HTTP协议类型】进行过滤。 对应的Value可选项如下: HTTP:HTTP 协议; HTTPS:HTTPS协议; QUIC:QUIC协议。 按照【状态码】进行过滤。 若只填写statusCode参数,则最多可查询近30天的数据; 若同时填写statusCode+Zonelds参数,则支持的查询数据范围为套餐支持的数据分析最大查询范围与30天两者中的较小值。 对应的Value可选项如下: 1XX:1xx类型的状态码; 100:100状态码; 101:101状态码; 102:102状态码; 2XX:2xx类型的状态码; 200:200状态码; 201:201状态码; 202:202状态码; 203:203状态码; 204:204状态码; 205:205状态码; 206:206状态码; 207:207状态码; 3XX:3xx类型的状态码; 300:300状态码; 301:301状态码; 302:302状态码; 303:303状态码; 304:304状态码; 305:305状态码; 307:307状态码; 4XX:4xx类型的状态码; 400:400状态码; 401:401状态码; 402:402状态码; 403:403状态码; 404:404状态码; 405:405状态码; 406:406状态码; 407:407状态码; 408:408状态码; 409:409状态码; 410:410状态码; 411:411状态码; 412:412状态码; 412:413状态码; 414:414状态码; 415:415状态码; 416:416状态码; 417:417状态码; 422:422状态码; 423:423状态码; 424:424状态码; 426:426状态码; 451:451状态码; 5XX:5xx类型的状态码; 500:500状态码; 501:501状态码; 502:502状态码; 503:503状态码; 504:504状态码; 505:505状态码; 506:506状态码; 507:507状态码; 510:510状态码; 514:514状态码; 544:544状态码。 按照【浏览器类型】进行过滤。 若只填写browserType参数,则最多可查询近30天的数据; 若同时填写browserType+Zonelds参数,则支持的查询数据范围为套餐支持的数据分析最大查询范围与30天两者中的较小值。 对应Value的可选项如下: Firefox:Firefox浏览器; Chrome:Chrome浏览器; Safari:Safari浏览器; Other:其他浏览器类型; Empty:浏览器类型为空; Bot:搜索引擎爬虫; MicrosoftEdge:MicrosoftEdge浏览器; IE:IE浏览器; Opera:Opera浏览器; QQBrowser:QQ浏览器; LBBrowser:LB浏览器; MaxthonBrowser:Maxthon浏览器; SouGouBrowser:搜狗浏览器; BIDUBrowser:百度浏览器; TaoBrowser:淘浏览器; UBrowser:UC浏览器。 按照【设备类型】进行过滤。 若只填写deviceType参数,则最多可查询近30天的数据; 若同时填写deviceType+Zonelds参数,则支持的查询数据范围为套餐支持的数据分析最大查询范围与30天两者中的较小值。 对应Value的可选项如下: TV:TV设备; Tablet:Tablet设备; Mobile:Mobile设备; Desktop:Desktop设备; Other:其他设备类型; Empty:设备类型为空。 按照【操作系统类型】进行过滤。 若只填写operatingSystemType参数,则最多可查询近30天的数据; 若同时填写operatingSystemType+Zonelds参数,则支持的查询数据范围为套餐支持的数据分析最大查询范围与30天两者中的较小值。 对应Value的可选项如下: Linux:Linux操作系统; MacOS:MacOs操作系统; Android:Android操作系统; IOS:IOS操作系统; Windows:Windows操作系统; NetBSD:NetBSD; ChromiumOS:ChromiumOS; Bot:搜索引擎爬虫; Other:其他类型的操作系统; Empty:操作系统为空。 按照【TLS版本】进行过滤。 若只填写tlsVersion参数,则最多可查询近30天的数据; 若同时填写tlsVersion+Zonelds参数,则支持的查询数据范围为套餐支持的数据分析最大查询范围与30天两者中的较小值。 对应Value的可选项如下: TLS1.0:TLS 1.0; TLS1.1:TLS 1.1; TLS1.2:TLS 1.2; TLS1.3:TLS 1.3。 按照【IP版本】进行过滤。 对应Value的可选项如下: 4:Ipv4; 6:Ipv6。 按照【标签Key】进行过滤。 按照【标签Value】进行过滤。 |
Area | 否 | String | 数据归属地区,取值有: |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
TotalCount | Integer | 查询结果的总条数。 |
Data | Array of TimingDataRecord | 时序流量数据列表。 注意:此字段可能返回 null,表示取不到有效值。 |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 根据协议查询时序流量数据
根据协议筛选条件获取请求数指标的数据
输入示例
POST / HTTP/1.1
Host: teo.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeTimingL7AnalysisData
<公共请求参数>
{
"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": "protocol",
"Operator": "equals",
"Value": [
"HTTP/1.0",
"HTTP/1.1"
]
}
],
"ZoneIds": [
"zone-2o7b38ba1hvr"
]
}
输出示例
{
"Response": {
"RequestId": "141a7ccd-9713-43a2-91d5-1b47692d0609",
"Data": [
{
"TypeKey": "251227260",
"TypeValue": [
{
"Avg": 803,
"Detail": [
{
"Timestamp": 1659139200,
"Value": 0
},
{
"Timestamp": 1661731200,
"Value": 0
}
],
"Max": 7921,
"MetricName": "l7Flow_request",
"Sum": 24918
}
]
}
],
"TotalCount": 1
}
}
示例2 根据标签查询时序流量数据
根据标签的筛选条件获取请求数指标
输入示例
POST / HTTP/1.1
Host: teo.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeTimingL7AnalysisData
<公共请求参数>
{
"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-2o7b38ba1hvr"
]
}
输出示例
{
"Response": {
"RequestId": "141a7ccd-9713-43a2-91d5-1b47692d0609",
"Data": [
{
"TypeKey": "251227260",
"TypeValue": [
{
"Avg": 803,
"Detail": [
{
"Timestamp": 1659139200,
"Value": 0
},
{
"Timestamp": 1661731200,
"Value": 0
}
],
"Max": 7921,
"MetricName": "l7Flow_request",
"Sum": 24918
}
]
}
],
"TotalCount": 1
}
}
示例3 查询七层数据分析类时序流量数据
查询七层流量请求数指标的数据
输入示例
POST / HTTP/1.1
Host: teo.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeTimingL7AnalysisData
<公共请求参数>
{
"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-2o7b38ba1hvr"
]
}
输出示例
{
"Response": {
"RequestId": "141a7ccd-9713-43a2-91d5-1b47692d0609",
"Data": [
{
"TypeKey": "251227260",
"TypeValue": [
{
"Avg": 803,
"Detail": [
{
"Timestamp": 1659139200,
"Value": 0
},
{
"Timestamp": 1661731200,
"Value": 0
}
],
"Max": 7921,
"MetricName": "l7Flow_request",
"Sum": 24918
}
]
}
],
"TotalCount": 1
}
}
5. 开发者资源
腾讯云 API 平台
腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。
API Inspector
用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。
SDK
云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。
- Tencent Cloud SDK 3.0 for Python: GitHub Gitee
- Tencent Cloud SDK 3.0 for Java: GitHub Gitee
- Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
- Tencent Cloud SDK 3.0 for Go: GitHub Gitee
- Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
- Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
- Tencent Cloud SDK 3.0 for C++: GitHub Gitee
- Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
FailedOperation | 操作失败。 |
InternalError.ProxyServer | 后端服务器发生未知错误。 |
InvalidParameter | 参数错误。 |
InvalidParameterValue | 参数取值错误。 |
LimitExceeded | 超过配额限制。 |
LimitExceeded.QueryTimeLimitExceeded | 查询时间范围超出限制。 |
OperationDenied | 操作被拒绝。 |
ResourceNotFound | 资源不存在。 |
ResourceUnavailable | 资源不可用。 |
UnauthorizedOperation.CamUnauthorized | Cam 未授权。 |