API Gateway ポータルを使用する - Amazon API Gateway
ポータルを使用するポータルのトラブルシューティング

API Gateway ポータルを使用する

ポータルを公開すると、ウェブで利用できるようになります。ポータルを使用するには、[ポータルのデフォルトのドメイン名] または [ドメイン名] をコピーし、ブラウザに入力します。ポータルがドメイン名を使用している場合、デフォルトのドメイン名を使用してポータルにアクセスすることはできません。

ポータルを使用する

次の手順は、ポータルにアクセスして製品 REST エンドポイントの [試してみる] を使用する方法を示しています。

ポータルを使用するには

  1. https://console.aws.amazon.com/apigateway で API Gateway コンソールにサインインします。

  2. メインナビゲーションペインで、[ポータル] を選択します。

  3. ポータルを選択します。

  4. [ポータルのデフォルトのドメイン名] または [ドメイン名] をコピーし、ブラウザに入力します。

  5. ポータルホームページでは、ポータル製品を検索し、製品ページを検出できます。ポータルの上部にある検索を使用して、ポータル内のすべてのコンテンツを検索します。[製品] 下にある検索バーを使用して、ポータル製品を検索します。

  6. ポータル製品を選択します。

  7. 製品 REST エンドポイントを選択します。

  8. [試してみる] ウィンドウで、API の呼び出しを試すパラメータを入力します。

  9. [試してみる] を選択します。API Gateway は API を呼び出し、ウィンドウに結果を表示します。

ポータルのトラブルシューティング

次に、ポータルを使用するときに発生する可能性のあるエラーや問題に関するトラブルシューティングのアドバイスを示します。

The portal webpage site can’t be reached

ポータルウェブページサイトにアクセスできないというエラーメッセージが表示された場合は、ポータルが公開されていることを確認してください。ドメイン名を使用した場合は、カスタムドメインの CloudFront ディストリビューションにトラフィックを誘導するために、API Gateway によって提供されたエイリアスレコードを追加したことを確認してください。

Try it failed

製品 REST エンドポイントで [試してみる] を使用することができない場合は、[試してみる] の状態が ACTIVE であることを確認します。さらに、API を呼び出すための正しいパラメータを必ず入力してください。

Pages are not appearing in your portal

製品 REST エンドポイントページまたは製品ページを作成したものの、ポータルに表示されない場合は、ページがドラフトでないことを確認してください。これを確認するには、次の操作を行います。

ページがドラフトでないことを確認するには

  1. https://console.aws.amazon.com/apigateway で API Gateway コンソールにサインインします。

  2. メインナビゲーションペインで、[ポータル製品] を選択します。

  3. ポータル製品を選択します。

  4. [ドキュメント] タブで、ページが [ドラフトドキュメントページ] または [ドラフト API リファレンスページ] セクションではなく、[カスタムドキュメントページ] または [API リファレンスページ] にあることを確認します。