Riferimento alle variabili di flusso

Questa pagina si applica ad Apigee e Apigee hybrid.

Visualizza documentazione di Apigee Edge.

Questa sezione fornisce informazioni di riferimento sulle variabili di flusso.

Apigee definisce le seguenti variabili di flusso:

apigee                 is                       request
apiproduct             loadbalancing            response
apiproxy               message                  route
client                 messageid                servicecallout
current                mint                     system
environment            organization             target
error                  proxy                    variable
fault                  publishmessage           
graphql                ratelimit

Ognuna di queste variabili è descritta nelle sezioni seguenti.

apigee

Una variabile helper che fornisce informazioni sul tempo di esecuzione del criterio.

Nella tabella seguente vengono descritte le proprietà della variabile apigee:

Proprietà Tipo Lettura/scrittura Descrizione Inizio dell'ambito
apigee.metrics.policy.policy_name.timeTaken Numero intero Sola lettura Il tempo, in nanosecondi, necessario per l'esecuzione del criterio. Norme

apiproduct

Una variabile di supporto che fornisce informazioni sui prodotti API.

La tabella seguente descrive le proprietà della variabile apiproduct:

Proprietà Tipo Lettura/scrittura Descrizione Inizio ambito
apiproduct.operation Stringa Sola lettura

Nome dell'operazione del prodotto API. Questa variabile consente di distinguere tra Impostazioni dei criteri per le quote e impostazioni delle quote relative al funzionamento di un prodotto API.

Ad esempio, my-operation.

 Richiesta proxy
apiproduct.operation.resource Stringa Sola lettura

Il nome della risorsa dell'operazione corrispondente a una richiesta.

 Richiesta proxy
apiproduct.operation.methods Array Sola lettura

Un array di metodi HTTP consentiti dall'operazione con corrispondenze.

 Richiesta proxy
apiproduct.operation.attributes.key_name Array Sola lettura

Recupera il valore dell'attributo personalizzato corrispondente a key_name.

 Richiesta proxy

Per ulteriori informazioni, consulta le seguenti risorse:

apiproxy

Descrive il proxy API.

Nella tabella seguente vengono descritte le proprietà della variabile apiproxy:

Proprietà Tipo Lettura/scrittura Descrizione Inizio ambito
apiproxy.name Stringa Sola lettura Nome del proxy API. Ad esempio, My Proxy. Richiesta proxy
apiproxy.revision Stringa Sola lettura Il numero di revisione di un proxy API. Ad esempio, 6. Richiesta proxy
apiproxy.basepath Stringa Sola lettura Il percorso base del deployment (specificato durante il deployment dell'API). Richiesta proxy

Per ulteriori informazioni sull'utilizzo dei proxy API, consulta Comprensione API e Proxy API.

client

L'applicazione o il sistema che ha inviato una richiesta al bilanciatore del carico.

Nella tabella seguente vengono descritte le proprietà della variabile client:

Proprietà Tipo Lettura/scrittura Descrizione Inizio dell'ambito
client.cn Stringa Sola lettura

Il nome comune specificato nel certificato TLS/SSL presentato dall'app client.

 Richiesta proxy
client.country Stringa Sola lettura

Il paese nel certificato TLS/SSL presentato dall'app client.

 Richiesta proxy
client.email.address Stringa Sola lettura

L'indirizzo email nel certificato TLS/SSL presentato dall'app client.

 Richiesta proxy
client.host Stringa Sola lettura

L'indirizzo IP dell'host HTTP associato alla richiesta ricevuta da ProxyEndpoint.

 Richiesta proxy
client.ip Stringa Sola lettura

L'indirizzo IP del client o del sistema che invia il messaggio al bilanciatore del carico. Ad esempio, potrebbe essere l'IP del client originale o l'IP di un bilanciatore del carico.

 Richiesta proxy
client.locality Stringa Sola lettura

La località (città) nel certificato TLS/SSL presentato dal client.

 Richiesta proxy
client.organization Stringa Sola lettura L'organizzazione nel certificato TLS/SSL presentato dal client. (Non necessariamente equivalente all'organizzazione su Apigee). Richiesta proxy
client.organization.unit Stringa Sola lettura

L'unità organizzativa nel certificato TLS/SSL presentato dal client.

 Richiesta proxy
client.port Numero intero Sola lettura

La porta HTTP associata alla richiesta del client di origine al ProxyEndpoint.

 Richiesta proxy
client.received.end.time Stringa Sola lettura

La data e l'ora, espresse in formato stringa, in cui il proxy ha terminato di ricevere la richiesta dal client di origine in ProxyEndpoint. Ad esempio: Wed, 21 Aug 2013 19:16:47 UTC.

Questo valore di tempo è la rappresentazione stringa del timestamp a 32 bit corrispondente quantità. Ad esempio, Wed, 21 Aug 2013 19:16:47 UTC corrisponde al valore del timestamp 1377112607413.

 Richiesta proxy
client.received.end.timestamp Lungo Sola lettura

Il valore del timestamp che specifica quando il proxy ha terminato di ricevere la richiesta dal il client di origine nel ProxyEndpoint. Questo valore è un numero intero a 64 bit (lungo) contenente il numero di millisecondi trascorsi dalla mezzanotte del 1° gennaio 1970 UTC.

 Richiesta proxy
client.received.start.time Stringa Sola lettura

L'ora, espressa in formato stringa, in cui il proxy ha iniziato a ricevere la richiesta dal client di origine in ProxyEndpoint. Ad esempio: Mer, 21 Aug 2013 19:16:47 UTC

Questo valore di tempo è la rappresentazione stringa del timestamp a 32 bit corrispondente quantità. Ad esempio, Wed, 21 Aug 2013 19:16:47 UTC corrisponde al valore del timestamp 1377112607413.

 Richiesta proxy
client.received.start.timestamp Lungo Sola lettura

Il valore del timestamp che specifica quando il proxy ha iniziato a ricevere la richiesta dal client di origine in ProxyEndpoint. Questo valore è un numero intero a 64 bit (long) contenente il numero di millisecondi trascorsi dalla mezzanotte del 1° gennaio 1970 UTC.

 Richiesta proxy
client.scheme Stringa Sola lettura

Restituisce HTTP o HTTPS a seconda del trasporto utilizzato dall'app client per inviare di richiesta di accesso.

 Richiesta proxy
client.sent.end.time Stringa Sola lettura

L'ora, espressa in formato stringa, in cui il proxy ha terminato l'invio della risposta. dal ProxyEndpoint al client. Ad esempio: Mer, 21 ago 2013 19:16:47 UTC.

Questo valore è una rappresentazione di stringa del corrispondente client.sent.end.timestamp a 32 bit. Ad esempio, Mer, 21 ago 2013 19:16:47 UTC corrisponde al valore timestamp di 1377112607413.

 PostClientFlow
client.sent.end.timestamp Lungo Sola lettura Il valore timestamp che specifica quando ProxyEndpoint ha terminato di restituire la risposta all'app client di origine. Questo valore è un numero intero a 64 bit (long) contenente il numero di millisecondi trascorsi dalla mezzanotte del 1° gennaio 1970 UTC. PostClientFlow
client.sent.start.time Stringa Sola lettura L'ora, espressa in formato stringa, in cui il ProxyEndpoint ha iniziato a restituire il all'app client di origine. Ad esempio, Mer, 21 ago 2013 19:16:47 UTC.

Questo valore è una rappresentazione di stringa del corrispondente client.sent.start.timestamp a 32 bit. Ad esempio, Mer, 21 ago 2013 19:16:47 UTC corrisponde al valore timestamp di 1377112607413.

 PostClientFlow
client.sent.start.timestamp Lungo Sola lettura Quando il proxy ha iniziato a inviare la risposta al client dal ProxyEndpoint. Questo valore è espresso come un numero intero a 64 bit (lungo) contenente il numero di millisecondi trascorsi dalla mezzanotte, il 1° gennaio 1970 UTC. PostClientFlow
client.ssl.enabled Stringa Sola lettura

true se il ProxyEndpoint è configurato per TLS/SSL; altrimenti false.

 Richiesta proxy
client.state Stringa Sola lettura

Lo stato nel certificato TLS/SSL presentato dal client.

 Richiesta proxy

current

Contiene informazioni sul flusso proxy API corrente.

La tabella seguente descrive le proprietà della variabile current:

Proprietà Tipo Lettura/scrittura Descrizione Inizio ambito
current.flow.name Stringa Sola lettura Il nome del flusso attualmente in esecuzione (ad esempio PreFlow, PostFlow o di un flusso condizionale). Richiesta proxy
current.flow.description Stringa Sola lettura La descrizione del flusso attualmente in esecuzione. Corrisponde al valore dell'elemento <Description> nella configurazione XML del flusso. Richiesta proxy

Puoi visualizzare queste proprietà nella visualizzazione Trace dell'interfaccia utente di Apigee.

environment

Un contenitore per la proprietà environment.name.

Nella tabella seguente vengono descritte le proprietà della variabile environment:

Proprietà Tipo Lettura/scrittura Descrizione Inizio dell'ambito
environment.name Stringa Sola lettura Nome dell'ambiente in cui è stata eseguita la transazione. Richiesta proxy

error

Un oggetto contestuale che rappresenta un messaggio di errore nel flusso di errori.

Nella tabella seguente vengono descritte le proprietà della variabile error:

Proprietà Tipo Lettura/scrittura Descrizione Inizio dell'ambito
error message Lettura/scrittura Errore di tipo message, che è un oggetto contestuale nel flusso di errori. Errore
error.content Stringa Lettura/scrittura Contenuto dell'errore. Errore
error.message Stringa Sola lettura

Messaggio associato a un errore il cui valore è disponibile solo prima dell'errore viene eseguito.

 Errore
error.status.code Numero intero Sola lettura

Il codice di stato HTTP associato all'errore. Ad esempio, 400.

 Errore
error.reason.phrase Stringa Sola lettura

La frase del motivo associata all'errore. Ad esempio: Bad Request.

 Errore
error.transport.message TransportMessage Sola lettura

Qualsiasi errore di tipo TransportMessage.

 Errore
error.state Numero intero Sola lettura

Stato nel flusso in cui si è verificato un errore.

 Errore
error.header.header_name Stringa Lettura/scrittura

Ottieni o imposta l'intestazione della risposta.

 Errore

fault

Fornisce informazioni sulla sorgente, sul motivo e sui dettagli di un errore di runtime. Apigee imposta queste variabili quando un criterio genera un errore e i valori sono specifici per ogni criterio. Per comprendere quando le variabili fault sono impostate, consulta Informazioni sugli errori dei criteri.

Proprietà Tipo Lettura/scrittura Descrizione Inizio dell'ambito
fault.name Stringa Sola lettura Il nome dell'errore, come descritto nella tabella Errori di runtime. incluso in ogni di riferimento alle norme. Questa variabile può essere utile nelle condizioni applicate a FaultRules. Errore
fault.reason Stringa Sola lettura Il motivo dell'errore. Ad esempio, quando le norme OASValidation rileva che una richiesta in entrata non è convalidata in base alla specifica OpenAPI, imposta questa variabile su una stringa che descriva il nome del criterio, il nome della specifica e dettagli che descrivono il motivo per cui la richiesta non è valida in base alla specifica. Altri criteri imposteranno questa variabile sui messaggi appropriati per i relativi errori. Errore
fault.category Stringa Sola lettura La categoria. Ad esempio, se l'errore si verifica in un passaggio del criterio, questa variabile potrebbe contenere il valore "Passaggio". Questa variabile può essere utile nelle condizioni applicate a FaultRules. Errore
fault.subcategory Stringa Sola lettura La sottocategoria. Ad esempio, se il criterio OASValidation rileva che una richiesta se non viene convalidata in base a una specifica OpenAPI, questa variabile verrà impostata su "OASValidationFailure". Questa variabile può essere utile nelle condizioni applicate a FaultRules. Errore

graphql

Ti consente di accedere ai risultati di una query GraphQL in fase di esecuzione. Per ulteriori informazioni, vedi Criterio GraphQL.

La tabella seguente descrive le proprietà della variabile graphql:

Proprietà Tipo Lettura/scrittura Descrizione
graphql Tipo complesso SOLA LETTURA/LETTURA SCRITTA La query GraphQL principale. AMBITO
graphql.fragment Tipo complesso SOLA LETTURA/LETTURA SCRITTA Un riferimento al frammento predefinito per questa query. AMBITO
graphql.fragment.count Numero intero Sola lettura Il numero di frament generati da questa query GraqhQL. AMBITO
graphql.fragment.INDEX.selectionSet.INDEX TIPO SOLA LETTURA/LETTURA/SCRITTURA Un riferimento al set di selezione nell'indice specificato. SCOPE
graphql.fragment.INDEX.selectionSet.INDEX.name Stringa SOLA LETTURA/LETTURA/SCRITTURA Il nome dell'insieme di selezioni nell'indice specificato. SCOPE
graphql.fragment.INDEX.selectionSet.count Numero intero Sola lettura Il numero di insiemi di selezione in questo frammento. SCOPE
graphql.fragment.INDEX.selectionSet.name Stringa SOLA LETTURA/LETTURA SCRITTA Il nome della selezione predefinita impostata nel frammento. SCOPE
graphql.operation Tipo complesso SOLA LETTURA/LETTURA/SCRITTURA Un riferimento all'operazione predefinita della query.

Non puoi impostare le quote a livello di operazione. Impostali invece a livello di ambiente.

 SCOPE
graphql.operation.name Stringa Sola lettura Il nome dell'operazione predefinita della query. AMBITO
graphql.operation.operationType Enumerazione Sola lettura Il tipo di operazione predefinita della query che può essere eseguita su questo proxy API. I valori possibili sono query, mutation o all. SCOPE
graphql.operation.selectionSet Tipo di complesso La selezione predefinita impostata per l'operazione predefinita della query. AMBITO
graphql.operation.selectionSet.count Numero intero Sola lettura Il numero di insiemi di selezione nell'operazione predefinita della query. AMBITO
graphql.operation.selectionSet.name Stringa Sola lettura Il nome dell'insieme di selezione predefinito dell'operazione predefinita della query. SCOPE
graphql.operation.selectionSet.INDEX Numero intero Sola lettura Un riferimento al set di selezione nell'indice specificato nell'elenco dei set di selezione. SCOPE
graphql.operation.selectionSet.INDEX.name Stringa Sola lettura Il nome della selezione nell'indice specificato nell'elenco dei set di selezione per questa operazione. SCOPE
graphql.operation.selectionSet.INDEX.[selectionSet] Tipo complesso SOLA LETTURA/LETTURA SCRITTA Uno o più oggetti dell'insieme di selezione aggiuntivi.

È possibile accedere in modo ricorsivo agli insiemi di selezione. Ad esempio, dopo un selectionSet.index, puoi avere un altro selectionSet.index anziché una proprietà name. Poi un altro e così via fino a raggiungere il valore <MaxCount> impostato nel criterio GraphQL.

SCOPE
graphql.operation.selectionSet.INDEX.directive Tipo complesso Un riferimento alla direttiva predefinita nell'insieme di selezione specificato. AMBITO
graphql.operation.selectionSet.INDEX.directive.count Tipo complesso SCOPE
graphql.operation.selectionSet.INDEX.directive.INDEX Numero intero Sola lettura Un riferimento all'istruzione nell'indice specificato. AMBITO
graphql.operation.selectionSet.INDEX.directive.INDEX.argument.INDEX Numero intero Sola lettura Un riferimento all'argomento nell'indice specificato. AMBITO
graphql.operation.selectionSet.INDEX.directive.INDEX.argument.INDEX.name Stringa Il nome dell'argomento nell'indice specificato. SCOPE
graphql.operation.selectionSet.INDEX.directive.INDEX.argument.INDEX.value Stringa Il valore dell'argomento nell'indice specificato. AMBITO
graphql.operation.selectionSet.INDEX.directive.name Stringa AMBITO
graphql.operation.variableDefinitions Tipo complesso Un riferimento a un elenco di definizioni di variabili per l'operazione predefinita della query. AMBITO
graphql.operation.variableDefinitions.count Numero intero Il numero di definizioni di variabili per l'operazione predefinita della query. AMBITO
graphql.operation.variableDefinitions.INDEX Numero intero Un riferimento alla definizione della variabile nell'indice specificato. AMBITO
graphql.operation.variableDefinitions.INDEX.name Stringa Il nome della definizione della variabile nell'indice specificato. SCOPE
graphql.operation.variableDefinitions.INDEX.type Il tipo del valore della definizione della variabile nell'indice specificato. AMBITO

is

Un contenitore per la proprietà is.error.

Nella tabella seguente vengono descritte le proprietà della variabile is:

Proprietà Tipo Lettura/scrittura Descrizione Inizio dell'ambito
is.error Booleano Sola lettura

Indicatore di errore.

 Richiesta proxy

loadbalancing

Fornisce informazioni sullo stato del bilanciamento del carico di TargetEndpoint.

La tabella seguente descrive le proprietà della variabile loadbalancing:

Proprietà Tipo Lettura/scrittura Descrizione Inizio dell'ambito
loadbalancing.failedservers Array di stringhe Sola lettura

Elenco di TargetServer non riusciti durante il bilanciamento del carico in TargetEndpoint.

 Risposta target
loadbalancing.isfallback Booleano Sola lettura

true se il fallback è abilitato per il TargetServer invocato durante il bilanciamento del carico in TargetEndpoint.

 Risposta target
loadbalancing.targetserver Stringa Sola lettura

TargetServer invocato durante il bilanciamento del carico in TargetEndpoint. Imposta solo se <Path> è impostato durante la definizione dell'elemento bilanciatore del carico.

 Risposta target

message

Un oggetto contestuale con lo stesso valore di request nel flusso di richiesta o di response nel flusso di risposta o di error nel flusso di errore.

La tabella seguente descrive le proprietà della variabile message:

Proprietà Tipo Lettura/scrittura Descrizione Inizio dell'ambito
message message Lettura/scrittura

Un oggetto contestuale con lo stesso valore di request nel flusso di richiesta o di response nel flusso di risposta o di error nel flusso di errore.

Richiesta proxy
message.content Stringa Lettura/scrittura

Contenuto della richiesta, della risposta o del messaggio di errore.

 Richiesta proxy
message.formparam.param_name Stringa Lettura/scrittura

Valore del parametro del modulo specificato.

 Richiesta proxy
message.formparam.param_name.
 values		 Raccolta Sola lettura

Tutti i valori del parametro del modulo specificato nel messaggio.

 Richiesta proxy
message.formparam.param_name.
 values.count		 Numero intero Sola lettura

Conteggio dei valori dei parametri del modulo specificati nel messaggio.

 Richiesta proxy
message.formparams.count Numero intero Sola lettura

Conteggio di tutti i parametri del modulo nel messaggio.

 Richiesta proxy
message.formparams.names Raccolta Sola lettura

Valore di tutti i parametri del modulo nel messaggio.

 Richiesta proxy
message.formparams.names.string Stringa Sola lettura

Un elenco separato da virgole di nomi di tutti i parametri del modulo presenti nel messaggio.

 Richiesta proxy
message.formstring Stringa Sola lettura

Valore della stringa del modulo nel messaggio.

 Richiesta proxy
message.header.header_name Stringa Lettura/scrittura

Consente di ottenere o impostare il valore di una determinata intestazione trovata nella richiesta. Se l'intestazione contiene una virgola, durante la lettura riceverai solo il segmento di testo fino alla prima virgola.

Ad esempio, se l'intestazione Cache-control è public, maxage=16544, il valore restituito da message.header.cache-control è public.

Se vuoi l'intera intestazione come stringa, utilizza una variabile come message.header.header_name.values.string.

 Richiesta proxy
message.header.header_name.N Stringa Lettura/scrittura

Il valore dell'N-esima intestazione specifica nel messaggio, richiesta o risposta, a seconda dello stato del flusso. Apigee divide i valori di testo delle intestazioni per virgole. L'indice inizia da 1 per il valore più a sinistra.

Ad esempio, se l'intestazione Cache-control è public,maxage=16544, il valore restituito da message.header.cache-control.2 è maxage=16544.

 Richiesta proxy
message.header.header_name.
 values		 Raccolta Sola lettura

Tutti i valori del nome dell'intestazione HTTP specificata nel messaggio.

 Richiesta proxy
message.header.header_name.
 values.count		 Numero intero Sola lettura

Conteggio dei valori del nome dell'intestazione HTTP specificato nel messaggio.

 Richiesta proxy
message.header.header_name.
 values.string		 Stringa Sola lettura

Tutti i valori di una determinata intestazione nel messaggio, sotto forma di una singola stringa.

Ad esempio, se l'intestazione Cache-control è public,maxage=16544, il valore restituito da message.header.cache-control.values.string è public,maxage=16544.

 Richiesta proxy
message.headers.count Numero intero Sola lettura

Conteggio di tutte le intestazioni HTTP nel messaggio.

 Richiesta proxy
message.headers.names Raccolta Sola lettura

Valore di tutte le intestazioni HTTP nel messaggio.

 Richiesta proxy
message.headers.names.string Stringa Sola lettura

Un elenco separato da virgole dei nomi di tutte le intestazioni del messaggio.

 Richiesta proxy
message.path Stringa Lettura/scrittura

Il percorso completo del messaggio di richiesta nell'URL senza eventuali parametri di ricerca.

Richiesta proxy
message.queryparam.param_name Stringa Sola lettura

Restituisce il parametro di query del messaggio specificato.

 Richiesta proxy
message.queryparam.param_name.N Stringa Lettura/scrittura

Il valore del parametro di query Nth nel messaggio. Ad esempio, se request.querystring è a=hello&a=world, il valore restituito di message.queryparam.a.1 è hello.

Come esempio di scrittura di più valori per un singolo nome di parametro di query, ad esempio type=siteid:1&type=language:us-en&type=currency:USD, imposta quanto segue:

  • Da message.queryparam.type.1 a siteid:1
  • Da message.queryparam.type.2 a language:en-us
  • Da message.queryparam.type.3 a currency:USD
 Richiesta proxy
message.queryparam.param_name.
 values		 Raccolta Sola lettura

Tutti i valori di un determinato parametro di query nel messaggio, formattato come elenco separato da virgole.

Ad esempio, se la stringa di query è a=hello&a=world, il valore di message.queryparam.a.values è ['hello', 'world']code>.

 Richiesta proxy
message.queryparam.param_name.
 values.count		 Numero intero Sola lettura

Il conteggio totale di un parametro di query specificato associato alla richiesta inviata al ProxyEndpoint dall'app client.

 Richiesta proxy
message.queryparams.count Numero intero Sola lettura

Il conteggio totale di tutti i parametri di query associati alla richiesta inviata a ProxyEndpoint dall'app client.

 Richiesta proxy
message.queryparams.names Raccolta Sola lettura

Un elenco di tutti i nomi dei parametri di query associati alla richiesta inviata al ProxyEndpoint dall'app client.

 Richiesta proxy
message.queryparams.names.string Stringa Sola lettura

Un elenco separato da virgole di nomi di tutti i parametri di ricerca presenti nel messaggio.

 Richiesta proxy
message.querystring Stringa Sola lettura

Una stringa contenente tutti i nomi dei parametri di query e i valori associati alla richiesta inviato al ProxyEndpoint dall'app client.

Ad esempio, per la richiesta http://api.apifactory.com/inventors?name=nick&surname=danger, il valore di message.querystring è name=nick&surname=danger.

 Richiesta proxy
message.status.code Numero intero Sola lettura

Codice di stato HTTP del messaggio di risposta dalla destinazione.

 Risposta target
message.transport.message TransportMessage Sola lettura

Messaggio di tipo TransportMessage, che è un oggetto contestuale.

 Richiesta proxy
message.uri Stringa Sola lettura

Il percorso dell'URI completo (segue l'URL del dominio) inclusi parametri di ricerca.

Ad esempio, per la richiesta http://api.apifactory.com/inventors?name=nikola&surname=tesla, questa variabile restituisce inventors?name=nikola&surname=tesla.

 Richiesta proxy
message.verb Stringa Sola lettura

Il verbo HTTP (GET, PUT, POST, DELETE e così via) associati alla richiesta.

 Richiesta proxy
message.version Stringa Lettura/scrittura

La versione HTTP associata alla richiesta inviata a ProxyEndpoint dal client un'applicazione.

 Richiesta proxy

Per ulteriori informazioni sui messaggi, consulta Riferimento per le funzioni dei modelli di messaggio.

messageid

Un contenitore per l'ID univoco globale della richiesta.

La tabella seguente descrive le proprietà della variabile messageid:

Proprietà Tipo Lettura/scrittura Descrizione Inizio dell'ambito
messageid Stringa Sola lettura

Contiene l'ID univoco globale per la richiesta, che include il nome host del bilanciatore del carico. Questo ID consente di monitorare le richieste ricevute dal bilanciatore del carico dopo che sono state inviate al gestore dei messaggi.

Questo ID viene registrato nei log degli errori di Apigee per correlare messageid agli errori.

 Richiesta proxy

mint

Una variabile di supporto che fornisce informazioni sulla monetizzazione.

Nella tabella seguente vengono descritte le proprietà della variabile mint:

Proprietà Tipo Lettura/scrittura Descrizione Inizio ambito
mint.limitscheck.is_request_blocked Booleano Sola lettura

Flag che specifica se la richiesta API è bloccata. Imposta su true se is_subscription_found è false.

Questa variabile di flusso è disponibile se il criterio MonetizationLimitsCheck è associato al proxy API. Consulta l'articolo Applicare i limiti di monetizzazione nei proxy API.

 Richiesta proxy
mint.limitscheck.is_subscription_found Booleano Sola lettura

Flag che specifica se lo sviluppatore ha un abbonamento attivo al prodotto API. Imposta su true se uno sviluppatore ha un abbonamento.

Questa variabile di flusso è disponibile se il criterio MonetizationLimitsCheck è associato al proxy API. Consulta Applicare i limiti di monetizzazione nei proxy API.

 Richiesta proxy
mint.limitscheck.prepaid_developer_balance Numerico Sola lettura

Saldo attuale nel portafoglio dell'account prepagato dello sviluppatore associato alla valuta del piano tariffario.

 Richiesta proxy
mint.limitscheck.prepaid_developer_currency Stringa Sola lettura

Valuta del saldo disponibile nella variabile mint.limitscheck.prepaid_developer_balance.

 Richiesta proxy
mint.limitscheck.purchased_product_name Stringa Sola lettura

Nome del prodotto API associato.

Questa variabile di flusso è disponibile se la norma MonetizationLimitsCheck è collegata al proxy API. Consulta l'articolo Applicare i limiti di monetizzazione nei proxy API.

 Richiesta proxy
mint.limitscheck.status_message Stringa Sola lettura

Informazioni aggiuntive sull'esecuzione del criterio MonetizationLimitsCheck a scopo di debug.

Questa variabile di flusso è disponibile se la norma MonetizationLimitsCheck è collegata al proxy API. Consulta Applicare i limiti di monetizzazione nei proxy API.

 Richiesta proxy
mint.mintng_consumption_pricing_rates Stringa Sola lettura

Tariffe basate sul consumo.

Imposta le commissioni durante la creazione di un piano tariffario.

 PostClientFlow
mint.mintng_consumption_pricing_type Stringa Sola lettura

Tipo di prezzo basato sul consumo. Ad esempio: FIXED_PER_UNIT

Impostare le tariffe basate sul consumo quando crei un piano tariffario.

 PostClientFlow
mint.mintng_currency Stringa Sola lettura

Valuta per il calcolo delle entrate.

Questa variabile di flusso ha il valore della variabile di monetizzazione currency.

 Criterio Data Capture
mint.mintng_dev_share Numerico Sola lettura

Le entrate da condividere con lo sviluppatore.

Imposta le entrate da condividere con lo sviluppatore quando crei un piano tariffario.

 PostClientFlow
mint.mintng_is_apiproduct_monetized Booleano Sola lettura

Flag che specifica se il prodotto API è attualmente monetizzato (ossia, se è attivo un piano tariffario).

Questa variabile di flusso viene aggiunta dal criterio VerifyAPIKey o VerifyAccessToken associato al proxy API. Consulta Aggiungere un criterio di autenticazione.

 Richiesta proxy
mint.mintng_price Numerico Sola lettura

Entrate per il calcolo della quota dello sviluppatore.

La variabile di flusso ha il valore della variabile di monetizzazione revShareGrossPrice.

 Criteri Data Capture e PostClientFlow
mint.mintng_price_multiplier Numerico Sola lettura

Fattore (moltiplicatore) per cui viene moltiplicato il costo per transazione.

La variabile di flusso ha il valore della variabile di monetizzazione perUnitPriceMultiplier.

 Norme DataCapture e PostClientFlow
mint.mintng_rate Numerico Sola lettura

Tariffa addebitata per la chiamata API.

Questa variabile di flusso mostra la tariffa basata sul consumo per chiamata API. Impostare la tariffa basata sul consumo quando crei un piano tariffario. Se hai configurato la variabile di monetizzazione perUnitPriceMultiplier nel criterio DataCapture, Apigee calcola il costo della transazione dopo aver considerato il valore della variabile perUnitPriceMultiplier. Per ulteriori informazioni, consulta Api price multiplier in Metriche.

 PostClientFlow
mint.mintng_rate_before_multipliers Numerico Sola lettura

Tariffa addebitata per la chiamata API senza il calcolo di perUnitPriceMultiplier.

Se il criterio Data Capture acquisisce perUnitPriceMultiplier variabile monetizzazione, questa variabile di flusso mostra il costo della transazione prima della moltiplicazione il costo di perUnitPriceMultiplier.

 PostClientFlow
mint.mintng_rate_plan_id Stringa Sola lettura

ID del piano tariffario.

Questa variabile di flusso viene aggiunta dal criterio VerifyAPIKey o VerifyAccessToken associato al proxy API. Vedi Aggiunta di un criterio di autenticazione.

 Richiesta proxy
mint.mintng_revenue_share_rates Stringa Sola lettura

Percentuali relative alla quota di condivisione delle entrate.

Imposta la percentuale di condivisione delle entrate durante la creazione di un piano tariffario.

 PostClientFlow
mint.mintng_revenue_share_type Stringa Sola lettura

Tipo di quota di condivisione delle entrate. Ad esempio: FIXED

Imposta il tipo di quota di condivisione delle entrate quando crei un piano tariffario.

 PostClientFlow
mint.mintng_tx_success Booleano Sola lettura

Specifica se la transazione è monetizzata.

Questa variabile di flusso ha il valore della variabile di monetizzazione transactionSuccess.

 Criterio Data Capture
mint.prepaid_updated_developer_usage Numerico Sola lettura

Utilizzo corrente dello sviluppatore prepagato.

L'utilizzo viene calcolato in base alla configurazione del piano tariffario e al valore della variabile di monetizzazione perUnitPriceMultiplier.

 PostClientFlow
mint.rateplan_end_time_ms Numerico Sola lettura

Tempo di scadenza del piano tariffario in millisecondi dall'epoca.

Questa variabile di flusso viene aggiunta dal criterio VerifyAPIKey o VerifyAccessToken collegato al proxy API. Vedi Aggiunta di un criterio di autenticazione.

 Richiesta proxy
mint.rateplan_start_time_ms Numerico Sola lettura

Tempo di attivazione del piano tariffario in millisecondi dall'epoca.

Questa variabile di flusso viene aggiunta dal criterio VerifyAPIKey o VerifyAccessToken associato al proxy API. Vedi Aggiunta di un criterio di autenticazione.

 Richiesta proxy
mint.status Stringa Sola lettura

Stato della chiamata monetizzata. Compilato solo in caso di errore.

 PostClientFlow
mint.status_code Numerico Sola lettura

Codice di stato HTTP della chiamata monetizzata. Compilato solo in caso di errore.

 PostClientFlow
mint.subscription_end_time_ms Numerico Sola lettura

Scadenza dell'abbonamento al prodotto API in millisecondi dall'epoca.

Questa variabile di flusso è disponibile se il criterio MonetizationLimitsCheck è associato al proxy API. Consulta Applicare i limiti di monetizzazione nei proxy API.

 Richiesta proxy
mint.subscription_start_time_ms Numerico Sola lettura

Tempo di attivazione dell'abbonamento al prodotto API in millisecondi dall'epoca.

Questa variabile di flusso è disponibile se la norma MonetizationLimitsCheck è collegata al proxy API. Consulta Applicare i limiti di monetizzazione nei proxy API.

 Richiesta proxy
mint.tx_success_result Booleano Sola lettura

Indica se la monetizzazione è andata a buon fine per la transazione.

La variabile mint.tx_success_result può avere i seguenti valori:

  • tx_success impostato su true: la variabile transactionSuccess è true e la transazione è monetizzata. Poiché la transazione è monetizzata, vengono calcolati i valori delle variabili mint.mintng_rate e mint.mintng_dev_share.
  • tx_success impostata su false: la variabile transactionSuccess è false e la transazione non è monetizzata. Poiché la transazione non è monetizzata, i valori delle variabili mint.mintng_rate e mint.mintng_dev_share non vengono calcolati.
  • tx_success non trovato. Il codice di stato del messaggio non era 2xx: la variabile transactionSuccess non viene acquisita e il codice di stato HTTP (message.status.code) della transazione non è 2xx. La transazione non è monetizzata.
  • tx_success non trovato. Il codice di stato del messaggio era 2xx: la variabile transactionSuccess non è e il codice di stato HTTP (message.status.code) della transazione è 2xx. La transazione è monetizzata.
 PostClientFlow

Per ulteriori informazioni, consulta le seguenti risorse:

organization

Un contenitore per la proprietà organization.name.

Nella tabella seguente vengono descritte le proprietà della variabile organization:

Proprietà Tipo Lettura/scrittura Descrizione Inizio ambito
organization.name Stringa Sola lettura

Nome dell'organizzazione.

 Richiesta proxy

Per saperne di più sulle organizzazioni, vedi Comprensione per le organizzazioni.

proxy

La configurazione del proxy API.

La tabella seguente descrive le proprietà della variabile proxy:

Proprietà Tipo Lettura/scrittura Descrizione Inizio ambito
proxy.basepath Stringa Sola lettura

Il valore del percorso base nella configurazione dell'endpoint del proxy API. Il percorso di base è il frammento URI più a sinistra che segue l'host nell'URL. Gli URI del flusso condizionale seguono il percorso di base.

Supponiamo che tu abbia un endpoint proxy API configurato con un percorso base /v2/weatherapi. (Vedi Configurazione degli endpoint proxy per maggiori dettagli.) In questo caso, se la richiesta in entrata utilizza l'URL https://myhost.example.net/v2/weatherapi/forecastrss?w=12797282:

  • Il nome host è myhost.example.net. Puoi recuperarlo leggendo la variabile request.header.host.
  • Il percorso di base è /v2/weatherapi. Recuperalo leggendo la variabile proxy.basepath.
  • Il suffisso del percorso è /forecastrss. Recuperalo leggendo la variabile proxy.pathsuffix.

Se definisci un percorso di base dinamico nella configurazione del proxy API, come /v2/*/weatherapicode>, poi la variabile proxy.basepath è impostato sul percorso dinamico. Per recuperare l'URL effettivo della richiesta, leggi e analizza la variabile proxy.url.

 Richiesta proxy
proxy.client.ip Stringa Sola lettura

L'indirizzo X-Forwarded-For della chiamata in entrata, ossia Indirizzo IP ricevuto da Apigee dall'ultimo handshake TCP esterno. Potrebbe trattarsi del client chiamante o di un bilanciatore del carico.

 Richiesta proxy
proxy.name Stringa Sola lettura

L'attributo name configurato per ProxyEndpoint.

 Richiesta proxy
proxy.pathsuffix Stringa Sola lettura

Il valore del suffisso del percorso nell'URL inviato dal client e ricevuto in ProxyEndpoint.

basepath è il componente del percorso più a sinistra che identifica in modo univoco un proxy API all'interno un gruppo di ambienti. Supponi di avere un endpoint API Proxy configurato con un percorso di base di /v2/weatherapi. In questo caso, una richiesta inviata a https://myhost.example.net/v2/weatherapi/forecastrss?w=12797282, la variabile proxy.pathsuffix conterrà la stringa /forecastrss.

 Richiesta proxy
proxy.url Stringa Sola lettura

Restituisce l'URL completo associato alla richiesta proxy ricevuta dal ProxyEndpoint, inclusi eventuali parametri di ricerca presenti.

 Richiesta proxy

Per ulteriori informazioni sull'utilizzo dei proxy API, consulta Comprensione delle API e Proxy API.

publishmessage

Viene compilato quando viene eseguita la norma PublishMessage.

Proprietà Tipo Lettura/scrittura Descrizione Inizio dell'ambito
publishmessage.message.id Stringa Sola lettura Restituisce messageId (ID del messaggio pubblicato) dal server Pub/Sub.

Apigee imposta questa variabile di flusso solo se la richiesta di pubblicazione ha esito positivo.

 Richiesta proxy

ratelimit

Compilato quando viene eseguito un criterio Quota o SpikeArrest.

La tabella seguente descrive le proprietà della variabile ratelimit:

Proprietà Tipo Lettura/scrittura Descrizione Inizio dell'ambito
ratelimit.policy_name.allowed.count Lungo Sola lettura Restituisce il conteggio della quota consentito. PostClientFlow
ratelimit.policy_name.used.count Lungo Sola lettura Restituisce la quota corrente utilizzata all'interno di un intervallo di quota. PostClientFlow
ratelimit.policy_name.available.count Lungo Sola lettura Restituisce il numero di quote disponibili nell'intervallo di quota. PostClientFlow
ratelimit.policy_name.exceed.count Lungo Sola lettura Restituisce 1 dopo il superamento della quota. PostClientFlow
ratelimit.policy_name.total.exceed.count Lungo Sola lettura Restituisce 1 dopo il superamento della quota. PostClientFlow
ratelimit.policy_name.expiry.time Lungo Sola lettura

Restituisce l'ora UTC (in millisecondi), che determina la scadenza della quota e l'inizio del nuovo intervallo di quota.

Quando il tipo del criterio di quota è rollingwindow, questo valore non è valido perché l'intervallo di quota non scade mai.

 PostClientFlow
ratelimit.policy_name.identifier Stringa Sola lettura Restituisce il riferimento all'identificatore (client) associato al criterio PostClientFlow
ratelimit.policy_name.class Stringa Sola lettura Restituisce la classe associata all'identificatore client PostClientFlow
ratelimit.policy_name.class.allowed.count Lungo Sola lettura Restituisce il numero di quote consentite definito nella classe PostClientFlow
ratelimit.policy_name.class.used.count Lungo Sola lettura Restituisce la quota utilizzata all'interno di un corso PostClientFlow
ratelimit.policy_name.class.available.count Lungo Sola lettura Restituisce il numero di quote disponibili nel corso PostClientFlow
ratelimit.policy_name.class.exceed.count Lungo Sola lettura Restituisce il conteggio delle richieste che supera il limite nella classe nella classe intervallo quota attuale PostClientFlow
ratelimit.policy_name.class.total.exceed.count Lungo Sola lettura Restituisce il conteggio totale delle richieste che supera il limite nella classe in tutte intervalli di quota, pertanto è la somma di class.exceed.count per intervalli di quota. PostClientFlow
ratelimit.policy_name.failed Booleano Sola lettura

Indica se il criterio ha avuto esito positivo o meno (true o false).

 PostClientFlow

Per ulteriori informazioni, consulta le seguenti risorse:

request

La richiesta completa, inclusi eventuali payload presenti.

Per ulteriori informazioni sui dati della richiesta, consulta In che modo vengono passati i dati delle richieste al server di backend?

Nella tabella seguente vengono descritte le proprietà della variabile request:

Proprietà Tipo Lettura/scrittura Descrizione Inizio dell'ambito
request message Sola lettura

La richiesta completa, inclusi eventuali payload presenti.

 Richiesta proxy
request.content Stringa Lettura/scrittura

Ottiene o imposta il payload del messaggio di richiesta.

 Richiesta proxy
request.formparam.param_name Stringa Lettura/scrittura

Recupera o imposta il valore del parametro del modulo specificato nella richiesta inviata dall'applicazione client.

 Richiesta proxy
request.formparam.param_name.
 values		 Raccolta Sola lettura

Tutti i valori di un particolare parametro di modulo nella richiesta, formattati come elenco separato da virgole.

Ad esempio, se il payload è a=hello&x=greeting&a=world, poi il valore di request.formparam.a.values è ['hello', 'world'].

 Richiesta proxy
request.formparam.param_name.
 values.count		 Numero intero Sola lettura

Conteggio di tutti i valori per il parametro del modulo specificato associato alla richiesta.

 Richiesta proxy
request.formparam.param_name.N Stringa Lettura/scrittura

Il valore dell'ennesimo parametro del modulo nel messaggio. Ad esempio, se la stringa del modulo è a=hello&a=world, il valore restituito di request.formparam.a.1 è hello.

 Richiesta proxy
request.formparams.count Numero intero Sola lettura

Conteggio di tutti i parametri associati alla richiesta inviata dall'applicazione client.

 Richiesta proxy
request.formparams.names Raccolta Sola lettura

Un elenco di tutti i nomi di tutti i parametri associati alla richiesta.

 Richiesta proxy
request.formparams.names.string Stringa Sola lettura

Un elenco separato da virgole di tutti i nomi dei parametri del modulo associati alla richiesta.

 Richiesta proxy
request.formstring Stringa Sola lettura

Il valore formparam completo nella richiesta inviata dall'app client.

Ad esempio, name=test&type=first&group=A.

 Richiesta proxy
request.grpc.rpc.name Stringa Sola lettura

Applicabile solo con un server di destinazione gRPC. Il nome RPC. Per informazioni sui proxy gRPC, consulta Creare proxy per le API gRPC.

Richiesta proxy
request.grpc.service.name Stringa Sola lettura

Applicabile solo se utilizzi un server target gRPC. Il nome del servizio di stato gRPC. Per informazioni su gRPC per i proxy, consulta Creazione di proxy API gRPC.

Richiesta proxy
request.header.header_name Stringa Lettura/scrittura

Consente di ottenere o impostare il valore di una determinata intestazione trovata nella richiesta. Se l'intestazione contiene una virgola, durante la lettura riceverai solo il segmento di testo fino alla prima virgola.

Ad esempio, se l'intestazione Cache-control è public, maxage=16544, il valore restituito di request.header.cache-control è public.

Se vuoi che l'intera intestazione sia come stringa, utilizza una variabile come request.header.header_name.values.string.

 Richiesta proxy
request.header.header_name.N Stringa Lettura/scrittura

Il valore dell'N-esimo valore dell'intestazione nella richiesta. Apigee suddivide i valori del testo dell'intestazione con virgole. L'indice inizia da 1 per il valore più a sinistra.

Ad esempio, se l'intestazione Cache-control è public, maxage=16544, il valore restituito di request.header.cache-control.2 è maxage=16544.

 Richiesta proxy
request.header.header_name.
 values		 Raccolta Sola lettura

Tutti i valori di una determinata intestazione nella richiesta.

 Richiesta proxy
request.header.header_name.
 values.count		 Numero intero Sola lettura

Conteggio di tutti i valori di una determinata intestazione nella richiesta.

 Richiesta proxy
request.header.header_name.
 values.string		 Stringa Sola lettura

Tutti i valori di una determinata intestazione nella richiesta, sotto forma di una singola stringa.

Ad esempio, se l'intestazione Cache-control è public, maxage=16544, il valore restituito di request.header.cache-control.values.string è public, maxage=16544.

 Richiesta proxy
request.headers.count Numero intero Sola lettura

Conteggio di tutte le intestazioni nella richiesta.

 Richiesta proxy
request.headers.names Raccolta Sola lettura

Nomi di tutte le intestazioni nella richiesta.

 Richiesta proxy
request.headers.names.string Stringa Sola lettura

Un elenco separato da virgole di nomi di tutte le intestazioni della richiesta.

 Richiesta proxy
request.path Stringa Sola lettura

Il percorso della risorsa senza proxy (escluso l'host) al servizio di backend, esclusi i parametri di query.

Ad esempio, se l'URI del servizio di backend è https://example.com/rest/api/latest, il valore di request.path è /rest/api/latest.

 Richiesta proxy
request.queryparam.param_name Stringa Lettura/scrittura

Il valore di un determinato parametro di query trovato nella richiesta.

 Richiesta proxy
request.queryparam.param_name.N Stringa Lettura/scrittura

Il valore del parametro di query Nth nella richiesta.

Ad esempio, se request.querystring è a=hello&a=world, il valore restituito di is request.queryparam.a.1 è hello.

Ecco un esempio di scrittura di più valori per un singolo nome di parametro di query, come type=siteid:1&type=language:us-en&type=currency:USD, imposta quanto segue:

  • Da request.queryparam.type.1 a siteid:1
  • Da request.queryparam.type.2 a language:en-us
  • Da request.queryparam.type.3 a currency:USD
 Richiesta proxy
request.queryparam.param_name.
 values		 Raccolta Sola lettura

Tutti i valori di un determinato parametro di query nella richiesta, formattati come elenco separato da virgole.

Ad esempio, se request.querystring è a=hello&b=lovely&a=world, il valore di request.queryparam.a.values è ['hello', 'world'].

 Richiesta proxy
request.queryparam.param_name.
 values.count		 Numero intero Sola lettura

Il conteggio di tutti i valori di un particolare parametro di query nella richiesta.

 Richiesta proxy
request.queryparams.count Numero intero Sola lettura

Il conteggio di tutti i parametri di query nella richiesta.

 Richiesta proxy
request.queryparams.names Raccolta Sola lettura

I nomi di tutti i parametri di query nella richiesta.

 Richiesta proxy
request.queryparams.names.string Stringa Sola lettura

Un elenco separato da virgole dei nomi di tutti i parametri di ricerca nella richiesta.

 Richiesta proxy
request.querystring Stringa Sola lettura

L'elenco completo dei parametri di query nella richiesta inviata dall'app client.

Ad esempio, se la richiesta è http://host.com/123?name=first&surname=second&place=address, questa variabile restituisce name=first&surname=second&place=address.

 Richiesta proxy
request.transportid Stringa Sola lettura

ID della richiesta, di tipo TransportMessage, contestuale.

 Richiesta proxy
request.transport.message Messaggio di trasporto Sola lettura

Richiesta di tipo TransportMessage che è contestuale.

 Richiesta proxy
request.uri Stringa Sola lettura

In un proxy API, il proxy <BasePath> in ProxyEndpoint (oltre all'URL di base del proxy) viene mappato all'URL del servizio di destinazione in TargetEndpoint. Ad esempio:

<ProxyEndpoint>
...
  <BasePath>/my-mock-proxy</BasePath>

Rimanda a

<TargetEndpoint>
...
  <HTTPTargetConnection>
    http://mocktarget.apigee.net
  </HTTPTargetConnection>

Nella richiesta, request.uri è il percorso di base del proxy + il resto dell'indirizzo, inclusi i parametri di ricerca.

Nella risposta, request.uri è il resto della inclusi i parametri di ricerca, dopo HTTPTargetConnection.

La differenza sta nel fatto che la richiesta originale è arrivata al proxy, ma poi il proxy invia un'altra richiesta al servizio di destinazione.

Supponiamo che venga effettuata la seguente chiamata al nostro proxy di esempio, che ha un percorso di base di /my-mock-proxy:

http://my_org-test.apigee.net/my-mock-proxy/user?user=Dude

E il proxy chiama:

http://mocktarget.apigee.net

che aggiunge /user?user=Dude all'URL.

  • Richiesta: request.uri = /my-mock-proxy/user?user=Dude
  • Risposta: request.uri = /user?user=Dude
 Richiesta proxy (diversa nella risposta)
request.url Stringa Sola lettura

L'URL completo della richiesta inviata all'endpoint di destinazione, inclusi i parametri della stringa di query, ma non il numero di porta (se specificato).

Ad esempio, se effettui una chiamata a un proxy di esempio http://my_org-test.apigee.net/my-mock-proxy/user?user=Dude e l'endpoint di destinazione è http://example.com:8080, il valore è:

  • Richiesta: n/d
  • Risposta: http://example.com/user?user=Dude
 Risposta target
request.verb Stringa Sola lettura

Il verbo HTTP utilizzato per la richiesta. Ad esempio, GET, PUT e DELETE.

 Richiesta proxy
request.version Stringa Sola lettura

La versione HTTP della richiesta. Ad esempio, 1.1.

 Richiesta proxy

response

La risposta completa, incluso qualsiasi payload presente.

Nella tabella seguente vengono descritte le proprietà della variabile response:

Proprietà Tipo Lettura/scrittura Descrizione Inizio dell'ambito
response message Lettura/scrittura

Messaggio di risposta completo restituito dal target.

 Risposta target
response.content Stringa Lettura/scrittura

Contenuti del payload del messaggio di risposta restituito dalla destinazione.

 Risposta target
response.header.header_name Stringa Lettura/scrittura

Recupera o imposta il valore di un'intestazione HTTP specificata nella risposta.

Se il testo dell'intestazione include una virgola, Apigee deduce più valori. In questo caso, response.header.header_name restituisce solo il primo valore.

Ad esempio, se l'intestazione Cache-control è public,maxage=16544, il valore restituito di response.header.cache-control è public.

Se vuoi l'intera intestazione come stringa, utilizza una variabile come response.header.header_name.values.string.

 Risposta target
response.header.header_name.
 values		 Raccolta Sola lettura

Tutti i valori di un'intestazione HTTP specificata nella risposta.

 Risposta target
response.header.header_name.
 values.count		 Numero intero Sola lettura

Conteggio di tutti i valori dell'intestazione HTTP specificata nella risposta.

 Risposta target
response.header.header_name.
 values.string		 Stringa Sola lettura

Tutti i valori di una determinata intestazione nella risposta, sotto forma di una singola stringa.

Ad esempio, se l'intestazione Cache-control è public,maxage=16544, il valore restituito da response.header.cache-control.values.string è public,maxage=16544.

 Risposta target
response.header.header_name.N Stringa Lettura/scrittura

Il valore dell'ennesima intestazione specifica nella risposta. Apigee suddivide i valori del testo dell'intestazione con virgole. L'indice inizia da 1 per il valore più a sinistra.

Ad esempio, se l'intestazione Cache-control è public,maxage=16544, dopodiché torna response.header.cache-control.2 maxage=16544.

 Risposta target
response.headers.count Numero intero Sola lettura

Conteggio di tutte le intestazioni nella risposta.

 Risposta target
response.headers.names Raccolta Sola lettura

I nomi di tutte le intestazioni della risposta.

 Risposta target
response.headers.names.string Stringa Sola lettura

Un elenco separato da virgole dei nomi di tutte le intestazioni nella risposta.

 Risposta target
response.reason.phrase Stringa Lettura/scrittura

La frase del motivo della risposta per una determinata richiesta.

 Risposta target
response.status.code Numero intero Lettura/scrittura

Il codice di risposta restituito per una richiesta. Puoi utilizzare questa variabile per eseguire l'override codice di stato della risposta, memorizzato in message.status.code. Per saperne di più, consulta message.

 Risposta target
response.transport.message Stringa Sola lettura

Risposta di tipo TransportMessage, che è un oggetto contestuale.

 Risposta target

route

Specifica i nomi di <RouteRule> e TargetEndpoint.

La tabella seguente descrive le proprietà della variabile route:

Proprietà Tipo Lettura/scrittura Descrizione Inizio ambito
route.name Stringa Sola lettura

Il nome del <RouteRule> che è stato eseguito nel ProxyEndpoint. Ad esempio: default. Una regola di routing fa riferimento a un endpoint di destinazione del proxy API da eseguire.

 Richiesta target
route.target Stringa Sola lettura

Il nome di TargetEndpoint che è stato eseguito. Ad esempio, default.

 Richiesta target

servicecallout

Descrive il TargetEndpoint per un criterio ServiceCallout.

Nella tabella seguente vengono descritte le proprietà della variabile servicecallout:

Proprietà Tipo Lettura/scrittura Descrizione Inizio ambito
servicecallout.policy_name.expectedcn Stringa Lettura/scrittura

Il nome comune previsto dell'endpoint target come indicato in un Norme relative a ServiceCallout. Questo valore è significativo solo quando TargetEndpoint fa riferimento a un endpoint TLS/SSL.

 Richiesta proxy
servicecallout.policy_name.target.url Stringa Lettura/scrittura

L'URL TargetEndpoint per uno specifico criterio ServiceCallout.

 Richiesta proxy
servicecallout.requesturi Stringa Lettura/scrittura

L'URI TargetEndpoint per un criterio ServiceCallout. L'URI è URL TargetEndpoint senza il protocollo e la specifica del dominio.

 Richiesta proxy

system

Specifica l'indirizzo IP del sistema, nonché i dettagli sul proxy.

La tabella seguente descrive le proprietà della variabile system:

Proprietà Tipo Lettura/scrittura Descrizione Inizio ambito
system.interface.interface_name Stringa Sola lettura

Indirizzo IP del sistema.

 Richiesta proxy
system.pod.name Stringa Sola lettura

Il nome del pod in cui è in esecuzione il proxy.

 Richiesta proxy
system.region.name Stringa Sola lettura

Il nome del data center regione in cui è in esecuzione il proxy.

 Richiesta proxy
system.time Stringa Sola lettura

L'ora in cui è stata letta questa variabile. Ad esempio, Wed, 21 Aug 2013 19:16:47 GMT.

Questo valore è la rappresentazione stringa del valore corrispondente di system.timestamp. Ad esempio, Wed, 21 Aug 2013 19:16:47 GMT corrisponde al valore del timestamp 1377112607413.

 Richiesta proxy
system.time.year Numero intero Sola lettura

La parte relativa all'anno di system.time.

 Richiesta proxy
system.time.month Numero intero Sola lettura

La parte relativa al mese di system.time.

 Richiesta proxy
system.time.day Numero intero Sola lettura

La parte del giorno del mese di system.time.

 Richiesta proxy
system.time.dayofweek Numero intero Sola lettura

La parte del giorno della settimana di system.time.

 Richiesta proxy
system.time.hour Numero intero Sola lettura

La parte oraria di system.time.

 Richiesta proxy
system.time.minute Numero intero Sola lettura

La parte in minuti di system.time.

 Richiesta proxy
system.time.second Numero intero Sola lettura

La seconda parte di system.time.

 Richiesta proxy
system.time.millisecond Numero intero Sola lettura

La parte in millisecondi di system.time.

 Richiesta proxy
system.time.zone Stringa Sola lettura

Fuso orario del sistema.

 Richiesta proxy
system.timestamp Lungo Sola lettura

L'intero a 64 bit (long) che rappresenta il momento in cui questa variabile è stata letta. Il valore è il numero di millisecondi trascorsi dalla mezzanotte del 1° gennaio 1970 UTC. Ad esempio: 1534783015000.

 Richiesta proxy
system.uuid Stringa Sola lettura

L'UUID del processore di messaggi che gestisce il proxy.

 Richiesta proxy

target

Descrive il target della richiesta.

Nella tabella seguente vengono descritte le proprietà della variabile target:

Proprietà Tipo Lettura/scrittura Descrizione Inizio ambito
target.basepath Stringa Sola lettura

Il percorso della risorsa (escluso il dominio) al servizio di destinazione, esclusa la query definito nel TargetEndpoint del proxy.

Ad esempio, supponiamo che un proxy API chiami il seguente target:

<TargetEndpoint name="default">
...
  <HTTPTargetConnection>
    <URL>http://mocktarget.apigee.net/user?user=Dude</URL>
  </HTTPTargetConnection>

In questo esempio, il target.basepath è /user.

Se il target fosse:

<TargetEndpoint name="default">
...
  <HTTPTargetConnection>
    <URL>http://mocktarget.apigee.net</URL>
  </HTTPTargetConnection>

Il valore target.basepath sarebbe nullo.

 Richiesta target
target.copy.pathsuffix Booleano Lettura/scrittura

Quando true, la richiesta inoltrata da ProxyEndpoint a TargetEndpoint conserva il percorso (il frammento di percorso dell'URI che segue l'URI definito nella base ProxyEndpoint ).

 Richiesta target
target.copy.queryparams Booleano Lettura/scrittura

Quando true, la richiesta inoltrata da ProxyEndpoint a TargetEndpoint conserva i parametri di query.

 Richiesta target
target.country Stringa Sola lettura

Paese del certificato TLS/SSL presentato dal server di destinazione

 Risposta target
target.cn Stringa Sola lettura

Il nome comune del TargetEndpoint. Questo valore è significativo solo quando TargetEndpoint fa riferimento a un endpoint TLS/SSL.

 Richiesta target
target.email.address Stringa Sola lettura

Indirizzo email del certificato TLS/SSL presentato dal server di destinazione

 Risposta target
target.expectedcn Stringa Lettura/scrittura

Il nome comune previsto dell'endpoint target. Ciò è significativo solo quando TargetEndpoint fa riferimento a un endpoint TLS/SSL.

 Richiesta proxy
target.host Stringa Sola lettura

Il nome di dominio del servizio di destinazione che restituisce la risposta al proxy API.

 Risposta target
target.ip Stringa Sola lettura

L'indirizzo IP del servizio di destinazione che restituisce la risposta al proxy API.

 Risposta target
target.locality Stringa Sola lettura

Località (città) del certificato TLS/SSL presentato dal server di destinazione

 Risposta target
target.name Stringa Sola lettura

Target a cui viene raggiunto il messaggio dall'endpoint di destinazione.

 Richiesta target
target.organization Stringa Sola lettura

Organizzazione del certificato TLS/SSL presentato dal server di destinazione.

 Risposta target
target.organization.unit Stringa Sola lettura

Unità organizzativa del certificato TLS/SSL presentato dal server di destinazione.

 Risposta target
target.port Numero intero Sola lettura

Il numero di porta del servizio di destinazione che restituisce la risposta al proxy API.

 Risposta target
target.received.end.time Stringa Sola lettura

La data e l'ora, espresse in formato stringa, in cui TargetEndpoint ha terminato di ricevere la risposta dal target. Ad esempio, Mer, 21 ago 2013 19:16:47 UTC.

Questo valore di tempo è la rappresentazione stringa del timestamp a 32 bit corrispondente quantità. Ad esempio, Mer, 21 ago 2013 19:16:47 UTC corrisponde al valore del timestamp di 1377112607413..

 Risposta target
target.received.end.
  timestamp		 Lungo Sola lettura

Il valore del timestamp che specifica quando il TargetEndpoint ha finito di ricevere la risposta dall'obiettivo. Ad esempio, 1534783015000. Questo valore è un numero intero a 64 bit (long) che specifica il numero di millisecondi trascorsi dalla mezzanotte del 1° gennaio 1970 UTC.

 Risposta target
target.received.start.time Stringa Sola lettura

L'ora, espressa in formato di stringa, in cui TargetEndpoint ha iniziato a ricevere la risposta dal target. Ad esempio, Mer, 21 ago 2013 19:16:47 UTC.

Questo valore temporale è la rappresentazione in stringa della quantità del timestamp a 32 bit corrispondente. Ad esempio, Wed, 21 Aug 2013 19:16:47 UTC corrisponde al valore del timestamp di 1377112607413.

 Risposta target
target.received.start.
  timestamp		 Lungo Sola lettura

Il valore del timestamp che specifica quando il TargetEndpoint ha iniziato a ricevere la risposta dall'obiettivo. Ad esempio, 1534783015000. Questo valore è un numero intero lungo a 64 bit specificando il numero di millisecondi trascorsi dalla mezzanotte del 1° gennaio 1970 UTC.

 Risposta target
target.scheme Stringa Sola lettura

Inizio ambito: Risposta target
Tipo: Stringa
Autorizzazione: Lettura/scrittura

Restituisce http o https in base al messaggio di richiesta.

 Richiesta target
target.sent.end.time Stringa Sola lettura

L'ora, espressa in formato stringa, in cui il proxy ha smesso di inviare la richiesta a all'URL specificato in TargetEndpoint. Ad esempio, Mer, 21 ago 2013 19:16:47 UTC.

Questo valore di tempo è la rappresentazione stringa del timestamp a 32 bit corrispondente quantità. Ad esempio, Wed, 21 Aug 2013 19:16:47 UTC corrisponde al valore del timestamp di 1377112607413.

 Richiesta target
target.sent.end.timestamp Lungo Sola lettura

Il valore del timestamp che specifica quando il proxy ha terminato di inviare la richiesta all'URL specificato in TargetEndpoint. Ad esempio, 1377112607413. Questo valore è un numero intero (long) di 64 bit contenente il numero di millisecondi trascorsi dalla mezzanotte del 1° gennaio 1970 UTC.

 Richiesta target
target.sent.start.time Stringa Sola lettura

L'ora, espressa in formato di stringa, in cui il proxy ha iniziato a inviare la richiesta all'URL specificato in TargetEndpoint. Ad esempio, Mer 21 ago 2013 19:16:47 UTC.

Questo valore di tempo è la rappresentazione stringa del timestamp a 32 bit corrispondente quantità. Ad esempio, Wed, 21 Aug 2013 19:16:47 UTC corrisponde al valore del timestamp di 1377112607413.

 Richiesta target
target.sent.start.timestamp Lungo Sola lettura

Il valore del timestamp che specifica quando il proxy ha iniziato a inviare la richiesta all'URL specificato in TargetEndpoint. Ad esempio, 1534783015000. Questo valore è un numero intero (long) di 64 bit che specifica il numero di millisecondi trascorsi dalla mezzanotte del 1° gennaio 1970 UTC.

 Richiesta target
target.ssl.enabled Booleano Sola lettura

Indica se TargetEndpoint è in esecuzione su TLS/SSL.

 Richiesta proxy
target.state Stringa Sola lettura

Stato del certificato TLS/SSL presentato dal server di destinazione.

 Risposta target
target.url Stringa Lettura/scrittura

L'URL configurato nel file XML TargetEndpoint o l'URL target dinamico (se target.url è impostato durante il flusso di messaggi). La variabile non include nessun parametri di ricerca o elementi di percorso aggiuntivi. Restituisce null se richiamato fuori dall'ambito o altrimenti non viene impostata.

 Richiesta target

variable

Un contenitore per la proprietà variable.expectedcn.

La tabella seguente descrive le proprietà della variabile variable:

Proprietà Tipo Lettura/scrittura Descrizione Inizio dell'ambito
variable.expectedcn Stringa Lettura/scrittura

Variabile esposta per il nome comune se è in esecuzione su TLS/SSL.

 Richiesta proxy

Per ulteriori informazioni sull'uso di TLS, vedi Opzioni per la configurazione di TLS.