查询网关分组监控明细数据

最近更新时间: 2026-09-17 00:03:59

1. 接口描述

接口请求域名： tsf.api3.fincloud.tencent.cn。

查询网关分组监控明细数据

默认接口请求频率限制：20次/秒。

接口更新时间：2024-09-14 11:55:39。

接口既验签名又鉴权。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见公共请求参数。

参数名称	必选	允许NULL	类型	描述
Action	是	否	String	公共参数，本接口取值：DescribeGroupUseDetail
Version	是	否	String	公共参数，本接口取值：2018-03-26
Region	是	否	String	公共参数，地域信息可通过DescribeRegions接口查看产品支持的地域列表
GatewayDeployGroupId	是	否	String	网关部署组ID 示例值：
GroupId	是	否	String	网关分组ID 示例值：
StartTime	是	否	Datetime	查询的日期,格式：yyyy-MM-dd HH:mm:ss 示例值：
EndTime	是	否	Datetime	查询的日期,格式：yyyy-MM-dd HH:mm:ss 示例值：
Count	否	否	Int64	指定top的条数,默认为10 示例值：

3. 输出参数

参数名称	类型	描述
Result	GroupDailyUseStatistics	日使用统计对象示例值：查看
RequestId	String	唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 错误码

以下仅列出了接口业务逻辑相关的错误码，其他错误码详见公共错误码。

错误码	描述
InvalidParameterValue.GatewayParameterInvalid	无效请求参数:%s。
MissingParameter.GatewayParameterRequired	缺少请求参数:%s。
FailedOperation.GatewayRemoteCallError	远端访问错误: %s。

5. 示例

示例1 查询网关分组监控明细数据

输入示例

https://tsf.api3.<no value>/?Action=DescribeGroupUseDetail
&Count=10
&GroupId=group-i54lzdrq
&EndTime=2020-09-22 00:00:00
&StartTime=2020-09-22 00:00:00
&GatewayDeployGroupId=group-dasdas
&<公共请求参数>

输出示例

{
    "Response": {
        "Result": {
            "TopReqAmount": [
                {
                    "ApiPath": "/v1/user/{userId}", 
                    "ServiceName": "provider-demo", 
                    "ApiId": "xx", 
                    "Value": "16000"
                }
            ], 
            "TopFailureRate": [
                {
                    "ApiPath": "/v1/user/{userId}", 
                    "ServiceName": "provider-demo", 
                    "ApiId": "xx", 
                    "Value": "0.80000"
                }
            ], 
            "TopAvgTimeCost": [
                {
                    "ApiPath": "/v1/user/{userId}", 
                    "ServiceName": "provider-demo", 
                    "ApiId": "xx", 
                    "Value": "0.23265"
                }
            ]
        }, 
        "RequestId": "5d996e05507e42d5970cd2e25ed5267a"
    }
}