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

最近更新时间: 2026-10-11 00:12:04

1. 接口描述

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

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

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

接口更新时间：2025-08-06 23:23:55。

接口只验签名不鉴权。

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 查询网关分组监控明细数据

输入示例

POST / HTTP/1.1
Host: tsf.api3.fincloud.tencent.com
Content-Type: application/json
X-TC-Action: DescribeGroupUseDetail
<Common Parameters>

{
  "GatewayDeployGroupId": "group-yd3b588a",
  "GroupId": "grp-nb08ur29",
  "StartTime": "2024-12-16 16:36:40",
  "EndTime": "2024-12-23 16:36:40",
  "Count": 10
}

输出示例

{
  "Response": {
    "RequestId": "76917645-69a0-4692-9555-75e8da464914",
    "Result": {
      "TopAvgTimeCost": [
        {
          "ApiId": "api-dtbc5cf0",
          "ApiPath": "/echo/{param}",
          "ServiceName": "provider-demo",
          "Value": "12.22782"
        }
      ],
      "TopFailureRate": [
        {
          "ApiId": "api-dtbc5cf0",
          "ApiPath": "/echo/{param}",
          "ServiceName": "provider-demo",
          "Value": "0.02182"
        }
      ],
      "TopReqAmount": [
        {
          "ApiId": "api-dtbc5cf0",
          "ApiPath": "/echo/{param}",
          "ServiceName": "provider-demo",
          "Value": "1.3412689E7"
        }
      ]
    }
  }
}