Trabajar con referencias

Esta página se aplica a Apigee y Apigee Hybrid.

Consulta la documentación de Apigee Edge.

Cuando configuras un TargetServer para que admita TLS, debes especificar un almacén de claves o un almacén de confianza mediante una referencia. Una referencia es una variable que contiene el nombre del almacén de claves o del almacén de confianza, en lugar de especificar directamente el nombre del almacén de claves.

Una referencia puede representarse con un objeto XML como el que se muestra a continuación:

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

La ventaja de usar una referencia es que puedes cambiar el valor de la referencia para cambiar el almacén de claves que usa el servidor de destino, por lo general, porque el certificado del almacén de claves actual vencerá pronto.

Solo puedes usar una referencia al almacén de claves y al almacén de confianza; no puedes usar una referencia al alias. Cuando cambies la referencia a un almacén de claves, asegúrate de que el nombre de alias del certificado sea el mismo que en el almacén de claves anterior.

Restricciones para el uso de referencias a almacenes de claves y al almacén de confianza

Si tienes un balanceador de cargas y cierras TLS en él, no puedes usar referencias a almacenes de claves y almacenes de confianza en el servidor de destino.

Crea una referencia

Puedes usar la IU o la API de Apigee para crear una referencia nueva.

Crea en la IU de Apigee

Para crear una referencia con la IU, haz lo siguiente:

  1. Accede a la IU de Apigee.
  2. Selecciona el nombre de tu organización.
  3. Selecciona Administrador > Entornos > Referencias.
  4. Selecciona el entorno (por lo general, prod o test).
  5. Selecciona el botón + Referencia.
  6. En la ventana emergente Agregar referencia, haz lo siguiente:
    1. Agrega el Nombre de la referencia.
    2. Selecciona la referencia, el almacén de claves o de confianza al que se hace referencia.
    3. Selecciona Agregar referencia.

Crea en la API de Apigee

Para crear una referencia con la llamada a la API de Create Reference, sigue estos pasos:

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

Modifica una referencia

Puedes usar la IU o la API de Apigee para modificar una referencia existente.

Modifica en la IU de Apigee

Para modificar el valor de una referencia en la IU, haz lo siguiente:

  1. Accede a la IU de Apigee.
  2. Selecciona el nombre de tu organización.
  3. Selecciona Administrador > Entornos > Referencias.
  4. Selecciona el entorno (por lo general, prod o test).
  5. Selecciona el botón Editar de la referencia.
  6. Actualiza la referencia para especificar el nuevo almacén de claves o de confianza. Precaución: Asegúrate de que el alias del almacén de claves nuevo tenga el mismo nombre que el alias del almacén de claves anterior.
  7. Guarda tus actualizaciones.

Cómo modificar en la API de Apigee

Para cambiar la referencia a fin de que apunte a un almacén de claves diferente, para asegurarte de que el alias del almacén de claves nuevo tenga el mismo nombre que el alias del almacén de claves anterior, usa la API Actualiza la referencia:

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