Kubernetes 用 Apigee APIM オペレータのリソース リファレンス

このページの内容は Apigee に適用されます。Apigee ハイブリッドには適用されません。

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

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

APIProduct

フィールド 説明
apiVersion

タイプ: string

 apim.googleapis.com/v1alpha1
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/v1alpha1
kind

タイプ: string

 APIOperationSet
metadata

タイプ: Kubernetes meta/v1.ObjectMeta

 metadata で使用可能なフィールドについては、Kubernetes API のドキュメントをご覧ください。
spec

タイプ: APIOperationSetSpec

 APIOperationSet の望ましい状態を定義します。

APIOperationSetSpec

フィールド 説明
quota

タイプ: 割り当て

 割り当ての定義。
restOperations

タイプ: Array

 RESTOperation 定義の配列。
apiProductRefs

タイプ: Array

APIProductRef リソースの配列、または RESTOperations が適用される 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/v1alpha1
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 ロケーションを特定します。

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/v1alpha1
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/v1alpha1
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/v1alpha1
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 です。

JavaScript

フィールド 説明
apiVersion

タイプ: string

 apim.googleapis.com/v1alpha1
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 コードの実行のタイムアウトを指定します。

SpikeArrest

フィールド 説明
apiVersion

タイプ: string

 apim.googleapis.com/v1alpha1
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

 truetrue に設定すると、SpikeArrest がリージョンに分散され、リージョン内の Apigee Message Processor（MP）間でリクエスト数が同期されます。

false に設定すると、SpikeArrest はローカルでトークン バケット アルゴリズムを使用します。詳細については、 UseEffectiveCount をご覧ください。

peakMessageRate

フィールド 説明
ref

タイプ: string

rate 値を参照する変数。
value

タイプ: string

参照が使用できない場合の実際の rate 値。

AssignMessage（Google トークン挿入）

フィールド 説明
apiVersion

タイプ: string

 apim.googleapis.com/v1alpha1
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

Google OAuth 2.0 トークンまたは OpenID Connect トークンを生成し、 Google Cloud Run 関数や Cloud Run などの特定の Google Cloud プロダクトで実行されているサービスまたはカスタム サービスへの認証済み呼び出しを行います。

AuthenticationBean

フィールド 説明
GoogleAccessToken

タイプ: GoogleAccessTokenBean

 Google OAuth 2.0 トークンを生成し、Google サービスへの認証済みの呼び出しを行います。
GoogleIDToken

タイプ: GoogleIDTokenBean

 ターゲット リクエストを認証するための OpenID Connect トークンを生成する構成。
headerName

タイプ: string

デフォルトでは、認証構成が存在する場合、Apigee は署名なしトークンを生成し、ターゲット システムに送信されるメッセージの Authorization ヘッダーにそれを挿入します。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 true に設定されている場合、新しいメッセージのタイプを指定します。有効な値は「request」または「response」です。