查询网关监控概览

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

1. 接口描述

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

查询网关监控概览

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

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

接口既验签名又鉴权。

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 查询网关监控概览

输入示例

https://tsf.api3.<no value>/?Action=DescribeGatewayMonitorOverview
&GatewayDeployGroupId=group-spzs5mv5
&<公共请求参数>

输出示例

{
    "Response":{
        "RequestId":"5d996e05507e42d5970cd2e25ed5267a",
        "Result":{
            "InvocationCountOfDay":"1213",
            "InvocationCount":"10987",
            "ErrorCountOfDay":"123",
            "ErrorCount":"8990",
            "SuccessRatioOfDay":"0.18671",
            "SuccessRatio":"0.35829"
        }
    }
}