Utilizzo dei riferimenti

Questa pagina si applica ad Apigee e Apigee hybrid.

Visualizza la documentazione di Apigee Edge.

Quando configuri un TargetServer per supportare TLS, devi specificare un archivio chiavi o un archivio di attendibilità utilizzando un riferimento. Un riferimento è una variabile che contiene il nome dell'archivio chiavi o dell'archivio di attendibilità, anziché specificare direttamente il nome dell'archivio chiavi o dell'archivio attendibilità.

Un riferimento può essere rappresentato da un oggetto XML come il seguente:

  <reference>
    <name>ReferenceName</name>
    <description>ReferencDescription</description>
    <resourceType>ReferredResourceType<resourceType>
    <refers>ReferredResource<refers>
  </reference>

Il vantaggio dell'utilizzo di un riferimento è che puoi modificare il valore del riferimento per modificare l'archivio chiavi utilizzato dal server di destinazione, in genere perché il certificato nell'archivio chiavi attuale scadrà nel prossimo futuro.

Puoi utilizzare solo un riferimento all'archivio chiavi e all'archivio attendibilità; non puoi utilizzare un riferimento all'alias. Quando modifichi il riferimento a un archivio chiavi, assicurati che il nome alias del certificato sia lo stesso dell'archivio chiavi precedente.

Limitazioni relative all'utilizzo dei riferimenti agli archivi chiavi e all'archivio attendibilità

Se disponi di un bilanciatore del carico e termina TLS sul bilanciatore del carico, non puoi utilizzare i riferimenti all'archivio chiavi e all'archivio di attendibilità nel server di destinazione.

Crea un riferimento

Puoi utilizzare l'interfaccia utente o l'API di Apigee per creare un nuovo riferimento.

Crea nella UI di Apigee

Per creare un riferimento utilizzando l'interfaccia utente:

  1. Accedi all'interfaccia utente di Apigee.
  2. Seleziona il nome della tua organizzazione.
  3. Seleziona Amministrazione > Ambienti > Riferimenti.
  4. Seleziona l'ambiente (in genere prod o test).
  5. Seleziona il pulsante + Riferimento.
  6. Nella finestra popup Aggiungi riferimento:
    1. Aggiungi il nome del riferimento.
    2. Seleziona il Riferimento, l'archivio chiavi o l'archivio di attendibilità di riferimento.
    3. Seleziona Aggiungi riferimento.

Crea nell'API Apigee

Per creare un riferimento utilizzando la chiamata API Create Reference:

      curl -H "Authorization: Bearer $TOKEN" \
        -X POST \
        -d '{
            "reference": {
              "name": MyReferenceName",
              "resourceType": "KeyStore",
              "refers": "KeyStoreID"
            }
           }' \
        https://apigee.googleapis.com/v1/{parent=organizations/*/environments/*}/references

Modificare un riferimento

Puoi utilizzare l'interfaccia utente o l'API Apigee per modificare un riferimento esistente.

Modifica nell'interfaccia utente di Apigee

Per modificare il valore di un riferimento nell'interfaccia utente:

  1. Accedi all'interfaccia utente di Apigee.
  2. Seleziona il nome della tua organizzazione.
  3. Seleziona Amministrazione > Ambienti > Riferimenti.
  4. Seleziona l'ambiente (in genere prod o test).
  5. Seleziona il pulsante Modifica per il riferimento.
  6. Aggiorna il riferimento per specificare il nuovo archivio chiavi o il nuovo archivio attendibilità. Attenzione: assicurati che l'alias nel nuovo archivio chiavi abbia lo stesso nome dell'alias del precedente archivio chiavi.
  7. Salva gli aggiornamenti.

Modifica nell'API Apigee

Per cambiare il riferimento in modo che punti a un archivio chiavi diverso, assicurandoti che l'alias nel nuovo archivio chiavi abbia lo stesso nome dell'alias dell'archivio chiavi precedente, utilizza l'API Update Reference:

        curl -H "Authorization: Bearer $TOKEN" \
          -X PUT \
          -d '{
              "reference": {
              "name": MyReferenceName",
              "resourceType": "KeyStore",
              "refers": "KeyStoreID"
          }
         }' \
        https://apigee.googleapis.com/v1/{name=organizations/*/environments/*/references/*}