本文為您介紹使用NAT GatewayOpenAPI的基本資料,包括版本說明、存取點說明、介面風格和調用方式支援情況。
NAT Gateway和Virtual Private Cloud使用同一個服務地址(Endpoint)。
OpenAPI介紹
為了能夠讓開發人員快速高效的學習和使用雲產品OpenAPI,阿里雲為使用者提供OpenAPI網站。它是一款集OpenAPI智能搜尋、文檔、線上調試、SDK擷取、CodeSample、調用出錯診斷、調用統計為一體的產品。您可以在OpenAPI門戶中調用阿里雲各雲產品開放的OpenAPI,查看OpenAPI請求和返回結果。此外,OpenAPI門戶會自動產生相應的SDK調用樣本,協助您快速使用阿里雲產品。更多資訊,請參見什麼是OpenAPI。
版本說明
阿里雲OpenAPI通過版本號碼管控各時期雲產品大版本的API列表,例如NAT Gateway目前支援2016-04-28
版本的API列表,2016-04-28
代表的是API版本號碼而非時間概念,所展示的都是最新的API公開資料,並非自2016-04-28
之後就未更新。
版本號碼 | 說明 |
推薦使用。 |
線上調試
NAT Gateway在OpenAPI門戶提供API調試等功能。在調用前,您需要瞭解NAT Gateway提供的版本、存取點說明、整合方式等資訊。
調試入口
調試API入口為:NAT Gateway調試入口
存取點說明
NAT GatewayOpenAPI支援多存取點。更多資訊,請參見服務存取點。
支援的使用者身份
您阿里雲帳號登入OpenAPI網站後,OpenAPI預設使用您的阿里雲帳號進行線上OpenAPI調試。阿里雲帳號擁有所有API的存取權限,風險很高。強烈建議您建立並使用RAM使用者進行API訪問或日常營運。請根據業務的實際情況按需分配許可權後進行介面調用。RAM使用者需具備操作NAT資源的許可權。具體操作,請參見使用RAM進行存取控制。
使用者身份 | 支援情況 |
支援 | |
RAM使用者(推薦) | 支援 |
RAM角色(推薦) | 支援 |
更多資訊
您可以通過以下文檔瞭解更多關於阿里雲OpenAPI的身份、憑據、授權、流量控制以及配額的相關內容。
整合方式
SDK是最易於整合,且支援度最好的OpenAPI調用方式,推薦您選擇使用SDK。
整合方式 | 支援情況 |
阿里雲SDK | 支援 |
阿里雲CLI | 支援 |
Resource Orchestration Service | 支援 |
Terraform | 支援 |
阿里雲SDK
阿里雲CLI
阿里雲命令列工具可以幫您在使用命令列終端時,使用
aliyun
命令與阿里雲服務進行互動,管理雲端服務資源。有關阿里雲CLI的更多詳細資料,請參見什麼是阿里雲CLI。Terraform
Terraform 是一種開源工具,用於安全高效地預覽,配置和管理雲基礎架構和資源。它與阿里雲的Resource Orchestration Service服務的運行機制類似,通過將模板轉化為內部資料後完成 OpenAPI 呼叫。更多詳情,請參見什麼是 Terraform。
Resource Orchestration Service
Resource Orchestration Service服務ROS(Resource Orchestration Service)是阿里雲提供的一項簡化雲端運算資源管理的服務。開發人員和管理員可以編寫模板,在模板中定義所需的阿里雲資源(例如:ECS 執行個體、RDS 資料庫執行個體)、資源間的依賴關係等。ROS 的編排引擎將根據模板自動完成所有資源的建立和配置,實現自動化部署及營運。更多詳情,請參見什麼是Resource Orchestration Service服務。
支援使用Resource Orchestration Service服務ROS調用NAT Gateway。編排的部分資源如下所示:
ALIYUN::VPC::NatGateway:建立NAT Gateway。
ALIYUN::VPC::SnatEntry:在SNAT列表中添加SNAT條目。
ALIYUN::VPC::NatIp:建立NAT IP地址。
ALIYUN::VPC::NatIpCidr:建立NAT IP位址區段。
DATASOURCE::VPC::NatGateways:查詢已建立的NAT Gateway。
DATASOURCE::VPC::NatGatewayZones:查詢NAT Gateway的可用性區域。
DATASOURCE::VPC::NatIpCidrs:查詢NAT IP位址區段列表。
自訂封裝API調用
原生HTTP調用需要您自己實現簽名演算法,並構建自訂請求,發起HTTP調用。有關簽名機制的更多詳細資料,請參見API概覽和V3版本請求體&簽名機制。
注意事項
如果調用API後返回錯誤,您需要根據返回的錯誤碼提示檢查傳入的請求參數及其取值是否正確。
您也可以記錄下調用返回的RequestID或SDK報錯資訊,通過阿里雲OpenAPI診斷平台進行自助診斷。