API Gateway:API Gateway を使用した VPC バックエンドサービスへのアクセス

前提条件

• VPC があること。詳細については、「IPv4 CIDR ブロックを持つ VPC の作成」および「IPv6 CIDR ブロックを持つ VPC の作成」をご参照ください。

• ECS インスタンスがあること。詳細については、「ECS インスタンスの作成」をご参照ください。

操作手順

API Gateway を使用して VPC 内のバックエンドサービスにアクセスするには、次の手順を実行します。

• VPC アクセス権限の作成

• API グループの作成

• API の作成

• アプリケーションの作成と API 呼び出しの権限付与

• セキュリティグループでの API Gateway エグレス IP アドレスの許可

• API のデバッグ

• API の呼び出し

VPC アクセス権限の作成

VPC アクセス権限を作成して、API Gateway が VPC にアクセスできるようにします。

1. API Gateway コンソールにログインします。 リージョンを選択し、左側のナビゲーションペインで、[API 管理] > [VPC 認可]を選択します。

2. [承認リスト] ページで、右上隅にある [承認を作成] をクリックします。

3. [VPC 承認の作成] ページで、[VPC 承認名]、[VPC ID]、[インスタンス ID または IP アドレス]、および[ポート]を入力します。

   説明

   • 特定のドメイン名を使用して SLB または ECS インスタンス上のサイト (vhost) にアクセスするには、Host フィールドにドメイン名を設定します。

   • VPC ID、インスタンス ID、またはプライベート IP アドレスは、ECS や Classic Load Balancer (CLB) インスタンスなどのバックエンドサービスの詳細ページで確認できます。

API グループの作成

API の作成

1. API Gateway コンソールにログインします。リージョンを選択し、左側のナビゲーションペインで [API 管理] > [グループ管理] を選択します。

2. [グループリスト] ページで、nginx-demo グループを見つけ、[アクション] 列の [API 管理] をクリックします。

3. [API リスト] ページで、右上隅にある [API の作成] をクリックします。

4. [API の作成] ページの [基本情報] セクションで、次のパラメーターを設定し、[次へ] をクリックします。

   [パラメーター]	[例]
   [グループ]	nginx-demo
   [API名]	nginx-test
   [セキュリティ]認証	Alibaba Cloud App
   [AppCode 認証]	AppCode (ヘッダーとクエリ) 認証を許可する
   [署名アルゴリズム]	HMAC_SHA256

5. [API リクエストの定義] セクションで、以下のパラメーターを設定し、[次へ] をクリックします。

   [パラメーター]	[例]
   [プロトコル]	HTTP、HTTPS
   [リクエストパス]	/nginx
   [HTTP メソッド]	GET
   [リクエストモード]	パススルー

   説明

   このステップでは、ブラウザ、モバイルアプリ、または他のビジネスシステムなどのクライアントが API にリクエストを送信する方法を定義します。リクエストプロトコル、リクエストパス、HTTP メソッド、リクエストモードを定義する必要があります。この例では、リクエストモードが [パススルー] に設定されています。これは、API Gateway がクライアントリクエストを元のパラメーターのまま VPC 内のバックエンドサービスに直接転送することを意味します。

6. [バックエンドサービスの定義] セクションで、以下のパラメーターを設定し、[次へ] をクリックします。

   [パラメーター]	[例]
   [バックエンド設定]	[カスタムバックエンドサービス] を選択します
   [バックエンドサービスタイプ]	[VPC] を選択します
   [VPC 承認名]	***-microservice
   [バックエンドリクエストパス]	/
   [HTTP メソッド]	GET
   [バックエンドタイムアウト]	10000

   説明

   このステップでは、クライアントリクエストを受信した後に API Gateway がパラメーターをマッピングし、バックエンドサービスに接続する方法を定義します。この例では、バックエンドサービスタイプは [VPC] です。作成した VPC アクセス権限を選択するか、その名前を入力し、バックエンドリクエストパスを指定します。

7. [レスポンスの定義] セクションで、[作成] をクリックします。

   説明

   このステップでは、呼び出し元が API を理解できるように API ドキュメントを生成します。レスポンスの Content-Type、レスポンス例、およびエラーレスポンス例を設定できます。この例では、これらの設定は行いません。[作成] をクリックします。

8. 表示されるメッセージで、[公開] をクリックします。

9. 「API 公開」ダイアログボックスで、[環境] を [リリース] に設定し、[備考] フィールドに説明を入力して、[公開] をクリックします。

   説明

   API を変更した後は、変更を有効にするために環境に公開する必要があります。API Gateway は、リリース、プレ、テストの 3 つの組み込み環境を提供します。

アプリケーションの作成と API の権限付与

アプリケーションは、API を呼び出すために使用される ID です。この例では、API の作成時に認証方法が「Alibaba Cloud App」に設定されています。API を公開した後、アプリケーションを作成し、API を呼び出す権限を付与する必要があります。

セキュリティグループでの API Gateway エグレス IP アドレスの許可

ECS インスタンスのセキュリティグループにトラフィックを制限するインバウンドルールがある場合、API Gateway のエグレス IP アドレスをセキュリティグループの許可リストに追加する必要があります。この操作により、セキュリティグループが API Gateway からのリクエストをブロックするのを防ぎます。必要なエグレス IP アドレスは、API グループをホストするインスタンスに属しています。

1. API Gateway コンソールにログインします。 左側のナビゲーションペインで、[API 管理] > [グループ管理] を選択し、対象の API グループの名前をクリックします。

2. [グループの詳細] ページで、グループの [インスタンスタイプ] を確認します。

3. 左側のナビゲーションペインで、[インスタンスとクラスター] をクリックします。インスタンスタイプをクリックし、対応するインスタンスを見つけ、[Egress IP アドレス]情報を表示します。

   [エグレス IP アドレス] には、[パブリックエグレス IP アドレス] と [内部 VPC アドレス] が含まれます。

4. ECS コンソールにログインします。左側のナビゲーションペインで、[インスタンス & イメージ] > [インスタンス] を選択します。ECS インスタンスの ID をクリックします。[セキュリティグループ] タブに移動し、セキュリティグループ名をクリックします。[セキュリティグループの詳細] ページで、[インバウンド] > [ルールのクイック追加] を選択し、ゲートウェイのアウトバウンド IP アドレスを設定します。

   [ルールのクイック追加] ダイアログボックスで、[権限ポリシー] を [許可] に設定します。[権限オブジェクト] フィールドにゲートウェイのエグレス IP アドレスを入力します。[ポート範囲] に [すべて (1/65535)] を選択し、[OK] をクリックします。

API のデバッグ

API を設定した後、この機能を使用して、クライアントから呼び出す前に期待どおりに動作することを確認します。

1. API Gateway コンソールにログインします。 左側のナビゲーションペインで、[API 呼び出し] > [デバッグ] を選択します。

2. 「デバッグ」ページで、作成した nginx-test API を選択します。「認証方法」には [AppCode を使用] を選択します。次に、[リクエストの送信] をクリックします。

   呼び出しが成功すると、レスポンスステータスコードは 200 になり、レスポンスボディには Welcome to nginx! などのテキストを含む、デフォルトの Nginx ウェルカムページが HTML 形式で返されます。

   デバッグに失敗した場合は、次のトピックをご参照ください。

   • FAQ の概要

   • エラーコード

API の呼び出し

詳細については、「クライアントからの API の呼び出し」をご参照ください。