全部產品
Search

搜尋本產品

    NAT Gateway：GetNatGatewayAttribute

    文件中心

    NAT Gateway：GetNatGatewayAttribute

    更新時間：Aug 27, 2026

    呼叫 GetNatGatewayAttribute 介面查詢單個 NAT 閘道器執行個體的資訊。

    介面說明

    本介面可以查詢單個公網 NAT 閘道器或 VPC NAT 閘道器的資訊，文中出現的「NAT 閘道器」不做具體的區分。

    調試

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

    調試

    授權資訊

    下表是API對應的授權資訊，可以在RAM權限原則語句的Action元素中使用，用來給RAM使用者或RAM角色授予調用此API的許可權。具體說明如下：

    • 操作：是指具體的許可權點。

    • 存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。

    • 資源類型：是指操作中支援授權的資源類型。具體說明如下：

      • 對於必選的資源類型，用前面加 * 表示。

      • 對於不支援資源級授權的操作，用全部資源表示。

    • 條件關鍵字：是指雲產品自身定義的條件關鍵字。

    • 關聯操作：是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權，操作才能成功。

    操作

    存取層級

    資源類型

    條件關鍵字

    關聯操作

    vpc:GetNatGatewayAttribute

    get

    *NatGateway

    acs:vpc:{#regionId}:{#accountId}:natgateway/{#NatGatewayId}

    		 無 無

    請求參數

    名稱

    類型

    必填

    描述

    樣本值
    RegionId

    string

    是

    NAT 閘道器所屬的地域 ID。

    您可以透過呼叫 DescribeRegions 介面取得地域 ID。

    cn-qingdao
    NatGatewayId

    string

    是

    NAT 閘道器執行個體 ID。

    ngw-bp1b0lic8uz4r6vf2****

    返回參數

    名稱

    類型

    描述

    樣本值

    object

    VpcId

    string

    NAT 閘道器執行個體所屬 VPC 的 ID。

    vpc-bp15zckdt37pq72z****
    CreationTime

    string

    NAT 閘道器的建立時間。格式為：YYYY-MM-DDThh:mm:ssZ。

    2021-12-08T12:20:20Z
    Status

    string

    NAT 閘道器的狀態。取值：

    • Creating：建立中。建立 NAT 閘道器是非同步操作，在建立完成之前是 Creating 狀態。

    • Available：可用。NAT 閘道器建立完成後的狀態，是穩定狀態。

    • Modifying：修改中。變更規格 NAT 閘道器是非同步操作，在變更規格的過程中是 Modifying 狀態。

    • Deleting：刪除中。刪除 NAT 閘道器是非同步操作，在刪除的過程中是 Deleting 狀態。

    • Converting：轉換中。普通型 NAT 閘道器轉換到增強型 NAT 閘道器是非同步操作，在轉換過程中是 Converting 狀態。

    Available
    NatType

    string

    公網 NAT 閘道器的類型，目前取值為 Enhanced，即增強型 NAT 閘道器。

    Enhanced
    NetworkType

    string

    NAT 閘道器的類型。取值：

    • internet：公網 NAT 閘道器。

    • intranet：VPC NAT 閘道器。

    internet
    RegionId

    string

    NAT 閘道器執行個體所在的地域 ID。

    cn-qingdao
    EcsMetricEnabled

    boolean

    是否開啟了閘道器流量監控功能。取值：

    • true：已開啟閘道器流量監控功能。

    • false：未開啟閘道器流量監控功能。

    true
    RequestId

    string

    請求 ID。

    4EC47282-1B74-4534-BD0E-403F3EE64CAF
    Description

    string

    NAT 閘道器執行個體的描述。

    NAT
    ExpiredTime

    string

    NAT 閘道器執行個體的過期時間。

    2021-12-26T12:20:20Z
    ResourceGroupId

    string

    資源群組 ID。

    rg-bp67acfmxazb4ph****
    NatGatewayId

    string

    NAT 閘道器執行個體的 ID。

    ngw-bp1047e2d4z7kf2ki****
    BusinessStatus

    string

    NAT 閘道器的業務狀態。取值：

    • Normal：正常。

    • FinancialLocked：欠費鎖定狀態。

    Normal
    Name

    string

    NAT 閘道器執行個體名稱。

    abc
    ForwardTable

    object

    DNAT 列表的資訊。

    ForwardTableId

    string

    DNAT 表的 ID。

    ftb-uf6gj3mhsg94qsqst****
    ForwardEntryCount

    integer

    DNAT 項目的個數。

    1
    SnatTable

    object

    SNAT 列表資訊。

    SnatEntryCount

    integer

    SNAT 項目的個數。

    1
    SnatTableId

    string

    SNAT 列表的 ID。

    stb-SnatTableIds****
    FullNatTable

    object

    FULLNAT 列表的資訊。

    FullNatEntryCount

    integer

    FULLNAT 項目的個數。

    1
    FullNatTableId

    string

    FULLNAT 表的 ID。

    fulltb-gw88z7hhlv43rmb26****
    BillingConfig

    object

    帳單設定資訊。

    InternetChargeType

    string

    NAT 閘道器執行個體的計費類型。取值：

    • PayBySpec：按固定規格計費。

    • PayByLcu：按使用量計費。

    PayBySpec
    AutoPay

    string

    是否自動付費，當 InstanceChargeType 參數的值為 PrePaid 時，返回以下值：

    • false：不開啟自動付費，產生訂單後需要到訂單中心完成支付。

    • true：開啟自動付費，自動支付訂單。

    當 InstanceChargeType 參數的值為 PostPaid 時，返回值為空。

    false
    Spec

    string

    公網 NAT 閘道器執行個體的規格，且當 InternetChargeType 為 PayBySpec 時，返回以下值：

    • Small：小型。

    • Middle：中型。

    • Large：大型。 當 InternetChargeType 為 PayByLcu 時，返回值為空。

    Small
    InstanceChargeType

    string

    NAT 閘道器執行個體的付費模式，取值：PostPaid（按量付費）。

    PostPaid
    PrivateInfo

    object

    NAT 閘道器執行個體的私網資訊。

    MaxBandwidth

    integer

    最大頻寬值，單位為 Mbps。

    5120
    VswitchId

    string

    NAT 閘道器執行個體所屬的交換器 ID。

    vsw-bp1s2laxhdf9ayjbo***
    PrivateIpAddress

    string

    私網 IP 地址。

    192.168.XX.XX
    IzNo

    string

    NAT 閘道器執行個體所屬的可用區。

    cn-qingdao-b
    EniInstanceId

    string

    彈性網卡執行個體 ID。

    eni-bp1cmgtoaka8vfyg****
    DeletionProtectionInfo

    object

    刪除保護資訊。

    Enabled

    boolean

    是否開啟刪除保護功能。

    • true：已開啟刪除保護功能。

    • false：未開啟刪除保護功能。

    true
    IpList

    array<object>

    公網 NAT 閘道器綁定的彈性公網 IP 列表。

    object

    公網 NAT 閘道器綁定的彈性公網 IP 列表。

    UsingStatus

    string

    公網 NAT 閘道器執行個體綁定的彈性公網 IP 的關聯關係。

    • idle：彈性公網 IP 未關聯 SNAT 項目或 DNAT 項目。

    • UsedBySnatTable：彈性公網 IP 已關聯 SNAT 項目。

    • UsedByForwardTable：彈性公網 IP 已關聯 DNAT 項目。

    idle
    IpAddress

    string

    彈性公網 IP 的地址。

    116.33.XX.XX
    AllocationId

    string

    彈性公網 IP 的執行個體 ID。

    eip-bp13e9i2qst4g6jzi****
    PrivateLinkEnabled

    boolean

    是否支援私網連線，取值：

    • true：支援私網連線。

    • false：不支援私網連線。

    true
    PrivateLinkMode

    string

    私網連線服務轉化模式，取值：

    • FullNat：使用 FULLNAT 模式。

    • Geneve：使用 Geneve 模式。

    FullNat
    EnableSessionLog

    boolean

    是否開啟工作階段記錄，取值：

    • true：已開啟工作階段記錄。

    • false：已關閉工作階段記錄。

    true
    LogDelivery

    object

    工作階段記錄設定資訊。

    LogDeliveryType

    string

    工作階段記錄投遞目的類型。取值： sls，阿里雲日誌服務 SLS。

    sls
    LogDestination

    string

    工作階段記錄寫入目的地址。

    acs:log:cn-hangzhou:0000:project/nat_session_log_project/logstore/session_log_test
    DeliveryStatus

    string

    工作階段記錄寫入狀態。取值：

    • Succsess：成功。

    • Failure：失敗。

    Failure
    DeliverLogsErrorMessage

    string

    工作階段記錄寫入失敗的錯誤訊息。

    LogStoreNotExist: logstore session_log_test does not exist
    AccessMode

    object

    反向存取 VPC NAT 閘道器的存取模式。

    ModeValue

    string

    存取模式取值：

    • route：路由模式。

    • tunnel：通道模式。

    route
    TunnelType

    string

    通道模式類型：

    • geneve：Geneve 類型。

    geneve
    AvailabilityMode

    string

    樣本

    正常返回樣本

    JSON格式

    {
  "VpcId": "vpc-bp15zckdt37pq72z****",
  "CreationTime": "2021-12-08T12:20:20Z",
  "Status": "Available",
  "NatType": "Enhanced",
  "NetworkType": "internet",
  "RegionId": "cn-qingdao",
  "EcsMetricEnabled": true,
  "RequestId": "4EC47282-1B74-4534-BD0E-403F3EE64CAF",
  "Description": "NAT",
  "ExpiredTime": "2021-12-26T12:20:20Z",
  "ResourceGroupId": "rg-bp67acfmxazb4ph****",
  "NatGatewayId": "ngw-bp1047e2d4z7kf2ki****",
  "BusinessStatus": "Normal",
  "Name": "abc",
  "ForwardTable": {
    "ForwardTableId": "ftb-uf6gj3mhsg94qsqst****",
    "ForwardEntryCount": 1
  },
  "SnatTable": {
    "SnatEntryCount": 1,
    "SnatTableId": "stb-SnatTableIds****"
  },
  "FullNatTable": {
    "FullNatEntryCount": 1,
    "FullNatTableId": "fulltb-gw88z7hhlv43rmb26****"
  },
  "BillingConfig": {
    "InternetChargeType": "PayBySpec",
    "AutoPay": "false",
    "Spec": "Small",
    "InstanceChargeType": "PostPaid"
  },
  "PrivateInfo": {
    "MaxBandwidth": 5120,
    "VswitchId": "vsw-bp1s2laxhdf9ayjbo***",
    "PrivateIpAddress": "192.168.XX.XX",
    "IzNo": "cn-qingdao-b",
    "EniInstanceId": "eni-bp1cmgtoaka8vfyg****"
  },
  "DeletionProtectionInfo": {
    "Enabled": true
  },
  "IpList": [
    {
      "UsingStatus": "idle",
      "IpAddress": "116.33.XX.XX",
      "AllocationId": "eip-bp13e9i2qst4g6jzi****"
    }
  ],
  "PrivateLinkEnabled": true,
  "PrivateLinkMode": "FullNat",
  "EnableSessionLog": true,
  "LogDelivery": {
    "LogDeliveryType": "sls",
    "LogDestination": "acs:log:cn-hangzhou:0000:project/nat_session_log_project/logstore/session_log_test",
    "DeliveryStatus": "Failure",
    "DeliverLogsErrorMessage": "LogStoreNotExist: logstore session_log_test does not exist"
  },
  "AccessMode": {
    "ModeValue": "route",
    "TunnelType": "geneve"
  },
  "AvailabilityMode": ""
}

    錯誤碼

    HTTP status code

    錯誤碼

    錯誤資訊

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

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

    變更歷史

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