DescribeNatGateways

最近更新时间: 2025-03-12 16:34:40

1. 接口描述

接口请求域名: vpc.api3.gds-cloud.com。

本接口(DescribeNatGateways)用于查询 NAT 网关。

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

接口更新时间:2019-07-04 17:39:30。

接口既验签名又鉴权。

2. 输入参数

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

参数名称 必选 允许NULL 类型 描述
Action String 公共参数,本接口取值:DescribeNatGateways
Version String 公共参数,本接口取值:2017-03-12
Region String 公共参数,地域信息可通过DescribeRegions接口查看产品支持的地域列表
NatGatewayIds Array of String NAT网关统一 ID,形如:nat-jktxx454
示例值: ["nat-3isn9hr0\r\n","nat-mxkohguo\r\n"]
Filters Array of Filter 过滤条件,参数不支持同时指定NatGatewayIds和Filters。
  • nat-gateway-id - String - (过滤条件)协议端口模板实例ID,形如:nat-jktxx454
  • vpc-id - String - (过滤条件)私有网络 唯一ID,形如:vpc-jktxx454
  • nat-gateway-name - String - (过滤条件)协议端口模板实例ID,形如:demo_nat

  • 示例值:查看
    Offset Uint64 偏移量,默认为0。
    示例值: 0
    Limit Uint64 返回数量,默认为20,最大值为100。
    示例值: 10

    3. 输出参数

    参数名称 类型 描述
    NatGatewaySet NatGateway NAT网关对象数组。
    示例值:查看
    TotalCount Uint64 符合条件的NAT网关对象个数。
    示例值: 2
    RequestId String 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

    4. 错误码

    该接口暂无业务逻辑相关的错误码,其他错误码详见公共错误码