このトピックでは、コンソールを使用して API を管理する方法について説明します。これには、API のバックエンドサービスの指定、ポリシーの追加、コンシューマー認証の構成などの手順が含まれます。
API のバックエンドサービスを指定する
インスタンス外で作成された API の場合、追加されたインターフェイスはデフォルトで関連付けられたバックエンドサービスの構成を継承しますが、バックエンドサービスを編集することはできません。
インスタンス内で作成された API の場合、追加されたインターフェイスはデフォルトで関連付けられたバックエンドサービスの構成を継承しますが、API ごとに個別に設定を構成することもできます。
Cloud-native API Gateway コンソール にログオンします。左側のナビゲーションバーで、[インスタンス] を選択し、上部のナビゲーションバーでリージョンを選択します。
[インスタンス] ページで、管理するゲートウェイインスタンスの ID をクリックします。左側のナビゲーションバーで、[API] を選択し、目的の API をクリックします。
API 操作の [操作の詳細] タブで、 の横にある [編集]バックエンド サービス をクリックします。
[バックエンドサービス] セクションで、パラメーターを構成し、[OK] をクリックします。
パラメーター
説明
構成方法
デフォルトの [構成方法] は [API から継承] です。
[操作ごとに個別に構成]: 操作はバックエンドサービスに個別に関連付けられます。操作用に構成されたバックエンドサービスは、API レベルの構成よりも優先されます。
[API から継承]: API に関連付けられたバックエンドサービスから継承します。
シナリオ
現在の操作のシナリオを選択します。
基本シナリオ: [単一サービス]、[モック]。
カナリアリリースシナリオ: [割合別 (マルチサービス)]、[コンテンツ別 (マルチサービス)]、[タグ別 (比例ベースのルーティング)]。
説明宛先サービスのトラフィックの割合の合計は 100% である必要があります。
バックエンドサービス
このゲートウェイまたは VPC の下のバックエンドサービスを関連付けます。このゲートウェイの下にバックエンドサービスがない場合は、[サービスの作成] をクリックして作成できます。
重要新しいサービスを作成する場合、サービスポート情報がすぐに表示されない場合があります。[サービス名] ドロップダウンリストを展開し、[更新] をクリックする必要があります。ポート情報の同期は非同期で実行されるため、完全なサービスポート情報がロードされて表示されるまで少し待つ必要がある場合があります。
API をデバッグする
前提条件
手順
Cloud-native API Gateway では、インスタンス外またはインスタンス内で API をデバッグできます。
インスタンス外の API
Cloud-native API Gateway コンソール にログオンします。左側のナビゲーションバーで、[API] を選択し、上部のナビゲーションバーでリージョンを選択します。
管理する API をクリックします。
インスタンス内の API
Cloud-native API Gateway コンソール にログオンします。左側のナビゲーションバーで、[インスタンス] を選択し、上部のナビゲーションバーでリージョンを選択します。
[インスタンス] ページで、ゲートウェイインスタンスの ID をクリックします。左側のナビゲーションバーで、[API] を選択し、管理する API をクリックします。
[操作] タブで、デバッグする操作を選択し、[デバッグ] をクリックします。
[デバッグ対象の操作] パネルで、パラメーターを構成し、[リクエストの送信] をクリックしてデバッグします。
API を編集する
Cloud-native API Gateway では、インスタンス外またはインスタンス内で API を編集できます。
インスタンス外の API
Cloud-native API Gateway コンソール にログオンします。左側のナビゲーションバーで、[API] を選択し、上部のナビゲーションバーでリージョンを選択します。
管理する API をクリックします。[操作] タブで、編集する操作を選択し、[編集] をクリックします。
[操作の編集] パネルで、操作の [基本情報]、[リクエスト定義]、[レスポンス定義]、[モック]、[コンシューマー認証] を変更できます。
インスタンス内の API
Cloud-native API Gateway コンソール にログオンします。左側のナビゲーションバーで、[インスタンス] を選択し、上部のナビゲーションバーでリージョンを選択します。
[インスタンス] ページで、ゲートウェイインスタンスの ID をクリックします。左側のナビゲーションバーで、[API] を選択し、管理する API をクリックします。
[操作] タブで、編集する操作を選択し、[編集] をクリックします。
[操作の編集] パネルで、操作の [基本情報]、[リクエスト定義]、[レスポンス定義]、[コンシューマー認証] を変更できます。
ストレステスト
前提条件
手順
Cloud-native API Gateway では、インスタンス外またはインスタンス内でストレステストを実行できます。
インスタンス外の API
Cloud-native API Gateway コンソール にログオンします。左側のナビゲーションバーで、[API] を選択し、上部のナビゲーションバーでリージョンを選択します。
管理する API をクリックします。
インスタンス内の API
Cloud-native API Gateway コンソール にログオンします。左側のナビゲーションバーで、[インスタンス] を選択し、上部のナビゲーションバーでリージョンを選択します。
[インスタンス] ページで、ゲートウェイインスタンスの ID をクリックします。左側のナビゲーションバーで、[API] を選択し、管理する API をクリックします。
[操作] タブで、ストレステストを開始する操作を選択し、 をクリックします。詳細については、「PTS ストレステストの概要」をご参照ください。
API を削除する
削除操作は元に戻せません。この操作を実行する際は注意してください。
Cloud-native API Gateway では、インスタンス外またはインスタンス内で API を削除できます。
インスタンス外の API
Cloud-native API Gateway コンソール にログオンします。左側のナビゲーションバーで、[API] を選択し、上部のナビゲーションバーでリージョンを選択します。
管理する API をクリックします。
インスタンス内の API
Cloud-native API Gateway コンソール にログオンします。左側のナビゲーションバーで、[インスタンス] を選択し、上部のナビゲーションバーでリージョンを選択します。
[インスタンス] ページで、ゲートウェイインスタンスの ID をクリックします。左側のナビゲーションバーで、[API] を選択し、管理する API をクリックします。
[操作] タブで、削除する操作を選択し、 をクリックし、確認ダイアログボックスで [OK] をクリックします。