Apigee APIM Operator for Kubernetes リソース リファレンス

このページの内容は Apigee を対象としています。Apigee ハイブリッドは対象としていません。

Apigee Edge のドキュメントを表示する。

このページでは、Apigee APIM Operator for Kubernetes でサポートされている各 Kubernetes リソースについて説明します。省略可と明記されていない限り、すべての項目は入力必須です。

APIProduct

フィールド	説明
apiVersion タイプ: string	apim.googleapis.com/v1
kind タイプ: string	APIProduct
metadata タイプ: Kubernetes meta/v1.ObjectMeta	metadata で使用可能なフィールドについては、Kubernetes API のドキュメントをご覧ください。
spec タイプ: APIProductSpec	spec は、APIProductSet の望ましい状態を定義します。

APIProductSpec

フィールド	説明
name タイプ: string	API プロダクトの名前。
approvalType タイプ: string	API プロダクトで定義された API へのアクセスのために API キーを承認する方法を指定するフラグ。manual に設定すると、コンシューマ キーが生成され、pending として返されます。この場合、API キーは明示的に承認されるまで使用できません。 auto に設定すると、コンシューマ キーが生成され、approved として返されます。このキーは直ちに使用できます。
description タイプ: string	API プロダクトの説明。
displayName タイプ: string	UI またはデベロッパー ポータルに表示される名前。API アクセスを登録するデベロッパーに表示されます。
analytics タイプ: アナリティクス	このプロダクトに関連するオペレーションのアナリティクスを収集するかどうかを定義します。
enforcementRefs タイプ: Array	API プロダクトに適用する EnforcementRef リソースの配列。
attributes タイプ: Array	一連の属性。お客様固有のメタデータで API 製品のデフォルト プロファイルを拡張するために使用できます。

EnforcementRef

フィールド	説明
name タイプ: string	ターゲット リソースの名前。
kind タイプ: string	APIMExtensionPolicy
group タイプ: string	Apigee APIM Operator の APIGroup（apim.googleapis.com）。
namespace タイプ: string	（省略可）参照先の名前空間。指定しない場合は、ローカル名前空間が推論されます。

属性

フィールド	説明
name タイプ: string	属性のキー。
value タイプ: string	属性の値。

APIOperationSet

フィールド	説明
apiVersion タイプ: string	apim.googleapis.com/v1
kind タイプ: string	APIOperationSet
metadata タイプ: Kubernetes meta/v1.ObjectMeta	metadata で使用可能なフィールドについては、Kubernetes API のドキュメントをご覧ください。
spec タイプ: APIOperationSetSpec	APIOperationSet の望ましい状態を定義します。

APIOperationSetSpec

フィールド	説明
quota タイプ: 割り当て	割り当ての定義。
restOperations タイプ: Array	RESTOperation 定義の配列。
apiProductRefs タイプ: Array	APIProductRef リソースの配列、または RESTOperation を適用する API プロダクトへの参照。

割り当て

フィールド	説明
limit タイプ: integer	指定された interval と timeUnit について、API プロダクトによってアプリごとに許可されるリクエスト メッセージの数。
interval タイプ: integer	リクエスト メッセージの数を計算する期間。
timeUnit タイプ: string	期間に定義された時間単位。有効な値には、minute、hour、day、month があります。

RESTOperation

フィールド	説明
name タイプ: string	REST オペレーションの名前。
path タイプ: string	methods と組み合わせて使用される path は、割り当てまたは API プロダクトと一致する HTTP パスです。
methods タイプ: array	path と組み合わせて使用される methods は、割り当てまたは API プロダクトと一致する該当する HTTP メソッドのリスト（タイプ: strings）です。

APIProductRef

フィールド	説明
name タイプ: string	ターゲット リソースの名前。
kind タイプ: string	APIProduct
group タイプ: string	Apigee APIM Operator の APIGroup（apim.googleapis.com）。
namespace タイプ: string	（省略可）参照先の名前空間。指定しない場合は、ローカル名前空間が推論されます。

APIMExtensionPolicy

フィールド	説明
apiVersion タイプ: string	apim.googleapis.com/v1
kind タイプ: string	APIMExtensionPolicy
metadata タイプ: Kubernetes meta/v1.ObjectMeta	metadata で使用可能なフィールドについては、Kubernetes API のドキュメントをご覧ください。
spec タイプ: APIMExtensionPolicySpec	APIMExtensionPolicy の望ましい状態を定義します。

APIMExtensionPolicySpec

フィールド	説明
apigeeEnv	（省略可）Apigee 環境。 指定しない場合は、新しい環境が作成され、使用可能なすべてのインスタンスにアタッチされます。 指定する場合は、外部グローバル ロードバランサを使用しているときに、この環境を使用可能なすべてのインスタンスにアタッチする必要があります。
failOpen タイプ: boolean	Apigee ランタイムに到達できない場合にフェイル オープンするかどうかを指定します。true に設定すると、ランタイムに到達できない場合でも、Apigee ランタイムへの呼び出しは成功とみなされます。
timeout タイプ: string	Apigee ランタイムへの呼び出しが失敗するまでのタイムアウト時間を秒単位またはミリ秒単位で指定します。例: 10s
targetRef タイプ: ExtensionServerRef	拡張機能をインストールする Google Kubernetes Engine Gateway を特定します。
location タイプ: string	APIMExtensionPolicy が適用される Google Cloud のロケーションを特定します。
supportedEvents タイプ: イベントの List	Apigee に送信される Extension Processor イベントのリストを指定します。これには次のようなものがあります。 "REQUEST_HEADERS" "RESPONSE_HEADERS" "REQUEST_BODY"（プレビュー） "RESPONSE_BODY"（プレビュー） "REQUEST_TRAILERS" "RESPONSE_TRAILERS"

ExtensionServerRef

フィールド	説明
name タイプ: string	ターゲット リソースの名前。
kind タイプ: string	ターゲット リソースの kind を指定します（例: Gateway、Service）。
group タイプ: string	Apigee APIM Operator の APIGroup（apim.googleapis.com）。
namespace タイプ: string	（省略可）参照先の名前空間。指定しない場合は、ローカル名前空間が推論されます。

ApigeeGatewayPolicy

フィールド	説明
apiVersion タイプ: string	apim.googleapis.com/v1
kind タイプ: string	ApigeeGatewayPolicy
metadata タイプ: Kubernetes meta/v1.ObjectMeta	metadata で使用可能なフィールドについては、Kubernetes API のドキュメントをご覧ください。
spec タイプ: ApigeeGatewayPolicySpec	ApigeeGatewayPolicy の望ましい状態を定義します。

ApigeeGatewayPolicySpec

フィールド	説明
ref タイプ: ExtensionServerRef	GKE Gateway に適用されるポリシーを管理するために作成された APIM テンプレートを参照します。
targetRef タイプ: ExtensionServerRef	この特定の Gateway ポリシーを適用する APIM 拡張機能ポリシーを参照します。GKE Gateway を間接的に参照します。
serviceAccount	（省略可）Apigee ProApigee プロキシで Google 認証トークンを生成するために使用されるサービス アカウントを指定します。

ApimTemplate

フィールド	説明
apiVersion タイプ: string	apim.googleapis.com/v1
kind タイプ: string	ApimTemplate
metadata タイプ: Kubernetes meta/v1.ObjectMeta	metadata で使用可能なフィールドについては、Kubernetes API のドキュメントをご覧ください。
spec タイプ: ApimTemplateSpec	ApimTemplate の望ましい状態を定義します。

ApimTemplateSpec

フィールド	説明
templates タイプ: list	リクエスト フローで実行するポリシーを指定する ApimTemplateFlow リソースのリスト。
apimTemplateRule タイプ: ExtensionServerRef	適用されたポリシーの検証に使用する APIM テンプレート ルールを指定します。

ApimTemplateFlow

フィールド	説明
policies タイプ: list ConditionalParameterReference	リクエスト フローの一部として実行されるポリシーの順序付きリストを指定する ConditionalParameterReference リソースのリスト。
condition タイプ: string	このリソースの実行条件を指定します。

ConditionalParameterReference

フィールド	説明
condition Type: string	このリソースの実行条件を指定します。

ApimTemplateRule

フィールド	説明
apiVersion タイプ: string	apim.googleapis.com/v1
kind タイプ: string	ApimTemplateRule
metadata タイプ: Kubernetes meta/v1.ObjectMeta	metadata で使用可能なフィールドについては、Kubernetes API のドキュメントをご覧ください。
spec タイプ: ApimTemplateRuleSpec	ApimTemplateRule の望ましい状態を定義します。

ApimTemplateRuleSpec

フィールド	説明
requiredList	ApimTemplate に存在する必要があるポリシーのリスト（タイプ: strings）。
denyList	ApimTemplate に存在すべきでないポリシーのリスト（タイプ: strings）。
allowList	ApimTemplate に存在する可能性があるものの必須ではないポリシーのリスト（タイプ: strings）。
override タイプ: boolean	ルールを使用する APIM テンプレートが存在する場合、APIM テンプレート ルールの更新をオーバーライドします。有効な値は true または false です。

AssignMessage（Google トークンの挿入）

フィールド	説明
apiVersion タイプ: string	apim.googleapis.com/v1
kind タイプ: string	AssignMessage
metadata タイプ: Kubernetes meta/v1.ObjectMeta	metadata で使用可能なフィールドについては、Kubernetes API のドキュメントをご覧ください。
spec タイプ: AssignMessageBean	AssignMessage ポリシーの望ましい状態を定義します。

AssignMessageBean

フィールド	説明
setActions タイプ: array	SetActionsBean オブジェクトの配列。AssignTo 要素で指定された、リクエストやレスポンスの既存のプロパティ値を置き換えます。 ヘッダーまたはパラメータが元のメッセージにすでに存在する場合、setActions は値を上書きします。 それ以外の場合、setActions は指定どおりに新しいヘッダーまたはパラメータを追加します。
AssignTo タイプ: AssignToBean	AssignMessage ポリシーで操作するメッセージを指定します。オプションには、リクエスト、レスポンス、新しいカスタム メッセージがあります。

SetActionsBean

フィールド	説明
Authentication タイプ: AuthenticationBean	Cloud Run functions や Cloud Run などの特定の Google Cloud プロダクトで実行されている Google サービスまたはカスタム サービスに対する認証済み呼び出しを行うための Google OAuth 2.0 トークンまたは OpenID Connect トークンを生成します。

AuthenticationBean

フィールド	説明
GoogleAccessToken タイプ: GoogleAccessTokenBean	Google サービスに対して認証済み呼び出しを行うための Google OAuth 2.0 トークンを生成します。
GoogleIDToken タイプ: GoogleIDTokenBean	ターゲット リクエストを認証するための OpenID Connect トークンを生成する構成。
headerName タイプ: string	デフォルトでは、認証構成が存在する場合、Apigee は署名なしトークンを生成し、ターゲット システムに送信されるメッセージの認可ヘッダーに挿入します。headerName 要素を使用すると、その署名なしトークンを保持する別のヘッダーの名前を指定できます。

GoogleAccessTokenBean

フィールド	説明
scopes タイプ: array	有効な Google API スコープを指定する strings の配列。詳細については、Google API の OAuth 2.0 スコープをご覧ください。
LifetimeInSeconds タイプ: integer	アクセス トークンの存続期間を秒単位で指定します。

GoogleIDTokenBean

フィールド	説明
Audience タイプ: AudienceBean	生成された認証トークンのオーディエンス（トークンによってアクセス権が付与される API やサービス アカウントなど）。
IncludeEmail タイプ: boolean	true に設定すると、生成された認証トークンには、サービス アカウント email と email_verified クレームが含まれます。

AudienceBean

フィールド	説明
useTargetHost タイプ: string	Audience の値が空であるか、ref 変数が有効な値に解決されない場合、かつ useTargetUrl が true である場合、ターゲットの URL（クエリ パラメータを除く）がオーディエンスとして使用されます。
useTargetUrl タイプ: boolean	デフォルトでは、useTargetUrl は false となっています。

AssignToBean

フィールド	説明
createNew タイプ: boolean	値を割り当てるときに、ポリシーによって新しいメッセージが作成されるかどうかを決定します。true に設定すると、ポリシーによって新しいメッセージが作成されます。
type タイプ: string	CreateNew が true に設定されている場合に、新しいメッセージのタイプを指定します。 有効な値は request または response です。

JavaScript

フィールド	説明
apiVersion タイプ: string	apim.googleapis.com/v1
kind タイプ: string	JavaScript
metadata タイプ: Kubernetes meta/v1.ObjectMeta	metadata で使用可能なフィールドについては、Kubernetes API のドキュメントをご覧ください。
spec タイプ: JavascriptBean	JavaScript ポリシーの望ましい状態を定義します。

JavascriptBean

フィールド	説明
mode タイプ: array	ProxyRequest または ProxyResponse を指定する strings の配列。ポリシーがリクエスト フローまたはレスポンス フローに接続されているかどうかを決定します。
source タイプ: string	インライン JavaScript コード。
timeLimit タイプ: integer	JavaScript コード実行のタイムアウトを指定します。

KVM

フィールド	説明
apiVersion タイプ: string	apim.googleapis.com/v1
kind タイプ: string	KVM
metadata タイプ: Kubernetes meta/v1.ObjectMeta	metadata で使用可能なフィールドについては、Kubernetes API のドキュメントをご覧ください。
spec タイプ: KeyValueMapOperationsBean	KVM ポリシーの望ましい状態を定義します。

KeyValueMapOperationsBean

フィールド	説明
MapName タイプ: MapName	実行時に動的に使用する KVM をポリシーが識別できるようにします。
expiryTimeInSecs タイプ: integer	指定した KVM からキャッシュに保存された値を Apigee が更新するまでの期間を秒単位で指定します。
initialEntries タイプ: list	KVM のシード値。この値は初期化時に KVM に入力されます。

OASValidation

フィールド	説明
apiVersion タイプ: string	apim.googleapis.com/v1
kind タイプ: string	OASValidation
metadata タイプ: Kubernetes meta/v1.ObjectMeta	metadata で使用可能なフィールドについては、Kubernetes API のドキュメントをご覧ください。
spec タイプ: OASValidationBean	OASValidation ポリシーの望ましい状態を定義します。

OASValidationBean

フィールド	説明
openApiSpec タイプ: string	yaml 内の検証する OpenAPI 仕様を指定します。これは複数行の yaml フラグメントであるため、「|」区切り文字を使用します。
source タイプ: string	message、request、response のいずれか。request に設定すると、クライアント アプリからの受信リクエストが評価されます。response に設定すると、ターゲット サーバーからのレスポンスが評価されます。message に設定すると、ポリシーがリクエスト フローとレスポンス フローのどちらに接続されているかに応じて、リクエストまたはレスポンスが自動的に評価されます。
options タイプ: OASValidationOptions	OASValidationOptions を参照

OASValidationOptions

フィールド	説明
validateMessageBody タイプ: boolean	ポリシーで OpenAPI 仕様のオペレーションのリクエスト本文スキーマに照らしてメッセージ本文を検証する必要があるかどうかを指定します。メッセージ本文の内容を検証する場合は true に設定します。メッセージ本文が存在するかどうかだけを検証する場合は false に設定します。
allowUnspecifiedParameters タイプ: StrictOptions	StrictOptions を参照

StrictOptions

フィールド	説明
header タイプ: boolean	OpenAPI 仕様で定義されていないヘッダー パラメータをリクエストで指定できるようにするには、このパラメータを true に設定します。それ以外の場合は、このパラメータを false に設定してポリシーの実行が失敗するようにします。
query タイプ: boolean	OpenAPI 仕様で定義されていないクエリ パラメータをリクエストで指定できるようにするには、このパラメータを true に設定します。それ以外の場合は、このパラメータを false に設定してポリシーの実行が失敗するようにします。
cookie タイプ: boolean	OpenAPI 仕様で定義されていない Cookie パラメータをリクエストで指定できるようにするには、このパラメータを true に設定します。それ以外の場合は、このパラメータを false に設定してポリシーの実行が失敗するようにします。

APIMResourceStatus

フィールド	説明
currentState タイプ: enum	リソースの現在の状態を表示します。 RUNNING = リソースを実行中 CREATING = リソースを作成中 CREATED = リソースを作成済み UPDATING = リソースを更新中 DELETING = リソースを削除中 CREATE_UPDATE_FAILED = 作成または更新オペレーションが失敗 DELETE_FAILED = 削除オペレーションが失敗
errorMessage タイプ: string	currentState フィールドのいずれかのエラー状態に関連するエラー メッセージ。
operationResult タイプ: string	リソースの作成、更新、削除に関連するいずれかの長時間実行オペレーションからのレスポンス文字列。

ServiceCallout

フィールド	説明
apiVersion タイプ: string	apim.googleapis.com/v1
kind タイプ: string	ServiceCallout
metadata タイプ: Kubernetes meta/v1.ObjectMeta	metadata で使用可能なフィールドについては、Kubernetes API のドキュメントをご覧ください。
spec タイプ: ServiceCalloutBean	ServiceCallout ポリシーの望ましい状態を定義します。

ServiceCalloutBean

フィールド	説明
httpTargetConnection タイプ: HttpTargetConnection	URL、TLS / SSL、HTTP プロパティなど、トランスポートの詳細を提供します。
request タイプ: CalloutRequest	API プロキシから他のサービスに送信されるリクエスト メッセージを格納する変数を指定します。
Response タイプ: string	外部サービスから API プロキシに返されるレスポンス メッセージを格納する変数を指定します。

HttpTargetConnection

フィールド	説明
url タイプ: string	ターゲット サービスの URL。
properties タイプ: Map of <string, string>	バックエンド サービスに対する HTTP トランスポートのプロパティ。詳細については、エンドポイント プロパティのリファレンスをご覧ください。

CalloutRequest

フィールド	説明
url タイプ: string	ターゲット サービスの URL。
properties タイプ: Map of <string, string>	バックエンド サービスに対する HTTP トランスポートのプロパティ。詳細については、エンドポイント プロパティのリファレンスをご覧ください。

SpikeArrest

フィールド	説明
apiVersion タイプ: string	apim.googleapis.com/v1
kind タイプ: string	SpikeArrest
metadata タイプ: Kubernetes meta/v1.ObjectMeta	metadata で使用可能なフィールドについては、Kubernetes API のドキュメントをご覧ください。
spec タイプ: SpikeArrestBean	SpikeArrest ポリシーの望ましい状態を定義します。

SpikeArrestBean

フィールド	説明
mode タイプ: array	ProxyRequest または ProxyResponse を指定する strings の配列。ポリシーがリクエスト フローまたはレスポンス フローに接続されているかどうかを決定します。
peakMessageRate タイプ: peakMessageRate	SpikeArrest のメッセージ レートを指定します。
useEffectiveCount タイプ: boolean	true に設定すると、SpikeArrest はリージョン内で分散され、リージョン内の Apigee Message Processor（MP）間でリクエスト数が同期されます。 false に設定すると、SpikeArrest はローカルでトークン バケット アルゴリズムを使用します。詳細については、UseEffectiveCount をご覧ください。

peakMessageRate

フィールド	説明
ref タイプ: string	rate 値を参照する変数。
value タイプ: string	参照が使用できない場合の実際の rate 値。

ResponseCache ポリシー

フィールド	説明
apiVersion タイプ: string	apim.googleapis.com/v1
kind タイプ: string	ResponseCache
metadata タイプ: Kubernetes meta/v1.ObjectMeta	metadata で使用可能なフィールドについては、Kubernetes API のドキュメントをご覧ください。
spec タイプ: APIExtensionPolicySpec	ResponseCache の望ましい状態を定義します。

ResponseCacheBean

フィールド	説明
mode タイプ: boolean	ProxyRequest または ProxyResponse を指定します。ポリシーがリクエスト フローまたはレスポンス フローに接続されているかどうかを決定します。
cacheExpiry タイプ: cacheExpiry	cacheExpiry オブジェクトを提供します。
cacheKey タイプ: cacheKey	cacheKey オブジェクトを提供します。
cacheLookupTimeOut タイプ: integer	キャッシュ ルックアップのタイムアウト時間を指定します。
cacheResourceRef タイプ: string	変数参照を使用しているキャッシュ リソース ID を指定します。
excludeErrorResponse タイプ: boolean	このポリシーでは、任意のステータス コードが設定された HTTP レスポンスをキャッシュに保存できます。つまり、2xx ステータス コードと 3xx ステータス コードを含む、成功レスポンスとエラー レスポンスの両方がキャッシュに保存されます。
skipCacheLookupCondition タイプ: string	実行時に true と評価された場合に、キャッシュ ルックアップをスキップしてキャッシュを更新するように指定する式を定義します。
skipCachePopulationCondition タイプ: string	実行時に	実行時に true と評価された場合に、キャッシュへの書き込みをスキップするように指定する式を定義します。
useAcceptHeader タイプ: boolean	true に設定すると、レスポンスの Accept ヘッダーの値をレスポンス キャッシュ エントリのキャッシュキーに追加します。
useResponseCacheHeaders タイプ: boolean	true に設定すると、キャッシュ内のレスポンスの「有効期間」（TTL）を設定する際に、HTTP レスポンス ヘッダーが考慮されます。

cacheExpiry

フィールド	説明
expiryDate タイプ: object	キャッシュ エントリの有効期限の日付を指定します。
timeOfDay タイプ: object	キャッシュ エントリの有効期限の時刻を指定します。
timeoutInSeconds タイプ: object	キャッシュ エントリが期限切れになるまでの秒数を指定します。

cacheKey

フィールド	説明
cacheKeyPrefix タイプ: string	キャッシュキーの接頭辞として使用する値を指定します。
fragments タイプ: object	キャッシュキーに含める値を指定します。この値を使用して、キャッシュに保存されたレスポンスと一致するリクエストの名前空間が作成されます。