Mit Verweisen arbeiten

Diese Seite gilt für Apigee und Apigee Hybrid.

Apigee Edge-Dokumentation aufrufen

Wenn Sie einen TargetServer für die Unterstützung von TLS konfigurieren, geben Sie einen Schlüsselspeicher oder Truststore mit einem Verweis an. Ein Verweis ist eine Variable, die den Namen des Schlüsselspeichers oder Truststore enthält, statt den jeweiligen Namen direkt anzugeben.

Ein Ziel kann durch ein XML-Objekt wie das folgende dargestellt werden:

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

Der Vorteil eines Verweises besteht darin, dass Sie den Wert des Verweises ändern können, um den vom Zielserver verwendeten Schlüsselspeicher zu ändern, beispielsweise wenn das Zertifikat im aktuellen Schlüsselspeicher bald abläuft.

Sie können nur einen Verweis auf den Schlüsselspeicher und Truststore verwenden. Sie können keinen Verweis auf den Alias verwenden. Wenn Sie den Verweis auf einen Schlüsselspeicher ändern, achten Sie darauf, dass der Aliasname des Zertifikats mit dem alten Schlüsselspeicher identisch ist.

Einschränkungen bei der Verwendung von Verweisen auf Schlüsselspeicher und Truststore

Wenn Sie einen Load-Balancer haben und TLS auf dem Load-Balancer beenden, können Sie keine Keystore- und Truststore-Verweise auf dem Zielserver verwenden.

Verweis erstellen

Sie können die Apigee-UI oder API verwenden, um einen neuen Verweis zu erstellen.

Apigee-Benutzeroberfläche

So erstellen Sie einen Verweis mit der Google Cloud Console:

  1. Rufen Sie in der Google Cloud Console die Seite Verwaltung > Umgebungen auf.

    Zur Seite „Umgebungen“

  2. Wählen Sie die gewünschte Umgebung aus, in der Sie die Referenz erstellen möchten.

  3. Klicken Sie auf den Tab Referenzen.

  4. Klicken Sie auf Referenz erstellen.

  5. Geben Sie im Bereich Referenz erstellen die folgenden Details ein:
    • Name: Der Name des Verweises.
    • Schlüsselspeicher: Der Schlüsselspeicher, auf den sich die Referenz bezieht.

  6. Klicken Sie auf Erstellen.

API

So erstellen Sie einen Verweis mit dem API-Aufruf Verweis erstellen:

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

Verweis ändern

Sie können die Apigee-UI oder die API verwenden, um einen vorhandenen Verweis zu ändern.

Apigee-Benutzeroberfläche

So ändern Sie einen Verweis über die Google Cloud Console:

  1. Rufen Sie in der Google Cloud Console die Seite Verwaltung > Umgebungen auf.

    Zur Seite „Umgebungen“

  2. Wählen Sie die gewünschte Umgebung aus, in der Sie den Verweis ändern möchten.

  3. Klicken Sie auf den Tab Referenzen.

  4. Wählen Sie in der angezeigten Liste die Referenz aus, die Sie ändern möchten.

  5. Klicken Sie auf  Aktionen > Bearbeiten.

  6. Aktualisieren Sie im Bereich Referenz bearbeiten die Referenz, um den neuen Schlüsselspeicher anzugeben.

  7. Klicken Sie auf Aktualisieren.

API

Wenn Sie den Verweis so ändern möchten, dass er auf einen anderen Schlüsselspeicher verweist und dabei der Alias im neuen Schlüsselspeicher denselben Namen wie der Alias im alten Schlüsselspeicher hat, verwenden Sie die Update Reference API:

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