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.

In der Apigee-UI erstellen

So erstellen Sie einen Verweis über die UI:

  1. Melden Sie sich in der Apigee-UI an.
  2. Wählen Sie den Namen Ihrer Organisation aus.
  3. Wählen Sie Admin > Umgebungen > Verweise aus.
  4. Wählen Sie die Umgebung aus (normalerweise prod oder test).
  5. Wählen Sie die Schaltfläche + Verweis aus.
  6. Im Pop-up-Fenster Verweis hinzufügen:
    1. Fügen Sie den Namen des Verweises hinzu.
    2. Wählen Sie den Verweis und den zugehörigen Schlüsselspeicher oder Truststore aus.
    3. Wählen Sie Verweis hinzufügen aus.

In der Apigee API erstellen

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.

In der Apigee-UI ändern

So ändern Sie den Wert eines Verweises in der UI:

  1. Melden Sie sich in der Apigee-UI an.
  2. Wählen Sie den Namen Ihrer Organisation aus.
  3. Wählen Sie Admin > Umgebungen > Verweise aus.
  4. Wählen Sie die Umgebung aus (normalerweise prod oder test).
  5. Wählen Sie die Schaltfläche Bearbeiten für den Verweis aus.
  6. Aktualisieren Sie den Verweis, um den neuen Schlüsselspeicher oder Truststore anzugeben. Achtung: Der Alias im neuen Schlüsselspeicher muss denselben Namen wie im alten Schlüsselspeicher haben.
  7. Speichern Sie die Änderungen.

In der Apigee API ändern

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 '{
              "reference": {
              "name": MyReferenceName",
              "resourceType": "KeyStore",
              "refers": "KeyStoreID"
          }
         }' \
        https://apigee.googleapis.com/v1/{name=organizations/*/environments/*/references/*}