API 中心
有奖捉虫：办公协同&微信生态&物联网文档专题 HOT
文档中心 > API 中心 > 私有网络 > 网关流量监控相关接口 > 查询网关来访IP流控带宽

查询网关来访IP流控带宽

最近更新时间：2024-03-12 02:02:44

我的收藏

本页目录：

1. 接口描述

接口请求域名： vpc.tencentcloudapi.com 。

本接口（DescribeGatewayFlowQos）用于查询网关来访IP流控带宽。

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

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

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

参数名称 必选 类型 描述
Action 是 String 公共参数，本接口取值：DescribeGatewayFlowQos。
Version 是 String 公共参数，本接口取值：2017-03-12。
Region 是 String 公共参数，详见产品支持的 地域列表。
GatewayId 是 String 网关实例ID，目前我们支持的网关实例类型有，
专线网关实例ID，形如，dcg-ltjahce6；
Nat网关实例ID，形如，nat-ltjahce6；
VPN网关实例ID，形如，vpn-ltjahce6。
示例值：vpngw-4je9dgin
IpAddresses.N 否 Array of String 限流的云服务器内网IP。
示例值：10.0.0.12
Offset 否 Integer 偏移量，默认为0。
示例值：0
Limit 否 Integer 返回数量，默认为20，最大值为100。
示例值：20

3. 输出参数

参数名称 类型 描述
GatewayQosSet Array of GatewayQos 实例详细信息列表。
TotalCount Integer 符合条件的实例数量。
示例值：1
RequestId String 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 示例1 查询VPN网关来访IP流控带宽

输入示例

https://vpc.tencentcloudapi.com/?Action=DescribeGatewayFlowQos
&GatewayId=vpngw-4je9dgin
&<公共请求参数>

输出示例

{
    "Response": {
        "GatewayQosSet": [
            {
                "VpcId": "vpc-mrzkofih",
                "IpAddress": "10.0.0.12",
                "Bandwidth": 10,
                "CreateTime": "2020-01-01 10:00:00"
            }
        ],
        "TotalCount": 1,
        "RequestId": "5cf1a813-d4f8-4e0c-8f90-c155a84a3ea1"
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台，方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况，并自动生成各语言版本的 API 代码，也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集（SDK），支持多种编程语言，能更方便的调用 API。

命令行工具

6. 错误码

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

错误码 描述
InvalidParameterValue 参数取值错误。
InvalidParameterValue.LimitExceeded 参数值超出限制。
InvalidParameterValue.Range 参数值不在指定范围。
ResourceNotFound 资源不存在。
UnsupportedOperation.InvalidState 资源状态不合法。
中国站