查询单元化网关API监控明细数据
最近更新时间: 2026-09-17 00:04:00
1. 接口描述
接口请求域名： tsf.api3.fincloud.tencent.cn。
查询网关API监控明细数据（仅单元化网关），非单元化网关使用DescribeApiUseDetail
默认接口请求频率限制：20次/秒。
接口更新时间：2025-05-17 02:40:48。
接口既验签名又鉴权。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见公共请求参数。
| 参数名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Action | 是 | 否 | String | 公共参数，本接口取值：DescribeUnitApiUseDetail |
| Version | 是 | 否 | String | 公共参数，本接口取值：2018-03-26 |
| Region | 是 | 否 | String | 公共参数，地域信息可通过DescribeRegions接口查看产品支持的地域列表 |
| GatewayDeployGroupId | 是 | 否 | String | 网关部署组ID 示例值： |
| ApiId | 否 | 否 | String | 网关分组Api ID 示例值： |
| StartTime | 是 | 否 | String | 查询的日期,格式：yyyy-MM-dd HH:mm:ss 示例值： |
| EndTime | 是 | 否 | String | 查询的日期,格式：yyyy-MM-dd HH:mm:ss 示例值： |
| GatewayInstanceId | 否 | 否 | String | 网关实例ID 示例值： |
| GroupId | 是 | 否 | String | 网关分组ID 示例值： |
| Period | 是 | 否 | Int64 | 监控统计数据粒度 示例值： |
| Offset | 是 | 否 | Int64 | 翻页查询偏移量 示例值： |
| Limit | 是 | 否 | Int64 | 翻页查询每页记录数 示例值： |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| Result | GroupUnitApiUseStatistics | 单元化使用统计对象 示例值：查看 |
| RequestId | String | 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 |
4. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见公共错误码。
| 错误码 | 描述 |
|---|---|
| InvalidParameterValue.GatewayParameterInvalid | 无效请求参数:%s。 |
| MissingParameter.GatewayParameterRequired | 缺少请求参数:%s。 |
| FailedOperation.GatewayRemoteCallError | 远端访问错误: %s。 |
| ResourceNotFound.InterfaceNotFound | [%s]模块未提供该接口[%s]。。 |
5. 示例
示例1 查询网关API监控明细数据
输入示例
https://tsf.api3.<no value>/?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"
}
}