应用性能监控
有奖捉虫：办公协同&微信生态&物联网文档专题 HOT
文档中心 > 应用性能监控

通用指标列表接口

最近更新时间：2024-04-03 11:10:26

我的收藏

本页目录：

1. 接口描述

接口请求域名： apm.tencentcloudapi.com 。

拉取通用指标列表

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action 是 String 公共参数，本接口取值：DescribeMetricRecords。
Version 是 String 公共参数，本接口取值：2021-06-22。
Region 是 String 公共参数，详见产品支持的 地域列表。
Filters.N 是 Array of Filter 过滤条件
示例值：[{"Type":"=","Key":"span.kind","Value":"server"}]
Metrics.N 是 Array of QueryMetricItem 指标列表
示例值：[{"Compare":"1","Compares":["CompareByYesterday","CompareByLastWeek"],"MetricName":"qps"}]
GroupBy.N 是 Array of String 聚合维度
示例值：["service.instance"]
OrderBy 否 OrderBy 排序
示例值：{"Key":"service_duration_avg","Value":"DESC"}
InstanceId 否 String 实例ID
示例值：52Dpv13GR
Limit 否 Integer 每页大小
示例值：10
StartTime 否 Integer 开始时间
示例值：1618361193
Offset 否 Integer 分页起始点
示例值：1
EndTime 否 Integer 结束时间
示例值：1618361193
BusinessName 否 String 业务名称（默认值：taw）
示例值：taw
PageIndex 否 Integer 页码
示例值：1
PageSize 否 Integer 页长
示例值：10
OrFilters.N 否 Array of Filter Or过滤条件
示例值：[{"Type":"=","Key":"span.kind","Value":"server"}]

3. 输出参数

参数名称 类型 描述
Records Array of ApmMetricRecord 指标结果集
注意：此字段可能返回 null，表示取不到有效值。
示例值：[{"Fields":[{"LastPeriodValue":[{"Key":"abc","Value":0}],"CompareVal":"abc","Unit":"s","Value":691.42,"Key":"ab","CompareVals":[{"Value":"v1","Key":"k1"},{"Key":"k2","Value":"v2"}]}],"Tags":[{"Value":"v1","Key":"k1"}]}]
TotalCount Integer 查询指标结果集条数
注意：此字段可能返回 null，表示取不到有效值。
示例值：1
RequestId String 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 请求参数实例

场景一

输入示例

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

{
    "OrderBy": {
        "Key": "service_duration_avg",
        "Value": "DESC"
    },
    "Filters": [
        {
            "Type": "=",
            "Key": "span.kind",
            "Value": "server"
        }
    ],
    "InstanceId": "apm-6xYKFXYxo",
    "BusinessName": "taw",
    "Metrics": [
        {
            "Compare": "1",
            "Compares": [
                "CompareByYesterday",
                "CompareByLastWeek"
            ],
            "MetricName": "qps"
        }
    ],
    "Limit": "10",
    "StartTime": "1618361193",
    "Offset": "22",
    "EndTime": "1618677137",
    "PageIndex": 1,
    "PageSize": 10,
    "GroupBy": [
        "service.instance"
    ]
}

输出示例

{
    "Response": {
        "Records": [
            {
                "Fields": [
                    {
                        "CompareVal": "abc",
                        "CompareVals": [
                            {
                                "Key": "abc",
                                "Value": "abc"
                            }
                        ],
                        "Value": 0,
                        "Unit": "abc",
                        "Key": "abc",
                        "LastPeriodValue": [
                            {
                                "Key": "abc",
                                "Value": 0
                            }
                        ]
                    }
                ],
                "Tags": [
                    {
                        "Key": "abc",
                        "Value": "abc"
                    }
                ]
            }
        ],
        "TotalCount": 0,
        "RequestId": "abc"
    }
}

示例2 通用指标列表接口

场景2

输入示例

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

{
    "Filters": [
        {
            "Key": "span.kind",
            "Type": "in",
            "Value": "server,consumer"
        }
    ],
    "Metrics": [
        {
            "MetricName": "duration_avg",
            "Compares": [
                "CompareByYesterday",
                "CompareByLastWeek"
            ]
        }
    ],
    "GroupBy": [
        "service.instance"
    ],
    "Limit": 10,
    "Offset": 1,
    "StartTime": 1618361193,
    "EndTime": 1618677137,
    "OrderBy": {
        "Key": "duration_avg",
        "Value": "DESC"
    }
}

输出示例

{
    "Response": {
        "Records": [
            {
                "Fields": [
                    {
                        "LastPeriodValue": [
                            {
                                "Key": "abc",
                                "Value": 0
                            }
                        ],
                        "CompareVal": "abc",
                        "Unit": "s",
                        "Value": 691.42,
                        "Key": "ab",
                        "CompareVals": [
                            {
                                "Value": "v1",
                                "Key": "k1"
                            },
                            {
                                "Key": "k2",
                                "Value": "v2"
                            }
                        ]
                    }
                ],
                "Tags": [
                    {
                        "Value": "v1",
                        "Key": "k1"
                    }
                ]
            }
        ],
        "RequestId": "re",
        "TotalCount": 0
    }
}

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.AppIdNotMatchInstanceInfo appid和实例信息不匹配。
FailedOperation.InstanceIdIsEmpty 实例ID为空。
FailedOperation.InstanceNotFound apm实例不存在。
FailedOperation.InvalidInstanceID 非法实例id。
FailedOperation.InvalidRequest 不合法请求
InternalError 内部错误。
InvalidParameter 参数错误。
中国站