コンテンツにスキップ
Kong Logo | Kong Docs Logo
  • ドキュメント
    • API仕様を確認する
      View all API Specs すべてのAPI仕様を表示 View all API Specs arrow image
    • ドキュメンテーション
      API Specs
      Kong Gateway
      軽量、高速、柔軟なクラウドネイティブAPIゲートウェイ
      Kong Konnect
      SaaSのエンドツーエンド接続のための単一プラットフォーム
      Kong AI Gateway
      GenAI インフラストラクチャ向けマルチ LLM AI Gateway
      Kong Mesh
      Kuma と Envoy をベースにしたエンタープライズサービスメッシュ
      decK
      Kongの構成を宣言型で管理する上で役立ちます
      Kong Ingress Controller
      Kubernetesクラスタ内で動作し、Kongをプロキシトラフィックに設定する
      Kong Gateway Operator
      YAMLマニフェストを使用してKubernetes上のKongデプロイメントを管理する
      Insomnia
      コラボレーティブAPI開発プラットフォーム
  • Plugin Hub
    • Plugin Hubを探索する
      View all plugins すべてのプラグインを表示 View all plugins arrow image
    • 機能性 すべて表示 View all arrow image
      すべてのプラグインを表示
      AI's icon
      AI
      マルチ LLM AI Gatewayプラグインを使用してAIトラフィックを管理、保護、制御する
      認証's icon
      認証
      認証レイヤーでサービスを保護する
      セキュリティ's icon
      セキュリティ
      追加のセキュリティレイヤーでサービスを保護する
      トラフィック制御's icon
      トラフィック制御
      インバウンドおよびアウトバウンドAPIトラフィックの管理、スロットル、制限
      サーバーレス's icon
      サーバーレス
      他のプラグインと組み合わせてサーバーレス関数を呼び出します
      分析と監視's icon
      分析と監視
      APIとマイクロサービストラフィックを視覚化、検査、監視
      変革's icon
      変革
      Kongでリクエストとレスポンスをその場で変換
      ログ記録's icon
      ログ記録
      インフラストラクチャに最適なトランスポートを使用して、リクエストと応答データをログに記録します
  • サポート
  • コミュニティ
  • Kongアカデミー
デモを見る 無料トライアルを開始
Kong Gateway
3.3.x
  • Home icon
  • Kong Gateway
  • Admin API
  • Consumer Groups
  • Consumer Groups Reference
report-issue問題を報告する
  • Kong Gateway
  • Kong Konnect
  • Kong Mesh
  • Kong AI Gateway
  • Plugin Hub
  • decK
  • Kong Ingress Controller
  • Kong Gateway Operator
  • Insomnia
  • Kuma

  • ドキュメント投稿ガイドライン
  • 3.10.x (latest)
  • 3.9.x
  • 3.8.x
  • 3.7.x
  • 3.6.x
  • 3.5.x
  • 3.4.x (LTS)
  • 3.3.x
  • 2.8.x (LTS)
  • アーカイブ (2.6より前)
  • Introduction
    • Overview of Kong Gateway
    • Support
      • Version Support Policy
      • Third Party Dependencies
      • Browser Support
      • Software Bill of Materials
    • Stability
    • Release Notes
    • Breaking Changes
      • Kong Gateway 3.3.x
      • Kong Gateway 3.2.x
      • Kong Gateway 3.1.x
      • Kong Gateway 3.0.x
      • Kong Gateway 2.8.x or earlier
    • Key Concepts
      • Services
      • Routes
      • Consumers
      • Upstreams
      • Plugins
    • How Kong Works
      • Routing Traffic
      • Load Balancing
      • Health Checks and Circuit Breakers
      • Kong Performance Testing
    • Glossary
  • Get Started with Kong
    • Get Kong
    • Services and Routes
    • Rate Limiting
    • Proxy Caching
    • Key Authentication
    • Load-Balancing
  • Kong in Production
    • Deployment Topologies
      • Overview
      • Kubernetes Topologies
      • Hybrid Mode
        • Overview
        • Deploy Kong Gateway in Hybrid mode
      • DB-less Deployment
      • Traditional
    • Installation Options
      • Overview
      • Kubernetes
        • Overview
        • Install Kong Gateway
        • Configure the Admin API
        • Install Kong Manager
        • Install Developer Portal
      • Docker
        • Using docker run
        • Build your own Docker images
      • Linux
        • Amazon Linux
        • Debian
        • Red Hat
        • Ubuntu
      • Post-installation
        • Set up a data store
        • Apply Enterprise license
        • Enable Kong Manager (Enterprise)
    • Running Kong
      • Running Kong as a non-root user
      • Securing the Admin API
      • Using systemd
    • Access Control
      • Start Kong Gateway Securely
      • Programmatically Creating Admins
      • Enabling RBAC
    • Licenses
      • Overview
      • Download your License
      • Deploy Enterprise License
      • Using the License API
      • Monitor Licenses Usage
    • Networking
      • Default Ports
      • DNS Considerations
      • Network and Firewall
      • CP/DP Communication through a Forward Proxy
      • PostgreSQL TLS
        • Configure PostgreSQL TLS
        • Troubleshooting PostgreSQL TLS
    • Kong Configuration File
    • Environment Variables
    • Serving a Website and APIs from Kong
    • Monitoring
      • Overview
      • Prometheus
      • StatsD
      • Datadog
      • Health Check Probes
    • Tracing
      • Overview
      • Writing a Custom Trace Exporter
      • Tracing API Reference
    • Resource Sizing Guidelines
    • Security Update Process
    • Blue-Green Deployments
    • Canary Deployments
    • Clustering Reference
    • Logging
      • Log Reference
      • Dynamic log level updates
      • Customize Gateway Logs
    • Configure a gRPC service
    • Use the Expressions Router
    • Upgrade and Migration
      • Upgrading Kong Gateway 3.x.x
      • Backup and Restore
      • Upgrade Strategies
        • Dual-Cluster Upgrade
        • In-Place Upgrade
        • Blue-Green Upgrade
        • Rolling Upgrade
      • Upgrade from 2.8 LTS to 3.4 LTS
      • Migrate from OSS to Enterprise
      • Migration Guidelines Cassandra to PostgreSQL
      • Breaking Changes
  • Kong Gateway Enterprise
    • Overview
    • Kong Vitals
      • Overview
      • Metrics
      • Analytics with InfluxDB
      • Analytics with Prometheus
      • Estimate Analytics Storage in PostgreSQL
    • Secrets Management
      • Overview
      • Getting Started
      • Advanced Usage
      • Backends
        • Overview
        • Environment Variables
        • AWS Secrets Manager
        • Google Cloud Secret Manager
        • HashiCorp Vault
      • How-To
        • Securing the Database with AWS Secrets Manager
      • Reference Format
    • Dynamic Plugin Ordering
      • Overview
      • Get Started with Dynamic Plugin Ordering
    • Dev Portal
      • Overview
      • Enable the Dev Portal
      • Publish an OpenAPI Spec
      • Structure and File Types
      • Themes Files
      • Working with Templates
      • Using the Editor
      • Authentication and Authorization
        • Basic Auth
        • Key Auth
        • OIDC
        • Sessions
        • Adding Custom Registration Fields
        • Manage Developers
        • Developer Roles and Content Permissions
      • Application Registration
        • Authorization Provider Strategy
        • Enable Application Registration
        • Enable Key Authentication for Application Registration
        • Enable External Authentication
          • External OAuth2 Support
          • Set up Okta and Kong for External Oauth
          • Set up Azure AD and Kong for External Authentication
        • Manage Applications
      • Customize Dev Portal
        • Theme Editing
        • Migrating Templates Between Workspaces
        • Markdown Rendering Module
        • Customizing Portal Emails
        • Adding and Using JavaScript Assets
        • Single Page App in Dev Portal
        • Alternate OpenAPI Renderer
      • SMTP
      • Workspaces
      • Helpers CLI
      • Portal API Documentation
    • Audit Logging
    • Keyring and Data Encryption
    • Workspaces
    • Consumer Groups
    • Event Hooks
    • Configure Data Plane Resilience
    • About Control Plane Outage Management
    • FIPS 140-2
      • Overview
      • Install the FIPS Compliant Package
    • Authenticate your Kong Gateway Amazon RDS database with AWS IAM
  • Kong Manager
    • Overview
    • Enable Kong Manager
    • Get Started with Kong Manager
      • Services and Routes
      • Rate Limiting
      • Proxy Caching
      • Authentication with Consumers
      • Load Balancing
    • Authentication and Authorization
      • Overview
      • Create a Super Admin
      • Workspaces and Teams
      • Reset Passwords and RBAC Tokens
      • Basic Auth
      • LDAP
        • Configure LDAP
        • LDAP Service Directory Mapping
      • OIDC
        • Configure OIDC
        • OIDC Authenticated Group Mapping
      • Sessions
      • RBAC
        • Overview
        • Enable RBAC
        • Add a Role and Permissions
        • Create a User
        • Create an Admin
    • Networking Configuration
    • Workspaces
    • Create Consumer Groups
    • Sending Email
  • Develop Custom Plugins
    • Overview
    • File Structure
    • Implementing Custom Logic
    • Plugin Configuration
    • Accessing the Data Store
    • Storing Custom Entities
    • Caching Custom Entities
    • Extending the Admin API
    • Writing Tests
    • (un)Installing your Plugin
    • Plugin Development Kit
      • Overview
      • kong.client
      • kong.client.tls
      • kong.cluster
      • kong.ctx
      • kong.ip
      • kong.jwe
      • kong.log
      • kong.nginx
      • kong.node
      • kong.request
      • kong.response
      • kong.router
      • kong.service
      • kong.service.request
      • kong.service.response
      • kong.table
      • kong.tracing
      • kong.vault
      • kong.websocket.client
      • kong.websocket.upstream
    • Plugins in Other Languages
      • Go
      • Javascript
      • Python
      • Running Plugins in Containers
      • External Plugin Performance
  • Kong Plugins
    • Overview
    • Authentication Reference
    • Allow Multiple Authentication Plugins
    • Plugin Queuing
      • Overview
      • Plugin Queuing Reference
  • Admin API
    • Overview
    • Information Routes
    • Health Routes
    • Tags
    • Debug Routes
    • Services
    • Routes
    • Consumers
    • Plugins
    • Certificates
    • CA Certificates
    • SNIs
    • Upstreams
    • Targets
    • Vaults
    • Keys
    • Licenses
    • Workspaces
    • RBAC
    • Admins
    • Developers
    • Consumer Groups
    • Event Hooks
    • Keyring and Data Encryption
    • Audit Logs
    • Status API
  • Reference
    • kong.conf
    • Injecting Nginx Directives
    • CLI
    • Key Management
    • Performance Testing Framework
    • The Expressions Language
      • Overview
      • Language References
      • Performance Optimizations
    • Rate Limiting Library
    • FAQ
enterprise-switcher-icon 次に切り替える: OSS
On this pageOn this page
  • List consumer groups
    • List all consumer groups
    • List a specific consumer group
    • List all consumers in a consumer group
    • List consumer groups for a consumer
  • Create a consumer group
  • Add a consumer to a group
  • Delete a consumer group
  • Remove consumers
    • Remove a consumer from all groups
    • Remove a consumer from a consumer group
    • Remove all consumers from a consumer group
  • Configure rate limiting for a consumer group
  • Delete the configurations for a consumer group

このページは、まだ日本語ではご利用いただけません。翻訳中です。

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

Consumer Groups Reference

Use consumer groups to manage custom rate limiting configuration for subsets of consumers.

The consumer_groups endpoint works together with the Rate Limiting Advanced plugin. To use consumer groups for rate limiting, configure the plugin with the enforce_consumer_groups and consumer_groups parameters, then use the /consumer_groups endpoint to manage the groups.

Consumer groups can be tagged and filtered by tags.

For more information and examples of setting up and managing consumer groups, see the Consumer Groups examples.

List consumer groups

List all consumer groups

Endpoint

/consumer_groups

Response

HTTP/1.1 200 OK
{
    "data": [
        {
            "created_at": 1557522650,
            "id": "42b022c1-eb3c-4512-badc-1aee8c0f50b5",
            "name": "my_group",
            "tags": null
        },
        {
            "created_at": 1637706162,
            "id": "fa6881b2-f49f-4007-9475-577cd21d34f4",
            "name": "my_group2",
            "tags": null
        }
    ],
    "next": null
}

List a specific consumer group

Endpoint

/consumer_groups/{GROUP_NAME|GROUP_ID}
Attribute Description
GROUP_NAME|GROUP_ID
required
The name or UUID of the consumer group.

Response

HTTP/1.1 200 OK
{
    "consumer_group": {
        "created_at": 1638917780,
        "id": "be4bcfca-b1df-4fac-83cc-5cf6774bf48e",
        "name": "JL",
        "tags": null
    }
}

List all consumers in a consumer group

Endpoint

/consumer_groups/{GROUP_NAME|GROUP_ID}/consumers
Attribute Description
GROUP_NAME|GROUP_ID
required
The name or UUID of the consumer group.

Response

HTTP/1.1 200 OK
{
    "consumers": [
        {
            "created_at": 1638918560,
            "id": "288f2bfc-04e2-4ec3-b6f3-40408dff5417",
            "type": 0,
            "username": "BarryAllen",
            "username_lower": "barryallen"
        },
        {
            "created_at": 1638915577,
            "id": "8089a0e6-1d31-4e00-bf51-5b902899b4cb",
            "type": 0,
            "username": "DianaPrince",
            "username_lower": "dianaprince"
        }
    ]
}

List consumer groups for a consumer

View all consumer groups that a consumer is assigned to.

Endpoint

/consumers/{CONSUMER_NAME|CONSUMER_ID}/consumer_groups
Attribute Description
USERNAME|CONSUMER_ID
required
The name or UUID of the consumer.

Response

HTTP/1.1 200 OK
{
    "consumer_groups": [
        {
            "created_at": 1638918476,
            "id": "e2c3f16e-22c7-4ef4-b6e4-ab25c522b339",
            "name": "JL",
            "tags": null,
        }
    ]
}

Create a consumer group

Endpoint

/consumer_groups

Request body

Attribute Description
name
required
A unique name for the consumer group you want to create.
tags
optional
An optional set of strings associated with the consumer group for grouping and filtering.

Response

HTTP 201 Created
{
  "created_at": 1557522650,
  "id": "fa6881b2-f49f-4007-9475-577cd21d34f4",
  "name": "JL",
  "tags": ["tag1", "tag2"]
}

Endpoint

/consumer_groups/{GROUP_NAME}
Attribute Description
GROUP_NAME
required
A unique name for the consumer group you want to create.
tags
optional
An optional set of strings associated with the consumer group for grouping and filtering.

Response

HTTP 201 Created
{
  "created_at": 1557522650,
  "id": "fa6881b2-f49f-4007-9475-577cd21d34f4",
  "name": "JL",
  "tags": ["tag1", "tag2"]
}

Add a consumer to a group

Add a consumer to a specific consumer group.

If you add a consumer to multiple groups:

  • If all groups are allowed by the Rate Limiting Advanced plugin, only the first group’s settings will apply.
  • Otherwise, whichever group is specified in the Rate Limiting Advanced plugin will be active.

Consumers endpoint

/consumers/{CONSUMER_NAME|CONSUMER_ID}/consumer_groups
Attribute Description
CONSUMER_NAME|CONSUMER_ID
required
The name or UUID of the consumer.

Request body

Attribute Description
group
required
The name or ID of the group to add the consumer to.

Response

HTTP 201 Created
{
    "consumer": {
        "created_at": 1638918560,
        "custom_id": null,
        "id": "288f2bfc-04e2-4ec3-b6f3-40408dff5417",
        "tags": null,
        "type": 0,
        "username": "BarryAllen",
        "username_lower": "barryallen"
    },
    "consumer_groups": [
        {
            "created_at": 1638918476,
            "id": "e2c3f16e-22c7-4ef4-b6e4-ab25c522b339",
            "name": "JL",
            "tags": null
        }
    ]
}

Consumer groups endpoint

/consumer_groups/{GROUP_NAME|GROUP_ID}/consumers
Attribute Description
GROUP_NAME|GROUP_ID
required
The name or UUID of the consumer group.

Request body

Attribute Description
consumer
required
The name or ID of the consumer to add to this group.

Response

HTTP 201 Created
{
  "consumer_group": {
  "created_at": 1638915521,
  "id": "8a4bba3c-7f82-45f0-8121-ed4d2847c4a4",
  "name": "JL"
  },
  "consumers": [
    {
        "created_at": 1638915577,
        "id": "8089a0e6-1d31-4e00-bf51-5b902899b4cb",
        "type": 0,
        "username": "DianaPrince",
        "username_lower": "dianaprince"
    }
  ]
}

Delete a consumer group

Deleting a consumer group removes all consumers from that group. It does not delete any consumers.

Endpoint

/consumer_groups/{GROUP_NAME|GROUP_ID}
Attribute Description
GROUP_NAME|GROUP_ID
required
The name or UUID of the consumer group to delete.

Response

HTTP/1.1 204 No Content

Remove consumers

Remove a consumer from all groups

Endpoint

/consumers/{CONSUMER_NAME|CONSUMER_ID}/consumer_groups
Attribute Description
CONSUMER_NAME|CONSUMER_ID
required
The name or UUID of the consumer to remove from all groups.

Response

HTTP/1.1 204 No Content

Remove a consumer from a consumer group

Consumer endpoint

/consumers/{CONSUMER_NAME|CONSUMER_ID}/consumer_groups/{GROUP_NAME|GROUP_ID}
Attribute Description
CONSUMER_NAME|CONSUMER_ID
required
The name or UUID of the consumer to remove.
GROUP_NAME|GROUP_ID
required
The name or UUID of the consumer group to remove the consumer from.

Response

HTTP/1.1 204 No Content

Consumer groups endpoint

/consumer_groups/{GROUP_NAME|GROUP_ID}/consumers/{CONSUMER_NAME|CONSUMER_ID}
Attribute Description
GROUP_NAME|GROUP_ID
required
The name or UUID of the consumer group to remove the consumer from.
CONSUMER_NAME|CONSUMER_ID
required
The name or UUID of the consumer to remove.

Response

HTTP/1.1 204 No Content

Remove all consumers from a consumer group

/consumer_groups/{GROUP_NAME|GROUP_ID}/consumers
Attribute Description
GROUP_NAME|GROUP_ID
required
The name or UUID of the consumer group to remove all consumers from.

Response

HTTP/1.1 204 No Content

Configure rate limiting for a consumer group

Define custom rate limiting settings for a consumer group. This endpoint overrides the settings of the Rate Limiting Advanced plugin.

/consumer_groups/{GROUP_NAME|GROUP_ID}/overrides/plugins/rate-limiting-advanced
Attribute Description
GROUP_NAME|GROUP_ID
required
The name or UUID of the consumer group to configure.

Request Body

Attribute Description
config.limit
required
An array of one or more requests-per-window limits to apply. There must be a matching number of window limits and sizes specified.
config.window_size
required
An array of one or more window sizes to apply a limit to (defined in seconds). There must be a matching number of window limits and sizes specified.
config.window_type
optional
Set the time window type to either sliding (default) or fixed.
config.retry_after_jitter_max
optional
The upper bound of a jitter (random delay) in seconds to be added to the Retry-After header of denied requests (status = 429) in order to prevent all the clients from coming back at the same time. The lower bound of the jitter is 0; in this case, the Retry-After header is equal to the RateLimit-Reset header.

Response

HTTP/1.1 201 Created
{
    "config": {
        "limit": [
            10
        ],
        "retry_after_jitter_max": 0,
        "window_size": [
            10
        ],
        "window_type": "sliding"
    },
    "group": "test-group",
    "plugin": "rate-limiting-advanced"
}

Delete the configurations for a consumer group

Delete custom rate limiting settings for a consumer group.

/consumer_groups/{GROUP_NAME|GROUP_ID}/overrides/plugins/rate-limiting-advanced
Attribute Description
GROUP_NAME|GROUP_ID
required
The name or UUID of the consumer group to configure.

Response

HTTP/1.1 204 No Content
Thank you for your feedback.
Was this page useful?
情報が多すぎる場合 close cta icon
Kong Konnectを使用すると、より多くの機能とより少ないインフラストラクチャを実現できます。月額1Mリクエストが無料。
無料でお試しください
  • Kong
    APIの世界を動かす

    APIマネジメント、サービスメッシュ、イングレスコントローラーの統合プラットフォームにより、開発者の生産性、セキュリティ、パフォーマンスを大幅に向上します。

    • 製品
      • Kong Konnect
      • Kong Gateway Enterprise
      • Kong Gateway
      • Kong Mesh
      • Kong Ingress Controller
      • Kong Insomnia
      • 製品アップデート
      • 始める
    • ドキュメンテーション
      • Kong Konnectドキュメント
      • Kong Gatewayドキュメント
      • Kong Meshドキュメント
      • Kong Insomniaドキュメント
      • Kong Konnect Plugin Hub
    • オープンソース
      • Kong Gateway
      • Kuma
      • Insomnia
      • Kongコミュニティ
    • 会社概要
      • Kongについて
      • お客様
      • キャリア
      • プレス
      • イベント
      • お問い合わせ
  • 利用規約• プライバシー• 信頼とコンプライアンス
© Kong Inc. 2025