このページの内容は Apigee と Apigee ハイブリッドに該当します。
Apigee Edge のドキュメントを表示する
学習内容
このチュートリアルでは、次のことを学習します。
- レスポンス メッセージのヘッダーと本文の内容を確認する方法。
- エラー メッセージを確認する方法
必要なもの
このチュートリアルを始める前に、次のことを行います。
- コマンドラインから API 呼び出しを行うために、マシンに
curlがインストールされていることを確認します。 - 始める前にの手順を完了します。
- プロキシに SpikeArrest ポリシーを追加します。SpikeArrest ポリシーは、API プロキシに送信できるリクエスト数を制限するポリシーです。プロキシには少なくとも 1 つのポリシーが必要です。
メッセージ データを表示する
Apigee プロキシ エディタのデバッグビューでは、ヘッダー、変数、オブジェクトなど、API プロキシ リクエストとレスポンス フローのレスポンス時間などの詳細を表示できます。さらに、API プロキシによる処理に従ってリクエストまたはレスポンスがどのように変化するかも確認できます。デバッグビューの詳細については、デバッグの使用をご覧ください。
このページでは、デバッグビューを使用して、SpikeArrest ポリシーのレートを超えた場合の状況を確認する方法について説明します。
Cloud コンソールの UI
Debug v2（新規）
Cloud コンソール UI のデバッグビューを使用して、SpikeArrest ポリシーのレートが超過した場合の状況を確認するには:
- Cloud コンソール UI を開きます。
- プロジェクトを選択します。
- [プロキシ開発] > [API プロキシ] をクリックします。
- デバッグする API プロキシの名前をクリックします。
- [開発] タブをクリックします。
- [ポリシー] > [SpikeArrest] ポリシーをクリックします。
- 編集ペインで、[レート] を [1pm] に変更します。
- [保存] をクリックします。これにより、成功した API 呼び出しと失敗した（制限を超えている）API 呼び出しの両方を確認できるようになります。
- 更新したプロキシをデプロイします。
- [デバッグ] タブをクリックします。
- [Start Debug Session] をクリックします。
ダイアログで操作を行う場合:
- デバッグ セッションを実行する環境を選択します。
-
（省略可）[フィルタ] プルダウン リストから、作成するデバッグ セッションのすべてのトランザクションに適用するフィルタを選択します。デフォルトは
None (All transactions)で、デバッグデータ内のすべてのトランザクションが含まれます。フィルタの使用方法については、デバッグ セッションでのフィルタの使用をご覧ください。組み込みフィルタの詳細については、定義済みフィルタの使用をご覧ください。
- [開始] をクリックします。
-
[トランザクション] ペインに 1 つ以上の
200レスポンスと 1 つ以上の429レスポンスが表示されるまで、curlを使用して（またはウェブブラウザで URL を使用して）API プロキシを複数回呼び出します。
-
429トランザクションをクリックします。[トランザクション マップ] ペインに、エラーアイコンの付いた SpikeArrest ポリシーを含むフロー図が表示されます。
-
エラーアイコンをクリックします。[Error Properties] ペインが表示されます。
（前へ）ボタンと （次へ）ボタンをクリックすると、フロー内のステップ間を移動して、各ステップの詳細を確認できます。
デバッグ セッション全体を 1 つのドキュメントとしてダウンロードするには、[Download Session] をクリックします。デバッグ セッションは、終了後 24 時間で削除されるため、それ以降にデバッグ セッションを表示する場合は、事前にダウンロードしておく必要があります。
Debug v1
- API プロキシの [開発] タブで、Spike Arrest ポリシーの
<Rate>が再び 1pm になるように編集し、[保存] をクリックしてプロキシを保存します。これにより、成功した API 呼び出しと失敗した（制限を超えた）API 呼び出しの両方を確認できるようになります。 - プロキシ エディタで [デバッグ] タブをクリックします。
- [Start Debug Session] をクリックします。
- デバッグ セッションを実行する環境を選択します。
- （省略可）[フィルタ] プルダウン リストから、作成するデバッグ セッションのすべてのトランザクションに適用するフィルタを選択します。デフォルトは
None (All transactions)で、デバッグデータ内のすべてのトランザクションが含まれます。フィルタの使用方法については、デバッグ セッションでのフィルタの使用をご覧ください。組み込みフィルタの詳細については、定義済みフィルタの使用をご覧ください。
- [開始] をクリックします。
-
左側のペインに少なくとも 1 つの
200レスポンスと 1 つの429レスポンスが表示されるまで、curlを使用して（またはウェブブラウザで URL を使用して）、再度 API プロキシを複数回呼び出します。
- 左側の [トランザクション] ペインで、
429トランザクションをクリックします。これにより、右側のペインにトランザクションのガントチャートが表示されます。
Spike Arrest ポリシーの行があり、エラーアイコン付きで表示されます。
「エラー」というラベルの付いた行をクリックします。グラフの右側にエラーの詳細が表示されます。次の図に、エラーの詳細の [プロパティ] セクションを示します。
ダイアログで操作を行う場合:
ガントチャートの下にある [戻る] ボタンと [次へ] ボタンをクリックすると、フロー内のステップ間を移動して、各ステップの詳細を確認できます。
デバッグ セッション全体を 1 つのドキュメントとしてダウンロードするには、[Download Session] をクリックします。デバッグ セッションは、終了後 24 時間で削除されるため、それ以降にセッションを表示する場合は、事前にダウンロードしておく必要があります。
従来の UI
- API プロキシの [Develop] タブで、Spike Arrest ポリシーの
<Rate>が再び 1pm になるように編集し、[Save] をクリックしてプロキシを保存します。これにより、成功した API 呼び出しと失敗した（制限を超えている）API 呼び出しの両方を確認できるようになります。 - プロキシ エディタで [Debug] タブをクリックします。
- [Start a debug session] で、プロキシがデプロイされている環境を選択します。
- [Start Debug Session] をクリックします。
-
[Debug Transactions] ペインに 1 つ以上の
200レスポンスと 1 つの429レスポンスが表示されるまで、curlを使用して（またはウェブブラウザで URL を使用して）API プロキシを繰り返し呼び出します。curl -v https://YOUR_ENV_GROUP_HOSTNAME/my-proxy
ここで、
YOUR ENV_GROUP_HOSTNAMEは環境グループのホスト名です。環境グループのホスト名を探すをご覧ください。200レスポンスと429レスポンスを以下に示します。
- 左側の [Transactions] ペインで、
200トランザクションをクリックします。このデバッグの詳細が、メイン ウィンドウのトランザクション マップに読み込まれ、リクエスト / レスポンス図が表示されます。Spike Arrest アイコンはリクエスト フローにあります。 - フロー図で、レスポンス フローの右端にある丸いアイコン（下の図で示されているアイコン）をクリックします。
[Phase Details] ペインに、フローのその時点で使用可能なデータが表示されます。このペインをスクロールすると、HTTP レスポンスのヘッダーと本文の内容を確認できます。
- 次は、デバッグでエラーを調べます。
[Transactions] ペインで
429トランザクションをクリックします。メイン エディタ ウィンドウに、リクエスト内のアイテムのみを含むフロー図が表示されます。フロー図にはエラーを示す赤い感嘆符が付いた Spike Arrest アイコンも表示されます。Spike Arrest アイコンの右側にある小さなチューブ型のエラーアイコンをクリックし、[Phase Details] ペインで Spike Arrest ポリシー違反の詳細を確認します。
フロー図内の [Back] ボタンや [Next] ボタンをクリックすると、フロー内のポイント間を移動してデバッグの詳細を確認できます。
デバッグ セッション全体を 1 つのドキュメントとして表示する場合は、[Download Debug Session] をクリックしてダウンロードします。
詳細については、デバッグの使用をご覧ください。