应用性能监控获取应用概览数据

1. 接口描述

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

应用概览数据拉取

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

推荐使用 API Explorer

点击调试

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

2. 输入参数

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

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：DescribeServiceOverview。
Version	是	String	公共参数，本接口取值：2021-06-22。
Region	是	String	公共参数，详见产品支持的地域列表。
InstanceId	是	String	业务系统 ID 示例值：apm-52Dpv13GR
Metrics.N	是	Array of QueryMetricItem	指标列表
StartTime	是	Integer	开始时间（单位：秒）示例值：1618361193
EndTime	是	Integer	结束时间（单位：秒）示例值：1618361193
GroupBy.N	是	Array of String	聚合维度示例值：service.name
Filters.N	否	Array of Filter	过滤条件
OrderBy	否	OrderBy	排序方式 Value 填写： - asc：对查询指标进行升序排序 - desc：对查询指标进行降序排序
Limit	否	Integer	每页大小示例值：10
Offset	否	Integer	分页起始点示例值：1

3. 输出参数

参数名称	类型	描述
Records	Array of ApmMetricRecord	指标结果集
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 获取应用概览数据

输入示例

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

{
    "Filters": [
        {
            "Type": "=",
            "Key": "span.kind",
            "Value": "client"
        }
    ],
    "InstanceId": "apm-059oXBfTL",
    "Metrics": [
        {
            "Compare": "CompareByYesterday",
            "MetricName": "service_request_count_sum"
        }
    ],
    "StartTime": 1742374000,
    "EndTime": 1742374331,
    "GroupBy": [
        "service.name"
    ]
}

输出示例

{
    "Response": {
        "Records": [
            {
                "Fields": [
                    {
                        "CompareVal": "",
                        "CompareVals": [
                            {
                                "Key": "CompareByYesterday",
                                "Value": "-1.6%"
                            },
                            {
                                "Key": "CompareByLastWeek",
                                "Value": "-0.8%"
                            }
                        ],
                        "Key": "service_request_count_sum",
                        "LastPeriodValue": [
                            {
                                "Key": "CompareByYesterday",
                                "Value": 125
                            },
                            {
                                "Key": "CompareByLastWeek",
                                "Value": 124
                            }
                        ],
                        "Unit": "",
                        "Value": 126
                    }
                ],
                "Tags": [
                    {
                        "Key": "service.name",
                        "Value": "ot-java-delivery-service"
                    }
                ]
            }
        ],
        "RequestId": "c7a656fe-971c-47cc-8dc4-ae76630e4761"
    }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

Tencent Cloud SDK 3.0 for Python: GitHub, Gitee
Tencent Cloud SDK 3.0 for Java: GitHub, Gitee
Tencent Cloud SDK 3.0 for PHP: GitHub, Gitee
Tencent Cloud SDK 3.0 for Go: GitHub, Gitee
Tencent Cloud SDK 3.0 for Node.js: GitHub, Gitee
Tencent Cloud SDK 3.0 for .NET: GitHub, Gitee
Tencent Cloud SDK 3.0 for C++: GitHub, Gitee
Tencent Cloud SDK 3.0 for Ruby: GitHub, Gitee

命令行工具

Tencent Cloud CLI 3.0

6. 错误码

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

错误码	描述
AuthFailure	CAM签名/鉴权错误。
AuthFailure.UnauthorizedOperation	AuthFailure.UnauthorizedOperation
FailedOperation	操作失败。
FailedOperation.AppIdNotMatchInstanceInfo	AppID 和业务系统信息不匹配。
FailedOperation.InstanceIdIsEmpty	业务系统 ID 为空。
FailedOperation.InstanceNotFound	APM 业务系统不存在。
FailedOperation.InvalidRequest	不合法请求
InternalError	内部错误。
InvalidParameter	参数错误。

获取应用概览数据

本页目录：