全部产品
Search

搜索本产品

    NAT 网关：ListNatIps - 查询NAT IP地址列表

    文档中心

    NAT 网关：ListNatIps - 查询NAT IP地址列表

    更新时间：Aug 28, 2026

    调用ListNatIps接口查询NAT IP地址列表。

    调试

    您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

    调试

    授权信息

    当前API暂无授权信息透出。

    请求参数

    名称

    类型

    必填

    描述

    示例值
    RegionId

    string

    是

    要查询的 NAT IP 地址列表所属 NAT 网关实例的地域 ID。

    您可以通过调用 DescribeRegions 接口获取地域 ID。

    eu-central-1
    NatGatewayId

    string

    是

    要查询 NAT IP 地址所属 NAT 网关实例 ID。

    ngw-gw8v16wgvtq26vh59****
    NatIpCidr

    string

    否

    要查询的 NAT IP 地址所在的地址段。

    192.168.0.0/24
    DryRun

    boolean

    否

    是否只预检此次请求。取值：

    • true：发送检查请求，不会查询 NAT IP 地址列表。检查项包括是否填写了必需参数、请求格式、业务限制。如果检查不通过，则返回对应错误。如果检查通过，则返回错误码DryRunOperation。

    • false（默认值）：发送正常请求，通过检查后返回 HTTP 2xx 状态码并直接进行操作。

    false
    ClientToken

    string

    否

    客户端 Token，用于保证请求的幂等性。

    由客户端生成该参数值，要保证在不同请求间唯一，最大值不超过 64 个 ASCII 字符。

    说明

    若您未指定，则系统自动使用 API 请求的 RequestId 作为 ClientToken 标识。每次 API 请求的 RequestId 可能不一样。

    5A2CFF0E-5718-45B5-9D4D-70B3FF3898
    NatIpStatus

    string

    否

    查询的 NAT IP 地址的状态。取值：

    • Available：可用状态。

    • Deleting：删除中。

    • Creating：创建中。

    Available
    NextToken

    string

    否

    是否拥有下一次查询的令牌（Token）。取值：

    • 第一次查询和没有下一次查询时，均无需填写。

    • 如果有下一次查询，取值为上一次 API 调用返回的 NextToken 值。

    FFmyTO70tTpLG6I3FmYAXGKPd****f84eb48b699f0a4883
    MaxResults

    string

    否

    分批次查询时每次显示的条目数。取值范围：1~100，默认值为 20。

    20
    NatIpName

    array

    否

    要查询的 NAT IP 地址的名称。N 取值为 1~20。

    test

    string

    否

    要查询的 NAT IP 地址的名称。N 取值为 1~20。

    test
    NatIpIds

    array

    否

    要查询的 NAT IP 地址实例 ID。N 取值为 1~20。

    vpcnatip-gw8a863sut1zijxh0****

    string

    否

    要查询的 NAT IP 地址实例 ID。N 取值为 1~20。

    vpcnatcidr-gw8ov42ei6xh1jys2****
    RegionId

    string

    是

    要查询的 NAT IP 地址列表所属 NAT 网关实例的地域 ID。

    您可以通过调用 DescribeRegions 接口获取地域 ID。

    eu-central-1
    IpOrigin

    string

    否

    要查询的 NAT IP 来源的属性枚举。可能值：

    • prefix：属于 IP 前缀的 NAT IP。

    • cidr：不属于任何 IP 前缀的孤立 NAT IP。

    • 空：查询全部 NAT IP。

    cidr
    Ipv4Prefix

    string

    否

    要查询的 IP 前缀地址段。

    192.168.0.0/28

    返回参数

    名称

    类型

    描述

    示例值

    object

    NextToken

    string

    是否拥有下一次查询的令牌（Token）。取值：

    • 如果 NextToken 为空表示没有下一次查询。

    • 如果 NextToken 有返回值，该取值表示下一次查询开始的令牌。

    FFmyTO70tTpLG6I3FmYAXGKPd****
    RequestId

    string

    请求 ID。

    7E78CEEA-BF8F-44D1-9DCD-D9141135B71E
    TotalCount

    string

    查询到的 NAT IP 地址结果数目。

    1
    NatIps

    array<object>

    NAT IP 地址列表。

    object

    IsDefault

    boolean

    是否是默认 NAT IP 地址。取值：

    • true：是默认 NAT IP 地址。

    • false：不是默认 NAT IP 地址。

    true
    NatIp

    string

    查询的 NAT IP 地址。

    192.168.0.126
    Ipv4Prefix

    string

    查询的 NAT IP 地址所属的 IP 前缀地址段。

    192.168.0.0/28
    NatIpCidr

    string

    查询的 NAT IP 地址所在的地址段。

    192.168.0.0/24
    NatIpId

    string

    查询的 NAT IP 地址实例 ID。

    vpcnatip-gw8a863sut1zijxh0****
    NatIpDescription

    string

    查询的 NAT IP 地址的描述信息。

    default
    NatGatewayId

    string

    查询的 NAT IP 地址所属的 VPC NAT 网关实例 ID。

    ngw-gw8v16wgvtq26vh59****
    NatIpName

    string

    查询的 NAT IP 地址的名称。

    default
    NatIpStatus

    string

    查询的 NAT IP 地址的状态。取值：

    • Available：可用状态。

    • Deleted：已删除。

    • Deleting：删除中。

    • Creating：创建中。

    • Associated：已关联 SNAT 或 DNAT 条目。

    • Associating：关联 SNAT 或 DNAT 条目中。

    Available

    示例

    正常返回示例

    JSON格式

    {
  "NextToken": "FFmyTO70tTpLG6I3FmYAXGKPd****",
  "RequestId": "7E78CEEA-BF8F-44D1-9DCD-D9141135B71E",
  "TotalCount": "1",
  "NatIps": [
    {
      "IsDefault": true,
      "NatIp": "192.168.0.126",
      "Ipv4Prefix": "192.168.0.0/28",
      "NatIpCidr": "192.168.0.0/24",
      "NatIpId": "vpcnatip-gw8a863sut1zijxh0****",
      "NatIpDescription": "default",
      "NatGatewayId": "ngw-gw8v16wgvtq26vh59****",
      "NatIpName": "default",
      "NatIpStatus": "Available"
    }
  ]
}

    错误码

    HTTP status code

    错误码

    错误信息

    描述
    404 InvalidRegionId.NotFound The specified RegionId does not exist in our records.

    访问错误中心查看更多错误码。

    变更历史

    更多信息，参考变更详情。