查询网关监控概览

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

1. 接口描述

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

查询网关监控概览

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

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

接口只验签名不鉴权。

2. 输入参数

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

参数名称	必选	允许NULL	类型	描述
Action	是	否	String	公共参数，本接口取值：DescribeGatewayMonitorOverview
Version	是	否	String	公共参数，本接口取值：2018-03-26
Region	是	否	String	公共参数，地域信息可通过DescribeRegions接口查看产品支持的地域列表
GatewayDeployGroupId	是	否	String	网关部署组ID 示例值：

3. 输出参数

参数名称	类型	描述
Result	MonitorOverview	监控概览对象示例值：查看
RequestId	String	唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 错误码

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

错误码	描述
InvalidParameterValue.GatewayParameterInvalid	无效请求参数:%s。
MissingParameter.GatewayParameterRequired	缺少请求参数:%s。
UnauthorizedOperation.NoPrivilege	用户无权限访问该接口。。
FailedOperation.GatewayRemoteCallError	远端访问错误: %s。
FailedOperation.TsfPrivilegeError	TSF权限模块异常，请联系系统管理员。。
ResourceNotFound.MicroserviceOffline	目标微服务已离线[%s]。。
UnauthorizedOperation.NoLicense	缺少License。。

5. 示例

示例1 查询网关监控概览

输入示例

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

{
  "GatewayDeployGroupId": "group-yd3b588a"
}

输出示例

{
  "Response": {
    "RequestId": "12520484-ddf5-4876-9550-142f7e6fafa3",
    "Result": {
      "ErrorCount": "292635",
      "ErrorCountOfDay": "292635",
      "InvocationCount": "13412691",
      "InvocationCountOfDay": "13412691",
      "SuccessRatio": "0.97818",
      "SuccessRatioOfDay": "0.97818"
    }
  }
}