1. 接口描述
接口请求域名： tsf.tencentcloudapi.com 。
查询网关API监控明细数据（仅单元化网关），非单元化网关使用DescribeApiUseDetail
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：DescribeUnitApiUseDetail。 |
| Version | 是 | String | 公共参数，本接口取值：2018-03-26。 |
| Region | 是 | String | 公共参数，详见产品支持的 地域列表。 |
| GatewayDeployGroupId | 是 | String | 网关部署组ID 示例值：group-i54lzdrq |
| ApiId | 是 | String | 网关分组Api ID 示例值：api-qabo8xyl |
| StartTime | 是 | Timestamp | 查询的日期,格式：yyyy-MM-dd HH:mm:ss 示例值：2020-09-22 00:00:00 |
| EndTime | 是 | Timestamp | 查询的日期,格式：yyyy-MM-dd HH:mm:ss 示例值：2020-09-22 00:00:00 |
| GatewayInstanceId | 是 | String | 网关实例ID 示例值：gw-ins-4hkjbwxy |
| GroupId | 是 | String | 网关分组ID 示例值：grp-vcgimq3x |
| Offset | 是 | Integer | 翻页查询偏移量 示例值：0 |
| Limit | 是 | Integer | 翻页查询每页记录数 示例值：20 |
| Period | 否 | Integer | 监控统计数据粒度 示例值：60 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| Result | GroupUnitApiUseStatistics | 单元化使用统计对象 |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 查询网关API监控明细数据
输入示例
https://tsf.tencentcloudapi.com/?Action=DescribeUnitApiUseDetail
&ApiId=api-qabo8xyl
&GatewayInstanceId=gw-ins-4hkjbwxy
&GatewayDeployGroupId=gw-e42d597
&GroupId=grp-vcgimq3x
&Period=60
&Offset=0
&Limit=20
&EndTime=2020-09-22 00:00:00
&StartTime=2020-09-22 00:00:00
&<公共请求参数>输出示例
{
"Response": {
"Result": {
"TotalCount": 20,
"Content": [
{
"NamespaceId": "ns-123456",
"NamespaceName": "ns-test",
"SumReqAmount": "8213434",
"AvgFailureRate": "82.11",
"AvgTimeCost": "10.11",
"MetricDataPointMap": {
"SumReqAmount": [
{
"Key": "1615374000000",
"Value": null,
"Tag": null
},
{
"Key": "1615374060000",
"Value": null,
"Tag": null
}
],
"AvgFailureRate": [
{
"Key": "1615374000000",
"Value": null,
"Tag": null
},
{
"Key": "1615374060000",
"Value": null,
"Tag": null
}
],
"AvgTimeCost": [
{
"Key": "1615374000000",
"Value": null,
"Tag": null
},
{
"Key": "1615374060000",
"Value": null,
"Tag": null
}
]
},
"TopStatusCode": [
{
"Name": "2xx",
"Count": "20000",
"Ratio": "0.35565"
},
{
"Name": "4xx",
"Count": "18000",
"Ratio": "0.28625"
}
],
"TopTimeCost": [
{
"Name": "0_50_ms",
"Count": "20000",
"Ratio": "0.35565"
},
{
"Name": "50_100_ms",
"Count": "18000",
"Ratio": "0.28625"
},
{
"Name": "100_200_ms",
"Count": "13000",
"Ratio": "0.28625"
},
{
"Name": "others",
"Count": "13000",
"Ratio": "0.28625"
}
],
"Quantile": {
"MaxValue": "12.13",
"MinValue": "0.32",
"FifthPositionValue": "0.26",
"NinthPositionValue": "1.32"
}
},
{
"NamespaceId": "ns-1234567",
"NamespaceName": "ns-test2",
"SumReqAmount": "20",
"AvgFailureRate": "11.21",
"AvgTimeCost": "20.12",
"MetricDataPointMap": {
"SumReqAmount": [
{
"Key": "1615374000000",
"Value": null,
"Tag": null
},
{
"Key": "1615374060000",
"Value": null,
"Tag": null
}
],
"AvgFailureRate": [
{
"Key": "1615374000000",
"Value": null,
"Tag": null
},
{
"Key": "1615374060000",
"Value": null,
"Tag": null
}
],
"AvgTimeCost": [
{
"Key": "1615374000000",
"Value": null,
"Tag": null
},
{
"Key": "1615374060000",
"Value": null,
"Tag": null
}
]
},
"TopStatusCode": [
{
"Name": "2xx",
"Count": "20000",
"Ratio": "0.35565"
},
{
"Name": "4xx",
"Count": "18000",
"Ratio": "0.28625"
}
],
"TopTimeCost": [
{
"Name": "0_50_ms",
"Count": "20000",
"Ratio": "0.35565"
},
{
"Name": "50_100_ms",
"Count": "18000",
"Ratio": "0.28625"
},
{
"Name": "100_200_ms",
"Count": "13000",
"Ratio": "0.28625"
},
{
"Name": "others",
"Count": "13000",
"Ratio": "0.28625"
}
],
"Quantile": {
"MaxValue": "12.13",
"MinValue": "0.32",
"FifthPositionValue": "0.26",
"NinthPositionValue": "1.32"
}
}
]
},
"RequestId": "5d996e05507e42d5970cd2e25ed5267a"
}
}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。 |
| InvalidParameterValue.GatewayParameterInvalid | 无效请求参数:%s。 |
| MissingParameter.GatewayParameterRequired | 缺少请求参数:%s。 |
| ResourceNotFound.InterfaceNotFound | [%s]模块未提供该接口[%s]。。 |
