列出云拨测指标详细数据

最近更新时间:2024-05-24 01:14:41

我的收藏

1. 接口描述

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

查询云拨测指标数据,指标支持使用sum,avg,max,min聚合函数进行指标数据查询
拨测频率与groupby聚合时间设置关联,如拨测频率为 30 分钟,则 grouby 聚合时间建议设置为大于30分钟,避免出现查询数据为空的情况

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeProbeMetricData。
Version String 公共参数,本接口取值:2018-04-09。
Region String 公共参数,此参数为可选参数。
AnalyzeTaskType String 分析任务类型,支持以下几种类型:
AnalyzeTaskType_Network:网络质量
AnalyzeTaskType_Browse:页面性能
AnalyzeTaskType_Transport:端口性能
AnalyzeTaskType_UploadDownload:文件传输
AnalyzeTaskType_MediaStream:音视频体验
示例值:AnalyzeTaskType_UploadDownload
MetricType String 指标类型(counter、gauge以及histogram),指标查询默认传gauge
示例值:gauge
Field String 指标详细字段,可以传递传具体的指标也可以对指标进行聚合查询例如:"avg(ping_time)"代表整体时延(ms);不同的任务类型支持不同的field查询,以及聚合规则,详情可见https://cloud.tencent.com/document/product/248/87584。
示例值:avg(ping_time)
Filter String 过滤条件可以传单个过滤条件也可以拼接多个参数
示例值:host = '123' and time >= now()-30m
GroupBy String 聚合时间, 1m、1d、30d 等等
示例值:time(1m), operator
Filters.N Array of String 多条件过滤,支持多个过滤条件组合查询
例如:[""host" = 'www.test.com'", "time >= now()-1h"]
示例值:["host" = 'https://test.com'", "time >= now()-1h"]

3. 输出参数

参数名称 类型 描述
MetricSet String 返回指标 JSON 序列化后的字符串,具体如下所示:"[{"name":"task_navigate_request_gauge","columns":["time","avg(first_screen_time) / 1000"],"values":[[1641571200,6.756600000000001]],"tags":null}]"
示例值:""
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 请求浏览数据

请求浏览数据

输入示例

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

{
    "AnalyzeTaskType": "AnalyzeTaskType_Network",
    "MetricType": "gauge",
    "Field": "sum(\"error_count\")",
    "GroupBy": "time(30d), \"operator\"",
    "Filters": [
        "\"host\" = 'default-host'",
        "time >= now()-1h"
    ]
}

输出示例

{
    "Response": {
        "MetricSet": "[{\"name\":\"netenv_request_gauge\",\"columns\":[\"time\",\"sum(error_count)\"],\"values\":[[xxxxx,xxxxx]],\"tags\":null}]",
        "RequestId": "xxxxx"
    }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

命令行工具

6. 错误码

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

错误码 描述
FailedOperation 操作失败。
FailedOperation.DbQueryFailed 数据库查询错误。