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, especificas 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 o del almacén de confianza.

Una referencia se puede representar mediante un objeto XML como el siguiente:

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

La ventaja de usar una referencia es que puedes cambiar su valor para modificar el almacén de claves que usa el servidor de destino. Esto suele hacerse porque el certificado del almacén de claves actual va a caducar en breve.

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

Restricciones de uso de referencias a almacenes de claves y almacenes de confianza

Si tienes un balanceador de carga y finalizas TLS en él, no podrás usar referencias de almacén de claves y de almacén de confianza en el servidor de destino.

Crear una referencia

Puedes usar la interfaz de usuario o la API de Apigee para crear una referencia.

Consola de Apigee Google Cloud

Para crear una referencia con la consola Google Cloud , sigue estos pasos:

  1. En la Google Cloud consola, ve a la página Gestión > Entornos.

    Ir a Entornos

  2. Selecciona el entorno en el que quieras crear la referencia.

  3. Haz clic en la pestaña Referencias.

  4. Haz clic en Crear referencia.

  5. En el panel Crear referencia, introduce los siguientes detalles:
    • Nombre: el nombre de la referencia.
    • Almacén de claves: el almacén de claves al que apunta la referencia.

  6. Haz clic en Crear.

Interfaz clásica

Para crear una referencia mediante la interfaz de usuario, sigue estos pasos:

  1. Inicia sesión en la interfaz de usuario de Apigee.
  2. Selecciona el nombre de tu organización.
  3. Selecciona Administrar > Entornos > Referencias.
  4. Selecciona el entorno (normalmente, prod o test).
  5. Seleccione el botón + Referencia.
  6. En la ventana emergente Añadir referencia:
    1. Añade el nombre de la referencia.
    2. Seleccione la Referencia, el almacén de claves o el almacén de confianza al que se hace referencia.
    3. Selecciona Añadir referencia.

API

Para crear una referencia con la llamada a la API CreateReference, haz lo siguiente:

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

Modificar una referencia

Puede usar la interfaz de usuario o la API de Apigee para modificar una referencia.

Consola de Apigee Google Cloud

Para modificar una referencia mediante la consola Google Cloud , sigue estos pasos:

  1. En la Google Cloud consola, ve a la página Gestión > Entornos.

    Ir a Entornos

  2. Selecciona el entorno en el que quieras modificar la referencia.

  3. Haz clic en la pestaña Referencias.

  4. En la lista que se muestra, selecciona la referencia que quieras modificar.

  5. Haz clic en Acciones > Editar.

  6. En el panel Editar referencia, actualiza la referencia para especificar el nuevo almacén de claves.

  7. Haz clic en Actualizar.

UI clásica de Apigee

Para modificar el valor de una referencia en la interfaz de usuario, sigue estos pasos:

  1. Inicia sesión en la interfaz de usuario de Apigee.
  2. Selecciona el nombre de tu organización.
  3. Selecciona Administrar > Entornos > Referencias.
  4. Selecciona el entorno (normalmente, 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 nuevo almacén de claves tenga el mismo nombre que el alias del antiguo. almacén de claves.
  7. Guarda los cambios.

API

Para cambiar la referencia de forma que apunte a otro almacén de claves, asegúrate de que el alias del nuevo almacén de claves tenga el mismo nombre que el alias del antiguo y usa la API Update Reference:

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