Schlüssel mit der API des Schlüsselmanagementservice verwalten

IBM Cloud® Hyper Protect Crypto Services stellt eine API für Schlüsselmanagementservices zum Speichern, Abrufen und Generieren von Verschlüsselungsschlüsseln bereit.

IBM Cloud-Berechtigungsnachweise abrufen

Zur Arbeit mit der API müssen Sie eigene Service- und Authentifizierungsnachweise generieren. Gehen Sie wie folgt vor, um Ihre Berechtigungsnachweise zusammenzustellen:

  1. Generieren Sie ein IBM Cloud-IAM-Zugriffstoken.
  2. Rufen Sie die Instanz-ID ab, die Ihre Hyper Protect Crypto Services-Serviceinstanz eindeutig identifiziert.

API-Anforderung für Schlüsselmanagementservice erstellen

Wenn Sie einen API-Aufruf für den Service absetzen, strukturieren Sie Ihre API-Anforderung auf dieselbe Weise, wie Sie Ihre ursprüngliche Instanz von Hyper Protect Crypto Services bereitgestellt haben.

Um Ihre Anforderung zu erstellen, kombinieren Sie einen regionalen Serviceendpunkt mit dem entsprechenden Authentifizierungsnachweis. Beispiel: Wenn Sie eine Serviceinstanz für die Region us-south erstellen, verwenden Sie den folgenden Endpunkt und die folgenden API-Header, um die Schlüssel in Ihrem Service zu durchsuchen:

Wenn Sie Ihre Instanzen nach dem 12. April 2024 in bestimmten Regionen erstellen, müssen Sie möglicherweise die neuen API-Endpunkte mit dem neuen Format <instance_ID>.ep11.<REGION>.hs-crypto.appdomain.cloud verwenden. Das Verfügbarkeitsdatum variiert je nach Region. Weitere Informationen zu den unterstützten Regionen, den Verfügbarkeitsdaten und den neuen Endpunkt-URLs finden Sie unter Neue Endpunkte.

curl -X GET \
    https://<INSTANCE_ID>.api.us-south.hs-crypto.appdomain.cloud/api/v2/keys \
    -H 'accept: application/vnd.ibm.collection+json' \
    -H 'authorization: Bearer <access_token>' \
    -H 'bluemix-instance: <instance_ID>'
  • Ersetzen Sie <port> durch die Portnummer Ihres API-Endpunkts. Sie können die <port> über Übersicht > Key Management endpoint URL im Dashboard Ihrer bereitgestellten Serviceinstanz abrufen. Sie können auch dynamisch die API-Endpunkt-URL abrufen.

    Beachten Sie, dass der Portbereich einer Hyper Protect Crypto Services-Instanz zwischen 8000- 19999 liegt.

    Der zurückgegebene Wert enthält Folgendes:

    {
      "instance_id": "<instance_ID>",
      "kms": {
        "public": "<instance_ID>.api.<region>.hs-crypto.appdomain.cloud",
        "private":"<instance_ID>.api.private.<region>.hs-crypto.appdomain.cloud"
      },
        "ep11": {
        "public": "<instance_ID>.ep11.<region>.hs-crypto.appdomain.cloud",
        "private":"<instance_ID>.ep11.private.<region>.hs-crypto.appdomain.cloud"
      }
    }
    

    Verwenden Sie für den Schlüsselmanagementservice <region> und <instance_ID> im Abschnitt kms.

  • Ersetzen Sie <access_token> und <instance_ID> durch Ihre abgerufenen Service- und Authentifizierungsberechtigungsnachweise.

Möchten Sie Ihre API-Anfragen verfolgen können, wenn etwas schiefgeht? Wenn Sie in Ihrer cURL-Anforderung das Flag -v angeben, erhalten Sie in den Antwortheadern den Wert correlation-id. Sie können diesen Wert verwenden, um die Anforderung zu Debugzwecken zu korrelieren und zu verfolgen.

Nächste Schritte

Nun sind Sie bereit, mit der Verwaltung Ihrer Verschlüsselungsschlüssel und -daten zu beginnen. Weitere Informationen zur programmgesteuerten Verwaltung Ihrer Schlüssel finden Sie in der API-Referenzdokumentation zum Schlüsselmanagementservice.