APIへのサブスクライバ・アクセスを管理するための使用計画の定義

API Gatewayを使用してAPIへのサブスクライバ・アクセスを管理するための使用計画を定義する方法をご紹介します。

APIゲートウェイを作成し、1つ以上のAPIをデプロイした後、APIプラン・マネージャは通常、次のことを行います。

• APIにアクセスするAPIコンシューマおよびAPIクライアントの監視および管理
• 顧客ごとに異なるアクセス層を設定します。

APIプラン・マネージャとして、使用プランおよびサブスクライバを作成することで、APIアクセスをモニターおよび管理できます。「使用プランおよび権限、サブスクライバおよびクライアント・トークン」を参照してください。

特定の顧客のニーズに合せて調整されたレート制限および割当て制限に従ってAPIアクセスを行うことができ、様々な顧客に対して異なるアクセス層を設定できます。たとえば、APIに3層のアクセスを提供するとします。1つのGold層で、1時間当たり最大1000件のリクエストを許可し、Silver層で1時間当たり最大500件のリクエストを許可し、Bronze層で1時間当たり最大100件のリクエストを許可します。また、1人の顧客による頻繁な使用が他の顧客に影響を与えないように、顧客ごとに1秒当たり10リクエストの一般レート制限を適用することもできます。

APIへのアクセスを管理するための使用プランおよびサブスクライバを設定するには、次を実行する必要があります:

• 使用計画に含めるのに適格なAPIデプロイメントにします。

  APIデプロイメントを使用プランに含めることができるようにするには、リクエストで渡されるクライアント・トークンの場所を指定する必要があります。APIデプロイメントが使用プランに含まれていると、APIデプロイメントにアクセスするには、サブスクライブされたAPIクライアントからのリクエストにこの場所にクライアント・トークンを含める必要があります。クライアント・トークンの場所は、APIデプロイメント仕様のすべてのルートのグローバル使用プラン・リクエスト・ポリシーで指定します。「使用計画に含めるためのAPIデプロイメントの適格化」を参照してください。

• APIデプロイメントをターゲットとして指定する資格を持つ使用プランを作成します。

  APIデプロイメントを包含に適格にすると、APIデプロイメントをターゲットとして指定し、オプションでレート制限と割当てを指定する権限を含む使用プラン定義を作成できます。特定の期間内のリクエスト数がリクエスト割当て制限を超える場合は、リクエストが引き続き許可されるか拒否されるかを指定できます。割当て制限を超えているためにリクエストが拒否された場合、レスポンス・ヘッダーはリクエストが再試行されるタイミングを示します。「使用計画の作成」を参照してください。

• 使用プランを指定するサブスクライバ定義を作成します。

  使用プランを作成したら、顧客(APIコンシューマ)とそのAPIクライアントに対して1つ以上のサブスクライバ定義を作成できます。サブスクライバ定義には、APIクライアントを一意に識別するためのクライアント名とクライアント・トークンが含まれ、APIへのアクセス権を付与する使用プランを指定します。「サブスクライバの作成」を参照してください。

使用プランを設定したら、メトリックを使用して使用パターンの把握や、レート制限と割当て制限が近づいて超えた場合にアラーム・メッセージを送信できます。APIゲートウェイ・メトリックを参照してください。