このページは Apigee と Apigee ハイブリッドに適用されます。
Apigee Edge ドキュメントを表示する
次のコンセプトは、Apigee で独自の意味を持つ共通の概念です。
A
- API のベースパスとリソース
- API は、ベースパスと一連のリソース（リソースパス）から構成されます。API ごとに、1 つのルート URL（ベースパス）と複数のリソースパスを定義します。API は、単純に一連の URI であると考えることができます。すべての API は共通のベースパスを共有します。API を管理しやすくするため、Apigee では、この未加工の URI に表示名と説明を付加しています。
- API コンシューマ
- API プロバイダによって作成された API を使用するアプリ デベロッパーと同じです。
- API デベロッパー
- API プロバイダ組織内で API を作成するソフトウェア エンジニア。アプリ デベロッパー（API コンシューマ）はこれらの API を使用してアプリを構築します。
- API プロダクト
- API リソース（URI）の集まりに、サービスプランを組み合わせたもので、デベロッパーに 1 つのバンドルとして提供されます。また API プロダクトには、モニタリングや分析のために、ビジネスに固有のメタデータを付加することもできます。1 つ以上のリソースを API プロダクトに付加して収益化することが可能です。さらに、こうした API プロダクトを API パッケージにバンドルして収益化できます。
- API プロバイダ
- API プロバイダは、API コンシューマ（アプリ デベロッパー）が使用する API を（Apigee を使用して）ビルドします。
- API プロキシ
- 既存の API のファサードとして機能するプロキシ。デベロッパーは、既存の API を呼び出すのではなく、Apigee によって生成された新しい API を呼び出します。ファサードによって、公開インターフェースがバックエンド API から切り離され、デベロッパーがバックエンドの変更を気にする必要がなくなります。また、内部の開発チームに影響を与えることなくエッジを刷新できます。バックエンドを変更しても、中断せずに引き続き同じ API を使い続けることができます。たとえば、Apigee では、複数のインターフェースを同じ API に公開し、API のシグネチャをカスタマイズして、デベロッパーのさまざまな分野におけるニーズを同時に満たせる高度なシナリオも実現できます。
- Apigee API
- 環境、組織、API プロキシ、その他のハイブリッド サービスの構成に使用可能なエンドポイント。
- アプリ デベロッパー
- アプリ デベロッパーは作成したアプリを API プロバイダに登録します。これにより、アプリ デベロッパーは、プロバイダの API プロキシの呼び出しに必要な API キーを取得します。
- アプリ
- デベロッパーは、アプリを使用して API プロダクトのリソースにアクセスします。アプリを作成する際に、アプリに含める API プロダクトを選択します。Apigee によってキーが生成されます。各アプリには、複数の API プロダクトへのアクセスを可能にする単一のキーが付与されます。アプリでは、リソースにアクセスできるユーザーを制御できます。アプリのキーを取り消しおよび更新することにより、API プロダクトに対するアクセス権を持つユーザーを制御できます。また、リソースのバンドルに対するアクセスは、アプリ内のプロダクトに対するアクセス権の取り消しや削除によって制御できます。
B
- 残高詳細
- 前払いデベロッパーの場合、デベロッパーの口座残高。
C
- Cassandra
（Apigee Hybrid のみ）ゲートウェイで実行されているアプリケーションの構成、分散割り当てカウンタ、API キー、OAuth トークンを格納するランタイム データ リポジトリ。
これは、リソース消費の多い StatefulSet であり、Message Processor とは別のワーカーノード上に配置する必要があります。
詳細については、ランタイム プレーンについてをご覧ください。
- 一元管理インフラストラクチャ（プレーン）
- 管理プレーンをご覧ください。
- コンテナ（化）イメージ
- イメージをご覧ください。
- コントロール プレーン
- 管理プレーンをご覧ください。
D.
- デプロイ
Apigee では、API プロキシを環境にデプロイして、ネットワーク構成に応じて、一般公開または限定公開で、インターネット上のアプリケーション クライアントにアクセスできるようにします。
- デベロッパー
- デベロッパーは、Apigee ユーザーが実行できるロールを指します。Apigee には 2 種類のデベロッパーがあります。
- API プロキシ デベロッパー - API プロキシを作成してポリシーを適用します。
- アプリケーション デベロッパー - API プロキシを使用するアプリケーションを作成します。
- デベロッパー カテゴリ料金プラン
- 特定のカテゴリのすべてのデベロッパーに適用される料金プラン。そのカテゴリのすべてのデベロッパーが購入できます。
- デベロッパー料金プラン
- 特定のデベロッパーに適用される料金プラン。そのデベロッパーだけが購入できます。
E
- 環境
Apigee 環境は、API プロキシをデプロイする組織内の分離されたソフトウェア環境です。環境は、デプロイされたプロキシの需要に合わせてスケーリングできます。1 つの組織に複数の環境を作成できます。
- 環境グループ
-
環境グループは、1 つ以上のホスト名を持つ Apigee 環境のグループです。ホスト名は、環境グループ内の任意の環境にデプロイされた API プロキシの呼び出しに使用される URL の一部です。
- 明示的な制限
- カスタム制限をご覧ください。
G
- GCR
- Google Container Repository。
- GKE
- Google Kubernetes Engine。コンテナ化アプリケーションを Kubernetes にデプロイするための、Google が管理する本番対応環境です。GKE を使用すれば、独自の Kubernetes クラスタをインストール、管理、運用する必要性が完全になくなるので、Kubernetes をすぐに起動して実行できます。
I
- イメージ リポジトリ
- 共有コンテナ イメージのグループ。
- 暗黙的制限
- 収益化によって設定される制限（デベロッパーのプリペイド残高制限など）。
- Ingress / Ingress コントローラ
- クラスタ外部からのトラフィックをクラスタ内部のサービスにルーティングするコンテナ化アプリ。
K
- KMS
- Key Management Service。トラフィックの暗号化と復号用の鍵と OAuth トークンを格納、維持、提示します。Apigee KMS は、アプリ、デベロッパー、API プロダクト用の鍵を管理します。
- KVM
- Key-Value マップ。暗号化されることも、暗号化されないこともある Key-Value 文字列ペアのカスタム コレクション。詳細については、Key-Value マップの使用をご覧ください。
- Kubernetes 管理マシン
- Kubernetes クラスタに対してコマンドを実行するために使用するローカルマシン。通常、このマシンは、Kubernetes VM にアクセス可能なデスクトップ マシンです。
M
- 管理プレーン
- サービス アカウントを介してランタイム プレーンと通信する、Google がホストするセントラル サービス。
- MART
ランタイム データ用の API は、ローカル ランタイム データストア（Cassandra）とやり取りします。パブリック Apigee API がランタイム データにアクセスして管理するための API プロバイダとして機能します。
MART は Message Processor と同様のステートレス アプリケーションです。これは Kubernetes コンテナ化アプリです。
詳細については、ランタイム プレーンについてをご覧ください。
- マスターノード
- apiserver、cloud-controller-manager（CCM）、scheduler、および kube-controller-manager を含むノードを表す Kubernetes 用語。
- Message Processor
-
（Apigee ハイブリッドのみ）Message Processor は、受信リクエストを評価し、Apigee ポリシーをすべて実行して、バックエンド システムやその他のシステムを呼び出してデータを取得します。システムからのレスポンスを受信すると、Message Processor はレスポンスをフォーマット化してクライアントに返します。
MP は Kubernetes Deployment です。単一の Apigee 環境用に構成され、Synchronizer がデータを提供する共有ファイル システム内の範囲指定されたサブディレクトリを指します。
MP はリソース消費が多く、Cassandra とは別のワーカーノードに配置する必要があります。
詳細については、ランタイム プレーンについてをご覧ください。
- 収益化
- 使いやすく柔軟な API プロダクトの収益化を実現する Apigee のコンポーネント。
- 月次使用料
- その月のデベロッパーの総使用料金。設定料金、トランザクション料金、定期料金が含まれます。
- 月払い
- 購入したプランに基づいてデベロッパーが支払った定期料金。料金プランには、使用状況に関係なく毎月デベロッパーに請求される定期料金を設定できます。
N
- 名前空間
- クラスタ リソースの分割に使用される仮想クラスタ。名前空間はユーザー数の多い大規模なクラスタ向けです。ユーザーが数十人しかいない小規模なクラスタでは、名前空間はほとんど必要ありません。
O
- 締切前調整
- 発行された請求書においてまだ適用されていない調整。
- 締切前請求月
- 最終的な請求書がまだ発行されていない暦月。
- オープンソース Kubernetes
- Kubernetes の参照実装。Kubernetes をご覧ください。Apigee Hybrid ランタイムは、オープンソース Kubernetes と CNCF 対応の Kubernetes のオープンソース ベースのバージョンで動作します。
- 組織
API プロキシ、API プロダクト、API パッケージ、アプリ、デベロッパーを含む、Apigee アカウント内のすべてのエンティティのコンテナ。このドキュメントでは、「Apigee 組織」と「ハイブリッド対応組織」を同じ意味で使用しています。
Apigee または Apigee Hybrid をインストールして使用するには、Google Cloud プロジェクトにバインドされた Apigee 組織 が必要です。これは、組織を作成するときにプロビジョニングというプロセスで行います。
Apigee 組織は、Google Cloud 組織とは異なります。意味が曖昧になる可能性がある場合、このドキュメントでは組織が Apigee 組織であることを明記します。
詳細については、組織タイプをご覧ください。
P
- Pod
- Pod は、Kubernetes の基本構成要素であり、ユーザーが作成またはデプロイする Kubernetes オブジェクト モデルの最も小さい単純な単位です。Pod は、クラスタ上で実行中のプロセスを表します。
- プリペイド残高
- 前払いデベロッパーが API パッケージに対して事前に支払う金額の残高。
- 前払いデベロッパー
- API プロダクトの使用料金を前払いするデベロッパー。資金は、API プロダクトが使用されたときに、前払いデベロッパーの残高から差し引かれます。デベロッパーは、API プロダクトを購入できるだけの十分なプリペイド残高を維持する必要があります。各デベロッパーは、API プロバイダによって前払いまたは後払いステータスに割り当てられます。
- ポリシー
- API フロー内において、アトミックかつ再利用可能なロジックの単位として実行される処理ステップ。通常、ポリシーには、適切なエンドポイントへのルーティング リクエスト、メッセージの形式変換、アクセス制御の強制、追加情報を要求するためのリモート サービスの呼び出し、外部ユーザーに対するセンシティブ データのマスキング、潜在的な脅威を見つけるためのメッセージ内容の検証、一般的なレスポンスのキャッシュ処理を通じたパフォーマンス向上などが含まれます。ポリシーは、リクエスト メッセージやレスポンス メッセージの内容やコンテキストに基づき、条件に応じて実行できます。たとえば、リクエスト メッセージがスマートフォンから送信された場合に、変換ポリシーを実行してレスポンスの形式をカスタマイズできます。
- 後払いデベロッパー
- 毎月 API プロダクトの使用料金が課金されるデベロッパー。デベロッパーは、料金プランで設定された支払い条件に基づいて、API プロダクトの使用料を支払います。デベロッパーには、API プロバイダによって後払いまたは前払いのステータスが割り当てられます。
- プロキシ
- 「API プロキシ」もご覧ください。API プロキシはバックエンド サービス API をフロントエンドとする抽象化レイヤで、セキュリティ、レート制限、割り当て、分析などの付加価値機能を提供します。
- プロキシ エンドポイント プロキシ エンドポイントは、API プロキシがクライアント アプリケーションとやり取りする方法を定義します。
- API プロキシが応答する URL の一部であるベースパスを使用して、プロキシ エンドポイントを構成します。URL の形式は
https://hostname/basepath/pathsuffixesです。API プロキシを作成するをご覧ください。
R
- 料金プラン
- 収益化された API パッケージにおいて提供される API プロダクトの使用に関する、料金、その他費用、および収益分配率についての仕様。
- レプリケーション コントローラ
- Pod を再スケジュールして、Pod の自己回復を処理します。
- リソース、リソースパス
- RESTful コンセプトの 1 つであり、特定のリソースまでのネットワーク パスを指定する統一リソース識別子（URI）です。
- リビジョン
- API プロキシにバンドルされた構成やポリシーの番号付きのバージョン管理されたパッケージです。この用語は、バージョンとは用途が区別されます。バージョンは、デベロッパーに公開されている API インターフェースを指します。下記の「バージョン」をご覧ください。
- ランタイム プレーン
独自の Kubernetes クラスタで管理する Apigee Hybrid サービスは、ランタイム プレーン内に存在します。これらのサービスは、サービス アカウントを介して管理プレーンと通信します。
MART、Synchronizer、Message Processor、Cassandra やその他のコンポーネントが含まれます。
詳細については、ランタイム プレーンについてをご覧ください。
- ランタイム インスタンス
- Apigee は、複数のランタイム インスタンス（地理上のリージョンごとに 1 つ）を使用して構成できます。ランタイム インスタンスに 1 つ以上の環境を接続できるため、リージョン間で API プロキシの高可用性を実現できます。
- サービス
ランタイム プレーン内の Kubernetes クラスタ上で実行されているコンテナ化アプリの総称です。MART、Synchronizer、Message Processors、Cassandra などがあります。
詳細については、ランタイム プレーンについてをご覧ください。
- ステートフル ノード
- 状態を維持するために永続ストレージを必要とするクラスタノード。専用ノードプールの構成をご覧ください。
- ステートレス ノード
- 永続ストレージを必要としないクラスタノード。専用ノードプールの構成をご覧ください。
- Synchronizer
各環境のデプロイ構成とイベントの管理プレーンをポーリングするランタイム プレーン サービス。デプロイされたプロキシやプロキシ構成ファイルなどの必要なメタデータをランタイム プレーンにダウンロードします。
Synchronizer は、Message Processor が読み取る共有ファイル システムに、自身の情報を保存します。これは DaemonSet アプリケーションとして実行されます。ランタイム API トラフィックはなく、単一のプロセス / Kubernetes Pod から複数の環境のデータを同期できます。
詳細については、ランタイム プレーンについてをご覧ください。
- ターゲット エンドポイント
ターゲット エンドポイントは、API プロキシがバックエンド サービスとやり取りする方法を定義します。セキュリティ設定、HTTP または HTTPS プロトコル、その他の接続情報など、リクエストが適切なバックエンド サービスに転送されるように、ターゲット ポイントを構成します。ターゲット エンドポイントの変更をご覧ください。
- チャージ
- 前払いデベロッパーがプリペイド残高に資金を追加する行為。
- transaction_success_def" id="transaction_success_def">transaction success
- 収益化変数（使用された場合）は、API トランザクションが収益化されているかどうかを示します。この変数を使用すると、HTTP ステータス コードに基づくデフォルトの動作をオーバーライドできます。 収益化の変数をご覧ください。
- UAP
統合分析プラットフォーム。受信したアナリティクス、デバッグ、デプロイのステータス データを処理し、Apigee Hybrid UI または Apigee API 経由でユーザーが利用できるようにする、管理プレーン内の Apigee サービス。
詳細については、デバッグ、分析、デプロイのステータス データの収集をご覧ください。
- UDCA
Universal Data Collection Agent は、ランタイム プレーンのデータ収集 Pod 内で実行されるサービスです。UDCA は分析、トレース、デプロイのステータス データを抽出して UAP に送信します。
詳細については、デバッグ、分析、デプロイのステータス データの収集をご覧ください。