API-Authentifizierung für OCI einrichten

Um eine lokale Umgebung mit einem OCI-Mandanten zu verbinden, richten Sie die API-Authentifizierung in einer Konfigurationsdatei ein.

Überblick

Wichtige Aufgaben:

  • Erstellen Sie API-Schlüssel in der Konsole.
  • Richten Sie eine OCI-Konfigurationsdatei für die API-Authentifizierung aus einer lokalen Umgebung ein.
  • OCI-CLI in der lokalen Umgebung installieren.

Weitere Informationen finden Sie in den folgenden Ressourcen:

Bevor Sie beginnen

Für eine erfolgreiche Ausführung dieses Tutorials benötigen Sie die folgende Konfiguration.

  • Ein unterstützter Browser
  • Eine MacOS-, Linux- oder Windows-Umgebung mit einem Windows-Subsystem für Linux (WSL).
  • Python 3 installiert. Die unterstützten Python-Versionen finden Sie in der Dokumentation zum Python-SDK.
  • Python 3 installiert.
  • Führen Sie das Tutorial Sandbox-Benutzer für Tutorials erstellen aus, und führen Sie folgende Schritte aus:
    • Halten Sie die Oracle Mobile Authenticator-App bereit.
    • Notieren Sie sich die folgenden Informationen aus dem Tutorial:
      • <sandbox-Benutzername>
      • <sandbox-Benutzerkennwort>
      • <Mandantenname>
      • <Domainname>
      • <Sandbox-Compartment>

1. API-Schlüssel erstellen

In diesem Tutorial generieren Sie das Private/Public-Key-Paar für den Sandbox-Benutzer in der Konsole. Wenn Sie das Schlüsselpaar mit der Konsole hinzufügen, generiert die Konsole auch ein Konfigurationsdateivorschau-Snippet für Sie.

  1. Melden Sie sich bei der Konsole an. Geben Sie unter Cloud-Accountname den Namen <tenancy-name> ein, und wählen Sie Weiter aus.
  2. Geben Sie als Identitätsdomain die <domain-name> ein. Beispiel: Standard, und wählen Sie Weiter aus.
  3. Geben Sie <sandbox-username> und <sandbox-user-password> ein, und wählen Sie Anmelden aus.
  4. Öffnen Sie die Oracle Mobile Authenticator-App, und rufen Sie den generierten Passcode für den Account <tenancy-name> <sandbox-username> ab.
  5. Geben Sie in der Konsole im Fenster Multifaktor-Authentifizierung den Passcode ein, und wählen Sie Anmelden aus.
    Sie werden zur Konsolenhomepage weitergeleitet.
  6. Wählen Sie in der oberen Navigationsleiste das Profilsymbol, und wählen Sie Benutzereinstellungen aus.
  7. Wählen Sie Token und Schlüssel aus.
  8. Wählen Sie unter API-Schlüssel die Option API-Schlüssel hinzufügen aus.
  9. Generieren oder geben Sie Schlüssel gemäß den Anweisungen im Dialogfeld an.
    Wichtig

    Wenn Sie Schlüssel generieren, laden Sie beide Schlüssel herunter, und speichern Sie die Schlüssel an einem sicheren Ort. Wenn Sie die Schlüssel verlieren, können sie nicht neu erstellt werden, und Sie müssen neue Schlüssel erneut erstellen.
  10. Wählen Sie Hinzufügen aus.
  11. In einem Dialogfeld werden die Konfigurationseinstellungen angezeigt. Kopieren Sie die Konfigurationsinformationen in eine Datei in Ihrer lokalen Umgebung namens config, und speichern Sie die Datei in einer sicheren Textdatei.

Wenn Sie Hilfe benötigen, lesen Sie Erforderliche Schlüssel und OCIDs für die API-Signatur.

2. Schlüsselberechtigungen ändern

  1. Navigieren Sie zu dem Ordner, in den Sie die Schlüssel im vorherigen Abschnitt heruntergeladen haben.
  2. (Optional) Ändern Sie den Namen der Schlüssel. Beispiel: <sandbox-user-private-key.pem> und <sandbox-user-public-key.pem>.
  3. Wechseln Sie vom Terminal zu Ihrem Home-Verzeichnis.
  4. Erstellen Sie ein .oci-Verzeichnis.
  5. Verschieben Sie den Public und Private Key in das Verzeichnis .oci, und schreiben Sie <path-to-private-key.pem> auf.
    Beispiel: <home-directory>/.oci/<sandbox-user-public-key.pem>
  6. Ändern Sie in der lokalen Umgebung die Berechtigung für die Private-Key-Datei mit dem folgenden Befehl:
    chmod 400 <path-to-private-key.pem>

4. OCI-CLI installieren

  1. Installieren Sie die OCI-CLI und das Python-SDK mit pip:
    pip install oci-cli

    Alle obligatorischen Bibliotheken sind installiert.

  2. Prüfen Sie, ob die OCI-CLI installiert ist. Geben Sie folgenden Befehl ein.
    pip list
    Der Befehl listet die installierten Packages auf, einschließlich oci-cli. Beispiel:
    oci-cli                  <version>

4. Lokale Konfigurationsdatei erstellen

  1. Geben Sie im Verzeichnis .oci den folgenden Befehl ein: touch config.
  2. Fügen Sie die API-Schlüsselkonfigurationsdaten, die Sie im vorherigen Abschnitt kopiert haben, in die Datei config ein.

    Beispieldatei config.

    [DEFAULT]
    user=<ocid1.user.oc1..xxx>
    fingerprint=<xx:xx:xx:xx>
    tenancy=<ocid1.tenancy.oc1..xxx>
    region=us-chicago-1
    key_file=<path-to-private-key.pem>       

    Diese Konfiguration gilt für das mit [Default] genannte Default-Profil.

5. Setup testen

Prüfen Sie, ob die OCI-CLI die Konfigurationsdatei verwendet, und stellen Sie eine Verbindung zu Ihrem Mandanten her.
  1. Prüfen Sie, ob die OCI-CLI installiert ist.
    oci

    Mit dem Befehl werden die verfügbaren Befehle für die CLI aufgeführt.

  2. Prüfen Sie, ob die Konfigurationsdatei funktioniert.
    oci os ns get

    Mit diesem Befehl wird der Namespace Ihres Mandanten abgerufen.

    oci iam region list

    Mit diesem Befehl werden die verfügbaren Regionen in Ihrem Mandanten aufgelistet.