旧バージョンのドキュメントを参照しています。 最新のドキュメントはこちらをご参照ください。

コンシューマ

コンシューマとは何ですか?

コンシューマーは通常、 Kong Gatewayによって管理される API を消費または使用するエンティティを指します。コンシューマは、アプリケーション、サービス、またはAPIとやり取りするユーザーです。彼らは必ずしも人間ではないため、 Kong Gatewayは、サービスを「消費する」存在として彼らをコンシューマと呼びます。 Kong Gatewayを使用すると、コンシューマを定義および管理し、アクセス制御ポリシーを適用し、APIの使用状況を監視できます。

APIへのアクセスを制御し、使用状況を追跡し、セキュリティを確保するには、コンシューマが不可欠です。 これらは、Key Authentication、OAuth、またはその他の認証および承認メカニズムによって識別されます。たとえば、サービスまたはルートにBasic Authプラグインを追加すると、コンシューマを識別したり、認証情報が無効な場合はアクセスをブロックしたりできるようになります。

Kong Gatewayと既存のプライマリデータストア間の一貫性を保つには、Kong Gatewayをコンシューマのプライマリデータストアとして使用するか、 既存のデータベースにコンシューマリストをマップすることができます。

プラグインをコンシューマに直接添付することで、レート制限など、コンシューマレベルで特定の制御を管理できます。

 
flowchart LR

A(Consumer entity)
B(Auth plugin)
C[Upstream service]

Client --> A
subgraph id1[Kong Gateway]
direction LR
A--Credentials-->B
end

B-->C
  

コンシューマ向けのユースケース

以下は、コンシューマの一般的なユースケースの例です。

コンシューマの管理

curl -i -X POST http://localhost:8001/consumers/ \
  --data username=example-consumer \
  --data custom_id=example-consumer-id \
  --data tags[]=silver-tier

curl -X POST https://{us|eu}.api.konghq.com/v2/control-planes/{controlPlaneId}/core-entities/consumers \
  --data '{
    "custom_id":"example-consumer-id",
    "tags":["silver-tier"],
    "username":"example-consumer"
    }'

_format_version: "3.0"
consumers:
- custom_id: example-consumer-id
  username: example-consumer
  tags:
    - silver-tier

apiVersion: configuration.konghq.com/v1
kind: KongConsumer
metadata:
 name: example-consumer
 annotations:
   kubernetes.io/ingress.class: kong
username: example-consumer

次の手順

コンシューマごとに認証情報が必要です。各認証方式に固有の手順については、認証プラグインを参照してください。プラグインを開き、 Using this plugin > Basic examples に移動し、目的のツールを選択して指示に従います。

よくある質問

関連リンク

• 認証に関する参考資料
• コンシューマAPIリファレンス - Kong Gateway
• コンシューマAPIリファレンス - Konnect
• コンシューマグループAPI参照
• コンシューマ側で有効化できるプラグイン