すべてのプロダクト
Search

このプロダクト

    API Gateway:EventBridge

    ドキュメントセンター

    API Gateway:EventBridge

    最終更新日:Jan 22, 2025

    このトピックでは、API GatewayのバックエンドサービスとしてEventBridgeを使用してAPIを作成および公開する方法について説明します。 このトピックでは、Alibaba Cloudアプリの認証方法と認証にアプリケーションのAppCodeを使用してAPIを呼び出す方法についても説明します。

    概要

    EventBridgeをバックエンドサービスとしてAPIを作成して公開するには、次の手順を順番に実行する必要があります。

    • バックエンドサービスの作成

    • APIグループの作成

    • APIの作成

    • アプリケーションを作成し、アプリケーションにAPIを呼び出す権限を付与する

    • APIのデバッグDebug the API

    • APIの呼び出し

    前提条件

    EventBridgeサービスが有効になり、カスタムイベントバスが作成されます。 詳細については、「カスタムイベントバスの管理」をご参照ください。

    手順1: バックエンドサービスの作成

    1. API Gatewayコンソールにログインします。 左側のナビゲーションウィンドウで、[APIの管理] > [バックエンドサービス] を選択します。

    2. ページの右上隅にある [バックエンドサービスの作成] をクリックします。 表示されるダイアログボックスで、バックエンドサービスの名前を入力し、[タイプ] を [EventBridge] に設定し、[確認] をクリックします。

    3. [バックエンドサービス] ページで、作成したバックエンドサービスを見つけ、[操作] 列の [バックエンドサービスの設定] を選択します。

    4. [本番環境] タブをクリックし、[基本情報] セクションの右上隅にある [作成] をクリックして、本番環境でバックエンドサービスを設定します。 APIを本番環境に公開する前に、本番環境でバックエンドサービスを設定する必要があります。

    5. [バックエンドサービスの定義] ページで、EventBridgeコンソールで作成したイベントバスを選択します。

    説明

    選択したイベントバスとAPI Gatewayインスタンスが同じリージョンにある場合、内部ネットワークを使用してAPIを呼び出すと、API Gatewayはイベントバスにイベントをプッシュします。 この例では、イベントバスとAPI Gatewayインスタンスの両方が中国 (杭州) リージョンにあります。 パラメーターを設定したら、[公開] をクリックします。

    手順2: APIグループの作成

    1. APIはAPIグループで管理されます。 APIを作成する前に、APIグループを作成する必要があります。

    API Gatewayコンソールの左側のナビゲーションウィンドウで、[APIの管理] > [APIグループ] を選択します。 ページの右上隅にある [グループの作成] をクリックします。 表示されるダイアログボックスで、インスタンスを選択し、グループ名を入力し、ベースパスを設定します。 APIグループは、使用するイベントバスと同じリージョンに存在する必要があります。

    APIグループを作成すると、[APIグループ] ページにAPIグループが表示されます。 グループ名をクリックすると、[グループの詳細] ページに移動できます。 このページでは、ドメイン名のバインド、基本情報の変更、インスタンスタイプの変更を行うことができます。

    API Gatewayは、パブリック第2レベルドメイン名をAPIグループに自動的に割り当てます。 このドメイン名は、デバッグとテストのみを目的としています。 このドメイン名を使用してAPI呼び出しを行う場合、中国本土以外のリージョンでは1日あたり100回の呼び出しを行い、中国本土のリージョンでは1日あたり1,000回の呼び出しを行うことができます。 APIグループを作成した後、独立したドメイン名をバインドすることを推奨します。 この例では、デフォルトの第2レベルドメイン名が使用されます。

    ステップ3: APIの作成

    API Gatewayコンソールの左側のナビゲーションウィンドウで、[APIの管理]-[API] を選択します。 ページの右上隅にある [APIの作成] をクリックします。

    1. APIの基本情報を設定します。

    この手順では、作成するAPIの基本情報 (APIが属するAPIグループ、APIの名前、認証方法、種類、説明など) を設定します。 この例では、Groupパラメーターは作成されたAPIグループに設定され、AppCode AuthenticationパラメーターはEnable AppCode Authentication (Header & Query) に設定されています。 必要に応じてその他のパラメーターを設定し、[次へ] をクリックします。

    1. APIのリクエスト情報を設定します。

    このステップでは、ブラウザ、モバイルアプリ、ビジネスシステムなどのクライアントがAPIのリクエストを送信する方法を定義します。 この手順で指定する必要があるパラメーターには、リクエストタイプ、プロトコル、リクエストパス、HTTPメソッド、リクエストモード、および [リクエストパラメーター] セクションのパラメーターが含まれます。 次に、[次へ] をクリックします。 この例では、Request Modeパラメーターはパススルーに設定されています。 このオプションは、API GatewayがAPIリクエストを処理せずにEventBridgeに直接渡すことを示します。

    1. APIのバックエンドサービス情報を設定します。

    このステップでは、API Gatewayがクライアントから受信したリクエストを送信するバックエンドサービスのタイプとURL、およびパラメーターのマッピングと処理方法を設定します。 この例では、[設定モード] に [既存のバックエンドサービスを使用] が選択され、[バックエンドサービスタイプ] に [EventBridge] が選択され、[バックエンドサービス] ドロップダウンリストから作成したバックエンドサービスが選択されます。 次へをクリックします。

    説明

    バックエンドサービスとしてEventBridgeを使用してAPIを作成する場合にのみ、既存のバックエンドサービスを選択できます。 バックエンドサービスはカスタマイズできません。

    1. APIの応答を定義します。

    このステップでは、レスポンス情報を設定してAPIドキュメントを生成します。 ドキュメントは、API呼び出し元がAPIをよりよく理解するのに役立ちます。 サンプル成功応答とサンプル失敗応答を定義できます。 この例では、このステップはスキップされる。 [作成] をクリックします。

    1. APIを公開します。

    APIで実行するすべての設定は、APIを環境に公開した後にのみ有効になります。 この例では、バックエンドサービスは本番環境でのみ構成されています。 したがって、APIは本番環境にのみ公開できます。 APIを別の環境に公開する場合は、事前にその環境でバックエンドサービスを設定する必要があります。 APIの作成が成功したことを示すメッセージで、[公開] をクリックします。 次に、画面の指示に従ってAPIを本番環境に公開します。

    ステップ4: アプリケーションを作成し、アプリケーションにAPIを呼び出す権限を付与する

    アプリケーションは、APIを呼び出すために使用するIDです。 前のAPI作成手順では、セキュリティ認証パラメーターがAlibaba Cloud Appに設定されています。 APIを公開した後、アプリケーションを作成し、アプリケーションにAPIを呼び出す権限を付与する必要があります。

    1. アプリケーションを作成します。

    API Gatewayコンソールの左側のナビゲーションウィンドウで、[APIの呼び出し]-[アプリ] を選択してアプリケーションを作成します。 Alibaba Cloud Appのセキュリティ認証方式には、AppKeyとAppSecretのペアとAppCodeの2つの認証モードが用意されています。 この例では、AppCodeが使用されます。 Alibaba Cloud Appのセキュリティ認証方法の詳細については、「API権限付与」をご参照ください。

    1. アプリケーションにAPIを呼び出す権限を付与します。

    [API] ページで、作成したAPIを見つけ、[操作] 列の [権限付与] をクリックします。 Stageパラメーターを、APIを公開した環境に設定します。 この例では、StageパラメーターはProductionに設定されています。 [承認用アプリの選択] セクションの検索ボックスに、作成したアプリケーションの名前を入力します。 検索結果で、作成したアプリケーションを選択し、[操作] 列の [追加] をクリックし、[確認] をクリックします。 アプリケーションがAPIの呼び出しを許可されていることを通知するメッセージが表示されます。

    ステップ5: APIのデバッグ

    API Gatewayはオンラインデバッグをサポートしています。 クライアントでこのAPIを呼び出す前に、この機能を使用してAPIが正しく構成されているかどうかを確認することを推奨します。

    [API] ページで、作成したAPIの名前をクリックします。 APIの詳細ページで、左側のナビゲーションツリーで [デバッグAPI] をクリックします。 APIのリクエストパラメーターを定義した場合、リクエストパラメーターに異なる値を入力して、APIが期待どおりに機能するかどうかを確認できます。

    APIをデバッグするときは、アプリ名パラメーターが許可されたアプリケーションに設定されていることを確認してください。 デバッグ用の環境は、アプリケーションがAPIの呼び出しを許可されている環境である必要があります。 そうしないと、デバッグが失敗する可能性があります。 この例では、デバッグ用の環境としてProductionが選択されています。

    デバッグが成功した後、返されたイベントIDに基づいて、イベントバス内のイベントの詳細を照会できます。

    ステップ6: APIを呼び出す

    上記の手順を実行した後、APIとアプリケーションを作成し、アプリケーションにAPIの呼び出しを許可し、APIをデバッグし、APIを本番環境に公開します。 このステップでは、アプリケーションAppCodeを使用して、ビジネスシステムでAPIを呼び出すことができます。

    APIの呼び出し方法の詳細については、「簡易認証モードでのAPIの呼び出し」をご参照ください。