1. 接口描述
接口请求域名： tsf.tencentcloudapi.com 。
服务调用监控统计概览
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：DescribeOverviewInvocation。 |
| Version | 是 | String | 公共参数，本接口取值：2018-03-26。 |
| Region | 是 | String | 公共参数，详见产品支持的 地域列表。 |
| NamespaceId | 否 | String | 命名空间ID， 此参数必填 可通过DescribeSimpleNamespaces查询已经创建的命名空间，也可以通过登录控制台查看 示例值：namespace-xxx |
| Type | 否 | String | 监控统计类型，必填，取值范围 SumReqAmount：请求量，AvgFailureRate：请求错误率，AvgTimeCost：平均响应耗时 示例值：SumReqAmount |
| Period | 否 | Integer | 监控统计数据粒度，可选值：60、3600、86400，分别对应1分钟、1小时、1天 示例值：60 |
| StartTime | 否 | Timestamp | 查询开始时间，格式为yyyy-MM-dd HH:mm:ss，默认为当天的 00:00:00 示例值：2019-05-28 17:45:43 |
| EndTime | 否 | Timestamp | 查询结束时间，格式为yyyy-MM-dd HH:mm:ss，默认为当前时间 示例值：2019-05-29 17:45:43 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| Result | Array of MetricDataPoint | 监控统计数据列表 |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 服务调用监控统计概览
输入示例
https://tsf.tencentcloudapi.com/?Action=DescribeOverviewInvocation
&NamespaceId=namespace-xxx
&Type=SumReqAmount
&StartTime=2019-05-28 17:45:43
&EndTime=2019-05-29 17:45:43
&<公共请求参数>输出示例
{
"Response": {
"RequestId": "2903f230-fabc-4dff-b4c4-1fbe0fd73ebe",
"Result": []
}
}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.TsfApmCtsdbClientRequestError | TSF应用性能管理CTSDB客户端调用失败。 |
| InternalError.UnhandledException | 模块未处理异常。 |
| InvalidParameter.TsfApmStatsSearchRequestParamError | TSF应用性能管理运行状态统计查询请求参数错误。 |
| ResourceNotFound.MicroserviceOffline | 目标微服务已离线。 |
| UnauthorizedOperation.NoPrivilege | 用户无权限访问该接口。 |
