查询网关API监控明细数据

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

1. 接口描述

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

查询网关API监控明细数据

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

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

接口只验签名不鉴权。

2. 输入参数

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

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

3. 输出参数

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

4. 错误码

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

错误码	描述
InvalidParameterValue.GatewayParameterInvalid	无效请求参数:%s。
MissingParameter.GatewayParameterRequired	缺少请求参数:%s。
FailedOperation.GatewayRemoteCallError	远端访问错误: %s。
InternalError.UnhandledException	[%s]模块未处理异常。。
FailedOperation.UnhandledException	模块未处理异常。

5. 示例

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

输入示例

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

{
  "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"
        }
      ]
    }
  }
}