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 Apigee APIM per Kubernetes. A meno che non siano specificamente indicati come facoltativi, tutti i campi sono obbligatori.

APIProduct

Campo	Descrizione
apiVersion Tipo: string	apim.googleapis.com/v1
kind Tipo: string	APIProduct
metadata Type: Kubernetes meta/v1.ObjectMeta	Consulta la documentazione dell'API Kubernetes per i campi disponibili in metadata.
spec Tipo: APIProductSpec	spec definisce lo stato desiderato di APIProductSet.

APIProductSpec

Campo	Descrizione
name Tipo: string	Il nome del prodotto API.
approvalType Tipo: string	Flag che specifica come vengono approvate le chiavi API 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 verranno approvate esplicitamente. Se è impostata su auto, la chiave utente 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 API.
analytics Tipo: Analytics	Definisce se raccogliere o meno i dati di 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 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	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/v1
kind Tipo: string	APIOperationSet
metadata Type: Kubernetes meta/v1.ObjectMeta	Consulta la documentazione dell'API Kubernetes per i campi disponibili in metadata.
spec Tipo: APIOperationSetSpec	Definisce lo stato desiderato di APIOperationSet.

APIOperationSetSpec

Campo	Descrizione
quota Tipo: Quota	Definizione della quota.
restOperations Tipo: Array	Array di definizioni RESTOperation.
apiProductRefs Tipo: Array	Array di risorse APIProductRef o riferimenti ai prodotti API a cui devono essere applicate le RESTOperations.

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 corrispondere per una quota e/o per un prodotto API.
methods Tipo: array	In combinazione con path, methods è l'elenco (come strings) dei metodi HTTP applicabili da abbinare 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	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/v1
kind Tipo: string	APIMExtensionPolicy
metadata Type: Kubernetes meta/v1.ObjectMeta	Consulta la documentazione dell'API Kubernetes per i campi disponibili in metadata.
spec Tipo: APIMExtensionPolicySpec	Definisce lo stato desiderato di APIMExtensionPolicy.

APIMExtensionPolicySpec

Campo	Descrizione
apigeeEnv	(Facoltativo) Ambiente Apigee. Se non viene fornito alcun valore, viene creato un nuovo ambiente e collegato a tutte le istanze disponibili. Se fornito, questo ambiente deve essere collegato a tutte le istanze disponibili quando utilizzi 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.
supportedEvents Tipo: List di eventi	Specifica l'elenco degli eventi del processore di estensione inviati ad Apigee. Questi includono: "REQUEST_HEADERS" "RESPONSE_HEADERS" "REQUEST_BODY" (anteprima) "RESPONSE_BODY" (anteprima) "REQUEST_TRAILERS" "RESPONSE_TRAILERS"

ExtensionServerRef

Campo	Descrizione
name Tipo: string	Il nome della risorsa di destinazione.
kind Tipo: string	Specifica il kind della risorsa di destinazione, ad esempio Gateway o Service.
group Tipo: string	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/v1
kind Tipo: string	ApigeeGatewayPolicy
metadata Type: 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 gestire i criteri applicati al gateway GKE.
targetRef Tipo: ExtensionServerRef	Si riferisce al criterio di estensione APIM che deve applicare questo criterio di gateway specifico. Si riferisce indirettamente al gateway GKE.
serviceAccount	(Facoltativo) Specifica il account di servizio utilizzato per generare Google token di autenticazione in un proxy Apigee ProApigee.

ApimTemplate

Campo	Descrizione
apiVersion Tipo: string	apim.googleapis.com/v1
kind Tipo: string	ApimTemplate
metadata Type: 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 di 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/v1
kind Tipo: string	ApimTemplateRule
metadata Type: Kubernetes meta/v1.ObjectMeta	Consulta la documentazione dell'API Kubernetes per i campi disponibili in metadata.
spec Tipo: ApimTemplateRuleSpec	Definisce lo stato desiderato di ApimTemplateRule.

ApimTemplateRuleSpec

Campo	Descrizione
requiredList	L'elenco delle policy (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 potrebbero essere presenti in ApimTemplate, ma non sono obbligatori.
override Tipo: boolean	Esegue l'override degli aggiornamenti alla regola del modello APIM nel caso in cui esistano modelli APIM che utilizzano la regola. I valori validi sono true o false.

AssignMessage (inserimento tokenGoogle )

Campo	Descrizione
apiVersion Tipo: string	apim.googleapis.com/v1
kind Tipo: string	AssignMessage
metadata Type: Kubernetes meta/v1.ObjectMeta	Consulta la documentazione dell'API Kubernetes per i campi disponibili in metadata.
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 parametri come specificato.
AssignTo Tipo: AssignToBean	Specifica su quale messaggio 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 Cloud Run Functions 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 tipo bearer e lo inserisce nell'intestazione Authorization del messaggio inviato al sistema di destinazione. L'elemento headerName ti consente di specificare il nome di un'intestazione diversa per contenere il token di autenticazione.

GoogleAccessTokenBean

Campo	Descrizione
scopes Tipo: array	Array di strings che specifica un ambito API di 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 per il token di autenticazione generato, ad esempio l'API o il account di servizio a cui è stato concesso l'accesso dal token.
IncludeEmail Tipo: boolean	Se impostato su true, il token di autenticazione generato conterrà le attestazioni email e email_verified del 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, viene utilizzato come pubblico l'URL della destinazione (esclusi i parametri di ricerca).
useTargetUrl Tipo: boolean	Per impostazione predefinita, useTargetUrl è false.

AssignToBean

Campo	Descrizione
createNew Tipo: boolean	Determina se il criterio crea un nuovo messaggio quando assegna i valori. Se impostata su true, la policy 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.

JavaScript

Campo	Descrizione
apiVersion Tipo: string	apim.googleapis.com/v1
kind Tipo: string	JavaScript
metadata Type: Kubernetes meta/v1.ObjectMeta	Consulta la documentazione dell'API Kubernetes per i campi disponibili in metadata.
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 la policy è allegata al flusso di richiesta o al flusso di risposta.
source Tipo: string	Codice JavaScript incorporato.
timeLimit Tipo: integer	Specifica il timeout per l'esecuzione del codice JavaScript.

KVM

Campo	Descrizione
apiVersion Tipo: string	apim.googleapis.com/v1
kind Tipo: string	KVM
metadata Type: Kubernetes meta/v1.ObjectMeta	Consulta la documentazione dell'API Kubernetes per i campi disponibili in metadata.
spec Tipo: KeyValueMapOperationsBean	Definisce lo stato desiderato della policy KVM.

KeyValueMapOperationsBean

Campo	Descrizione
MapName Tipo: MapName	Consente al criterio di identificare dinamicamente quale KVM utilizzare in fase di runtime.
expiryTimeInSecs Tipo: integer	Specifica la durata in secondi dopo la quale Apigee aggiorna il valore memorizzato nella cache dal KVM specificato.
initialEntries Tipo: list	Valori iniziali per le KVM, che vengono inseriti nella KVM al momento dell'inizializzazione.

OASValidation

Campo	Descrizione
apiVersion Tipo: string	apim.googleapis.com/v1
kind Tipo: string	OASValidation
metadata Type: Kubernetes meta/v1.ObjectMeta	Consulta la documentazione dell'API Kubernetes per i campi disponibili in metadata.
spec Tipo: OASValidationBean	Definisce lo stato desiderato del criterio OASValidation.

OASValidationBean

Campo	Descrizione
openApiSpec Tipo: string	Specifica la specifica OpenAPI in yaml da convalidare. Poiché si tratta di un frammento yaml multiriga, utilizza il delimitatore "|".
source Tipo: string	Uno dei valori message, request o response. Se impostato su request, valuterà le richieste in entrata dalle app client; se impostato su response, valuterà le risposte dai server di destinazione. Se impostato su message, valuterà automaticamente la richiesta o la risposta a seconda che il criterio sia collegato al flusso di richiesta o di risposta.
options Tipo: OASValidationOptions	Vedi OASValidationOptions/td>

OASValidationOptions

Campo	Descrizione
validateMessageBody Tipo: boolean	Specifica se la policy deve convalidare il corpo del messaggio in base allo schema del corpo della richiesta dell'operazione nella specifica OpenAPI. Imposta su true per convalidare i contenuti del corpo del messaggio. Imposta su false per convalidare solo l'esistenza del corpo del messaggio.
allowUnspecifiedParameters Tipo: StrictOptions	Vedi StrictOptions

StrictOptions

Campo	Descrizione
header Tipo: boolean	Per consentire la specifica nella richiesta di parametri di intestazione non definiti nella specifica OpenAPI, imposta questo parametro su true. In caso contrario, imposta questo parametro su false per causare l'errore di esecuzione del criterio.
query Tipo: boolean	Per consentire la specifica nella richiesta di parametri di ricerca non definiti nella specifica OpenAPI, imposta questo parametro su true. In caso contrario, imposta questo parametro su false per causare l'esito negativo dell'esecuzione del criterio.
cookie Tipo: boolean	Per consentire la specifica nella richiesta di parametri dei cookie non definiti nella specifica OpenAPI, imposta questo parametro su true. In caso contrario, imposta questo parametro su false per causare l'errore di esecuzione del criterio.

APIMResourceStatus

Campo	Descrizione
currentState Tipo: enum	Mostra lo stato attuale della risorsa: RUNNING = la risorsa è in stato di esecuzione. CREATING = risorsa in fase di creazione CREATED = risorsa creata UPDATING = risorsa in fase di aggiornamento DELETING = la risorsa è in fase di eliminazione CREATE_UPDATE_FAILED = create or update operation failed DELETE_FAILED = eliminazione dell'operazione non riuscita
errorMessage Tipo: string	Messaggio di errore relativo a uno degli stati di errore del campo currentState.
operationResult Tipo: string	Una stringa di risposta di una delle operazioni a lunga esecuzione correlate alla creazione, all'aggiornamento o all'eliminazione delle risorse.

ServiceCallout

Campo	Descrizione
apiVersion Tipo: string	apim.googleapis.com/v1
kind Tipo: string	ServiceCallout
metadata Type: Kubernetes meta/v1.ObjectMeta	Consulta la documentazione dell'API Kubernetes per i campi disponibili in metadata.
spec Tipo: ServiceCalloutBean	Definisce lo stato desiderato del criterio ServiceCallout.

ServiceCalloutBean

Campo	Descrizione
httpTargetConnection Tipo: HttpTargetConnection	Fornisce i dettagli di trasporto, come URL, TLS/SSL e proprietà HTTP.
request Tipo: CalloutRequest	Specifica la variabile contenente il messaggio di richiesta inviato dal proxy API all'altro servizio.
Response Tipo: string	Specifica la variabile contenente il messaggio di risposta restituito al proxy API dal servizio esterno.

HttpTargetConnection

Campo	Descrizione
url Tipo: string	L'URL del servizio di destinazione.
properties Tipo: Map of <string, string>	Proprietà di trasporto HTTP al servizio di backend. Per saperne di più, consulta Riferimento per le proprietà degli endpoint.

CalloutRequest

Campo	Descrizione
url Tipo: string	L'URL del servizio di destinazione.
properties Tipo: Map of <string, string>	Proprietà di trasporto HTTP al servizio di backend. Per saperne di più, consulta Riferimento per le proprietà degli endpoint.

SpikeArrest

Campo	Descrizione
apiVersion Tipo: string	apim.googleapis.com/v1
kind Tipo: string	SpikeArrest
metadata Type: Kubernetes meta/v1.ObjectMeta	Consulta la documentazione dell'API Kubernetes per i campi disponibili in metadata.
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 la policy è allegata al flusso di richiesta o al flusso 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 token bucket localmente. Per ulteriori informazioni, vedi UseEffectiveCount.

peakMessageRate

Campo	Descrizione
ref Tipo: string	Variabile che fa riferimento al valore rate.
value Tipo: string	Valore rate effettivo se non è disponibile un riferimento.

Policy ResponseCache

Campo	Descrizione
apiVersion Tipo: string	apim.googleapis.com/v1
kind Tipo: string	ResponseCache
metadata Type: Kubernetes meta/v1.ObjectMeta	Consulta la documentazione dell'API Kubernetes per i campi disponibili in metadata.
spec Tipo: APIExtensionPolicySpec	Definisce lo stato desiderato di ResponseCache.

ResponseCacheBean

Campo	Descrizione
mode Tipo: boolean	Specifica ProxyRequest o ProxyResponse. Determina se la policy è allegata al flusso di richiesta o al flusso di risposta.
cacheExpiry Tipo: cacheExpiry	Fornisce l'oggetto cacheExpiry.
cacheKey Tipo: cacheKey	Fornisce l'oggetto cacheKey.
cacheLookupTimeOut tipo: integer	Specifica il periodo di timeout della ricerca nella cache.
cacheResourceRef tipo: string	Specifica l'identificatore della risorsa cache utilizzando un riferimento a una variabile.
excludeErrorResponse tipo: boolean	Questa norma può memorizzare nella cache le risposte HTTP con qualsiasi codice di stato. Ciò significa che sia le risposte di successo che quelle di errore possono essere memorizzate nella cache, inclusi i codici di stato 2xx e 3xx.
skipCacheLookupCondition tipo: string	Definisce un'espressione che, se valutata come true in fase di runtime, specifica che la ricerca nella cache deve essere ignorata e la cache deve essere aggiornata
skipCachePopulationCondition tipo: string	Definisce un'espressione che, se valutata,	Definisce un'espressione che, se valutata come true in fase di runtime, specifica che la ricerca nella cache deve essere ignorata e che la cache deve essere aggiornata in fase di runtime, specifica che la scrittura nella cache deve essere ignorata.
useAcceptHeader tipo: boolean	Imposta su true per aggiungere i valori delle intestazioni della risposta Accept alla chiave della cache della voce della cache della risposta.
useResponseCacheHeaders tipo: boolean	Imposta il valore true per fare in modo che le intestazioni di risposta HTTP vengano prese in considerazione quando imposti la durata (TTL) della risposta nella cache.

cacheExpiry

Campo	Descrizione
expiryDate Tipo: object	Specifica la data di scadenza di una voce della cache.
timeOfDay Tipo: object	Specifica l'ora del giorno in cui una voce della cache deve scadere.
timeoutInSeconds Tipo: object	Specifica il numero di secondi dopo i quali una voce della cache deve scadere.

cacheKey

Campo	Descrizione
cacheKeyPrefix Tipo: string	Specifica un valore da utilizzare come prefisso della chiave cache.
fragments Tipo: object	Specifica un valore da includere nella chiave cache per creare uno spazio dei nomi per le richieste corrispondenti alle risposte memorizzate nella cache.