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: |
apim.googleapis.com/v1alpha1
|
kind
Tipo: |
APIProduct
|
metadata
|
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: |
Il nome del prodotto API. |
approvalType
Tipo: |
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 |
description
Tipo: |
Descrizione del prodotto API. |
displayName
Tipo: |
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 di risorse EnforcementRef da applicare al prodotto API. |
attributes
Tipo: |
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: |
Il nome della risorsa di destinazione. |
kind
Tipo: |
APIMExtensionPolicy
|
group
Tipo: |
L'APIGroup per l'operatore Apigee APIM, ovvero apim.googleapis.com .
|
namespace
Tipo: |
(Facoltativo) Lo spazio dei nomi del referente. Se non specificato, viene dedotto lo spazio dei nomi locale. |
Attributo
Campo | Descrizione |
---|---|
name
Tipo: |
La chiave dell'attributo. |
value
Tipo: |
Il valore dell'attributo. |
APIOperationSet
Campo | Descrizione |
---|---|
apiVersion
Tipo: |
apim.googleapis.com/v1alpha1
|
kind
Tipo: |
APIOperationSet
|
metadata
|
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 di definizioni di RESTOperation. |
apiProductRefs
Tipo: |
Array di risorse APIProductRef o riferimenti a prodotti API a cui devono essere applicate le operazioni REST. |
Quota
Campo | Descrizione |
---|---|
limit
Tipo: |
Numero di messaggi di richiesta consentiti per app dal prodotto API per interval
e timeUnit specificati.
|
interval
Tipo: |
Intervallo di tempo su cui viene calcolato il numero di messaggi di richiesta. |
timeUnit
Tipo: |
Unità di tempo definita per l'intervallo. I valori validi includono minute , hour ,
day o month .
|
RESTOperation
Campo | Descrizione |
---|---|
name
Tipo: |
Il nome dell'operazione REST. |
path
Tipo: |
In combinazione con methods , path è il percorso HTTP da associare a una quota
e/o a un prodotto API.
|
methods
Tipo: |
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: |
Il nome della risorsa di destinazione. |
kind
Tipo: |
APIProduct
|
group
Tipo: |
L'APIGroup per l'operatore Apigee APIM, ovvero apim.googleapis.com .
|
namespace
Tipo: |
(Facoltativo) Lo spazio dei nomi del referente. Se non specificato, viene dedotto lo spazio dei nomi locale. |
APIMExtensionPolicy
Campo | Descrizione |
---|---|
apiVersion
Tipo: |
apim.googleapis.com/v1alpha1
|
kind
Tipo: |
APIMExtensionPolicy |
metadata
|
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: |
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: |
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: |
Identifica la Google Cloud posizione in cui viene applicato APIMExtensionPolicy. |
ExtensionServerRef
Campo | Descrizione |
---|---|
name
Tipo: |
Il nome della risorsa di destinazione. |
kind
Tipo: |
Specifica il kind della risorsa target, ad esempio Gateway o Service .
|
group
Tipo: |
L'APIGroup per l'operatore Apigee APIM, ovvero apim.googleapis.com .
|
namespace
Tipo: |
(Facoltativo) Lo spazio dei nomi del referente. Se non specificato, viene dedotto lo spazio dei nomi locale. |
ApigeeGatewayPolicy
Campo | Descrizione |
---|---|
apiVersion
Tipo: |
apim.googleapis.com/v1alpha1 |
kind
Tipo: |
ApigeeGatewayPolicy |
metadata
|
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: |
apim.googleapis.com/v1alpha1 |
kind
Tipo: |
ApimTemplate |
metadata
|
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: |
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: |
Un elenco di risorse ConditionalParameterReference che specificano l'elenco ordinato dei criteri da eseguire nell'ambito del flusso di richieste. |
condition
Tipo: |
Specifica le condizioni per l'esecuzione di questa risorsa. |
ConditionalParameterReference
Campo | Descrizione |
---|---|
condition
|
Specifica le condizioni per l'esecuzione di questa risorsa. |
ApimTemplateRule
Campo | Descrizione |
---|---|
apiVersion
Tipo: |
apim.googleapis.com/v1alpha1 |
kind
Tipo: |
ApimTemplateRule |
metadata
|
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: |
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: |
apim.googleapis.com/v1alpha1 |
kind
Tipo: |
JavaScript |
metadata
|
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 di strings che specifica ProxyRequest o ProxyResponse . Determina se il criterio è collegato al flussi di richiesta o di risposta.
|
source
Tipo: |
Codice JavaScript in linea. |
timeLimit
Tipo: |
Specifica il timeout per l'esecuzione del codice JavaScript. |
SpikeArrest
Campo | Descrizione |
---|---|
apiVersion
Tipo: |
apim.googleapis.com/v1alpha1 |
kind
Tipo: |
SpikeArrest |
metadata
|
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 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: |
Se impostato su true true, 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 |
peakMessageRate
Campo | Descrizione |
---|---|
ref
Tipo: |
Variabile che fa riferimento al valore rate .
|
value
Tipo: |
Valore effettivo di rate se non è disponibile un riferimento.
|
AssignMessage (Google iniezione di token)
Campo | Descrizione |
---|---|
apiVersion
Tipo: |
apim.googleapis.com/v1alpha1 |
kind
Tipo: |
AssignMessage |
metadata
|
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 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, |
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: |
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 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: |
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: |
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: |
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: |
Per impostazione predefinita, useTargetUrl è false .
|
AssignToBean
Campo | Descrizione |
---|---|
createNew
Tipo: |
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: |
Specifica il tipo del nuovo messaggio quando CreateNew è impostato su true true.
I valori validi sono request o response.
|