Apigee APIM-Operator für Kubernetes-Ressource – Referenz

Diese Seite gilt für Apigee, aber nicht für Apigee Hybrid.

Apigee Edge-Dokumentation aufrufen

Auf dieser Seite finden Sie eine Referenz für jede Kubernetes-Ressource, die vom Apigee APIM-Operator für Kubernetes (Vorabversion) unterstützt wird. Sofern nicht ausdrücklich als optional gekennzeichnet, sind alle Felder erforderlich.

APIProduct

Feld Beschreibung
apiVersion

Typ: string

apim.googleapis.com/v1alpha1
kind

Typ: string

APIProduct
metadata

Typ: Kubernetes meta/v1.ObjectMeta

Informationen zu den in metadata verfügbaren Feldern finden Sie in der Dokumentation zur Kubernetes API.
spec

Typ: APIProductSpec

spec definiert den gewünschten Status des APIProductSet.

APIProductSpec

Feld Beschreibung
name

Typ: string

Der Name des API-Produkts.
approvalType

Typ: string

Flag, das angibt, wie API-Schlüssel für den Zugriff auf die vom API-Produkt definierten APIs zugelassen sind. Wenn dieser Wert auf manual gesetzt ist, wird der Consumer-Key generiert und als pending zurückgegeben. In diesem Fall funktionieren die API-Schlüssel erst, wenn sie explizit genehmigt wurden.

Wenn dieser Wert auf auto gesetzt ist, wird der Nutzerschlüssel generiert und als approved zurückgegeben. Er kann dann sofort verwendet werden.

description

Typ: string

Beschreibung des API-Produkts.
displayName

Typ: string

Name, der in der Benutzeroberfläche oder im Entwicklerportal für Entwickler angezeigt wird, die sich für den API-Zugriff registrieren.
analytics

Typ: Analytics

Hier wird festgelegt, ob Analysen für Vorgänge erfasst werden sollen, die mit diesem Produkt verknüpft sind.
enforcementRefs

Typ: Array

Array von EnforcementRef-Ressourcen, die auf das API-Produkt angewendet werden sollen.
attributes

Typ: Array

Array von Attributen, mit denen das Standard-API-Produktprofil mit kundenspezifischen Metadaten erweitert werden kann.

EnforcementRef

Feld Beschreibung
name

Typ: string

Der Name der Zielressource.
kind

Typ: string

APIMExtensionPolicy
group

Typ: string

Die APIGroup für den Apigee APIM-Betreiber, also apim.googleapis.com.
namespace

Typ: string

(Optional) Der Namespace des Referenzobjekts. Wenn Sie keinen angeben, wird der lokale Namespace abgeleitet.

Attribut

Feld Beschreibung
name

Typ: string

Der Schlüssel des Attributs.
value

Typ: string

Der Wert des Attributs.

APIOperationSet

Feld Beschreibung
apiVersion

Typ: string

apim.googleapis.com/v1alpha1
kind

Typ: string

APIOperationSet
metadata

Typ: Kubernetes meta/v1.ObjectMeta

Informationen zu den in metadata verfügbaren Feldern finden Sie in der Dokumentation zur Kubernetes API.
spec

Typ: APIOperationSetSpec

Definiert den gewünschten Status der APIOperationSet.

APIOperationSetSpec

Feld Beschreibung
quota

Typ: Kontingent

Kontingentdefinition.
restOperations

Typ: Array

Array von RESTOperation-Definitionen.
apiProductRefs

Typ: Array

Array von APIProductRef-Ressourcen oder Referenzen auf API-Produkte, für die die RESTOperations gelten sollen.

Kontingent

Feld Beschreibung
limit

Typ: integer

Anzahl der Anfragenachrichten, die pro App vom API-Produkt für die angegebenen interval und timeUnit zulässig sind.
interval

Typ: integer

Zeitraum, über den die Anzahl der Anfragenachrichten berechnet wird.
timeUnit

Typ: string

Für das Intervall definierte Zeiteinheit. Zulässige Werte sind minute, hour, day oder month.

RESTOperation

Feld Beschreibung
name

Typ: string

Der Name des REST-Vorgangs.
path

Typ: string

In Kombination mit methods ist path der HTTP-Pfad, der mit einem Kontingent und/oder einem API-Produkt abgeglichen werden soll.
methods

Typ: array

In Kombination mit path ist methods die Liste (als strings) der anwendbaren HTTP-Methoden, die mit einem Kontingent und/oder einem API-Produkt abgeglichen werden sollen.

APIProductRef

Feld Beschreibung
name

Typ: string

Der Name der Zielressource.
kind

Typ: string

APIProduct
group

Typ: string

Die APIGroup für den Apigee APIM-Betreiber, also apim.googleapis.com.
namespace

Typ: string

(Optional) Der Namespace des Referenzobjekts. Wenn Sie keinen angeben, wird der lokale Namespace abgeleitet.

APIMExtensionPolicy

Feld Beschreibung
apiVersion

Typ: string

apim.googleapis.com/v1alpha1
kind

Typ: string

APIMExtensionPolicy
metadata

Typ: Kubernetes meta/v1.ObjectMeta

Informationen zu den in metadata verfügbaren Feldern finden Sie in der Dokumentation zur Kubernetes API.
spec

Typ: APIMExtensionPolicySpec

Definiert den gewünschten Status von APIMExtensionPolicy.

APIMExtensionPolicySpec

Feld Beschreibung
apigeeEnv (Optional) Apigee-Umgebung.

Wenn keine Umgebung angegeben wird, wird eine neue Umgebung erstellt und an alle verfügbaren Instanzen angehängt.

Falls angegeben, muss diese Umgebung bei Verwendung eines externen globalen Load Balancers mit allen verfügbaren Instanzen verbunden sein.

failOpen

Typ: boolean

Gibt an, ob Fail Open verwendet werden soll, wenn die Apigee-Laufzeit nicht erreichbar ist. Wenn true festgelegt ist, werden Aufrufe an die Apigee-Laufzeit als erfolgreich behandelt, auch wenn die Laufzeit nicht erreichbar ist.
timeout

Typ: string

Gibt das Zeitlimit in Sekunden oder Millisekunden an, nach dem Aufrufe der Apigee-Laufzeit fehlschlagen. Beispiel: 10s.
targetRef

Typ: ExtensionServerRef

Gibt das Google Kubernetes Engine-Gateway an, in dem die Erweiterung installiert werden soll.
location

Typ: string

Gibt den Speicherort an, Google Cloud an dem die APIMExtensionPolicy erzwungen wird.

ExtensionServerRef

Feld Beschreibung
name

Typ: string

Der Name der Zielressource.
kind

Typ: string

Gibt den kind der Zielressource an, z. B. Gateway oder Service.
group

Typ: string

Die APIGroup für den Apigee APIM-Betreiber, also apim.googleapis.com.
namespace

Typ: string

(Optional) Der Namespace des Referenzobjekts. Wenn Sie keinen angeben, wird der lokale Namespace abgeleitet.

ApigeeGatewayPolicy

Feld Beschreibung
apiVersion

Typ: string

apim.googleapis.com/v1alpha1
kind

Typ: string

ApigeeGatewayPolicy
metadata

Typ: Kubernetes meta/v1.ObjectMeta

Informationen zu den in metadata verfügbaren Feldern finden Sie in der Dokumentation zur Kubernetes API.
spec

Typ: ApigeeGatewayPolicySpec

Definiert den gewünschten Status von ApigeeGatewayPolicy.

ApigeeGatewayPolicySpec

Feld Beschreibung
ref

Typ: ExtensionServerRef

Bezieht sich auf die APIM-Vorlage, die zum Verwalten der Richtlinien erstellt wurde, die auf das GKE-Gateway angewendet werden.
targetRef

Typ: ExtensionServerRef

Bezieht sich auf die APIM-Erweiterungsrichtlinie, auf die diese bestimmte Gateway-Richtlinie angewendet werden soll. Verweist indirekt auf das GKE-Gateway.
serviceAccount (Optional) Gibt das Dienstkonto an, das zum Generieren von Google Authentifizierungstokens in einem Apigee ProApigee-Proxy verwendet wird.

ApimTemplate

Feld Beschreibung
apiVersion

Typ: string

apim.googleapis.com/v1alpha1
kind

Typ: string

ApimTemplate
metadata

Typ: Kubernetes meta/v1.ObjectMeta

Informationen zu den in metadata verfügbaren Feldern finden Sie in der Dokumentation zur Kubernetes API.
spec

Typ: ApimTemplateSpec

Definiert den gewünschten Status von ApimTemplate.

ApimTemplateSpec

Feld Beschreibung
templates

Typ: list

Eine Liste von ApimTemplateFlow-Ressourcen, die die Richtlinien angeben, die im Anfrageablauf ausgeführt werden sollen.
apimTemplateRule

Typ: ExtensionServerRef

Gibt die APIM-Vorlagenregel an, die zum Validieren der angewendeten Richtlinien verwendet werden soll.

ApimTemplateFlow

Feld Beschreibung
policies

Typ: list ConditionalParameterReference

Eine Liste von ConditionalParameterReference-Ressourcen, die die sortierte Liste der Richtlinien angeben, die im Rahmen des Anfragevorgangs ausgeführt werden sollen.
condition

Typ: string

 Gibt die Bedingungen für die Ausführung dieser Ressource an.

ConditionalParameterReference

Feld Beschreibung
condition

Type: string

 Gibt die Bedingungen für die Ausführung dieser Ressource an.

ApimTemplateRule

Feld Beschreibung
apiVersion

Typ: string

apim.googleapis.com/v1alpha1
kind

Typ: string

ApimTemplateRule
metadata

Typ: Kubernetes meta/v1.ObjectMeta

Informationen zu den in metadata verfügbaren Feldern finden Sie in der Dokumentation zur Kubernetes API.
spec

Typ: ApimTemplateRuleSpec

Definiert den gewünschten Status von ApimTemplateRule.

ApimTemplateRuleSpec

Feld Beschreibung
requiredList Die Liste der Richtlinien (als strings), die in der ApimTemplate vorhanden sein müssen.
denyList Die Liste der Richtlinien (als strings), die nicht in der ApimTemplate vorhanden sein sollten.
allowList Die Liste der Richtlinien (als strings), die in der ApimTemplate vorhanden sein können, sind aber nicht erforderlich.
override

Typ: boolean

 Überschreibt Aktualisierungen der APIM-Vorlagenregel, falls APIM-Vorlagen mit der Regel vorhanden sind. Gültige Werte sind true und false.

JavaScript

Feld Beschreibung
apiVersion

Typ: string

apim.googleapis.com/v1alpha1
kind

Typ: string

JavaScript
metadata

Typ: Kubernetes meta/v1.ObjectMeta

Informationen zu den in metadata verfügbaren Feldern finden Sie in der Dokumentation zur Kubernetes API.
spec

Typ: JavascriptBean

Definiert den gewünschten Status der JavaScript-Richtlinie.

JavascriptBean

Feld Beschreibung
mode

Typ: array

Array von strings, das ProxyRequest oder ProxyResponse angibt. Bestimmt, ob die Richtlinie an den Anfrage- oder Antwortablauf angehängt ist.
source

Typ: string

Inline-JavaScript-Code
timeLimit

Typ: integer

Gibt das Timeout für die Ausführung von JavaScript-Code an.

SpikeArrest

Feld Beschreibung
apiVersion

Typ: string

apim.googleapis.com/v1alpha1
kind

Typ: string

SpikeArrest
metadata

Typ: Kubernetes meta/v1.ObjectMeta

Informationen zu den in metadata verfügbaren Feldern finden Sie in der Dokumentation zur Kubernetes API.
spec

Typ: SpikeArrestBean

Definiert den gewünschten Status der SpikeArrest-Richtlinie.

SpikeArrestBean

Feld Beschreibung
mode

Typ: array

Array von strings, das ProxyRequest oder ProxyResponse angibt. Bestimmt, ob die Richtlinie an den Anfrage- oder Antwortablauf angehängt ist.
peakMessageRate

Typ: peakMessageRate

Gibt die Nachrichtenrate für SpikeArrest an.
useEffectiveCount

Typ: boolean

Wenn true auf „true“ festgelegt ist, wird SpikeArrest in einer Region verteilt. Die Anzahl der Anfragen wird zwischen den Apigee Message Processors (MPs) in einer Region synchronisiert.

Wenn false festgelegt ist, verwendet SpikeArrest lokal einen Token-Bucket-Algorithmus. Weitere Informationen finden Sie unter UseEffectiveCount.

peakMessageRate

Feld Beschreibung
ref

Typ: string

Variable, die auf den Wert rate verweist.
value

Typ: string

Der tatsächliche rate-Wert, wenn keine Referenz verfügbar ist.

AssignMessage (Google -Token-Injection)

Feld Beschreibung
apiVersion

Typ: string

apim.googleapis.com/v1alpha1
kind

Typ: string

AssignMessage
metadata

Typ: Kubernetes meta/v1.ObjectMeta

Informationen zu den in metadata verfügbaren Feldern finden Sie in der Dokumentation zur Kubernetes API.
spec

Typ: AssignMessageBean

Definiert den gewünschten Status der AssignMessage-Richtlinie.

AssignMessageBean

Feld Beschreibung
setActions

Typ: array

Array von SetActionsBean-Objekten. Ersetzt Werte vorhandener Attribute in der Anfrage oder Antwort, die durch das Element AssignTo angegeben werden.

Wenn die Header oder Parameter bereits in der ursprünglichen Nachricht vorhanden sind, werden die Werte von setActions überschrieben. Andernfalls fügt setActions neue Header oder Parameter hinzu, wie angegeben.

AssignTo

Typ: AssignToBean

Gibt an, auf welche Nachricht die AssignMessage-Richtlinie angewendet wird. Zu den Optionen gehören die Anfrage, die Antwort oder eine neue benutzerdefinierte Nachricht.

SetActionsBean

Feld Beschreibung
Authentication

Typ: AuthenticationBean

Generiert Google OAuth 2.0- oder OpenID Connect-Tokens für authentifizierte Aufrufe an Google Dienste oder benutzerdefinierte Dienste, die in bestimmten Google Cloud Produkten ausgeführt werden, z. B. Cloud Run-Funktionen und Cloud Run.

AuthenticationBean

Feld Beschreibung
GoogleAccessToken

Typ: GoogleAccessTokenBean

Generiert Google OAuth 2.0-Tokens für authentifizierte Aufrufe an Google-Dienste.
GoogleIDToken

Typ: GoogleIDTokenBean

Konfiguration zum Generieren eines OpenID Connect-Tokens zur Authentifizierung der Zielanfrage.
headerName

Typ: string

Wenn eine Authentifizierungskonfiguration vorhanden ist, generiert Apigee standardmäßig ein Inhabertoken und fügt es in den Autorisierungsheader der Nachricht ein, die an das Zielsystem gesendet wird. Mit dem Element headerName können Sie den Namen eines anderen Headers angeben, der das Inhabertoken enthält.

GoogleAccessTokenBean

Feld Beschreibung
scopes

Typ: array

Array von strings, das einen gültigen Google API-Bereich angibt. Weitere Informationen finden Sie unter OAuth 2.0-Bereiche für Google APIs.
LifetimeInSeconds

Typ: integer

Gibt die Lebensdauer des Zugriffstokens in Sekunden an.

GoogleIDTokenBean

Feld Beschreibung
Audience

Typ: AudienceBean

Das Zielobjekt für das generierte Authentifizierungstoken, z. B. die API oder das Dienstkonto, dem das Token Zugriff gewährt.
IncludeEmail

Typ: boolean

Wenn dafür true festgelegt ist, enthält das generierte Authentifizierungstoken die Anforderungen email und email_verified des Dienstkontos.

AudienceBean

Feld Beschreibung
useTargetHost

Typ: string

Wenn der Wert von Audience leer ist oder die Variable ref nicht in einen gültigen Wert aufgelöst wird und useTargetUrl true ist, dann wird die URL des Ziels (ohne Abfrageparameter) als Zielgruppe verwendet.
useTargetUrl

Typ: boolean

Standardmäßig ist useTargetUrl auf false festgelegt.

AssignToBean

Feld Beschreibung
createNew

Typ: boolean

Bestimmt, ob die Richtlinie eine neue Nachricht erstellt, wenn Werte zugewiesen werden. Wenn dieser Wert auf true gesetzt ist, wird von der Richtlinie eine neue Nachricht erstellt.
type

Typ: string

Gibt den Typ der neuen Nachricht an, wenn CreateNew auf true „wahr“ gesetzt ist. Gültige Werte sind request oder response.