HTTP API は、HTTP プロトコルを使用して、分散システム内の内部サービスを迅速に公開できます。このトピックでは、コンソールで HTTP API を作成する方法について説明します。
ユースケース
API は、ユースケースに応じて、インスタンス内またはインスタンス外で作成できます。
インスタンス内での API 作成
-
専用リソース管理:API は、特定のインスタンス内のリソースまたは内部ロジックのみを管理します。
-
セキュリティと分離:データまたは機能に厳密な分離が必要で、インスタンス内からのみ呼び出し可能です。
-
サービス構成の簡素化:構成を特定のインスタンスに限定することで、API 管理が簡素化されます。
インスタンス外での API 作成
-
インスタンス間の共有アクセス:複数のインスタンスで 1 つの API 定義を共有します。
-
一元化された管理とモニタリング:統合された権限コントロール、ロギング、トラフィック管理。
インスタンス内に作成された API は、そのインスタンス内でのみ表示および管理できます。
インスタンス外で作成された API は、インスタンス内では編集または削除できません。外部 API リストから管理する必要があります。
コンソールでの HTTP API の作成
Cloud-native API Gateway で API を作成するには、2 つの方法があります:
外部 API
Cloud-native API Gateway コンソールにログインします。左側メニューで、[API] を選択します。上部メニューで、リージョンを選択します。
Create API をクリックし、[HTTP API] カードにある [作成] をクリックします。
インスタンス内 API
Cloud-native API Gateway コンソールにログインします。左側メニューで、インスタンス を選択します。上部メニューで、リージョンを選択します。
インスタンス ページで、対象のゲートウェイインスタンスの ID をクリックします。左側メニューで、[API] を選択します。右上隅にある Create API をクリックします。
[HTTP API] カードにある Create をクリックします。
Create REST API パネルで、パラメーターを設定し、OK をクリックします。
設定項目
説明
[API Name]
API のカスタム名です。API 名は、グローバルで一意である必要があります。
[Description]
API の説明を入力します。
[resource]
対象のリソースグループを選択します。右側の リソースグループの作成 をクリックできます。
Ingress のインポートによる HTTP API の作成
前提条件
Cloud-native API Gateway で コンテナサービス ソースを作成しておく必要があります。詳細については、「サービスソースの管理」をご参照ください。
手順
Cloud-native API Gateway で API を作成するには、2 つの方法があります:
外部 API
Cloud-native API Gateway コンソールにログインします。左側メニューで、[API] を選択します。上部メニューで、リージョンを選択します。
Create API をクリックし、[HTTP API] カードにある Import Ingress をクリックします。
インスタンス内 API
Cloud-native API Gateway コンソールにログインします。左側メニューで、インスタンス を選択します。上部メニューで、リージョンを選択します。
インスタンス ページで、対象のゲートウェイインスタンスの ID をクリックします。左側メニューで、[API] を選択します。右上隅にある Create API をクリックします。
[HTTP API] カードにある Import Ingress をクリックします。
[HTTP API] セクションで、Import Ingress をクリックします。Import Ingress ページで、Ingress パラメーターを設定し、OK をクリックします。
設定項目
説明
[API Name]
API の名前です。[説明の追加] をクリックして、ルーティングの説明を追加することもできます。
[Description]
API の説明を入力します。最大 255 文字まで入力できます。
[Instance]
Cloud-native API Gateway インスタンスを選択します。
[Source Cluster]
サービスソースは、Ingress が存在するコンテナサービスクラスターです。
[resource]
リソースグループを選択します。
[Namespace]
リッスンする名前空間を指定します。空白のままにすると、ゲートウェイはすべての名前空間の Ingress リソースをリッスンします。
IngressClass
リッスンする IngressClass を指定します。空白のままにすると、ゲートウェイはすべてのタイプの Ingress リソースをリッスンします。
Ingress ステータスの更新
この機能を有効にすると、ゲートウェイがリッスンしている Ingress のステータスエンドポイントが、ゲートウェイのエントリエンドポイントに置き換えられます。