有奖捉虫:办公协同&微信生态&物联网文档专题 HOT

1. 接口描述

接口请求域名: teo.tencentcloudapi.com 。

本接口(DescribeTimingL4Data)用于查询四层时序流量数据列表。

默认接口请求频率限制:100次/秒。

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeTimingL4Data。
Version String 公共参数,本接口取值:2022-09-01。
Region String 公共参数,此参数为可选参数。
StartTime Timestamp ISO8601 开始时间。
EndTime Timestamp ISO8601 结束时间。
MetricNames.N Array of String 查询指标,取值有:
  • l4Flow_connections: 访问连接数;
  • l4Flow_flux: 访问总流量;
  • l4Flow_inFlux: 访问入流量;
  • l4Flow_outFlux: 访问出流量。
  • ZoneIds.N Array of String 站点 ID 集合,此参数必填。
    ProxyIds.N Array of String 四层实例列表, 不填表示选择全部实例。
    Interval String 查询时间粒度,取值有:
  • min: 1分钟 ;
  • 5min: 5分钟 ;
  • hour: 1小时 ;
  • day: 1天 。
  • 不填将根据开始时间跟结束时间的间距自动推算粒度,具体为:1小时范围内以min粒度查询,2天范围内以5min粒度查询,7天范围内以hour粒度查询,超过7天以day粒度查询。
    Filters.N Array of QueryCondition 过滤条件,详细的过滤条件Key值如下:
  • ruleId
       按照【转发规则ID】进行过滤。
  • proxyId
       按照【四层代理实例ID】进行过滤。
  • Area String 数据归属地区,取值有:
  • overseas:全球(除中国大陆地区)数据;
  • mainland:中国大陆地区数据;
  • global:全球数据。
  • 不填默认取值为global。

    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: DescribeTimingL4Data
    <公共请求参数>
    
    {
        "EndTime": "2022-08-29T19:17:59+08:00",
        "Interval": "day",
        "Area": "mainland",
        "StartTime": "2022-07-31T00:00:00+08:00",
        "MetricNames": [
            "l4Flow_inFlux"
        ],
        "ZoneIds": [
            "zone-28kw53cmc6ky"
        ]
    }

    输出示例

    {
        "Response": {
            "RequestId": "e12e0659-ae34-4140-9878-4a61db0c3639",
            "Data": [
                {
                    "TypeKey": "251227260",
                    "TypeValue": [
                        {
                            "Avg": 740563,
                            "Detail": [
                                {
                                    "Timestamp": 1659139200,
                                    "Value": 0
                                },
                                {
                                    "Timestamp": 1659225600,
                                    "Value": 0
                                }
                            ],
                            "Max": 6319079,
                            "MetricName": "l4Flow_inFlux",
                            "Sum": 22957455
                        }
                    ]
                }
            ],
            "TotalCount": 1
        }
    }

    示例2 根据四层代理ID查询四层流量数据

    输入示例

    POST / HTTP/1.1
    Host: teo.tencentcloudapi.com
    Content-Type: application/json
    X-TC-Action: DescribeTimingL4Data
    <公共请求参数>
    
    {
        "EndTime": "2022-08-29T19:17:59+08:00",
        "Interval": "day",
        "Area": "mainland",
        "StartTime": "2022-07-31T00:00:00+08:00",
        "MetricNames": [
            "l4Flow_inFlux"
        ],
        "ZoneIds": [
            "zone-28kw53cmc6ky"
        ],
        "Filters": [
            {
                "Key": "proxyId",
                "Operator": "equals",
                "Value": [
                    "sid-2c2uug8ubfmn"
                ]
            }
        ]
    }

    输出示例

    {
        "Response": {
            "RequestId": "962792de-3bfe-483d-99a7-3cfde0467495",
            "Data": [
                {
                    "TypeKey": "zone-28kw53cmc6ky",
                    "TypeValue": [
                        {
                            "Avg": 267,
                            "Detail": [
                                {
                                    "Timestamp": 1671669600,
                                    "Value": 390
                                },
                                {
                                    "Timestamp": 1671669900,
                                    "Value": 740
                                },
                                {
                                    "Timestamp": 1671670200,
                                    "Value": 0
                                },
                                {
                                    "Timestamp": 1671670500,
                                    "Value": 0
                                },
                                {
                                    "Timestamp": 1671670800,
                                    "Value": 562
                                },
                                {
                                    "Timestamp": 1671671100,
                                    "Value": 690
                                },
                                {
                                    "Timestamp": 1671671400,
                                    "Value": 0
                                },
                                {
                                    "Timestamp": 1671671700,
                                    "Value": 1353
                                },
                                {
                                    "Timestamp": 1671672000,
                                    "Value": 1291
                                },
                                {
                                    "Timestamp": 1671672300,
                                    "Value": 0
                                },
                                {
                                    "Timestamp": 1671672600,
                                    "Value": 0
                                },
                                {
                                    "Timestamp": 1671672900,
                                    "Value": 300
                                },
                                {
                                    "Timestamp": 1671673200,
                                    "Value": 453
                                },
                                {
                                    "Timestamp": 1671673500,
                                    "Value": 0
                                },
                                {
                                    "Timestamp": 1671673800,
                                    "Value": 19
                                },
                                {
                                    "Timestamp": 1671674100,
                                    "Value": 0
                                },
                                {
                                    "Timestamp": 1671674400,
                                    "Value": 0
                                },
                                {
                                    "Timestamp": 1671674700,
                                    "Value": 204
                                },
                                {
                                    "Timestamp": 1671675000,
                                    "Value": 530
                                },
                                {
                                    "Timestamp": 1671675300,
                                    "Value": 0
                                },
                                {
                                    "Timestamp": 1671675600,
                                    "Value": 975
                                },
                                {
                                    "Timestamp": 1671675900,
                                    "Value": 777
                                },
                                {
                                    "Timestamp": 1671676200,
                                    "Value": 0
                                },
                                {
                                    "Timestamp": 1671676500,
                                    "Value": 530
                                },
                                {
                                    "Timestamp": 1671676800,
                                    "Value": 320
                                },
                                {
                                    "Timestamp": 1671677100,
                                    "Value": 303
                                },
                                {
                                    "Timestamp": 1671677400,
                                    "Value": 0
                                },
                                {
                                    "Timestamp": 1671677700,
                                    "Value": 183
                                },
                                {
                                    "Timestamp": 1671678000,
                                    "Value": 320
                                },
                                {
                                    "Timestamp": 1671678300,
                                    "Value": 670
                                },
                                {
                                    "Timestamp": 1671678600,
                                    "Value": 131
                                },
                                {
                                    "Timestamp": 1671678900,
                                    "Value": 804
                                },
                                {
                                    "Timestamp": 1671679200,
                                    "Value": 131
                                }
                            ],
                            "Max": 31540,
                            "MetricName": "l4Flow_outFlux",
                            "Sum": 147864
                        }
                    ]
                }
            ],
            "TotalCount": 1
        }
    }

    示例3 根据转发规则ID查询四层流量数据

    输入示例

    POST / HTTP/1.1
    Host: teo.tencentcloudapi.com
    Content-Type: application/json
    X-TC-Action: DescribeTimingL4Data
    <公共请求参数>
    
    {
        "EndTime": "2022-08-29T19:17:59+08:00",
        "Interval": "day",
        "Area": "mainland",
        "StartTime": "2022-07-31T00:00:00+08:00",
        "MetricNames": [
            "l4Flow_inFlux"
        ],
        "ZoneIds": [
            "zone-28kw53cmc6ky"
        ],
        "Filters": [
            {
                "Key": "ruleId",
                "Operator": "equals",
                "Value": [
                    "rule-033950bf-6fc4-11ed-8ab2-525400a22580"
                ]
            }
        ]
    }

    输出示例

    {
        "Response": {
            "RequestId": "962792de-3bfe-483d-99a7-3cfde0467495",
            "Data": [
                {
                    "TypeKey": "zone-28kw53cmc6ky",
                    "TypeValue": [
                        {
                            "Avg": 267,
                            "Detail": [
                                {
                                    "Timestamp": 1671669600,
                                    "Value": 390
                                },
                                {
                                    "Timestamp": 1671669900,
                                    "Value": 740
                                },
                                {
                                    "Timestamp": 1671670200,
                                    "Value": 0
                                },
                                {
                                    "Timestamp": 1671670500,
                                    "Value": 0
                                },
                                {
                                    "Timestamp": 1671670800,
                                    "Value": 562
                                },
                                {
                                    "Timestamp": 1671671100,
                                    "Value": 690
                                },
                                {
                                    "Timestamp": 1671671400,
                                    "Value": 0
                                },
                                {
                                    "Timestamp": 1671671700,
                                    "Value": 1353
                                },
                                {
                                    "Timestamp": 1671672000,
                                    "Value": 1291
                                },
                                {
                                    "Timestamp": 1671672300,
                                    "Value": 0
                                },
                                {
                                    "Timestamp": 1671672600,
                                    "Value": 0
                                },
                                {
                                    "Timestamp": 1671672900,
                                    "Value": 300
                                },
                                {
                                    "Timestamp": 1671673200,
                                    "Value": 453
                                },
                                {
                                    "Timestamp": 1671673500,
                                    "Value": 0
                                },
                                {
                                    "Timestamp": 1671673800,
                                    "Value": 19
                                },
                                {
                                    "Timestamp": 1671674100,
                                    "Value": 0
                                },
                                {
                                    "Timestamp": 1671674400,
                                    "Value": 0
                                },
                                {
                                    "Timestamp": 1671674700,
                                    "Value": 204
                                },
                                {
                                    "Timestamp": 1671675000,
                                    "Value": 530
                                },
                                {
                                    "Timestamp": 1671675300,
                                    "Value": 0
                                },
                                {
                                    "Timestamp": 1671675600,
                                    "Value": 975
                                },
                                {
                                    "Timestamp": 1671675900,
                                    "Value": 777
                                },
                                {
                                    "Timestamp": 1671676200,
                                    "Value": 0
                                },
                                {
                                    "Timestamp": 1671676500,
                                    "Value": 530
                                },
                                {
                                    "Timestamp": 1671676800,
                                    "Value": 320
                                },
                                {
                                    "Timestamp": 1671677100,
                                    "Value": 303
                                },
                                {
                                    "Timestamp": 1671677400,
                                    "Value": 0
                                },
                                {
                                    "Timestamp": 1671677700,
                                    "Value": 183
                                },
                                {
                                    "Timestamp": 1671678000,
                                    "Value": 320
                                },
                                {
                                    "Timestamp": 1671678300,
                                    "Value": 670
                                },
                                {
                                    "Timestamp": 1671678600,
                                    "Value": 131
                                },
                                {
                                    "Timestamp": 1671678900,
                                    "Value": 804
                                },
                                {
                                    "Timestamp": 1671679200,
                                    "Value": 131
                                }
                            ],
                            "Max": 31540,
                            "MetricName": "l4Flow_outFlux",
                            "Sum": 147864
                        }
                    ]
                }
            ],
            "TotalCount": 1
        }
    }

    5. 开发者资源

    腾讯云 API 平台

    腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

    API Inspector

    用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。

    SDK

    云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

    命令行工具

    6. 错误码

    以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码

    错误码 描述
    FailedOperation 操作失败。
    InternalError.ProxyServer 后端服务器发生未知错误。
    InternalError.RouteError 后端服务路由地址错误。
    LimitExceeded 超过配额限制。
    ResourceNotFound 资源不存在。
    ResourceUnavailable 资源不可用。
    UnauthorizedOperation.CamUnauthorized Cam 未授权。