このトピックでは、OpenAPIを使用してNAT Gateway操作を呼び出す方法について説明します。バージョン、エンドポイント、スタイル、呼び出し方法について説明します。
NAT GatewayとVirtual Private Cloudは同じエンドポイントを使用します。
OpenAPI Explorerの紹介
Alibaba Cloudは、さまざまなAlibaba CloudサービスのAPI操作を効率的に理解して使用するためのOpenAPI Explorerを提供しています。 OpenAPI Explorerは、インテリジェント検索、ドキュメント、オンラインデバッグ、SDK取得、サンプルコード、コールエラー診断、コール統計などの機能をAPI操作と統合しています。 OpenAPI Explorerでは、Alibaba CloudサービスのAPI操作を呼び出し、APIのリクエストとレスポンスを表示できます。 OpenAPI Explorerは、Alibaba Cloudサービスの使用に役立つSDKサンプルコードを自動的に生成することもできます。 詳細については、「OpenAPIとは」をご参照ください。
バージョン
Alibaba Cloud OpenAPI Explorerは、Alibaba CloudサービスAPIのバージョンをバージョン番号で管理します。 たとえば、NAT Gatewayは2016-04-28バージョンのAPIをサポートしています。 2016-04-28 APIバージョン番号ですが、日付はありません。 ユーザーには、APIに関する最新の公開情報が提供されます。 2016-04-28は、NAT Gateway APIの最新バージョンです。
APIバージョン | 説明 |
このバージョンを使用することを推奨します。 |
オンラインデバッグ
NAT Gatewayは、OpenAPI ExplorerでのAPIデバッグなどの機能を提供します。 API操作を呼び出す前に、NAT Gatewayが提供する次の情報 (バージョン、エンドポイント、および統合方法) を理解する必要があります。
デバッグページ
エンドポイント
NAT Gateway APIは、複数のアクセスポイントをサポートします。 詳細については、「エンドポイント」をご参照ください。
サポートされているユーザーID
Alibaba Cloudアカウントを使用してOpenAPI Explorerにログインすると、OpenAPI ExplorerはAlibaba Cloudアカウントを使用してデフォルトでオンラインデバッグを実行します。 Alibaba Cloudアカウントには、すべてのAPI操作に対する権限があります。 Alibaba Cloudアカウントを使用してAPI操作を呼び出すと、セキュリティリスクが発生する可能性があります。 RAM (Resource Access Management) ユーザーとしてAPI操作を呼び出すか、ルーチンのO&Mを実行することを推奨します。 RAMユーザーとしてAPI操作を呼び出す前に、RAMユーザーに必要な権限を付与します。 RAMユーザーには、NAT Gatewayリソースに対する権限が必要です。 詳細については、「RAMを使用したアクセス制御の実装」をご参照ください。
ユーザーID | 対応 |
必須 | |
RAMユーザー (推奨) | 必須 |
RAMロール (推奨) | 必須 |
関連ドキュメント
OpenAPI ExplorerのユーザーID、資格情報、承認、トラフィック制御、およびクォータの詳細については、次のトピックを参照してください。
統合方法
SDKはアプリケーションと簡単に統合でき、幅広い操作をカバーできます。 SDKを使用してAPI操作を呼び出すことを推奨します。
統合方法 | 対応 |
Alibaba Cloud SDK | 必須 |
Alibaba Cloud CLI | 必須 |
Resource Orchestration Service (ROS) | 必須 |
テラフォーム | 必須 |
Alibaba Cloud SDK
Alibaba Cloudは、Java、C# 、Go、Python、Node.js、TypeScript、PHP、C ++ などの複数のプログラミング言語でSDKを提供しています。 SDKをアプリケーションと統合して、API操作を直接呼び出すことができます。 SDKは、署名ロジック、タイムアウトメカニズム、および再試行メカニズムをカプセル化し、開発を容易にする要求および応答オブジェクトを提供します。 詳細は、「Alibaba Cloud SDK」をご参照ください。
Alibaba Cloud SDKを使用して、OpenAPI ExplorerでAPI操作を呼び出すことができます。 サポートされているプログラミング言語と依存関係のインストール方法の詳細については、「VPC SDK」をご参照ください。
Alibaba Cloud CLI
aliyunコマンドを実行して、Alibaba Cloudサービスと対話し、クラウドサービスリソースを管理できます。 詳細については、「Alibaba Cloud CLIとは」をご参照ください。テラフォーム
Terraformは、クラウドインフラストラクチャとリソースを安全かつ効率的にプレビュー、設定、管理するために使用されるオープンソースツールです。 TerraformはROSと同様のメカニズムで機能します。 テンプレートを解釈してAPI操作を呼び出します。 詳細については、「Terraformとは何ですか?」をご参照ください。
ROS
ROSは、クラウドコンピューティングリソースの管理を簡素化できるAlibaba Cloudサービスです。 必要なECS (Elastic Compute Service) やApsaraDB RDSインスタンスなどのクラウドコンピューティングリソース、およびリソース間の関係を記述するテンプレートを作成できます。 ROSは、テンプレートに基づいてすべてのリソースを自動的に作成および構成し、自動デプロイとO&Mを実装します。詳細については、「ROSとは何ですか?」をご参照ください。
ROSを使用してNAT Gateway操作を呼び出すことができます。 いくつかのオーケストレーションされたリソース:
ALIYUN::VPC::NatGateway: NATゲートウェイを作成します。
ALIYUN::VPC::SnatEntry: SNATエントリをSNATテーブルに追加します。
ALIYUN::VPC::NatIp: NAT IPアドレスを作成します。
ALIYUN::VPC::NatIpCidr: NAT CIDRブロックを作成します。
DATASOURCE::VPC::NatGateways: NAT Gatewayを照会します。
DATASOURCE::VPC::NatGatewayZones: NATゲートウェイのゾーンを照会します。
DATASOURCE::VPC::NatIpCidrs: NAT CIDRブロックを照会します。
カスタムAPIカプセル化
ネイティブHTTP呼び出しを行うには、カスタムリクエストを作成してリクエストに署名する必要があります。 署名メカニズムの詳細については、「関数別の操作のリスト」および「リクエスト構文と署名メソッドV3」をご参照ください。
使用上の注意
APIを呼び出した後にエラーが返された場合は、返されたエラーコードに基づいてリクエストパラメーターの値が有効かどうかを確認する必要があります。
Alibaba Cloud OpenAPI Diagnosticsプラットフォームを使用して、返されたリクエストIDまたはSDKエラーメッセージに基づいてセルフサービス診断を実行できます。