查询指标

最近更新时间:2024-03-12 01:44:48

我的收藏

1. 接口描述

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

查询指标,返回固定时间点指标内容

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeSampleQuery。
Version String 公共参数,本接口取值:2021-07-28。
Region String 公共参数,本接口不需要传递此参数。
JobId String job id
示例值:"123"
ScenarioId String 场景Id
示例值:"123"
Metric String 指标名。取值范围参见 DescribeMetricLabelWithValues 接口返回的所有指标名
示例值:pts_engine_req_total
Aggregation String 聚合函数。取值范围:Rate,Count,Avg,P90,P95,P99,Gauge
示例值:Rate
ProjectId String 项目ID
示例值:project-xx
Labels.N Array of Label 标签过滤条件。各指标支持的标签参见 DescribeMetricLabelWithValues 接口返回的所有指标及其支持的标签
示例值:[{"LabelName":"Method", "LabelValue":"GET"}]

3. 输出参数

参数名称 类型 描述
MetricSample CustomSample 返回指标内容
注意:此字段可能返回 null,表示取不到有效值。
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查询总请求数

查询某个任务总的请求数

输入示例

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

{
    "ProjectId": "project-xx",
    "JobId": "123",
    "ScenarioId": "123",
    "Metric": "pts_engine_req_total",
    "Aggregation": "Count"
}

输出示例

{
    "Response": {
        "MetricSample": {
            "Metric": "pts_engine_req_total",
            "Aggregation": "Count",
            "Unit": "reqs",
            "Labels": [
                {
                    "LabelName": "method",
                    "LabelValue": "GET"
                }
            ],
            "Value": "1159362",
            "Timestamp": 1631693039208
        },
        "RequestId": "70805f6a-d7e1-4247-9d5a-fde3afe2b377"
    }
}

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签名/鉴权错误。
FailedOperation 操作失败。
FailedOperation.ResourceNotFound 资源不存在。
InternalError 内部错误。
InvalidParameter 参数错误。
InvalidParameterValue 参数取值错误。