調用DescribeNatGateways查詢NAT Gateway屬性-邊緣節點服務 ENS-阿里雲

調用DescribeNatGateways查詢已建立的NAT Gateway。

調試

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

調試

授權資訊

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

操作：是指具體的許可權點。
存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。
資源類型：是指操作中支援授權的資源類型。具體說明如下：
- 對於必選的資源類型，用前面加 * 表示。
- 對於不支援資源級授權的操作，用全部資源表示。
條件關鍵字：是指雲產品自身定義的條件關鍵字。
關聯操作：是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權，操作才能成功。

操作

存取層級

資源類型

條件關鍵字

關聯操作

ens:DescribeNatGateways

list

*全部資源

*

無

請求參數

名稱	類型	必填	描述	樣本值
EnsRegionId	string	否	ENS 節點 ID。	cn-wuxi-9
NatGatewayId	string	否	NAT Gateway的 ID。	nat-5t7nh1cfm6kxiszlttr38****
NetworkId	string	否	網路識別碼。	n-2zeuphj08tt7q3brd****
VSwitchId	string	否	交換器 ID。	vsw-5rllcjb3ol6duzjdnbm1o****
Name	string	否	NAT Gateway執行個體名稱。	test0
NatGatewayIds	array	否	NAT Gateway的 ID 數組。數組長度：1~100。
	string	否	NAT Gateway的 ID。	nat-5****4ik
EnsRegionIds	array	否	ENS 節點 ID 數組。數組長度：1~100。
	string	否	ENS 節點 ID。	cn-chengdu-telecom-4
PageNumber	integer	否	查詢列表的頁碼。起始值為 1。預設值：1。	1
PageSize	integer	否	分頁查詢時設定的每頁行數，最大值為 100 行。預設值：10。	10

返回參數

名稱	類型	描述	樣本值
	object	Schema of Response
RequestId	string	請求 ID。	2818A8F4-5E2B-5611-8732-5ACF7B677059
PageNumber	integer	當前查詢頁碼。	1
TotalCount	integer	查詢的 NAT Gateway列表條目數。	49
PageSize	integer	分頁查詢時每頁的行數。	10
NatGateways	array<object>	NAT Gateway的詳細資料。
	array<object>	NAT Gateway的詳細資料。
EnsRegionId	string	ENS 節點 ID。	cn-xiangyang-5
NatGatewayId	string	NAT Gateway的 ID。	nat-5t7nh1cfm6kxiszlttr38****
NetworkId	string	網路 ID。	n-5s2ml1olj0kzaws9n1yrj****
VSwitchId	string	交換器 ID。	vsw-5szpp1os9m55myirbflfw****
Name	string	NAT Gateway執行個體名稱。	test0
CreationTime	string	建立時間。UTC 時間，格式為：YYYY-MM-DDThh:mm:ssZ。	2021-11-22T07:03:32Z
Spec	string	NAT 執行個體規格。	enat.default
Status	string	要查詢的 NAT Gateway的狀態，取值： Creating：建立 NAT Gateway是非同步作業，在建立完成之前是 Creating 狀態。 Available：NAT Gateway建立完成後的狀態，是穩定點。 Deleting：刪除 NAT Gateway是非同步作業，在刪除的過程中是 Deleting 狀態。	Available
IpLists	array<object>	NAT Gateway綁定的 EIP 列表。
	object	NAT Gateway綁定的 EIP。
UsingStatus	string	NAT Gateway執行個體綁定的 EIP 的關聯關係。取值： UsedByForwardTable：使用該 EIP 配置了 DNAT 規則。 UsedBySnatTable：使用該 EIP 配置了 SNAT 規則。 Idle：閑置狀態，未配置 DNAT 和 SNAT 規則。	Idle
IpAddress	string	EIP 的 IP 位址。	8.XX.XX.162
AllocationId	string	EIP 的 ID。	eip-50g****
Tags	array<object>	標籤集合。
	object	標籤集合。
Value	string	標籤值。	TestValue
Key	string	標籤鍵。	TestKey
TagKey `deprecated`	string	標籤鍵。	TestKey
TagValue `deprecated`	string	標籤值。	TestValue

樣本

正常返回樣本

JSON格式

{
  "RequestId": "2818A8F4-5E2B-5611-8732-5ACF7B677059",
  "PageNumber": 1,
  "TotalCount": 49,
  "PageSize": 10,
  "NatGateways": [
    {
      "EnsRegionId": "cn-xiangyang-5",
      "NatGatewayId": "nat-5t7nh1cfm6kxiszlttr38****",
      "NetworkId": "n-5s2ml1olj0kzaws9n1yrj****",
      "VSwitchId": "vsw-5szpp1os9m55myirbflfw****",
      "Name": "test0",
      "CreationTime": "2021-11-22T07:03:32Z",
      "Spec": "enat.default",
      "Status": "Available",
      "IpLists": [
        {
          "UsingStatus": "Idle",
          "IpAddress": "8.XX.XX.162",
          "AllocationId": "eip-50g****"
        }
      ],
      "Tags": [
        {
          "Value": "TestValue",
          "Key": "TestKey",
          "TagKey": "TestKey",
          "TagValue": "TestValue"
        }
      ]
    }
  ]
}

錯誤碼

HTTP status code	錯誤碼	錯誤資訊	描述
400	Invalid%s	The specified parameter %s is invalid.
400	Missing%s	You must specify the parameter %s.
400	ens.interface.error	Failed to call API.	介面調用發生異常。
400	NoPermission	Permission denied.
400	InvalidParameter.%s	The specified field %s invalid. Please check it again.

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

變更歷史

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