1. 接口描述
接口请求域名： apm.tencentcloudapi.com 。
查询指标列表接口，查询指标更推荐使用DescribeGeneralMetricData接口
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：DescribeMetricRecords。 |
| Version | 是 | String | 公共参数，本接口取值：2021-06-22。 |
| Region | 是 | String | 公共参数，详见产品支持的 地域列表。 |
| InstanceId | 是 | String | 业务系统 ID 示例值：apm-CVfliqa8U |
| Metrics.N | 是 | Array of QueryMetricItem | 指标列表 |
| StartTime | 是 | Integer | 开始时间（单位为秒） 示例值：1618361193 |
| EndTime | 是 | Integer | 结束时间（单位为秒） 示例值：1618361193 |
| GroupBy.N | 是 | Array of String | 聚合维度 示例值：["service.instance"] |
| Filters.N | 否 | Array of Filter | 过滤条件 |
| OrFilters.N | 否 | Array of Filter | Or 过滤条件 |
| OrderBy | 否 | OrderBy | 排序 现支持的 Key 有： - startTime(开始时间) - endTime(结束时间) - duration(响应时间) 现支持的 Value 有： - desc(降序排序) - asc(升序排序) |
| BusinessName | 否 | String | 业务名称，控制台用户请填写taw。 示例值：taw |
| Type | 否 | String | 特殊处理查询结果 示例值：service_runtime_thread_pool |
| Limit | 否 | Integer | 每页大小，默认为1000，合法取值范围为0~1000 示例值：10 |
| Offset | 否 | Integer | 分页起始点 示例值：1 |
| PageIndex | 否 | Integer | 页码 示例值：1 |
| PageSize | 否 | Integer | 页长 示例值：10 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| Records | Array of ApmMetricRecord | 指标结果集 |
| TotalCount | Integer | 查询指标结果集条数 示例值：1 |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 查询每个服务实例的平均响应时间
输入示例
POST / HTTP/1.1
Host: apm.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeMetricRecords
<公共请求参数>
{
"InstanceId": "apm-eDyXPD6FF",
"Metrics": [
{
"MetricName": "duration_avg",
"Compares": [
"CompareByYesterday"
]
}
],
"StartTime": 1768200720,
"EndTime": 1768201620,
"GroupBy": [
"service.instance"
],
"Filters": [
{
"Type": "in",
"Key": "span.kind",
"Value": "server,consumer"
}
]
}输出示例
{
"Response": {
"Records": [
{
"Fields": [
{
"CompareVal": "",
"CompareVals": [
{
"Key": "CompareByYesterday",
"Value": "1.1%"
}
],
"Key": "duration_avg",
"LastPeriodValue": [
{
"Key": "CompareByYesterday",
"Value": 837.1754975463576
}
],
"NameCN": "平均响应时间",
"NameEN": "Average Response Time",
"Unit": "ms",
"Value": 846.6
}
],
"Tags": [
{
"Key": "service.instance",
"Value": "10.244.3.220"
},
{
"Key": "color",
"Value": "green"
}
]
},
{
"Fields": [
{
"CompareVal": "",
"CompareVals": [
{
"Key": "CompareByYesterday",
"Value": "-12.0%"
}
],
"Key": "duration_avg",
"LastPeriodValue": [
{
"Key": "CompareByYesterday",
"Value": 321.9870221880734
}
],
"NameCN": "平均响应时间",
"NameEN": "Average Response Time",
"Unit": "ms",
"Value": 283.3
}
],
"Tags": [
{
"Key": "service.instance",
"Value": "10.244.3.226"
},
{
"Key": "color",
"Value": "green"
}
]
},
{
"Fields": [
{
"CompareVal": "",
"CompareVals": [
{
"Key": "CompareByYesterday",
"Value": "100%"
}
],
"Key": "duration_avg",
"LastPeriodValue": [
{
"Key": "CompareByYesterday",
"Value": 0
}
],
"NameCN": "平均响应时间",
"NameEN": "Average Response Time",
"Unit": "ms",
"Value": 1608.8
}
],
"Tags": [
{
"Key": "service.instance",
"Value": ""
},
{
"Key": "color",
"Value": "green"
}
]
}
],
"RequestId": "8d1d6400-8852-498b-aeca-de9fb14774da",
"TotalCount": 3
}
}示例2 查询特定应用每个接口的错误请求数
输入示例
POST / HTTP/1.1
Host: apm.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeMetricRecords
<公共请求参数>
{
"InstanceId": "apm-eDyXPD6FF",
"Metrics": [
{
"MetricName": "err_error_request_count",
"Compares": [
"CompareByYesterday"
]
}
],
"StartTime": 1768183020,
"EndTime": 1768183920,
"GroupBy": [
"operation"
],
"Filters": [
{
"Type": "=",
"Key": "service.name",
"Value": "java-gateway-service"
}
],
"OrderBy": {
"Key": "err_error_request_count",
"Value": "desc"
},
"Limit": 10,
"Offset": 0
}输出示例
{
"Response": {
"Records": [
{
"Fields": [
{
"CompareVal": "",
"CompareVals": [
{
"Key": "CompareByYesterday",
"Value": "0"
}
],
"Key": "err_error_request_count",
"LastPeriodValue": [
{
"Key": "CompareByYesterday",
"Value": 15
}
],
"NameCN": "错误数",
"NameEN": "Error Count",
"Unit": "个",
"Value": 15
}
],
"Tags": [
{
"Key": "operation",
"Value": "GET mock-security-service-route"
}
]
},
{
"Fields": [
{
"CompareVal": "",
"CompareVals": [
{
"Key": "CompareByYesterday",
"Value": "0"
}
],
"Key": "err_error_request_count",
"LastPeriodValue": [
{
"Key": "CompareByYesterday",
"Value": 15
}
],
"NameCN": "错误数",
"NameEN": "Error Count",
"Unit": "个",
"Value": 15
}
],
"Tags": [
{
"Key": "operation",
"Value": "FilteringWebHandler.handle"
}
]
}
],
"RequestId": "05301a08-7c8b-41cd-889b-a6386238e82b",
"TotalCount": 2
}
}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: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Java: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for PHP: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Go: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Node.js: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for .NET: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for C++: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Ruby: CNB, GitHub, Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| FailedOperation | 操作失败。 |
| FailedOperation.AppIdNotMatchInstanceInfo | AppID 和业务系统信息不匹配。 |
| FailedOperation.InstanceIdIsEmpty | 业务系统 ID 为空。 |
| FailedOperation.InstanceNotFound | APM 业务系统不存在。 |
| FailedOperation.InvalidInstanceID | 非法业务系统 ID。 |
| FailedOperation.InvalidRequest | 不合法请求 |
| InternalError | 内部错误。 |
| InvalidParameter | 参数错误。 |
