文档中心>API 中心>私有网络>NAT网关相关接口>查询可创建的私网NAT网关配额数量

查询可创建的私网NAT网关配额数量

最近更新时间:2024-07-02 01:27:52

我的收藏

1. 接口描述

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

本接口(DescribePrivateNatGatewayLimits)用于查询可创建的私网NAT网关配额数量

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribePrivateNatGatewayLimits。
Version String 公共参数,本接口取值:2017-03-12。
Region String 公共参数,详见产品支持的 地域列表
Filters.N Array of Filter 查询VPC下可创建的私网网关配额数量,可选值:
  • VpcId - String - 所在VpcId
  • Offset Integer 偏移量,默认值为0。
    示例值:0
    Limit Integer 返回数目,默认值为20。
    示例值:20

    3. 输出参数

    参数名称 类型 描述
    TotalCount Integer 查询返回结果个数。
    示例值:1
    PrivateNatGatewayLimitSet Array of PrivateNatGatewayLimit 私网网关配额。
    RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

    4. 示例

    示例1 查询可创建的私网NAT网关配额数量

    输入示例

    POST / HTTP/1.1
    Host: vpc.tencentcloudapi.com
    Content-Type: application/json
    X-TC-Action: DescribePrivateNatGatewayLimits
    <公共请求参数>
    
    {
        "Filters": [
            {
                "Name": "VpcId",
                "Values": [
                    "vpc-12234568"
                ]
            }
        ],
        "Offset": 0,
        "Limit": 20
    }

    输出示例

    {
        "Response": {
            "TotalCount": 1,
            "PrivateNatGatewayLimitSet": [
                {
                    "UniqVpcId": "vpc-12234568",
                    "TotalLimit": 1000,
                    "Available": 998
                }
            ],
            "RequestId": "cd37ad3b-6b94-41f4-bd83-8a2b0d801aae"
        }
    }

    5. 开发者资源

    腾讯云 API 平台

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

    API Inspector

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

    SDK

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

    命令行工具

    6. 错误码

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

    错误码 描述
    InternalError 内部错误。
    InvalidParameter 参数错误。
    InvalidParameter.FilterInvalidKey 指定过滤条件不存在。
    InvalidParameter.FilterNotDict 指定过滤条件不是键值对。
    InvalidParameter.FilterValuesNotList 指定过滤选项值不是列表。
    InvalidParameterValue 参数取值错误。
    InvalidParameterValue.Malformed 入参格式不合法。
    InvalidParameterValue.Range 参数值不在指定范围。
    UnsupportedOperation.ActionNotFound 接口不存在。