1. 接口描述
接口请求域名： tsf.tencentcloudapi.com 。
查询网关API监控明细数据
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：DescribeApiUseDetail。 |
| Version | 是 | String | 公共参数，本接口取值：2018-03-26。 |
| Region | 是 | String | 公共参数，详见产品支持的 地域列表。 |
| GatewayDeployGroupId | 是 | String | 网关部署组ID 示例值：group-yo476mrv |
| ApiId | 是 | String | 网关分组Api ID 示例值：api-megi25v8 |
| StartTime | 是 | Timestamp | 查询的日期,格式：yyyy-MM-dd HH:mm:ss 示例值：2024-12-16 14:52:28 |
| EndTime | 是 | Timestamp | 查询的日期,格式：yyyy-MM-dd HH:mm:ss 示例值：2024-12-23 14:52:28 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| Result | GroupApiUseStatistics | 日使用统计对象 示例值：{"Quantile":{"FifthPositionValue":"18.70000","MaxValue":"934.68000","MinValue":"9.13000","NinthPositionValue":"24.88900"},"TopStatusCode":[{"Count":"39788487","Name":"2xx","Ratio":"0.9999875593700789"}],"TopTimeCost":[{"Count":"39741921","Name":"0_100_ms","Ratio":"0.9988172353844087"},{"Count":"36896","Name":"100_200_ms","Ratio":"9.27291881958679E-4"},{"Count":"9941","Name":"200_500_ms","Ratio":"2.498430344360155E-4"},{"Count":"224","Name":"500_2000_ms","Ratio":"5.629699196626845E-6"},{"Count":"0","Name":"2000_ms","Ratio":"0.0"}]} |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 查询网关API监控明细数据
输入示例
POST / HTTP/1.1
Host: tsf.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeApiUseDetail
<公共请求参数>
{
"GatewayDeployGroupId": "group-yo476mrv",
"ApiId": "api-megi25v8",
"StartTime": "2024-12-16 14:52:28",
"EndTime": "2024-12-23 14:52:28"
}输出示例
{
"Response": {
"RequestId": "a3fbcf43-9d0e-4f29-b5c3-cd591ab0ad74",
"Result": {
"Quantile": {
"FifthPositionValue": "18.70000",
"MaxValue": "934.68000",
"MinValue": "9.13000",
"NinthPositionValue": "24.88900"
},
"TopStatusCode": [
{
"Count": "39788487",
"Name": "2xx",
"Ratio": "0.9999875593700789"
}
],
"TopTimeCost": [
{
"Count": "39741921",
"Name": "0_100_ms",
"Ratio": "0.9988172353844087"
},
{
"Count": "36896",
"Name": "100_200_ms",
"Ratio": "9.27291881958679E-4"
},
{
"Count": "9941",
"Name": "200_500_ms",
"Ratio": "2.498430344360155E-4"
},
{
"Count": "224",
"Name": "500_2000_ms",
"Ratio": "5.629699196626845E-6"
},
{
"Count": "0",
"Name": "2000_ms",
"Ratio": "0.0"
}
]
}
}
}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. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| FailedOperation.GatewayRemoteCallError | 远端访问错误: %s。 |
| FailedOperation.UnhandledException | 模块未处理异常。 |
| InternalError.UnhandledException | [%s]模块未处理异常。。 |
| InvalidParameterValue.GatewayParameterInvalid | 无效请求参数:%s。 |
| MissingParameter.GatewayParameterRequired | 缺少请求参数:%s。 |
