有奖:语音产品征文挑战赛等你来> HOT

1. 接口描述

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

查询指定时刻指标的最新值

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:QueryMetric。
Version String 公共参数,本接口取值:2020-10-16。
Region String 公共参数,详见产品支持的 地域列表
Query String 查询语句,使用PromQL语法
示例值:access_evaluation_duration_bucket
TopicId String 指标主题ID
示例值:8e7c3bd9-ef13-4981-xxxx-207971e1f80f
Time Integer 查询时间,秒级Unix时间戳
示例值:1695197431

3. 输出参数

参数名称 类型 描述
ResultType String 指标查询结果类型
示例值:vector
Result String 指标查询结果
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查询指标最新值

输入示例

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

{
    "TopicId": "8e7c3bd9-xxxx-xxxx-xxxx-207971e1f80f",
    "Query": "access_evaluation_duration_bucket",
    "Time": 1695197431
}

输出示例

{
    "Response": {
        "RequestId": "1ee38aa1-xxxx-xxxx-xxxx-b1961a464c99",
        "ResultType": "vector",
        "Result": "[{\"metric\":{\"__name__\":\"access_evaluation_duration_bucket\",\"container\":\"grafana\",\"endpoint\":\"http\",\"instance\":\"172.17.0.6:3000\",\"job\":\"grafana\",\"le\":\"0.00064\",\"namespace\":\"monitoring\",\"pod\":\"grafana-6676ccf9c9-zjk62\",\"prometheus\":\"monitoring/k8s\",\"prometheus_replica\":\"prometheus-k8s-0\",\"service\":\"grafana\"},\"value\":[1695197431,\"5808\"]},{\"metric\":{\"__name__\":\"access_evaluation_duration_bucket\",\"container\":\"grafana\",\"endpoint\":\"http\",\"instance\":\"172.17.0.6:3000\",\"job\":\"grafana\",\"le\":\"0.01024\",\"namespace\":\"monitoring\",\"pod\":\"grafana-6676ccf9c9-zjk62\",\"prometheus\":\"monitoring/k8s\",\"prometheus_replica\":\"prometheus-k8s-0\",\"service\":\"grafana\"},\"value\":[1695197431,\"5808\"]},{\"metric\":{\"__name__\":\"access_evaluation_duration_bucket\",\"container\":\"grafana\",\"endpoint\":\"http\",\"instance\":\"172.17.0.6:3000\",\"job\":\"grafana\",\"le\":\"0.04096\",\"namespace\":\"monitoring\",\"pod\":\"grafana-6676ccf9c9-zjk62\",\"prometheus\":\"monitoring/k8s\",\"prometheus_replica\":\"prometheus-k8s-0\",\"service\":\"grafana\"},\"value\":[1695197431,\"5808\"]},{\"metric\":{\"__name__\":\"access_evaluation_duration_bucket\",\"container\":\"grafana\",\"endpoint\":\"http\",\"instance\":\"172.17.0.6:3000\",\"job\":\"grafana\",\"le\":\"0.65536\",\"namespace\":\"monitoring\",\"pod\":\"grafana-6676ccf9c9-zjk62\",\"prometheus\":\"monitoring/k8s\",\"prometheus_replica\":\"prometheus-k8s-0\",\"service\":\"grafana\"},\"value\":[1695197431,\"5808\"]},{\"metric\":{\"__name__\":\"access_evaluation_duration_bucket\",\"container\":\"grafana\",\"endpoint\":\"http\",\"instance\":\"172.17.0.6:3000\",\"job\":\"grafana\",\"le\":\"2.62144\",\"namespace\":\"monitoring\",\"pod\":\"grafana-6676ccf9c9-zjk62\",\"prometheus\":\"monitoring/k8s\",\"prometheus_replica\":\"prometheus-k8s-0\",\"service\":\"grafana\"},\"value\":[1695197431,\"5808\"]},{\"metric\":{\"__name__\":\"access_evaluation_duration_bucket\",\"container\":\"grafana\",\"endpoint\":\"http\",\"instance\":\"172.17.0.6:3000\",\"job\":\"grafana\",\"le\":\"0.00016\",\"namespace\":\"monitoring\",\"pod\":\"grafana-6676ccf9c9-zjk62\",\"prometheus\":\"monitoring/k8s\",\"prometheus_replica\":\"prometheus-k8s-0\",\"service\":\"grafana\"},\"value\":[1695197431,\"5805\"]},{\"metric\":{\"__name__\":\"access_evaluation_duration_bucket\",\"container\":\"grafana\",\"endpoint\":\"http\",\"instance\":\"172.17.0.6:3000\",\"job\":\"grafana\",\"le\":\"+Inf\",\"namespace\":\"monitoring\",\"pod\":\"grafana-6676ccf9c9-zjk62\",\"prometheus\":\"monitoring/k8s\",\"prometheus_replica\":\"prometheus-k8s-0\",\"service\":\"grafana\"},\"value\":[1695197431,\"5808\"]},{\"metric\":{\"__name__\":\"access_evaluation_duration_bucket\",\"container\":\"grafana\",\"endpoint\":\"http\",\"instance\":\"172.17.0.6:3000\",\"job\":\"grafana\",\"le\":\"0.00256\",\"namespace\":\"monitoring\",\"pod\":\"grafana-6676ccf9c9-zjk62\",\"prometheus\":\"monitoring/k8s\",\"prometheus_replica\":\"prometheus-k8s-0\",\"service\":\"grafana\"},\"value\":[1695197431,\"5808\"]},{\"metric\":{\"__name__\":\"access_evaluation_duration_bucket\",\"container\":\"grafana\",\"endpoint\":\"http\",\"instance\":\"172.17.0.6:3000\",\"job\":\"grafana\",\"le\":\"0.16384\",\"namespace\":\"monitoring\",\"pod\":\"grafana-6676ccf9c9-zjk62\",\"prometheus\":\"monitoring/k8s\",\"prometheus_replica\":\"prometheus-k8s-0\",\"service\":\"grafana\"},\"value\":[1695197431,\"5808\"]},{\"metric\":{\"__name__\":\"access_evaluation_duration_bucket\",\"container\":\"grafana\",\"endpoint\":\"http\",\"instance\":\"172.17.0.6:3000\",\"job\":\"grafana\",\"le\":\"1e-05\",\"namespace\":\"monitoring\",\"pod\":\"grafana-6676ccf9c9-zjk62\",\"prometheus\":\"monitoring/k8s\",\"prometheus_replica\":\"prometheus-k8s-0\",\"service\":\"grafana\"},\"value\":[1695197431,\"5593\"]},{\"metric\":{\"__name__\":\"access_evaluation_duration_bucket\",\"container\":\"grafana\",\"endpoint\":\"http\",\"instance\":\"172.17.0.6:3000\",\"job\":\"grafana\",\"le\":\"4e-05\",\"namespace\":\"monitoring\",\"pod\":\"grafana-6676ccf9c9-zjk62\",\"prometheus\":\"monitoring/k8s\",\"prometheus_replica\":\"prometheus-k8s-0\",\"service\":\"grafana\"},\"value\":[1695197431,\"5787\"]}]"
    }
}

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.QueryError 查询语句运行失败。
FailedOperation.Timeout 操作超时
InternalError 内部错误。
InternalError.SearchError 检索错误
InternalError.SearchFailed 检索失败
InvalidParameter 参数错误。
MissingParameter 缺少参数错误。
ResourceNotFound.TopicNotExist 日志主题不存在。