criterio ReadPropertySet

Panoramica

Il criterio ReadPropertySet legge gli insiemi 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. Non tutti gli utenti devono conoscere i tipi di criteri e di ambiente. Per informazioni sui tipi di criteri e sulla disponibilità di ciascun 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 tuo 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 si inserisce un nuovo criterio ReadPropertySet nella UI di Apigee, il modello contiene stub per tutte le operazioni possibili. Di seguito sono riportate informazioni sugli elementi obbligatori.

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 name può contenere lettere, numeri, spazi, trattini, trattini bassi e punti. Questo valore non può superare i 255 caratteri.

Facoltativamente, 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 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 seguente tabella fornisce una descrizione generale degli elementi secondari di <ReadPropertySet>:

Elemento secondario Obbligatorio? Descrizione
<Read> Obbligatorio Legge e risolve una variabile di un insieme 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 è stato risolto.

Esempio

Questa sezione fornisce un esempio di utilizzo di <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 dell'insieme 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 dell'insieme di proprietà e imposta il risultato in una variabile di flusso.

L'elemento <Read> specifica la variabile dell'insieme di proprietà da risolvere e la variabile di flusso su cui impostare quel valore. Include anche un valore predefinito facoltativo, che viene utilizzato nel caso di un insieme di proprietà non risolte. Puoi includere più elementi <Read> in un unico 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 dell'insieme 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 seguente tabella 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 prova prima a risolvere Name in base al valore ref, poi al valore. Se nessuno dei due è risolvibile, si applica <DefaultValue>, se fornito.

<Name> e <Key> si combinano in propertyset.{value_resolved_from_Name}.{value_resolved_from_Key}.

<Key> Obbligatorio Stringa

La chiave dell'insieme di proprietà utilizzato per risolvere la variabile. Specifica ref, il valore o entrambi.

Apigee prova prima a risolvere Key in base al valore ref, poi al valore. Se nessuno dei due è risolvibile, si applica <DefaultValue>, se fornito.

<Name> e <Key> si combinano in propertyset.{value_resolved_from_Name}.{value_resolved_from_Key}.

<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 è stato risolto. Impostalo su true per ignorare le variabili non risolte e continuare l'elaborazione.

IgnoreUnresolvedVariables non è applicabile se viene fornito <DefaultValue>.

Valore predefinito False
Obbligatorio? Facoltativo
Tipo Booleano
Elemento principale <ReadPropertySet>
Elementi secondari Nessuna

Messaggi di errore

Questa sezione descrive i codici e i messaggi di errore restituiti, nonché le variabili di errore impostate da Apigee specifiche per il criterio <ReadPropertySet>. È importante sapere se stai sviluppando regole di errore per gestire gli errori. Per saperne di più, consulta le sezioni Cosa devi sapere sugli errori dei criteri e Gestione degli errori.

Errori di runtime

Questi errori possono verificarsi quando il criterio viene eseguito.

Codice di errore Stato HTTP Causa
steps.readpropertyset.UnresolvedVariable 500

Questo errore si verifica se una variabile specificata nel criterio ReadPropertySet corrisponde a:

  • Fuori ambito (non disponibile nel flusso specifico in cui viene eseguito il criterio)
    • o
  • Impossibile risolvere (non è definito).

Se <IgnoreUnresolvedVariables> è falso e <DefaultValue> non è specificato, la risoluzione non riesce.

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 una delle seguenti condizioni è vera:
  • Non sono stati impostati né un riferimento né un nome per <Name>
  • Non sono stati impostati né un riferimento né un nome per <Key>
  • Nessun valore fornito per <AssignTo>

Variabili di errore

Queste variabili vengono impostate quando il 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, come elencato nella precedente tabella Errori di runtime. Il nome dell'errore è l'ultima parte del codice di 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). Come riferimento, su GitHub sono disponibili gli schemi dei criteri.