查询通道统计数据

最近更新时间:2024-10-30 01:36:51

我的收藏

1. 接口描述

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

该接口用于查询监听器统计数据,包括出入带宽,出入包量,并发,丢包和时延数据。支持300, 3600和86400的细粒度,取值为细粒度范围内最大值。

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeProxyStatistics。
Version String 公共参数,本接口取值:2018-05-29。
Region String 公共参数,此参数为可选参数。
ProxyId String 通道ID
示例值:link-rfgt56hy
StartTime Timestamp 起始时间(2019-03-25 12:00:00)
示例值:2019-03-25 12:00:00
EndTime Timestamp 结束时间(2019-03-25 12:00:00)
示例值:2019-03-26 12:00:00
MetricNames.N Array of String 统计指标名称列表,支持:
入带宽:InBandwidth,
出带宽:OutBandwidth,
并发:Concurrent,
入包量:InPackets,
出包量:OutPackets,
丢包率:PacketLoss,
延迟:Latency,
HTTP请求量:HttpQPS,
HTTP请求量利用率:HttpQPSPercent,
HTTPS请求量:HttpsQPS,
HTTPS请求量利用率:HttpsQPSPercent
示例值:["Concurrent\n"]
Granularity Integer 监控粒度,目前支持60,300,3600,86400,单位:秒。
当时间范围不超过3天,支持最小粒度60秒;
当时间范围不超过7天,支持最小粒度300秒;
当时间范围不超过30天,支持最小粒度3600秒。
示例值:300
Isp String 运营商(通道为三网通道时有效),支持CMCC,CUCC,CTCC,传空值或不传则合并三个运营商数据
示例值:CMCC

3. 输出参数

参数名称 类型 描述
StatisticsData Array of MetricStatisticsInfo 通道统计数据
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查询通道统计数据

查询通道统计数据

输入示例

POST / HTTP/1.1
Host: gaap.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeProxyStatistics
<公共请求参数>

{
    "ProxyId": "link-rfgt56hy",
    "EndTime": "2019-03-26 12:00:00",
    "Granularity": 300,
    "StartTime": "2019-03-25 12:00:00",
    "MetricNames": [
        "Concurrent"
    ]
}

输出示例

{
    "Response": {
        "StatisticsData": [
            {
                "MetricName": "Concurrent",
                "MetricData": [
                    {
                        "Time": 1564734780,
                        "Data": 2000
                    },
                    {
                        "Time": 1564734720,
                        "Data": 2001
                    }
                ]
            }
        ],
        "RequestId": "5c680029-66b2-4be8-9630-7bd316ce70dd"
    }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

命令行工具

6. 错误码

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

错误码 描述
AuthFailure CAM签名/鉴权错误。
AuthFailure.NotEnterpriseAuthorization 非企业认证客户。
AuthFailure.UnauthorizedOperation 子账户未授权操作。
FailedOperation 操作失败。
FailedOperation.ResourceCanNotAccess 该资源不可访问。
FailedOperation.UserNotConfirmProtocol 未开通协议。
InternalError 内部错误。
InvalidParameter 参数错误。
InvalidParameterValue 参数取值错误。
MissingParameter 缺少参数错误。
ResourceNotFound 资源不存在。
ResourceUnavailable.AccountViolation 账号下存在违规资源,详情请查看站内信或邮件。
UnauthorizedOperation 未授权操作。