Panoramica
Il criterio ReadPropertySet legge gli insiemi di proprietà e compila la variabile di flusso con i risultati.
Questo è un criterio standard e può essere implementato in qualsiasi tipo di ambiente. Non tutti gli utenti devono conoscere i tipi di criteri e di ambiente. Per informazioni sui tipi di criteri e sulla disponibilità con ogni tipo di ambiente, consulta Tipi di criteri.
<ReadPropertySet>
elemento
Definisce un criterio ReadPropertySet.
Valore predefinito | Consulta la scheda Criterio predefinito di seguito |
Obbligatorio? | Obbligatorio |
Tipo | Oggetto complesso |
Elemento principale | N/A |
Elementi secondari |
<Read> |
L'elemento <ReadPropertySet>
utilizza la seguente sintassi:
Sintassi
L'elemento <ReadPropertySet>
utilizza la seguente sintassi:
<ReadPropertySet name="read-property-set"> <Read> <Name ref="set-ref">property-set-name</Name> <Key ref="key-ref">key-name</Key> <AssignTo>var1</AssignTo> <DefaultValue>default-value</DefaultValue> </Read> ... <IgnoreUnresolvedVariables>true</IgnoreUnresolvedVariables> </ReadPropertySet>
Criterio predefinito
L'esempio seguente mostra le impostazioni predefinite quando aggiungi un criterio ReadPropertySet al flusso nella UI di Apigee:
<ReadPropertySet name="read-property-set"> <Read> <Name ref="set-ref">property-set-name</Name> <Key ref="key-ref">key-name</Key> <AssignTo>var1</AssignTo> <DefaultValue>default-value</DefaultValue> </Read> <IgnoreUnresolvedVariables>true</IgnoreUnresolvedVariables> </ReadPropertySet>
Quando inserisci un nuovo criterio ReadPropertySet nell'interfaccia utente di Apigee, il modello contiene stub per tutte le possibili operazioni. Vedi di seguito per informazioni sugli elementi richiesti.
Questo elemento ha i seguenti attributi comuni a tutti i criteri:
Attributo | Predefinito | Obbligatorio? | Descrizione |
---|---|---|---|
name |
N/A | Obbligatorio |
Il nome interno del criterio. Il valore dell'attributo Facoltativamente, utilizza l'elemento |
continueOnError |
falso | Facoltativo | Imposta su false per restituire un errore in caso di errore del criterio. Questo è un comportamento previsto per
la maggior parte dei criteri. Imposta su true per continuare l'esecuzione del flusso anche dopo un errore nel criterio. Vedi anche:
|
enabled |
true | Facoltativo | Imposta su true per applicare il criterio. Imposta su false per disattivare il
criterio. Il criterio non verrà applicato anche se rimane collegato a un flusso. |
async |
falso | Deprecato | Questo attributo è stato ritirato. |
La tabella seguente fornisce una descrizione generale degli elementi secondari di <ReadPropertySet>
:
Elemento secondario | Obbligatorio? | Descrizione |
---|---|---|
<Read> |
Obbligatorio | Legge e risolve una variabile di set di proprietà e la imposta su una variabile di flusso specificata. |
<IgnoreUnresolvedVariables> |
Facoltativo | Determina se l'elaborazione si interrompe quando un insieme di proprietà non è risolto. |
Esempio
Questa sezione fornisce un esempio utilizzando <ReadPropertySet>
.
Esempio
In questo esempio viene utilizzato <ReadPropertySet>
per ottenere propertyset.environment.name.request.headers.api-version
e assegnarlo a target_url
. Se non si ottiene il valore del set di proprietà,
viene utilizzato https://httpbin.org/get
.
<ReadPropertySet name="read-property-set"> <Read> <Name ref="set-ref">environment.name</Name> <Key ref="key-ref">request.headers.api-version</Key> <AssignTo>target_url</AssignTo> <DefaultValue>https://httpbin.org/get</DefaultValue> </Read> <IgnoreUnresolvedVariables>false</IgnoreUnresolvedVariables> </ReadPropertySet>
Riferimento elemento secondario
In questa sezione vengono descritti gli elementi secondari di <ReadPropertySet>
.
<Read>
Risolve una variabile di set di proprietà e imposta il risultato in una variabile di flusso.
L'elemento <Read>
specifica la variabile del set di proprietà da risolvere e la variabile di flusso su cui
impostare questo valore. Include inoltre un valore predefinito facoltativo, utilizzato nel caso in cui una serie di proprietà non sia risolta. Puoi includere più elementi <Read>
in un singolo criterio <ReadPropertySet>
.
Valore predefinito | N/A |
Obbligatorio? | Facoltativo |
Tipo | Tipo complesso |
Elemento principale |
<ReadPropertySet>
|
Elementi secondari |
<Name> <Key> <AssignTo> <DefaultValue> |
L'elemento <Read>
utilizza la seguente sintassi:
Sintassi
<Read> <Name ref="set-ref">property-set-name</Name> <Key ref="key-ref">key-name</Key> <AssignTo>var1</AssignTo> <DefaultValue>default-value</DefaultValue> </Read>
Esempio
In questo esempio viene utilizzato <ReadPropertySet>
per ottenere propertyset.environment.name.request.headers.api-version
e assegnarlo a target_url
. Se non si ottiene il valore del set di proprietà,
viene utilizzato https://httpbin.org/get
.
<ReadPropertySet name="read-property-set"> <Read> <Name ref="environment.name">my-property-set-name</Name> <Key ref="request.headers.api-version">my-property-set-key</Key> <AssignTo>target_url</AssignTo> <DefaultValue>https://httpbin.org/get</DefaultValue> </Read> <IgnoreUnresolvedVariables>false</IgnoreUnresolvedVariables> </ReadPropertySet>
La tabella seguente fornisce una descrizione generale degli elementi secondari di <Read>
.
Elemento secondario | Obbligatorio? | Descrizione |
---|---|---|
<Name> |
Obbligatorio | Stringa La proprietà impostata per la lettura. Specifica ref , il valore o entrambi.
Apigee prima prova a risolvere il problema
|
<Key> |
Obbligatorio | Stringa La chiave del set di proprietà utilizzata per risolvere la variabile. Specifica ref , il valore o entrambi.
Apigee prima prova a risolvere il problema
|
<AssignTo> |
Obbligatorio | Stringa Specifica la variabile di flusso a cui assegnare la variabile risolta. |
<DefaultValue> |
Facoltativo | Stringa Specifica un valore predefinito da utilizzare quando la variabile non può essere risolta. |
<IgnoreUnresolvedVariables>
Determina se l'elaborazione si interrompe quando un insieme di proprietà non è risolto. Imposta su true
per ignorare le variabili non risolte e continuare l'elaborazione.
IgnoreUnresolvedVariables
non è applicabile se viene fornito
<DefaultValue>
.
Valore predefinito | Falso |
Obbligatorio? | Facoltativo |
Tipo | Booleano |
Elemento principale |
<ReadPropertySet>
|
Elementi secondari | Nessuna |
Messaggi di errore
Questa sezione descrive i codici e i messaggi di errore che vengono restituiti, nonché le variabili di errore impostate da Apigee specifiche per il criterio <ReadPropertySet>
.
Queste informazioni sono importanti per sapere se stai sviluppando regole di errore per
gestirle. Per scoprire di più, consulta Cosa devi sapere sugli errori relativi alle norme e Gestione degli errori.
Errori di runtime
Questi errori possono verificarsi durante l'esecuzione del criterio.
Codice di errore | Stato HTTP | Causa |
---|---|---|
steps.readpropertyset.UnresolvedVariable |
500 |
Questo errore si verifica se una variabile specificata nel criterio ReadPropertySet è:
Se |
Errori di deployment
Questi errori possono verificarsi quando esegui il deployment di un proxy contenente questo criterio.
Nome errore | Causa |
---|---|
steps.readpropertyset.EmptyReads |
Il criterio non ha elementi secondari <Read> . |
steps.readpropertyset.FieldUnset |
Questo codice viene restituito quando si verifica una delle seguenti condizioni:
|
Variabili di errore
Queste variabili vengono impostate quando questo criterio attiva un errore in fase di runtime. Per maggiori informazioni, consulta la sezione Cosa devi sapere sugli errori dei criteri.
Variabili | Dove | Esempio |
---|---|---|
fault.name="FAULT_NAME" |
FAULT_NAME è il nome dell'errore, indicato nella tabella Errori di runtime sopra. Il nome dell'errore è l'ultima parte del codice dell'errore. | fault.name Matches "UnresolvedVariable" |
readpropertyset.POLICY_NAME.failed |
POLICY_NAME è il nome specificato dall'utente del criterio che ha generato l'errore. | readpropertyset.RPS-SetResponse.failed = true |
Esempio di risposta di errore
{ "fault": { "faultstring": "ReadPropertySet[RPS-SetResponse]: unable to resolve variable [variable_name]", "detail": { "errorcode": "steps.readpropertyset.UnresolvedVariable" } } }
Esempio di regola di errore
<FaultRule name="ReadPropertySet Faults"> <Step> <Name>RPS-CustomSetVariableErrorResponse</Name> <Condition>(fault.name = "SetVariableFailed")</Condition> </Step> <Condition>(readpropertyset.failed = true)</Condition> </FaultRule>
Schema
Ogni tipo di criterio è definito da uno schema XML (.xsd
). Per riferimento, gli schemi dei criteri sono disponibili su GitHub.