APIゲートウェイ・バック・エンドとしてのHTTPまたはHTTPS URLの追加

コンソールを使用してAPIデプロイメント仕様にHTTPまたはHTTPSバック・エンドを追加するには:

1. コンソールを使用してAPIデプロイメントを作成し、「最初から」オプションを選択して、「基本情報」ページで詳細を入力します。

   詳細は、APIデプロイメントの作成によるAPIゲートウェイへのAPIのデプロイおよびAPIゲートウェイの更新を参照してください。

2. 「認証」ページで、認証オプションを指定します。

   認証オプションの詳細は、APIデプロイメントへの認証と認可の追加を参照してください。

3. 「ルート」ページで、新しいルートを作成し、次を指定します:

   • パス: リストされたメソッドを使用したバックエンド・サービスへのAPIコールのパス。指定するルート・パスで次の点に注意してください:

     • デプロイメント・パス接頭辞に対して相対的です(APIデプロイメントの作成によるAPIゲートウェイへのAPIのデプロイを参照)
     • 先頭にスラッシュ(/)を付ける必要があります。単一のスラッシュのみも可能です
     • スラッシュは複数使用でき(連続していない場合)、スラッシュで終了できます
     • 英数字の大文字と小文字を使用できます
     • 特殊文字$ - _ . + ! * ' ( ) , % ; : @ & = を使用できます
     • パラメータおよびワイルドカードを使用できます(ルート・パスへのパス・パラメータおよびワイルドカードの追加を参照)
   • メソッド: バックエンド・サービスが受け入れた1つ以上のメソッド。たとえば、GET, PUTです。

   • 単一のバックエンドの追加または複数のバックエンドの追加: すべてのリクエストを同じバックエンドにルーティングするか、入力したコンテキスト変数およびルールに従ってリクエストを異なるバックエンドにルーティングするか。

     これらの手順では、単一のバックエンドを使用することを想定しているため、「単一のバックエンドの追加」を選択します。または、異なるバック・エンドを使用する場合は、「複数のバックエンドの追加」を選択し、コンソールを使用したAPIデプロイメント仕様への動的バック・エンド選択の追加の手順に従います。

   • バックエンド・タイプ:バックエンド・サービスのタイプ(HTTP)。

   • URL: バックエンド・サービスとして使用するURL。フォーマットは<protocol>://<host>:<port>/<path>です。説明は次のとおりです:

     • <protocol>は、httpまたはhttpsのいずれかです。
     • <host>は、バックエンド・サービスのホスト名またはホストIPアドレスです。たとえば、api.weather.govです。ホスト名を指定する場合は、APIゲートウェイのサブネットの「DHCPオプション」プロパティを使用して、実行時にホスト名をIPアドレスに解決する方法を制御します。
     • <port>はオプションで、ポート番号です。

     • <path>はオプションで、バックエンド・サービスが配置されているホストのサブディレクトリまたはファイルです。

       <path>にはパラメータを直接含めずに、コンテキスト変数を含めることができることに注意してください。コンテキスト変数を使用してパス、問合せおよびヘッダー・パラメータをパスに置換する方法を示す詳細と例は、ポリシーおよびHTTPバック・エンド定義へのコンテキスト変数の追加を参照してください。

     たとえば、"url": "https://api.weather.gov"です。

   • 接続確立タイムアウト(秒): オプションで、バックエンド・サービスとの接続確立時に許可される時間を示す浮動小数点値(秒)を指定します。最小は1.0、最大は75.0です。指定されていない場合、デフォルト値の60.0秒が使用されます。
   • リクエスト送信タイムアウト(秒): オプションで、リクエストをバックエンド・サービスに送信する際に許可される時間を示す浮動小数点値(秒)を指定します。最小は1.0、最大は300.0です。指定されていない場合、デフォルト値の10.0秒が使用されます。
   • 読取りレスポンス・タイムアウト(秒): オプションで、バックエンド・サービスからのレスポンスの読取り時に許可される時間を示す浮動小数点値(秒)。最小は1.0、最大は300.0です。指定されていない場合、デフォルト値の10.0秒が使用されます。
   • SSL検証の無効化: バックエンド・サービスとの通信時にSSL検証を無効化するかどうか。デフォルトでは、このオプションは選択されていません。

   この例では、ルートは天気サービスをHTTPバック・エンドとして定義します。

   フィールド:	入力:
   パス:	/weather
   メソッド:	GET
   バックエンド・タイプ:	HTTP
   URL:	https://api.weather.gov
   接続確立タイムアウト(秒):	45
   リクエスト送信タイムアウト(秒):	15
   読取りレスポンス・タイムアウト(秒):	15
   SSL検証の無効化:	(選択されていません)

4. (オプション)「別のルート」を選択して、追加ルートの詳細を入力します。
5. 「次」を選択して、APIデプロイメント用に入力した詳細を確認します。
6. APIデプロイメントを作成または更新するには、「作成」または「変更の保存」を選択します。
7. (オプション) コールしてAPIが正常にデプロイされていることを確認します(APIゲートウェイにデプロイされたAPIのコールを参照)。

JSONファイルのAPIデプロイメント仕様にHTTPまたはHTTPSバック・エンドを追加するには:

1. 任意のJSONエディタを使用して、次のフォーマットで新しいAPIデプロイメント仕様を作成します(APIデプロイメント仕様の作成を参照):

   {
     "requestPolicies": {},
     "routes": [
       {
         "path": "<api-route-path>",
         "methods": ["<method-list>"],
         "backend": {
           "type": "HTTP_BACKEND",
           "url": "<identifier>",
           "connectTimeoutInSeconds": <seconds>,
           "readTimeoutInSeconds": <seconds>,						
           "sendTimeoutInSeconds": <seconds>,
           "isSSLVerifyDisabled": <true|false>
         },
         "requestPolicies": {},
       }
     ]
   }

   ここでは:

   • "requestPolicies"は、APIデプロイメントの動作を制御するオプションのポリシーを指定します。APIデプロイメント仕様のすべてのルートにポリシーを適用する場合は、routesセクションの外にポリシーを配置します。特定のルートのみにポリシーを適用する場合は、ポリシーをroutesセクション内に配置します。APIデプロイメント仕様へのリクエスト・ポリシーとレスポンス・ポリシーの追加を参照してください。

   • <api-route-path>には、バックエンド・サービスに対してリストされているメソッドを使用して、APIコールのパスを指定します。指定するルート・パスで次の点に注意してください:

     • デプロイメント・パス接頭辞に対して相対的です(APIデプロイメントの作成によるAPIゲートウェイへのAPIのデプロイを参照)
     • 先頭にスラッシュ(/)を付ける必要があります。単一のスラッシュのみも可能です
     • スラッシュは複数使用でき(連続していない場合)、スラッシュで終了できます
     • 英数字の大文字と小文字を使用できます
     • 特殊文字$ - _ . + ! * ' ( ) , % ; : @ & = を使用できます
     • パラメータおよびワイルドカードを使用できます(ルート・パスへのパス・パラメータおよびワイルドカードの追加を参照)
   • <method-list>は、バックエンド・サービスによって受け入れられる1つ以上のメソッドをカンマで区切って指定します。たとえば、"GET, PUT"です。
   • "type": "HTTP_BACKEND"は、HTTPまたはHTTPS URLであるAPIゲートウェイ・バック・エンドを指定します。

   • "url: "<identifier>"は、バックエンド・サービスとして使用するURLを<protocol>://<host>:<port>/<path>のフォーマットで指定します。説明は次のとおりです:

     • <protocol>は、httpまたはhttpsのいずれかです。
     • <host>は、バックエンド・サービスのホスト名またはホストIPアドレスです。たとえば、api.weather.govです。ホスト名を指定する場合は、APIゲートウェイのサブネットの「DHCPオプション」プロパティを使用して、実行時にホスト名をIPアドレスに解決する方法を制御します。
     • <port>はオプションで、ポート番号です。

     • <path>はオプションで、バックエンド・サービスが配置されているホストのサブディレクトリまたはファイルです。

       <path>にはパラメータを直接含めずに、コンテキスト変数を含めることができることに注意してください。コンテキスト変数を使用してパス、問合せおよびヘッダー・パラメータをパスに置換する方法を示す詳細と例は、ポリシーおよびHTTPバック・エンド定義へのコンテキスト変数の追加を参照してください。

     たとえば、"url": "https://api.weather.gov"です。

   • "connectTimeoutInSeconds": <seconds>は、バックエンド・サービスとの接続確立時に許可する時間を示すオプションの浮動小数点値(秒)です。最小は0.0、最大は75.0です。指定されていない場合、デフォルト値の60.0秒が使用されます。
   • "readTimeoutInSeconds": <seconds>は、バックエンド・サービスからのレスポンス読取り時に許可する時間を示すオプションの浮動小数点値(秒)です。最小は0.0、最大は300.0です。指定されていない場合、デフォルト値の10.0秒が使用されます。
   • "sendTimeoutInSeconds": <seconds>は、リクエストをバックエンド・サービスに送信する際に許可する時間を示すオプションの浮動小数点値(秒)です。最小は0.0、最大は300.0です。指定されていない場合、デフォルト値の10.0秒が使用されます。
   • "isSSLVerifyDisabled": <true|false>は、バックエンド・サービスとの通信時にSSL検証を無効にするかどうかを示すオプションのブール値(trueまたはfalseのいずれか)です。指定されていない場合、デフォルト値のfalseが使用されます。

   たとえば、次の基本的なAPIデプロイメント仕様では、HTTPバック・エンドとして天気サービスを定義しています:

   {
     "routes": [
       {
         "path": "/weather",
         "methods": ["GET"],
         "backend": {
           "type": "HTTP_BACKEND",
           "url": "https://api.weather.gov",
           "connectTimeoutInSeconds": 45,
           "readTimeoutInSeconds": 15,						
           "sendTimeoutInSeconds": 15,
           "isSSLVerifyDisabled": false
         }
       }
     ]
   }

2. APIデプロイメント仕様を含むJSONファイルを保存します。

3. APIデプロイメント仕様は、次の方法でAPIデプロイメントを作成または更新するときに使用します:

   • JSONファイルをコンソールで「既存のAPIのアップロード」オプションで指定します
   • APIゲートウェイREST APIへのリクエストでJSONファイルを指定します

   詳細は、APIデプロイメントの作成によるAPIゲートウェイへのAPIのデプロイを参照してください。

4. (オプション) APIをコールして、APIがデプロイされていることを確認します(APIゲートウェイにデプロイされたAPIのコールを参照)。