APIアクセスポリシー
アクセスポリシーは、クライアントがAPIを使用する方法を制御します。
これにより、単一のクライアントによるAPIの過剰利用を防ぎ、APIユーザーコミュニティのパフォーマンス低下を招く可能性を抑えます。 アクセスポリシーは任意ですが、アクセスポリシーを作成してクライアントに関連付けない場合、そのクライアントにはAPI利用状況の制限が適用されません。
各アクセスポリシーには、2種類の制限があります:
| ポリシー種別 | 説明 |
|---|---|
| レート制限ポリシー | 短時間(1分など)内に実行できるAPIコール数を制限します。 |
| リクエスト制限ポリシー | 長期間(30日など)内に実行できるAPIコール数を制限します。 |
プラットフォーム > API platform > ポリシーに移動して、既存のアクセスポリシーを表示し、新しいアクセスポリシーを作成します。
新しいアクセスポリシーの作成
新しいアクセスポリシーを作成するには、次の手順を実行します:
プラットフォーム > API platform > ポリシーに移動します。
+ 新規ポリシーをクリックします。 新規ポリシーの作成ダイアログが表示されます。
新しいポリシーを作成
ポリシーの一意の名前を入力します。
レート制限の時間間隔を選択します。
レート制限の間隔内でプロファイルごとに許可されるリクエスト数を指定します。
利用状況クォータの時間間隔を選択します。
利用状況クォータ内でプロファイルごとに許可されるリクエスト数を指定します。
ポリシーの作成をクリックします。 新しいポリシーがポリシーページに表示されます。
ポリシーを作成したら、アクセスプロファイルに関連付けます。 クライアントを作成できます。また、クライアントが存在する場合は、アクセスプロファイルを作成できます。
ポリシーの利用状況の管理
APIアクセスポリシーがレート制限または利用状況クォータを超過すると、サーバーは429エラーを返します。 クライアントのトラブルシューティングに役立つように、APIアクセスポリシーに関連付けられたリクエストのレスポンスには追加の詳細が含まれます:
| ヘッダー | 説明 |
|---|---|
retry-after | レート制限または利用状況の許容量に基づいて、次に有効なリクエストのタイムスタンプを示します。 |
Last updated: