全部產品
Search

搜尋本產品

    NAT Gateway：ListNatIps - 查詢NAT IP地址清單

    文件中心

    NAT Gateway：ListNatIps - 查詢NAT IP地址清單

    更新時間：Apr 27, 2026

    調用ListNatIps介面查詢NAT IP地址清單。

    調試

    您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。

    調試

    授權資訊

    當前API暫無授權資訊透出。

    請求參數

    名稱

    類型

    必填

    描述

    樣本值
    RegionId

    string

    是

    要查詢的 NAT IP 位址列表所屬 NAT Gateway執行個體的地區 ID。

    您可以通過調用 DescribeRegions 介面擷取地區 ID。

    eu-central-1
    NatGatewayId

    string

    是

    要查詢 NAT IP 位址所屬 NAT Gateway執行個體 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 Gateway執行個體的地區 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 Gateway執行個體 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.

    訪問錯誤中心查看更多錯誤碼。

    變更歷史

    更多資訊，參考變更詳情。