コンテンツにスキップ
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.8.x
  • Home icon
  • Kong Gateway
  • Plugin Development
  • PDK
  • kong.client
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より前)
  • はじめに
    • Kong Gatewayの概要
    • サポート
      • バージョンサポートポリシー
      • サードパーティの依存関係
      • ブラウザサポート
      • 脆弱性パッチ適用プロセス
      • ソフトウェア部品表
    • 安定性
    • リリースノート
    • 破壊的な変更
      • Kong Gateway 3.8.x
      • Kong Gateway 3.7.x
      • Kong Gateway 3.6.x
      • Kong Gateway 3.5.x
      • Kong Gateway 3.4.x
      • 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 以前
    • キーコンセプト
      • サービス
      • ルート
      • コンシューマ
      • アップストリーム
      • プラグイン
      • コンシューマグループ
    • How Kong Works
      • ルーティングトラフィック
      • ロードバランシング
      • ヘルスチェックとサーキットブレーカ
    • 用語集
  • Kong を始めよう
    • Kong をゲットする
    • サービスとルート
    • レート制限
    • プロキシキャッシュ
    • キー認証
    • ロードバランシング
  • コングをインストールする
    • 概要
    • Kubernetes
      • 概要
      • Kong Gatewayをインストール
      • Admin API
      • Kong Manager をインストールする
    • Docker
      • docker run を使用する
      • 独自の Docker イメージをビルドする
    • Linux
      • Amazon Linux
      • Debian
      • Red Hat
      • Ubuntu
    • インストール後
      • データストアを設定
      • エンタープライズライセンスを適用
      • Kong Managerを有効にする
  • Kong in production
    • 展開のトポロジーズ
      • 概要
      • ハイブリッドモード
        • 概要
        • ハイブリッドモードでKong Gatewayをデプロイする
      • DB-lessデプロイ
      • 繁体字版
    • Running Kong
      • non-rootユーザーとしてKongを実行しています
      • 管理者 API の保護
      • systemdの使用
    • アクセスコントロール
      • コングゲートウェイを安全に開始
      • プログラムによる管理者の作成
      • RBAC を有効にする
    • ライセンス
      • 概要
      • ライセンスをダウンロード
      • エンタープライズライセンスのデプロイ
      • ライセンスAPIの使用
      • ライセンス使用状況をモニターする
    • ネットワーク
      • デフォルトのポート
      • DNSに関する考察
      • ネットワークとファイアウォール
      • CP/DP Communication through a Forward Proxy
      • PostgreSQL TLS
        • PostgreSQL TLS の設定
        • PostgreSQL TLS のトラブルシューティング
    • Kongの設定ファイル
    • 環境変数
    • KongからウェブサイトとAPIを提供する
    • モニタリング
      • 概要
      • Prometheus
      • StatsD
      • Datadog
      • ヘルスチェックプローブ
      • AIメトリクスを公開してグラフ
    • トレース
      • 概要
      • カスタム・トレース・エクスポーターの作成
      • トレースAPIリファレンス
    • リソースサイズのガイドライン
    • セキュリティアップデートプロセス
    • ブルー・グリーンの展開
    • カナリアのデプロイ
    • クラスタリングリファレンス
    • パフォーマンス
      • パフォーマンステストのベンチマーク
      • パフォーマンスのベンチマークを作成
      • Brotli圧縮によるパフォーマンスの向上
    • ロギングとデバッグ
      • ログの参照
      • ダイナミックログレベルの更新
      • ゲートウェイログをカスタマイズ
      • デバッグリクエスト
      • AIゲートウェイ分析
    • gRPCサービスの設定
    • 式ルータを使用
    • アップグレードと移行
      • 香港ゲートウェイ3.x.xをアップグレードする
      • バックアップと復元
      • アップグレードの戦略
        • デュアルクラスターのアップグレード
        • インプレイスアップグレード
        • 青緑色のアップグレード
        • ローリングアップグレード
      • 2.8 LTSから3.4 LTSにアップグレード
      • OSSからエンタープライズへ移行
      • 移行ガイドライン Cassandra から PostgreSQL
      • 新しい DNS クライアントに移行
      • 破壊的な変更
  • Kong Gateway Enterprise
    • 概要
    • シークレット管理
      • 概要
      • はじめに
      • ローテーション
      • 高度な使い方
      • バックエンドの設定
        • 概要
        • 環境変数
        • AWS シークレットマネージャー
        • Azure Key Vault
        • Google Cloud Secret Manager
        • HashiCorp Vault
      • How-To
        • AWS シークレットマネージャでデータベースを保護する
      • 参照フォーマット
    • 動的なプラグインの順序
      • 概要
      • 動的なプラグインの順序を始めましょう
    • 監査ログ
    • キーリングとデータ暗号化
    • ワークスペース
    • コンシューマグループ
    • イベントフック
    • データ プレーンレジリエンスの設定
    • 制御機の停止管理について
    • FIPS 140-2
      • 概要
      • FIPS 準拠パッケージをインストール
      • FIPS 140-2 準拠プラグイン
    • AWS IAMでKong Gateway Amazon RDSデータベースを認証する
    • 署名された香港の画像の署名を確認します
    • 署名された香港画像のビルド証明書を確認する
  • Kong AI Gateway
    • 概要
    • AI ゲートウェイを始めよう
    • LLM プロバイダー統合ガイド
      • OpenAI
      • Cohere
      • Azure
      • Anthropic
      • ミストラル
      • Llama2
    • AIプラットフォーム統合ガイド
      • Gemini
      • Amazon Bedrock
    • AIゲートウェイ分析
    • AI指標を公開・グラフ
    • AI Gateway plugins
  • Kong Manager
    • 概要
    • Kong Managerを有効にする
    • Kong Manager を始めましょう
      • サービスとルート
      • レート制限
      • プロキシキャッシュ
      • コンシューマーとの認証
      • 負荷バランス
    • 認証と承認
      • 概要
      • スーパー管理者を作成
      • ワークスペースとチーム
      • パスワードとRBACトークンをリセット
      • ベーシック認証
      • LDAP
        • LDAP の設定
        • LDAP サービス ディレクトリ マッピング
      • OIDC
        • OIDCの設定
        • OIDC 認証済みグループマッピング
        • 以前の設定から移行
      • セッション
      • RBAC
        • 概要
        • RBACを有効にする
        • ロールと権限を追加
        • ユーザーを作成
        • 管理者を作成
    • ネットワーク設定
    • ワークスペース
    • 顧客グループを作成
    • メールを送信中
    • トラブルシューティング
  • カスタムプラグインを開発
    • 概要
    • はじめに
      • はじめに
      • プラグインプロジェクトの設定
      • プラグインテストを追加
      • プラグイン設定を追加
      • 外部サービスを消費する
      • プラグインをデプロイ
    • ファイル構造
    • カスタムロジックの実装
    • プラグインの設定
    • データストアへのアクセス
    • カスタムエンティティの保存
    • カスタムエンティティをキャッシュ中
    • 管理者 API の拡張
    • テストを書く
    • 設置と配布
    • プロキシ-ワズムフィルター
      • プロキシワズムフィルタを作成
      • プロキシ-ワズムフィルタの設定
    • プラグイン開発キット
      • 概要
      • kong.client
      • kong.client.tls
      • kong.cluster
      • kong.ctx
      • kong.ip
      • kong.jwe
      • kong.log
      • kong.nginx
      • kong.node
      • kong.plugin
      • kong.request
      • kong.response
      • kong.router
      • kong.service
      • kong.service.request
      • kong.service.response
      • kong.table
      • kong.telemetry.log
      • kong.tracing
      • kong.vault
      • kong.websocket.client
      • kong.websocket.upstream
    • 他の言語でのプラグイン
      • 移動
      • Javascript
      • Python
      • コンテナでのプラグインの実行
      • 外部プラグインのパフォーマンス
  • Kong Plugins
    • 概要
    • 認証リファレンス
    • 複数の認証プラグインを許可
    • プラグインのキュー
      • 概要
      • プラグインキューイングリファレンス
  • Admin API
    • 概要
    • 宣言設定
    • Enterprise API
      • 情報ルート
      • 健康ルート
      • タグ
      • デバッグルート
      • サービス
      • ルート
      • コンシューマ
      • プラグイン
      • 証明書
      • CA 証明書
      • SNI
      • アップストリーム
      • ターゲット
      • ヴォールト
      • キー
      • チェーンをフィルター
      • ライセンス
      • ワークスペース
      • RBAC
      • 管理者
      • コンシューマグループ
      • イベントフック
      • キーリングとデータ暗号化
      • 監査ログ
      • Status API
    • オープンソースAPI
  • 参照
    • kong.conf
    • Nginx ディレクティブの注入中
    • CLI
    • キー管理
    • 表現の言語
      • 概要
      • 言語リファレンス
      • パフォーマンスの最適化
    • ライブラリのレート制限
    • WebAssembly
    • FAQ
enterprise-switcher-icon 次に切り替える: OSS
On this pageOn this page
  • kong.client.get_ip()
  • kong.client.get_forwarded_ip()
  • kong.client.get_port()
  • kong.client.get_forwarded_port()
  • kong.client.get_credential()
  • kong.client.load_consumer(consumer_id[, search_by_username])
  • kong.client.get_consumer()
  • kong.client.authenticate(consumer, credential)
  • _CLIENT.set_authenticated_consumer_groups(group)
  • _CLIENT.set_authenticated_consumer_group(group)
  • _CLIENT.get_consumer_groups()
  • _CLIENT.get_consumer_group()
  • _CLIENT.authenticate_consumer_group_by_consumer_id(consumer_id)
  • kong.client.get_protocol([allow_terminated])
旧バージョンのドキュメントを参照しています。 最新のドキュメントはこちらをご参照ください。

kong.client

クライアント情報モジュール。

特定のリクエストのコンテキストでKongに接続しているクライアントに関する情報を取得するための関数のセット。

ほかの参照リソース:nginx.org/en/docs/http/ngx_http_realip_module.html

kong.client.get_ip()

リクエストを行っているクライアントのリモートアドレスを返します。このモジュールは 常に Kongに直接接続しているクライアントのアドレスを返します。つまり、 ロードバランサーがKongの前にある場合、この関数はダウンストリームの クライアントのアドレス ではなく 、ロードバランサーのアドレスを返します。

フェーズ

  • certificate, rewrite, access, header_filter, response, body_filter, log

戻り値

  • string: リクエストを行っているクライアントのリモートIPアドレス。

使用方法

-- Given a client with IP 127.0.0.1 making connection through
-- a load balancer with IP 10.0.0.1 to Kong answering the request for
-- https://example.com:1234/v1/movies
kong.client.get_ip() -- "10.0.0.1"

kong.client.get_forwarded_ip()

リクエストを行っているクライアントのリモートアドレスを返します。kong.client.get_ip とは異なり、この関数は、ロードバランサーがKongの前にある場合に転送されたアドレスを考慮します。 この関数が転送されたアドレスを返すかどうかは、以下のKong構成パラメータに応じて決まります。

  • trusted_ips
  • real_ip_header
  • real_ip_recursive

フェーズ

  • certificate, rewrite, access, header_filter, response, body_filter, log

戻り値

  • string:転送されたアドレスを考慮して、リクエストを行っているクライアントの リモートIPアドレス。

使用方法

-- Given a client with IP 127.0.0.1 making connection through
-- a load balancer with IP 10.0.0.1 to Kong answering the request for
-- https://username:password@example.com:1234/v1/movies

kong.client.get_forwarded_ip() -- "127.0.0.1"

-- Note: This example assumes that 10.0.0.1 is one of the trusted IPs, and that
-- the load balancer adds the right headers matching with the configuration
-- of `real_ip_header`, e.g. `proxy_protocol`.

kong.client.get_port()

リクエストを行っているクライアントのリモートポートを返します。これは 常に Kongに直接接続しているクライアントのポートを返します。つまり、 ロードバランサーがKongの前にある場合、この関数はダウンストリームの クライアントのポート ではなく 、ロードバランサーのポートを返します。

フェーズ

  • certificate, rewrite, access, header_filter, response, body_filter, log

戻り値

  • number:リモートクライアントのポート。

使用方法

-- [client]:40000 <-> 80:[balancer]:30000 <-> 80:[kong]:20000 <-> 80:[service]
kong.client.get_port() -- 30000

kong.client.get_forwarded_port()

リクエストを行っているクライアントのリモートポートを返します。kong.client.get_portとは異なり、この関数は、ロードバランサーがKongの前にある場合に転送されたポートを考慮します。この関数が転送されたポートを返すかどうかは、以下のKong構成パラメータに応じて決まります。

  • trusted_ips
  • real_ip_header
  • real_ip_recursive

フェーズ

  • certificate, rewrite, access, header_filter, response, body_filter, log

戻り値

  • number: 転送されたポートを考慮したリモートクライアントポート。

使用方法

-- [client]:40000 <-> 80:[balancer]:30000 <-> 80:[kong]:20000 <-> 80:[service]
kong.client.get_forwarded_port() -- 40000

-- Note: This example assumes that [balancer] is one of the trusted IPs, and that
-- the load balancer adds the right headers matching with the configuration
-- of `real_ip_header`, e.g. `proxy_protocol`.

kong.client.get_credential()

現在認証されているコンシューマの認証情報を返します。設定されていない場合は、nilを返します。

フェーズ

  • access、header_filter、response、body_filter、log

戻り値

  • string: 認証された認証情報。

使用方法

local credential = kong.client.get_credential()
if credential then
  consumer_id = credential.consumer_id
else
  -- request not authenticated yet
end

kong.client.load_consumer(consumer_id[, search_by_username])

データストアからコンシューマを返します。IDでコンシューマを検索し、オプションで名前による2番目の検索を実行することもできます。

フェーズ

  • access、header_filter、response、body_filter、log

パラメータ

  • consumer_id (string): 検索するコンシューマ ID
  • search_by_username (boolean、 オプション ): 真実かつ、 IDでコンシューマが見つからない場合、 ユーザー名による2回目の検索が実行されます。

戻り値

  1. table|nil:コンシューマエンティティまたは nil。

  2. nil|err:成功した場合はnil、失敗した場合はエラーメッセージ。

使用方法

local consumer_id = "john_doe"
local consumer = kong.client.load_consumer(consumer_id, true)

kong.client.get_consumer()

現在認証されているコンシューマの consumer エンティティを返します。 設定されていない場合は、nil を返します。

フェーズ

  • access、header_filter、response、body_filter、log

戻り値

  • table: 認証されたコンシューマエンティティ。

使用方法

local consumer = kong.client.get_consumer()
if consumer then
  consumer_id = consumer.id
else
  -- request not authenticated yet, or a credential
  -- without a consumer (external auth)
end

kong.client.authenticate(consumer, credential)

認証されたコンシューマおよび/または認証情報、および現在のリクエストの認証済みコンシューマグループを設定します。consumerとcredentialはどちらもnilになる可能性がありますが、少なくともどちらかは存在する必要があります。それ以外の場合、この関数はエラーをスローします。

フェーズ

  • access

パラメータ

  • consumer (table|nil): 設定するコンシューマー。値が指定されない場合、既存の値はすべて削除されます。
  • credential (table|nil): 設定する認証情報。値が指定されない場合、既存の値はすべて削除されます。

使用方法

-- assuming `credential` and `consumer` have been set by some authentication code
kong.client.authenticate(consumer, credentials)

_CLIENT.set_authenticated_consumer_groups(group)

現在のリクエストに対して認証されたコンシューマグループを明示的に設定します。 group が、テーブルでも nil でもない場合にはエラーを通知します。

フェーズ

  • auth_and_later

パラメータ

  • グループ (table|nil):設定するコンシューマグループ。「いいえ」の値が指定された場合、既存の値はすべてクリアされます。この値は、各グループが idやnameのようなグループのメタデータを含むテーブル。

使用方法

-- assuming `group` is provided by some code
_CLIENT.set_authenticated_consumer_groups(group)

_CLIENT.set_authenticated_consumer_group(group)

この関数は非推奨となり、set_authenticated_consumer_groupsが優先されるようになります。 現在のリクエストに対して認証されたコンシューマグループを明示的に設定します。 groupがテーブルでもnilでもない場合は、エラーをスローします。

フェーズ

  • auth_and_later

パラメータ

  • グループ (table|nil):設定するコンシューマグループ。「いいえ」の値が指定された場合、既存の値はすべてクリアされます。この値は、 idやnameのようなグループのメタデータを含むテーブルである必要があります。

使用方法

-- assuming `group` is provided by some code
_CLIENT.set_authenticated_consumer_group(group)

_CLIENT.get_consumer_groups()

現在のリクエストの認証済みコンシューマ グループを取得します。

フェーズ

  • auth_and_later

戻り値

  • table|nil: 認証されたコンシューマグループ。現在のリクエストに対してコンシューマグループが認証されていない場合は、nilを返します。

使用方法

local groups = _CLIENT.get_consumer_groups()

_CLIENT.get_consumer_group()

この関数は非推奨となり、get_consumer_groups が優先されるようになります。現在のリクエストに対する認証済みコンシューマグループを取得します。

フェーズ

  • auth_and_later

戻り値

  • table|nil:認証されたコンシューマグループ。ない場合はnilを返します 現在のリクエストに対してコンシューマ グループが認証されました。

使用方法

local group = _CLIENT.get_consumer_group()

_CLIENT.authenticate_consumer_group_by_consumer_id(consumer_id)

指定されたコンシューマ IDに基づいて、現在のリクエストのコンシューマグループを設定します。consumer_idが文字列でもnilでもない場合は、エラーが返されます。コンシューマグループがすでに認証されている場合、グループは上書きされません。この関数は、cache_keyのサブセットを使用して、redis-SCAN のような検索を実行します。consumer_group_mappingは決定論的な動作のためにグループ名でソートされますが、これは将来のリリースで変更される可能性があります。

フェーズ

  • access

パラメータ

  • consumer_id (string|nil):コンシューマグループ向けのコンシューマID。 値が未指定の場合、現在のコンシューマグループは変更されません。

使用方法

-- assuming `consumer_id` is provided by some code
_CLIENT.authenticate_consumer_group_by_consumer_id(consumer_id)

kong.client.get_protocol([allow_terminated])

現在のルートに一致するプロトコルを返します("http"、"https"、"tcp" または "tls")。一致するルートがない場合は nil を返します。これは、リクエストが間違っている場合に起こり得ます。

フェーズ

  • access、header_filter、response、body_filter、log

パラメータ

  • allow_terminated (boolean、 任意 ): 設定すると、HTTPSのチェック時にX-Forwarded-Protoヘッダーがチェックされます。

戻り値

  1. string|nil: "http"、 "https"、 "tcp"、 "tls"、 nilのいずれかになります。

  2. nil|err:成功した場合はnil、失敗した場合はエラーメッセージ。

使用方法

kong.client.get_protocol() -- "http"
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