Riferimento alla risorsa Apigee APIM Operator for Kubernetes

Questa pagina si applica ad Apigee, ma non ad Apigee hybrid.

Visualizza la documentazione di Apigee Edge.

Questa pagina è un riferimento per ogni risorsa Kubernetes supportata dall'operatore APIM di Apigee per Kubernetes (anteprima). A meno che non sia specificato diversamente come Facoltativo, tutti i campi sono obbligatori.

APIProduct

Campo Descrizione
apiVersion

Tipo: string

apim.googleapis.com/v1alpha1
kind

Tipo: string

APIProduct
metadata

Tipo: Kubernetes meta/v1.ObjectMeta

Per i campi disponibili in metadata, consulta la documentazione dell'API Kubernetes.
spec

Tipo: APIProductSpec

spec definisce lo stato desiderato di APIProductSet.

APIProductSpec

Campo Descrizione
name

Tipo: string

Il nome del prodotto API.
approvalType

Tipo: string

Indica come le chiavi API vengono approvate per accedere alle API definite dal prodotto API. Se impostata su manual, la chiave utente viene generata e restituita come pending. In questo caso, le chiavi API non funzioneranno finché non saranno approvate esplicitamente.

Se impostato su auto, la chiave consumer viene generata e restituita come approved e può essere utilizzata immediatamente.

description

Tipo: string

Descrizione del prodotto API.
displayName

Tipo: string

Nome visualizzato nella UI o nel portale per sviluppatori per gli sviluppatori che si registrano per l'accesso all'API.
analytics

Tipo: Analytics

Definisce se devono essere raccolti dati e analisi per le operazioni associate a questo prodotto.
enforcementRefs

Tipo: Array

Array di risorse EnforcementRef da applicare al prodotto API.
attributes

Tipo: Array

Array di attributi che possono essere utilizzati per estendere il profilo del prodotto dell'API predefinito con metadati specifici del cliente.

EnforcementRef

Campo Descrizione
name

Tipo: string

Il nome della risorsa di destinazione.
kind

Tipo: string

APIMExtensionPolicy
group

Tipo: string

L'APIGroup per l'operatore Apigee APIM, ovvero apim.googleapis.com.
namespace

Tipo: string

(Facoltativo) Lo spazio dei nomi del referente. Se non specificato, viene dedotto lo spazio dei nomi locale.

Attributo

Campo Descrizione
name

Tipo: string

La chiave dell'attributo.
value

Tipo: string

Il valore dell'attributo.

APIOperationSet

Campo Descrizione
apiVersion

Tipo: string

apim.googleapis.com/v1alpha1
kind

Tipo: string

APIOperationSet
metadata

Tipo: Kubernetes meta/v1.ObjectMeta

Per i campi disponibili in metadata, consulta la documentazione dell'API Kubernetes.
spec

Tipo: APIOperationSetSpec

Definisce lo stato desiderato dell'APIOperationSet.

APIOperationSetSpec

Campo Descrizione
quota

Tipo: Quota

Definizione della quota.
restOperations

Tipo: Array

Array di definizioni di RESTOperation.
apiProductRefs

Tipo: Array

Array di risorse APIProductRef o riferimenti a prodotti API a cui devono essere applicate le operazioni REST.

Quota

Campo Descrizione
limit

Tipo: integer

Numero di messaggi di richiesta consentiti per app dal prodotto API per interval e timeUnit specificati.
interval

Tipo: integer

Intervallo di tempo su cui viene calcolato il numero di messaggi di richiesta.
timeUnit

Tipo: string

Unità di tempo definita per l'intervallo. I valori validi includono minute, hour, day o month.

RESTOperation

Campo Descrizione
name

Tipo: string

Il nome dell'operazione REST.
path

Tipo: string

In combinazione con methods, path è il percorso HTTP da associare a una quota e/o a un prodotto API.
methods

Tipo: array

In combinazione con path, methods è l'elenco (come strings) dei metodi HTTP applicabili da associare a una quota e/o a un prodotto API.

APIProductRef

Campo Descrizione
name

Tipo: string

Il nome della risorsa di destinazione.
kind

Tipo: string

APIProduct
group

Tipo: string

L'APIGroup per l'operatore Apigee APIM, ovvero apim.googleapis.com.
namespace

Tipo: string

(Facoltativo) Lo spazio dei nomi del referente. Se non specificato, viene dedotto lo spazio dei nomi locale.

APIMExtensionPolicy

Campo Descrizione
apiVersion

Tipo: string

apim.googleapis.com/v1alpha1
kind

Tipo: string

APIMExtensionPolicy
metadata

Tipo: Kubernetes meta/v1.ObjectMeta

Per i campi disponibili in metadata, consulta la documentazione dell'API Kubernetes.
spec

Tipo: APIMExtensionPolicySpec

Definisce lo stato desiderato di APIMExtensionPolicy.

APIMExtensionPolicySpec

Campo Descrizione
apigeeEnv (Facoltativo) Ambiente Apigee.

Se non viene fornito, viene creato un nuovo ambiente e collegato a tutte le istanze disponibili.

Se fornito, questo ambiente deve essere collegato a tutte le istanze disponibili durante l'utilizzo di un bilanciatore del carico globale esterno.

failOpen

Tipo: boolean

Specifica se eseguire o meno il fail open quando il runtime Apigee non è raggiungibile. Se impostato su true, le chiamate al runtime Apigee verranno considerate riuscite anche se il runtime non è raggiungibile.
timeout

Tipo: string

Specifica il periodo di timeout prima che le chiamate al runtime Apigee non vadano a buon fine, in secondi o millisecondi. Ad esempio, 10s.
targetRef

Tipo: ExtensionServerRef

Identifica il gateway Google Kubernetes Engine in cui deve essere installata l'estensione.
location

Tipo: string

Identifica la Google Cloud posizione in cui viene applicato APIMExtensionPolicy.

ExtensionServerRef

Campo Descrizione
name

Tipo: string

Il nome della risorsa di destinazione.
kind

Tipo: string

Specifica il kind della risorsa target, ad esempio Gateway o Service.
group

Tipo: string

L'APIGroup per l'operatore Apigee APIM, ovvero apim.googleapis.com.
namespace

Tipo: string

(Facoltativo) Lo spazio dei nomi del referente. Se non specificato, viene dedotto lo spazio dei nomi locale.

ApigeeGatewayPolicy

Campo Descrizione
apiVersion

Tipo: string

apim.googleapis.com/v1alpha1
kind

Tipo: string

ApigeeGatewayPolicy
metadata

Tipo: Kubernetes meta/v1.ObjectMeta

Consulta la documentazione dell'API Kubernetes per i campi disponibili in metadata.
spec

Tipo: ApigeeGatewayPolicySpec

Definisce lo stato desiderato di ApigeeGatewayPolicy.

ApigeeGatewayPolicySpec

Campo Descrizione
ref

Tipo: ExtensionServerRef

Si riferisce al modello APIM creato per governare i criteri applicati a GKE Gateway.
targetRef

Tipo: ExtensionServerRef

Si riferisce al criterio di estensione APIM a cui deve essere applicato questo criterio di Gateway specifico. Si riferisce indirettamente al gateway GKE.
serviceAccount (Facoltativo) Specifica l'account di servizio utilizzato per generare Google token di autenticazione in un proxy Apigee Pro.

ApimTemplate

Campo Descrizione
apiVersion

Tipo: string

apim.googleapis.com/v1alpha1
kind

Tipo: string

ApimTemplate
metadata

Tipo: Kubernetes meta/v1.ObjectMeta

Consulta la documentazione dell'API Kubernetes per i campi disponibili in metadata.
spec

Tipo: ApimTemplateSpec

Definisce lo stato desiderato di ApimTemplate.

ApimTemplateSpec

Campo Descrizione
templates

Tipo: list

Un elenco di risorse ApimTemplateFlow che specificano i criteri da eseguire nel flusso di richieste.
apimTemplateRule

Tipo: ExtensionServerRef

Specifica la regola del modello APIM da utilizzare per convalidare i criteri applicati.

ApimTemplateFlow

Campo Descrizione
policies

Tipo: list ConditionalParameterReference

Un elenco di risorse ConditionalParameterReference che specificano l'elenco ordinato dei criteri da eseguire nell'ambito del flusso di richieste.
condition

Tipo: string

Specifica le condizioni per l'esecuzione di questa risorsa.

ConditionalParameterReference

Campo Descrizione
condition

Type: string

Specifica le condizioni per l'esecuzione di questa risorsa.

ApimTemplateRule

Campo Descrizione
apiVersion

Tipo: string

apim.googleapis.com/v1alpha1
kind

Tipo: string

ApimTemplateRule
metadata

Tipo: Kubernetes meta/v1.ObjectMeta

Per i campi disponibili in metadata, consulta la documentazione dell'API Kubernetes.
spec

Tipo: ApimTemplateRuleSpec

Definisce lo stato desiderato di ApimTemplateRule.

ApimTemplateRuleSpec

Campo Descrizione
requiredList L'elenco dei criteri (come strings) che devono essere presenti in ApimTemplate.
denyList L'elenco dei criteri (come strings) che non devono essere presenti in ApimTemplate.
allowList L'elenco dei criteri (come strings) che possono essere presenti in ApimTemplate, ma non sono obbligatori.
override

Tipo: boolean

Sostituisce gli aggiornamenti alla regola del modello APIM nel caso in cui esistano modelli APIM che utilizzano la regola. I valori validi sono true o false.

JavaScript

Campo Descrizione
apiVersion

Tipo: string

apim.googleapis.com/v1alpha1
kind

Tipo: string

JavaScript
metadata

Tipo: Kubernetes meta/v1.ObjectMeta

Per i campi disponibili in metadata, consulta la documentazione dell'API Kubernetes.
spec

Tipo: JavascriptBean

Definisce lo stato desiderato del criterio JavaScript.

JavascriptBean

Campo Descrizione
mode

Tipo: array

Array di strings che specifica ProxyRequest o ProxyResponse. Determina se il criterio è collegato al flussi di richiesta o di risposta.
source

Tipo: string

Codice JavaScript in linea.
timeLimit

Tipo: integer

Specifica il timeout per l'esecuzione del codice JavaScript.

SpikeArrest

Campo Descrizione
apiVersion

Tipo: string

apim.googleapis.com/v1alpha1
kind

Tipo: string

SpikeArrest
metadata

Tipo: Kubernetes meta/v1.ObjectMeta

Per i campi disponibili in metadata, consulta la documentazione dell'API Kubernetes.
spec

Tipo: SpikeArrestBean

Definisce lo stato desiderato del criterio SpikeArrest.

SpikeArrestBean

Campo Descrizione
mode

Tipo: array

Array di strings che specifica ProxyRequest o ProxyResponse. Determina se il criterio è collegato al flussi di richiesta o di risposta.
peakMessageRate

Tipo: peakMessageRate

Specifica la frequenza dei messaggi per SpikeArrest.
useEffectiveCount

Tipo: boolean

Se impostato su truetrue, SpikeArrest viene distribuito in una regione, con i conteggi delle richieste sincronizzati tra i processori di messaggi (MP) Apigee in una regione.

Se impostato su false, SpikeArrest utilizza un algoritmo bucket di token localmente. Per ulteriori informazioni, consulta UseEffectiveCount.

peakMessageRate

Campo Descrizione
ref

Tipo: string

Variabile che fa riferimento al valore rate.
value

Tipo: string

Valore effettivo di rate se non è disponibile un riferimento.

AssignMessage (Google iniezione di token)

Campo Descrizione
apiVersion

Tipo: string

apim.googleapis.com/v1alpha1
kind

Tipo: string

AssignMessage
metadata

Tipo: Kubernetes meta/v1.ObjectMeta

Per i campi disponibili in metadata, consulta la documentazione dell'API Kubernetes.
spec

Tipo: AssignMessageBean

Definisce lo stato desiderato del criterio AssignMessage.

AssignMessageBean

Campo Descrizione
setActions

Tipo: array

Array di oggetti SetActionsBean. Sostituisce i valori delle proprietà esistenti nella richiesta o nella risposta, come specificato dall'elemento AssignTo.

Se le intestazioni o i parametri sono già presenti nel messaggio originale, setActions sovrascrive i valori. In caso contrario, setActions aggiunge nuove intestazioni o nuovi parametri come specificato.

AssignTo

Tipo: AssignToBean

Specifica il messaggio su cui opera il criterio AssignMessage. Le opzioni includono la richiesta, la risposta o un nuovo messaggio personalizzato.

SetActionsBean

Campo Descrizione
Authentication

Tipo: AuthenticationBean

Genera token Google OAuth 2.0 o OpenID Connect per effettuare chiamate autenticate a Google servizi o servizi personalizzati in esecuzione su determinati Google Cloud prodotti, come le funzioni Cloud Run e Cloud Run.

AuthenticationBean

Campo Descrizione
GoogleAccessToken

Tipo: GoogleAccessTokenBean

Genera token Google OAuth 2.0 per effettuare chiamate autenticate ai servizi Google.
GoogleIDToken

Tipo: GoogleIDTokenBean

Configurazione per generare un token OpenID Connect per autenticare la richiesta di destinazione.
headerName

Tipo: string

Per impostazione predefinita, quando è presente una configurazione di autenticazione, Apigee genera un token di trasporto e lo inserisce nell'intestazione Authorization del messaggio inviato al sistema di destinazione. L'elemento headerName consente di specificare il nome di un altro intestazione per contenere il token di accesso.

GoogleAccessTokenBean

Campo Descrizione
scopes

Tipo: array

Array di strings che specifica un ambito dell'API Google valido. Per ulteriori informazioni, vedi Ambiti OAuth 2.0 per le API di Google.
LifetimeInSeconds

Tipo: integer

Specifica la durata del token di accesso in secondi.

GoogleIDTokenBean

Campo Descrizione
Audience

Tipo: AudienceBean

Il pubblico del token di autenticazione generato, ad esempio l'API o l'account di servizio a cui è stato concesso l'accesso dal token.
IncludeEmail

Tipo: boolean

Se impostato su true, il token di autenticazione generato conterrà i claim email e email_verified dell'account di servizio.

AudienceBean

Campo Descrizione
useTargetHost

Tipo: string

Se il valore di Audience è vuoto o la variabile ref non restituisce un valore valido e useTargetUrl è true, l'URL del target (esclusi eventuali parametri di query) viene utilizzato come segmento di pubblico.
useTargetUrl

Tipo: boolean

Per impostazione predefinita, useTargetUrl è false.

AssignToBean

Campo Descrizione
createNew

Tipo: boolean

Determina se il criterio crea un nuovo messaggio durante l'assegnazione dei valori. Se impostato su true, il criterio crea un nuovo messaggio.
type

Tipo: string

Specifica il tipo del nuovo messaggio quando CreateNew è impostato su true true. I valori validi sono request o response.