1. 接口描述
接口请求域名： apm.tencentcloudapi.com 。
服务概览数据拉取
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：DescribeServiceOverview。 |
| Version | 是 | String | 公共参数，本接口取值：2021-06-22。 |
| Region | 是 | String | 公共参数，详见产品支持的 地域列表。 |
| Filters.N | 是 | Array of Filter | 过滤条件 |
| Metrics.N | 是 | Array of QueryMetricItem | 指标列表 |
| GroupBy.N | 是 | Array of String | 聚合维度 |
| OrderBy | 否 | OrderBy | 排序 |
| InstanceId | 否 | String | 实例ID 示例值：52Dpv13GR |
| Limit | 否 | Integer | 每页大小 示例值：10 |
| StartTime | 否 | Integer | 开始时间 示例值：1618361193 |
| Offset | 否 | Integer | 分页起始点 示例值：1 |
| EndTime | 否 | Integer | 结束时间 示例值：1618361193 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| Records | Array of ApmMetricRecord | 指标结果集 注意：此字段可能返回 null，表示取不到有效值。 |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 获取服务概览数据
输入示例
POST / HTTP/1.1
Host: apm.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeServiceOverview
<公共请求参数>
{
"Filters": [
{
"Key": "span.kind",
"Type": "=",
"Value": "SPAN_KIND_SERVER"
}
],
"Metrics": [
{
"MetricName": "service_duration_avg",
"Compare": 1
},
{
"MetricName": "request_count_sum"
}
],
"GroupBy": [
"operation",
"service.component"
],
"Limit": 10,
"Offset": 1,
"StartTime": 1618361193,
"EndTime": 1618677137,
"OrderBy": {
"Key": "service_duration_avg",
"Value": "DESC"
}
}输出示例
{
"Response": {
"Records": [
{
"Tags": [
{
"Key": "operation",
"Value": "/DescribeAlarmList"
},
{
"Key": "service.component",
"Value": "HTTP"
}
],
"Fields": [
{
"Key": "service_duration_avg",
"Value": 0.02383373177662466,
"CompareVal": -0.004148131882911392
},
{
"Key": "request_count_sum",
"Value": 31184,
"CompareVal": 0
}
]
},
{
"Tags": [
{
"Key": "operation",
"Value": "/collector.CollectorService/PostSpans"
},
{
"Key": "service.component",
"Value": "gRPC"
}
],
"Fields": [
{
"Key": "service_duration_avg",
"Value": 18.811467216411906,
"CompareVal": 0.17306355798699288
},
{
"Key": "request_count_sum",
"Value": 4986,
"CompareVal": 0
}
]
},
{
"Tags": [
{
"Key": "operation",
"Value": "/notify.Notify/SendAlert"
},
{
"Key": "service.component",
"Value": "gRPC"
}
],
"Fields": [
{
"Key": "service_duration_avg",
"Value": 9.486143798828124,
"CompareVal": 0.4454246545216073
},
{
"Key": "request_count_sum",
"Value": 4111,
"CompareVal": 0
}
]
},
{
"Tags": [
{
"Key": "operation",
"Value": "HTTP GET"
},
{
"Key": "service.component",
"Value": "net/http"
}
],
"Fields": [
{
"Key": "service_duration_avg",
"Value": 14.46367618133845,
"CompareVal": 1
},
{
"Key": "request_count_sum",
"Value": 8345,
"CompareVal": 0
}
]
},
{
"Tags": [
{
"Key": "operation",
"Value": "HTTP POST"
},
{
"Key": "service.component",
"Value": "net/http"
}
],
"Fields": [
{
"Key": "service_duration_avg",
"Value": 12.396896973135917,
"CompareVal": 0.1693196368191666
},
{
"Key": "request_count_sum",
"Value": 15094,
"CompareVal": 0
}
]
},
{
"Tags": [
{
"Key": "operation",
"Value": "http_server_root"
},
{
"Key": "service.component",
"Value": "net/http"
}
],
"Fields": [
{
"Key": "service_duration_avg",
"Value": 68.29158163921177,
"CompareVal": -0.05762747632987753
},
{
"Key": "request_count_sum",
"Value": 104642033,
"CompareVal": 0
}
]
},
{
"Tags": [
{
"Key": "service.component",
"Value": "httpserverv3"
},
{
"Key": "operation",
"Value": "Ping"
}
],
"Fields": [
{
"Key": "service_duration_avg",
"Value": 0.4196629148780232,
"CompareVal": 1
},
{
"Key": "request_count_sum",
"Value": 10182,
"CompareVal": 0
}
]
},
{
"Tags": [
{
"Key": "operation",
"Value": "microServer_cdbwan"
},
{
"Key": "service.component",
"Value": "httpserverv3"
}
],
"Fields": [
{
"Key": "service_duration_avg",
"Value": 3.6889778198423007,
"CompareVal": 0.15496546525321617
},
{
"Key": "request_count_sum",
"Value": 191205,
"CompareVal": 0
}
]
}
],
"RequestId": "fyy3-g7ujmxbouxshy3plmkmhlnmdbfh"
}
}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
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| AuthFailure | CAM签名/鉴权错误。 |
| AuthFailure.UnauthorizedOperation | AuthFailure.UnauthorizedOperation |
| FailedOperation | 操作失败。 |
| FailedOperation.AppIdNotMatchInstanceInfo | appid和实例信息不匹配。 |
| FailedOperation.InstanceIdIsEmpty | 实例ID为空。 |
| FailedOperation.InstanceNotFound | apm实例不存在。 |
| FailedOperation.InvalidRequest | 不合法请求 |
| InternalError | 内部错误。 |
| InvalidParameter | 参数错误。 |