このページは Apigee と Apigee ハイブリッドに適用されます。
Apigee Edge のドキュメントを表示する。
このページでは、Apigee Operator for Kubernetes でサポートされている各 Kubernetes リソースについて説明します。省略可と明記されていない限り、すべての項目は入力必須です。
APIProduct
フィールド | 説明 |
---|---|
apiVersion
タイプ: |
apim.googleapis.com/v1
|
kind
タイプ: |
APIProduct
|
metadata
|
metadata で使用可能なフィールドについては、Kubernetes API のドキュメントをご覧ください。 |
spec
タイプ: APIProductSpec |
spec は、APIProductSet の望ましい状態を定義します。 |
APIProductSpec
フィールド | 説明 |
---|---|
name
タイプ: |
API プロダクトの名前。 |
approvalType
タイプ: |
API プロダクトで定義された API へのアクセスのために API キーを承認する方法を指定するフラグ。manual に設定すると、コンシューマ キーが生成され、pending として返されます。この場合、API キーは明示的に承認されるまで使用できません。
|
description
タイプ: |
API プロダクトの説明。 |
displayName
タイプ: |
UI またはデベロッパー ポータルに表示される名前。API アクセスを登録するデベロッパーに表示されます。 |
analytics
タイプ: アナリティクス |
このプロダクトに関連するオペレーションのアナリティクスを収集するかどうかを定義します。 |
enforcementRefs
タイプ: |
API プロダクトに適用する EnforcementRef リソースの配列。 |
attributes
タイプ: |
一連の属性。お客様固有のメタデータで API 製品のデフォルト プロファイルを拡張するために使用できます。 |
EnforcementRef
フィールド | 説明 |
---|---|
name
タイプ: |
ターゲット リソースの名前。 |
kind
タイプ: |
APIMExtensionPolicy
|
group
タイプ: |
Apigee APIM Operator の APIGroup(apim.googleapis.com )。 |
namespace
タイプ: |
(省略可)参照先の名前空間。指定しない場合は、ローカル名前空間が推論されます。 |
属性
フィールド | 説明 |
---|---|
name
タイプ: |
属性のキー。 |
value
タイプ: |
属性の値。 |
APIOperationSet
フィールド | 説明 |
---|---|
apiVersion
タイプ: |
apim.googleapis.com/v1
|
kind
タイプ: |
APIOperationSet
|
metadata
|
metadata で使用可能なフィールドについては、Kubernetes API のドキュメントをご覧ください。 |
spec
タイプ: APIOperationSetSpec |
APIOperationSet の望ましい状態を定義します。 |
APIOperationSetSpec
フィールド | 説明 |
---|---|
quota
タイプ: 割り当て |
割り当ての定義。 |
restOperations
タイプ: |
RESTOperation 定義の配列。 |
apiProductRefs
タイプ: |
APIProductRef リソースの配列、または RESTOperation を適用する API プロダクトへの参照。 |
割り当て
フィールド | 説明 |
---|---|
limit
タイプ: |
指定された interval と timeUnit について、API プロダクトによってアプリごとに許可されるリクエスト メッセージの数。 |
interval
タイプ: |
リクエスト メッセージの数を計算する期間。 |
timeUnit
タイプ: |
期間に定義された時間単位。有効な値には、minute 、hour 、day 、month があります。 |
RESTOperation
フィールド | 説明 |
---|---|
name
タイプ: |
REST オペレーションの名前。 |
path
タイプ: |
methods と組み合わせて使用される path は、割り当てまたは API プロダクトと一致する HTTP パスです。 |
methods
タイプ: |
path と組み合わせて使用される methods は、割り当てまたは API プロダクトと一致する該当する HTTP メソッドのリスト(タイプ: strings )です。 |
APIProductRef
フィールド | 説明 |
---|---|
name
タイプ: |
ターゲット リソースの名前。 |
kind
タイプ: |
APIProduct
|
group
タイプ: |
Apigee APIM Operator の APIGroup(apim.googleapis.com )。
|
namespace
タイプ: |
(省略可)参照先の名前空間。指定しない場合は、ローカル名前空間が推論されます。 |
APIMExtensionPolicy
フィールド | 説明 |
---|---|
apiVersion
タイプ: |
apim.googleapis.com/v1
|
kind
タイプ: |
APIMExtensionPolicy |
metadata
|
metadata で使用可能なフィールドについては、Kubernetes API のドキュメントをご覧ください。
|
spec
|
APIMExtensionPolicy の望ましい状態を定義します。 |
APIMExtensionPolicySpec
フィールド | 説明 |
---|---|
apigeeEnv
|
(省略可)Apigee 環境。
指定しない場合は、新しい環境が作成され、使用可能なすべてのインスタンスにアタッチされます。 指定する場合は、外部グローバル ロードバランサを使用しているときに、この環境を使用可能なすべてのインスタンスにアタッチする必要があります。 |
failOpen
タイプ: |
Apigee ランタイムに到達できない場合にフェイル オープンするかどうかを指定します。true に設定すると、ランタイムに到達できない場合でも、Apigee ランタイムへの呼び出しは成功とみなされます。
|
timeout
タイプ: |
Apigee ランタイムへの呼び出しが失敗するまでのタイムアウト時間を秒単位またはミリ秒単位で指定します。例: 10s |
targetRef
タイプ: ExtensionServerRef |
拡張機能をインストールする Google Kubernetes Engine Gateway を特定します。 |
location
タイプ: |
APIMExtensionPolicy が適用される Google Cloud のロケーションを特定します。 |
supportedEvents
タイプ: イベントの |
Apigee に送信される Extension Processor イベントのリストを指定します。これには次のようなものがあります。
|
ExtensionServerRef
フィールド | 説明 |
---|---|
name
タイプ: |
ターゲット リソースの名前。 |
kind
タイプ: |
ターゲット リソースの kind を指定します(例: Gateway 、Service )。
|
group
タイプ: |
Apigee APIM Operator の APIGroup(apim.googleapis.com )。
|
namespace
タイプ: |
(省略可)参照先の名前空間。指定しない場合は、ローカル名前空間が推論されます。 |
ApigeeGatewayPolicy
フィールド | 説明 |
---|---|
apiVersion
タイプ: |
apim.googleapis.com/v1 |
kind
タイプ: |
ApigeeGatewayPolicy |
metadata
|
metadata で使用可能なフィールドについては、Kubernetes API のドキュメントをご覧ください。
|
spec
|
ApigeeGatewayPolicy の望ましい状態を定義します。 |
ApigeeGatewayPolicySpec
フィールド | 説明 |
---|---|
ref タイプ: ExtensionServerRef |
GKE Gateway に適用されるポリシーを管理するために作成された APIM テンプレートを参照します。 |
targetRef
タイプ: ExtensionServerRef |
この特定の Gateway ポリシーを適用する APIM 拡張機能ポリシーを参照します。GKE Gateway を間接的に参照します。 |
serviceAccount
|
(省略可)Apigee ProApigee プロキシで Google 認証トークンを生成するために使用されるサービス アカウントを指定します。 |
ApimTemplate
フィールド | 説明 |
---|---|
apiVersion
タイプ: |
apim.googleapis.com/v1 |
kind
タイプ: |
ApimTemplate |
metadata
|
metadata で使用可能なフィールドについては、Kubernetes API のドキュメントをご覧ください。
|
spec
タイプ: ApimTemplateSpec |
ApimTemplate の望ましい状態を定義します。 |
ApimTemplateSpec
フィールド | 説明 |
---|---|
templates
タイプ: |
リクエスト フローで実行するポリシーを指定する ApimTemplateFlow リソースのリスト。 |
apimTemplateRule
タイプ: ExtensionServerRef |
適用されたポリシーの検証に使用する APIM テンプレート ルールを指定します。 |
ApimTemplateFlow
フィールド | 説明 |
---|---|
policies
タイプ: |
リクエスト フローの一部として実行されるポリシーの順序付きリストを指定する ConditionalParameterReference リソースのリスト。 |
condition
タイプ: |
このリソースの実行条件を指定します。 |
ConditionalParameterReference
フィールド | 説明 |
---|---|
condition
|
このリソースの実行条件を指定します。 |
ApimTemplateRule
フィールド | 説明 |
---|---|
apiVersion
タイプ: |
apim.googleapis.com/v1 |
kind
タイプ: |
ApimTemplateRule |
metadata
|
metadata で使用可能なフィールドについては、Kubernetes API のドキュメントをご覧ください。
|
spec
タイプ: ApimTemplateRuleSpec |
ApimTemplateRule の望ましい状態を定義します。 |
ApimTemplateRuleSpec
フィールド | 説明 |
---|---|
requiredList
|
ApimTemplate に存在する必要があるポリシーのリスト(タイプ: strings )。
|
denyList
|
ApimTemplate に存在すべきでないポリシーのリスト(タイプ: strings )。
|
allowList
|
ApimTemplate に存在する可能性があるものの必須ではないポリシーのリスト(タイプ: strings )。
|
override
タイプ: |
ルールを使用する APIM テンプレートが存在する場合、APIM テンプレート ルールの更新をオーバーライドします。有効な値は true または false です。 |
AssignMessage(Google トークンの挿入)
フィールド | 説明 |
---|---|
apiVersion
タイプ: |
apim.googleapis.com/v1 |
kind
タイプ: |
AssignMessage |
metadata
|
metadata で使用可能なフィールドについては、Kubernetes API のドキュメントをご覧ください。
|
spec
タイプ: AssignMessageBean |
AssignMessage ポリシーの望ましい状態を定義します。 |
AssignMessageBean
フィールド | 説明 |
---|---|
setActions
タイプ: |
SetActionsBean オブジェクトの配列。AssignTo 要素で指定された、リクエストやレスポンスの既存のプロパティ値を置き換えます。ヘッダーまたはパラメータが元のメッセージにすでに存在する場合、 |
AssignTo
タイプ: AssignToBean |
AssignMessage ポリシーで操作するメッセージを指定します。オプションには、リクエスト、レスポンス、新しいカスタム メッセージがあります。 |
SetActionsBean
フィールド | 説明 |
---|---|
Authentication
タイプ: AuthenticationBean |
Cloud Run functions や Cloud Run などの特定の Google Cloud プロダクトで実行されている Google サービスまたはカスタム サービスに対する認証済み呼び出しを行うための Google OAuth 2.0 トークンまたは OpenID Connect トークンを生成します。 |
AuthenticationBean
フィールド | 説明 |
---|---|
GoogleAccessToken
|
Google サービスに対して認証済み呼び出しを行うための Google OAuth 2.0 トークンを生成します。 |
GoogleIDToken
タイプ: GoogleIDTokenBean |
ターゲット リクエストを認証するための OpenID Connect トークンを生成する構成。 |
headerName
タイプ: |
デフォルトでは、認証構成が存在する場合、Apigee は署名なしトークンを生成し、ターゲット システムに送信されるメッセージの認可ヘッダーに挿入します。headerName 要素を使用すると、その署名なしトークンを保持する別のヘッダーの名前を指定できます。 |
GoogleAccessTokenBean
フィールド | 説明 |
---|---|
scopes
タイプ: |
有効な Google API スコープを指定する strings の配列。詳細については、Google API の OAuth 2.0 スコープをご覧ください。
|
LifetimeInSeconds
タイプ: |
アクセス トークンの存続期間を秒単位で指定します。 |
GoogleIDTokenBean
フィールド | 説明 |
---|---|
Audience
タイプ: AudienceBean |
生成された認証トークンのオーディエンス(トークンによってアクセス権が付与される API やサービス アカウントなど)。 |
IncludeEmail
タイプ: |
true に設定すると、生成された認証トークンには、サービス アカウント email と email_verified クレームが含まれます。
|
AudienceBean
フィールド | 説明 |
---|---|
useTargetHost
タイプ: |
Audience の値が空であるか、ref 変数が有効な値に解決されない場合、かつ useTargetUrl が true である場合、ターゲットの URL(クエリ パラメータを除く)がオーディエンスとして使用されます。
|
useTargetUrl
タイプ: |
デフォルトでは、useTargetUrl は false となっています。
|
AssignToBean
フィールド | 説明 |
---|---|
createNew
タイプ: |
値を割り当てるときに、ポリシーによって新しいメッセージが作成されるかどうかを決定します。true に設定すると、ポリシーによって新しいメッセージが作成されます。
|
type
タイプ: |
CreateNew が true に設定されている場合に、新しいメッセージのタイプを指定します。
有効な値は request または response です。
|
JavaScript
フィールド | 説明 |
---|---|
apiVersion
タイプ: |
apim.googleapis.com/v1 |
kind
タイプ: |
JavaScript |
metadata
|
metadata で使用可能なフィールドについては、Kubernetes API のドキュメントをご覧ください。
|
spec
タイプ: JavascriptBean |
JavaScript ポリシーの望ましい状態を定義します。 |
JavascriptBean
フィールド | 説明 |
---|---|
mode
タイプ: |
ProxyRequest または ProxyResponse を指定する strings の配列。ポリシーがリクエスト フローまたはレスポンス フローに接続されているかどうかを決定します。 |
source
タイプ: |
インライン JavaScript コード。 |
timeLimit
タイプ: |
JavaScript コード実行のタイムアウトを指定します。 |
KVM
フィールド | 説明 |
---|---|
apiVersion
タイプ: |
apim.googleapis.com/v1 |
kind
タイプ: |
KVM |
metadata
|
metadata で使用可能なフィールドについては、Kubernetes API のドキュメントをご覧ください。
|
spec
|
KVM ポリシーの望ましい状態を定義します。 |
KeyValueMapOperationsBean
フィールド | 説明 |
---|---|
MapName
タイプ: |
実行時に動的に使用する KVM をポリシーが識別できるようにします。詳細については、MapName 要素をご覧ください。 |
expiryTimeInSecs
タイプ: |
指定した KVM からキャッシュに保存された値を Apigee が更新するまでの期間を秒単位で指定します。詳細については、ExpiryTimeInSecs 要素をご覧ください。 |
initialEntries
タイプ: |
KVM のシード値。この値は初期化時に KVM に入力されます。詳しくは、InitialEntries 要素をご覧ください。 |
delete
タイプ: |
指定された Key-Value ペアを KVM から削除します。詳細については、Delete 要素を削除するをご覧ください。 |
get
タイプ: |
キーの値を KVM から取得します。詳細については、Get 要素をご覧ください。 |
OASValidation
フィールド | 説明 |
---|---|
apiVersion
タイプ: |
apim.googleapis.com/v1 |
kind
タイプ: |
OASValidation |
metadata
|
metadata で使用可能なフィールドについては、Kubernetes API のドキュメントをご覧ください。
|
spec
タイプ: OASValidationBean |
OASValidation ポリシーの望ましい状態を定義します。 |
status
タイプ: ApimResourceStatus |
OASValidation ポリシーのステータスを表示します。 |
OASValidationBean
フィールド | 説明 |
---|---|
openApiSpec
タイプ: |
yaml 内の検証する OpenAPI 仕様を指定します。これは複数行の yaml フラグメントであるため、「|」区切り文字を使用します。 |
source
タイプ: |
message 、request 、response のいずれか。request に設定すると、クライアント アプリからの受信リクエストが評価されます。response に設定すると、ターゲット サーバーからのレスポンスが評価されます。message に設定すると、ポリシーがリクエスト フローとレスポンス フローのどちらに接続されているかに応じて、リクエストまたはレスポンスが自動的に評価されます。 |
options
タイプ: |
OASValidationOptions を参照 |
OASValidationOptions
フィールド | 説明 |
---|---|
validateMessageBody
タイプ: |
ポリシーで OpenAPI 仕様のオペレーションのリクエスト本文スキーマに照らしてメッセージ本文を検証する必要があるかどうかを指定します。メッセージ本文の内容を検証する場合は true に設定します。メッセージ本文が存在するかどうかだけを検証する場合は false に設定します。 |
allowUnspecifiedParameters
タイプ: |
StrictOptions を参照 |
StrictOptions
フィールド | 説明 |
---|---|
header
タイプ: |
OpenAPI 仕様で定義されていないヘッダー パラメータをリクエストで指定できるようにするには、このパラメータを true に設定します。それ以外の場合は、このパラメータを false に設定してポリシーの実行が失敗するようにします。 |
query
タイプ: |
OpenAPI 仕様で定義されていないクエリ パラメータをリクエストで指定できるようにするには、このパラメータを true に設定します。それ以外の場合は、このパラメータを false に設定してポリシーの実行が失敗するようにします。 |
cookie
タイプ: |
OpenAPI 仕様で定義されていない Cookie パラメータをリクエストで指定できるようにするには、このパラメータを true に設定します。それ以外の場合は、このパラメータを false に設定してポリシーの実行が失敗するようにします。 |
ApimResourceStatus
フィールド | 説明 |
---|---|
currentState
タイプ: |
リソースの現在の状態を表示します。
|
errorMessage
タイプ: |
currentState フィールドのいずれかのエラー状態に関連するエラー メッセージ。 |
operationResult
タイプ: |
リソースの作成、更新、削除に関連するいずれかの長時間実行オペレーションからのレスポンス文字列。 |
ServiceCallout
フィールド | 説明 |
---|---|
apiVersion
タイプ: |
apim.googleapis.com/v1 |
kind
タイプ: |
ServiceCallout |
metadata
|
metadata で使用可能なフィールドについては、Kubernetes API のドキュメントをご覧ください。
|
spec
タイプ: ServiceCalloutBean |
ServiceCallout ポリシーの望ましい状態を定義します。 |
status
タイプ: ApimResourceStatus |
ServiceCallout ポリシーのステータスを表示します。 |
ServiceCalloutBean
フィールド | 説明 |
---|---|
httpTargetConnection
タイプ: |
URL、TLS / SSL、HTTP プロパティなど、トランスポートの詳細を提供します。 |
request
タイプ: CalloutRequest |
API プロキシから他のサービスに送信されるリクエスト メッセージを格納する変数を指定します。 |
Response
タイプ: |
外部サービスから API プロキシに返されるレスポンス メッセージを格納する変数を指定します。 |
HttpTargetConnection
フィールド | 説明 |
---|---|
url
タイプ: |
ターゲット サービスの URL。 |
properties
タイプ: |
バックエンド サービスに対する HTTP トランスポートのプロパティ。詳細については、エンドポイント プロパティのリファレンスをご覧ください。 |
timeout
タイプ: |
サービス コールアウトのタイムアウト(ミリ秒)。詳細については、タイムアウトをご覧ください。 |
CalloutRequest
フィールド | 説明 |
---|---|
url
タイプ: |
ターゲット サービスの URL。 |
properties
タイプ: |
バックエンド サービスに対する HTTP トランスポートのプロパティ。詳細については、エンドポイント プロパティのリファレンスをご覧ください。 |
SpikeArrest
フィールド | 説明 |
---|---|
apiVersion
タイプ: |
apim.googleapis.com/v1 |
kind
タイプ: |
SpikeArrest |
metadata
|
metadata で使用可能なフィールドについては、Kubernetes API のドキュメントをご覧ください。
|
spec
タイプ: SpikeArrestBean |
SpikeArrest ポリシーの望ましい状態を定義します。 |
SpikeArrestBean
フィールド | 説明 |
---|---|
mode
タイプ: |
ProxyRequest または ProxyResponse を指定する strings の配列。ポリシーがリクエスト フローまたはレスポンス フローに接続されているかどうかを決定します。 |
peakMessageRate
タイプ: peakMessageRate |
SpikeArrest のメッセージ レートを指定します。 |
useEffectiveCount
タイプ: |
true に設定すると、SpikeArrest はリージョン内で分散され、リージョン内の Apigee Message Processor(MP)間でリクエスト数が同期されます。
|
peakMessageRate
フィールド | 説明 |
---|---|
ref
タイプ: |
rate 値を参照する変数。
|
value
タイプ: |
参照が使用できない場合の実際の rate 値。
|
GenerateJWT
フィールド | 説明 |
---|---|
apiVersion
タイプ: |
apim.googleapis.com/v1 |
kind
タイプ: |
GenerateJWT |
metadata
|
metadata で使用可能なフィールドについては、Kubernetes API のドキュメントをご覧ください。
|
spec
タイプ: GenerateJWTBean |
GenerateJWT ポリシーの望ましい状態を定義します。 |
status
タイプ: ApimResourceStatus |
GenerateJWT ポリシーのステータスを表示します。 |
GenerateJWTBean
フィールド | 説明 |
---|---|
subject
タイプ: PropertyBean |
JWT のサブジェクトであるプリンシパルを識別します。詳しくは、Subject 要素をご覧ください。 |
issuer
タイプ: PropertyBean |
JWT を発行したプリンシパルを識別します。詳細については、Issuer 要素をご覧ください。 |
audience
タイプ: VarArrayBean |
この JWT の受け取りを想定された対象を指定します。詳しくは、Audience 要素をご覧ください。 |
id
タイプ: PropertyBean |
JWT の一意の識別子を指定します詳しくは、Id 要素をご覧ください。 |
expiresIn
タイプ: PropertyBean |
JWT の有効期限を指定します。詳細については、ExpiresIn 要素をご覧ください。 |
notBefore
タイプ: PropertyBean |
JWT の処理が許可されない時刻を指定します。詳細については、NotBefore 要素をご覧ください。 |
additionalClaims
タイプ: AdditionalClaimsBean |
JWT に含める追加のクレームを指定します。詳細については、AdditionalClaims 要素をご覧ください。 |
compress
タイプ: |
JWT ペイロードを圧縮するかどうかを指定します。詳細については、要素を圧縮するをご覧ください。 |
PropertyBean
フィールド | 説明 |
---|---|
value
タイプ: |
プロパティのリテラル値。 |
ref
タイプ: |
プロパティの値を含む変数への参照。 |
VarArrayBean
フィールド | 説明 |
---|---|
values
タイプ: |
リテラル文字列値の配列。 |
ref
タイプ: |
値の配列を含む変数への参照。 |
AdditionalClaimsBean
フィールド | 説明 |
---|---|
claims
タイプ: |
クレーム名とクレーム値のマッピング。 |
ref
タイプ: |
クレーム マップを含む変数への参照。 |
OAuthV2
フィールド | 説明 |
---|---|
apiVersion
タイプ: |
apim.googleapis.com/v1 |
kind
タイプ: |
OAuthV2 |
metadata
|
metadata で使用可能なフィールドについては、Kubernetes API のドキュメントをご覧ください。
|
spec
タイプ: OAuthV2Bean |
OAuthV2 ポリシーの望ましい状態を定義します。 |
status
タイプ: ApimResourceStatus |
OAuthV2 ポリシーのステータスを表示します。 |
OAuthV2Bean
フィールド | 説明 |
---|---|
operation
タイプ: |
実行する OAuthV2 オペレーション。指定できる値は次のとおりです。
|
configRef
タイプ: |
(省略可)再利用可能な OAuthV2 設定を含む OAuthV2Config カスタム リソース名への参照。 |
scope
タイプ: |
アクセス トークンのスコープ。詳細については、Scope 要素をご覧ください。 |
generateResponse
タイプ: GenerateResponse |
レスポンス生成を構成します。詳細については、GenerateResponse 要素をご覧ください。 |
generateErrorResponse
|
エラー レスポンスの生成を構成します。詳細については、GenerateErrorResponse 要素をご覧ください。 |
expiresIn
タイプ: PropertyExpiryBean |
アクセス トークンの有効期限。詳細については、ExpiresIn 要素をご覧ください。 |
refreshTokenExpiresIn
タイプ: PropertyExpiryBean |
更新トークンの有効期限。詳細については、RefreshTokenExpiresIn 要素をご覧ください。 |
supportedGrantTypes
タイプ: |
サポートされている付与タイプのリスト。詳細については、SupportedGrantTypes 要素をご覧ください。 |
redirectURI
タイプ: |
認証コード権限付与タイプで使用されるリダイレクト URI。詳細については、RedirectUri 要素をご覧ください。 |
responseType
タイプ: |
認証コード権限付与タイプのレスポンス タイプ。詳細については、ResponseType 要素をご覧ください。 |
clientID
タイプ: |
クライアント ID。詳しくは、ClientId 要素をご覧ください。 |
state
タイプ: |
認証コード権限付与タイプの state パラメータ。詳しくは、State 要素をご覧ください。 |
appEndUser
タイプ: |
エンドユーザー ID。詳細については、AppEndUser 要素をご覧ください。 |
code
タイプ: |
認証コード。詳細については、Code 要素をご覧ください。 |
userName
タイプ: |
パスワード権限付与タイプのユーザー名。詳細については、UserName 要素をご覧ください。 |
password
タイプ: |
パスワード権限付与タイプのパスワード。詳しくは、Password 要素をご覧ください。 |
grantType
タイプ: |
付与タイプ。詳細については、GrantType 要素をご覧ください。 |
refreshToken
タイプ: |
更新トークン。詳細については、RefreshToken 要素をご覧ください。 |
accessToken
タイプ: |
アクセス トークン。詳細については、AccessToken 要素をご覧ください。 |
cacheExpiryInSeconds
タイプ: PropertyExpiryBean |
キャッシュの有効期限(秒単位)。詳細については、キャッシュの有効期限の設定をご覧ください。 |
verifyAccessTokenPrefix
タイプ: |
(省略可)アクセス トークンを検証するときに使用する接頭辞。 |
externalAuthorization
タイプ: |
外部認証サービスを使用するかどうかを指定します。詳細については、ExternalAuthorization 要素をご覧ください。 |
reuseRefreshToken
タイプ: |
更新トークンを再利用するかどうかを指定します。詳細については、ReuseRefreshToken 要素をご覧ください。 |
rfcCompliance
タイプ: |
RFC 準拠を適用します。詳細については、RFCCompliantRequestResponse 要素をご覧ください。 |
enforceStrictCallbackURIEnforced
タイプ: |
(省略可)厳密なコールバック URI の照合を必須にします。 |
customAttributes
タイプ: CustomAttribute の |
トークンに追加するカスタム属性。詳細については、Attributes 要素をご覧ください。 |
externalAccessToken
タイプ: |
外部アクセス トークン。詳細については、ExternalAccessToken 要素をご覧ください。 |
externalRefreshToken
タイプ: |
外部更新トークン。詳細については、ExternalRefreshToken 要素をご覧ください。 |
storeToken
タイプ: |
トークンを保存するかどうかを指定します。詳細については、StoreToken 要素をご覧ください。 |
tokens
タイプ: |
無効にするトークンのリスト。詳細については、Tokens 要素をご覧ください。 |
algorithm
タイプ: |
JWT の署名に使用されるアルゴリズム。詳細については、Algorithm 要素をご覧ください。 |
secretKey
タイプ: SecretKey |
JWT の署名に使用される秘密鍵。詳細については、SecretKey 要素をご覧ください。 |
privateKey
タイプ: PrivateKey |
JWT の署名に使用される秘密鍵。詳細については、PrivateKey 要素をご覧ください。 |
publicKey
タイプ: PublicKey |
JWT の検証に使用される公開鍵。詳しくは、PublicKey 要素をご覧ください。 |
GenerateResponse
フィールド | 説明 |
---|---|
enabled
タイプ: |
true に設定する場合、または属性を省略した場合、ポリシーはレスポンスを生成して返します。 |
format
タイプ: |
XML 、FORM_PARAM のいずれか 1 つ。 |
GenerateErrorResponse
フィールド | 説明 |
---|---|
enabled
タイプ: |
true に設定する場合、または属性を省略した場合、ポリシーはレスポンスを生成して返します。 |
format
タイプ: |
XML 、FORM_PARAM のいずれか 1 つ。 |
realm
タイプ: PropertyBean |
WWW-Authenticate ヘッダーで返すレルム。 |
PropertyExpiryBean
フィールド | 説明 |
---|---|
value
タイプ: |
有効期限のリテラル値。 |
ref
タイプ: |
有効期限の値を含む変数への参照。 |
CustomAttribute
フィールド | 説明 |
---|---|
name
タイプ: |
カスタム属性の名前。 |
ref
タイプ: |
属性値を含む変数への参照。 |
value
タイプ: |
属性のリテラル値。 |
SecretKey
フィールド | 説明 |
---|---|
value
タイプ: PropertyBean |
JWT の署名に使用する秘密鍵を指定します。詳細については、SecretKey 要素をご覧ください。 |
PrivateKey
フィールド | 説明 |
---|---|
value
タイプ: PropertyBean |
JWT の署名に使用する秘密鍵を指定します。詳細については、PrivateKey 要素をご覧ください。 |
PublicKey
フィールド | 説明 |
---|---|
value
タイプ: PropertyBean |
JWT の検証に使用する公開鍵を指定します。詳しくは、PublicKey 要素をご覧ください。 |
ResponseCache ポリシー
フィールド | 説明 |
---|---|
apiVersion
タイプ: |
apim.googleapis.com/v1 |
kind
タイプ: |
ResponseCache |
metadata
|
metadata で使用可能なフィールドについては、Kubernetes API のドキュメントをご覧ください。
|
spec
|
ResponseCache の望ましい状態を定義します。 |
ResponseCacheBean
フィールド | 説明 |
---|---|
mode
タイプ: |
ProxyRequest または ProxyResponse を指定します。ポリシーがリクエスト フローまたはレスポンス フローに接続されているかどうかを決定します。 |
cacheExpiry
タイプ: cacheExpiry |
cacheExpiry オブジェクトを提供します。 |
cacheKey
タイプ: cacheKey |
cacheKey オブジェクトを提供します。 |
cacheLookupTimeOut
タイプ: |
キャッシュ ルックアップのタイムアウト時間を指定します。 |
cacheResourceRef
タイプ: |
変数参照を使用しているキャッシュ リソース ID を指定します。 |
excludeErrorResponse
タイプ: |
このポリシーでは、任意のステータス コードが設定された HTTP レスポンスをキャッシュに保存できます。つまり、2xx ステータス コードと 3xx ステータス コードを含む、成功レスポンスとエラー レスポンスの両方がキャッシュに保存されます。 |
skipCacheLookupCondition
タイプ: |
実行時に true と評価された場合に、キャッシュ ルックアップをスキップしてキャッシュを更新するように指定する式を定義します。 |
skipCachePopulationCondition
タイプ: |
実行時に true と評価された場合に、キャッシュへの書き込みをスキップするように指定する式を定義します。 |
useAcceptHeader
タイプ: |
true に設定すると、レスポンスの Accept ヘッダーの値をレスポンス キャッシュ エントリのキャッシュキーに追加します。 |
useResponseCacheHeaders
タイプ: |
true に設定すると、キャッシュ内のレスポンスの「有効期間」(TTL)を設定する際に、HTTP レスポンス ヘッダーが考慮されます。 |
cacheExpiry
フィールド | 説明 |
---|---|
expiryDate
タイプ: |
キャッシュ エントリの有効期限の日付を指定します。 |
timeOfDay
タイプ: |
キャッシュ エントリの有効期限の時刻を指定します。 |
timeoutInSeconds
タイプ: |
キャッシュ エントリが期限切れになるまでの秒数を指定します。 |
cacheKey
フィールド | 説明 |
---|---|
cacheKeyPrefix
タイプ: |
キャッシュキーの接頭辞として使用する値を指定します。 |
fragments
タイプ: |
キャッシュキーに含める値を指定します。この値を使用して、キャッシュに保存されたレスポンスと一致するリクエストの名前空間が作成されます。 |