Norme per la lettura di PropertySet

Panoramica

Il criterio ReadPropertySet legge i set di proprietà e compila la variabile di flusso con i risultati.

Questo criterio è un criterio standard e può essere implementato in qualsiasi tipo di ambiente. Per informazioni sui tipi di criteri e sulla loro disponibilità in base a ciascun tipo di ambiente, consulta Tipi di criteri.

Elemento <ReadPropertySet>

Definisce un criterio ReadPropertySet.

Valore predefinito	Consulta la scheda Criterio predefinito di seguito
Obbligatorio?	Obbligatorio
Tipo	Oggetto complesso
Elemento principale	N/D
Elementi secondari	<Read>

La sintassi dell'elemento <ReadPropertySet> è la seguente:

Sintassi

La sintassi dell'elemento <ReadPropertySet> è la seguente:

<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>

Norme predefinite

L'esempio seguente mostra le impostazioni predefinite quando aggiungi un criterio ReadPropertySet al flusso nell'interfaccia utente 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 operazioni possibili. Di seguito sono riportate le informazioni sugli elementi obbligatori.

Questo elemento ha i seguenti attributi comuni a tutti i criteri:

Attributo	Predefinito	Obbligatorio?	Descrizione
name	N/D	Obbligatorio	Il nome interno del criterio. Il valore dell'attributo name può contenere lettere, numeri, spazi, trattini, trattini bassi e punti. Questo valore non può superare i 255 caratteri. Se vuoi, utilizza l'elemento <DisplayName> per etichettare il criterio nell'editor proxy dell'interfaccia utente di gestione con un nome diverso in linguaggio naturale.
continueOnError	falso	Facoltativo	Imposta su false per restituire un errore quando un criterio non va a buon fine. Questo è un comportamento previsto per la maggior parte dei criteri. Imposta su true per continuare l'esecuzione del flusso anche dopo un fallimento del criterio. Vedi anche: Le regole di errore vengono attivate SOLO in uno stato di errore (informazioni su continueOnError) Gestione degli errori all'interno del flusso corrente
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	Ritirato	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 impostata per 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 con l'utilizzo di <ReadPropertySet>.

Esempio

Questo esempio utilizza <ReadPropertySet> per recuperare propertyset.environment.name.request.headers.api-version e assegnarlo a target_url. Se non viene ottenuto il valore impostato della 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 all'elemento secondario

Questa sezione descrive gli elementi secondari di <ReadPropertySet>.

<Read>

Risolve una variabile impostata per 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 il valore. Include anche un valore predefinito facoltativo, che viene utilizzato in caso di un insieme di proprietà irrisolto. Puoi includere più elementi <Read> in un unico criterio <ReadPropertySet>.

Valore predefinito	N/D
Obbligatorio?	Facoltativo
Tipo	Tipo complesso
Elemento principale	<ReadPropertySet>
Elementi secondari	<Name> <Key> <AssignTo> <DefaultValue>

La sintassi dell'elemento <Read> è la seguente:

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

Questo esempio utilizza <ReadPropertySet> per recuperarepropertyset.environment.name.request.headers.api-version e assegnarlo a target_url. Se il valore impostato della proprietà non viene ottenuto, 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. Fornisci ref, il valore o entrambi. Apigee tenta prima di risolvere il valore Name in base a ref, quindi il valore. Se nessuno è risolvibile, viene applicato <DefaultValue>, se fornito. <Name> e <Key> si combinano per formare propertyset.{value_resolved_from_Name}.{value_resolved_from_Key}.
<Key>	Obbligatorio	Stringa La chiave del set di proprietà utilizzata per la risoluzione della variabile. Fornisci ref, il valore o entrambi. Apigee tenta prima di risolvere il valore Key in base a ref, quindi il valore. Se nessuno è risolvibile, viene applicato <DefaultValue>, se fornito. <Name> e <Key> si combinano per formare propertyset.{value_resolved_from_Name}.{value_resolved_from_Key}.
<AssignTo>	Obbligatorio	Stringa Specifica la variabile del 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	Nessuno

Messaggi di errore

Questa sezione descrive i codici di errore e i messaggi di errore restituiti e le variabili di errore impostate da Apigee specifiche per il criterio <ReadPropertySet>. Queste informazioni sono importanti se stai sviluppando regole di errore per gestire gli errori. Per scoprire di più, consulta Informazioni importanti sugli errori relativi alle norme e Gestione degli errori.

Errori di runtime

Questi errori possono verificarsi durante l'esecuzione del criterio.

Codice guasto	Stato HTTP	Causa
steps.readpropertyset.UnresolvedVariable	500	Questo errore si verifica se una variabile specificata nel criterio ReadPropertySet è: Al di fuori dell'ambito (non disponibile nel flusso specifico in cui viene eseguito il criterio) o Non può essere risolto (non è definito). Se <IgnoreUnresolvedVariables> è false e <DefaultValue> non è specificato, la risoluzione non va a buon fine.

Errori di deployment

Questi errori possono verificarsi quando esegui il deployment di un proxy contenente questo criterio.

Nome dell'errore	Causa
steps.readpropertyset.EmptyReads	Il criterio non ha elementi secondari <Read>.
steps.readpropertyset.FieldUnset	Questo codice viene restituito quando una delle seguenti condizioni è vera: Non è impostato né un riferimento né un nome per <Name> Non è impostato né un riferimento né un nome per <Key> Non è stato fornito alcun valore per <AssignTo>

Variabili di errore

Queste variabili vengono impostate quando questo criterio attiva un errore in fase di runtime. Per ulteriori informazioni, consulta Informazioni importanti sugli errori relativi alle norme.

Variabili	Dove	Esempio
fault.name="FAULT_NAME"	FAULT_NAME è il nome dell'errore, come 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

Nota: per la gestione degli errori, la best practice è intercettare la parte errorcode della risposta all'errore. Non fare affidamento sul testo in faultstring, perché potrebbe cambiare.

  {  
    "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>
  

Schemi

Ogni tipo di norma è definito da uno schema XML (.xsd). Come riferimento, gli schemi delle norme sono disponibili su GitHub.