SDK- und CLI-Konfigurationsdatei

Für die Oracle Cloud Infrastructure-SDKs und -CLI sind grundlegende Konfigurationsinformationen erforderlich, wie Benutzerzugangsdaten und Mandanten-OCID. Sie können diese Informationen folgendermaßen angeben:

Konfigurationsdatei verwenden
Konfiguration zur Laufzeit deklarieren

Hinweis

Sie können eine Konfigurationsdatei mit der Konsole generieren. Weitere Informationen finden Sie unter API-Signaturschlüssel generieren (Konsole).

Die SDKs unterstützen beide Optionen vollständig. In der Dokumentation für jedes SDK finden Sie Informationen über das Konfigurationsobjekt und eventuelle Ausnahmen bei der Verwendung einer Konfigurationsdatei:

Für die CLI ist eine Konfigurationsdatei erforderlich. Sie können aber auch Umgebungsvariablen festlegen, um bestimmte Informationen bereitzustellen. Weitere Informationen finden Sie unter CLI-Umgebungsvariablen.

Dateiname und Speicherort

Der Standardname und Speicherort der Konfigurationsdatei lautet ~/.oci/config.

Hinweis

Unter Windows können Sie mit PowerShell den Ordner mit dem folgenden Befehl erstellen: mkdir %HOMEDRIVE%%HOMEPATH%\.oci. Der Explorer unterstützt nicht die Erstellung von Ordnernamen, die mit einem Punkt beginnen.

Dateieinträge

In der folgenden Tabelle werden die für die Konfigurationsdatei erforderlichen Basiseinträge aufgeführt, und es wird angegeben, wo die erforderlichen Informationen abgerufen werden können.


Eintrag	Beschreibung und Angabe, wo der Wert abgerufen werden kann	Erforderlich?
`user`	OCID des Benutzers, der die API aufruft. Die Werte finden Sie unter Erforderliche Schlüssel und OCIDs. Beispiel: `ocid1.user.oc1..<unique_ID>` (aus Gründen der Übersichtlichkeit gekürzt)	Ja
`fingerprint`	Fingerprint für den Public Key, der diesem Benutzer hinzugefügt wurde. Die Werte finden Sie unter Erforderliche Schlüssel und OCIDs.	Ja
`key_file`	Vollständiger Pfad und Dateiname des Private Keys. Wichtig: Das Schlüsselpaar muss im PEM-Format vorliegen. Anweisungen zum Generieren eines Schlüsselpaares im PEM-Format finden Sie unter Erforderliche Schlüssel und OCIDs. Beispiel (Linux/Mac OS): `~/.oci/oci_api_key.pem` Beispiel (Windows): `~/.oci/oci_api_key.pem` Dies entspricht der Datei `%HOMEDRIVE%%HOMEPATH%\.oci\oci_api_key.pem`.	Ja
`pass_phrase`	Passphrase für den Schlüssel, sofern er verschlüsselt ist. Achtung: Dieser Eintrag ist veraltet und nur aus Gründen der Abwärtskompatibilität enthalten. Vermeiden Sie das Speichern vertraulicher Informationen in der Konfigurationsdatei. Um die Sicherheit zu erhöhen, sollten Sie die Passphrase zur Laufzeit an das SDK/die CLI übergeben.	Ja, sofern der Schlüssel verschlüsselt ist und die Passphrase nicht so konfiguriert wurde, dass sie zur Laufzeit übergeben wird
`tenancy`	OCID Ihres Mandanten. Die Werte finden Sie unter Erforderliche Schlüssel und OCIDs. Beispiel: `ocid1.tenancy.oc1..<unique_ID>`	Ja
`region`	Eine Oracle Cloud Infrastructure-Region. Siehe Regionen und Availability-Domains. Beispiel: `us-ashburn-1`	Ja
`security_token_file`	Bei der Sessiontokenauthentifizierung ist dieser Parameter erforderlich. Bei dieser Authentifizierungsmethode sind fingerprint, user und pass_phrase nicht erforderlich. Wenn Sie eine Session mit der OCI-Befehlszeilenschnittstelle (CLI) starten, werden alle für diese Authentifizierungsmethode erforderlichen Parameter ausgefüllt. Informationen hierzu finden Sie unter Tokenbasierte CLI-Session starten.	Bedingt

Benutzerdefinierte Werte

Einige Oracle Cloud Infrastructure-SDKs unterstützen die Definition benutzerdefinierter Werte in der Konfigurationsdatei. Weitere Informationen finden Sie in der Dokumentation zu jedem SDK.

Profile und Vererbung

Sie können mehrere Profile mit unterschiedlichen Werten für diese Einträge erstellen und dann angeben, welches Profil geladen werden soll.

Einige Oracle Cloud Infrastructure-SDKs erfordern ein Standardprofil und unterstützen die Profilvererbung. Dies bedeutet, dass jeder Wert, der nicht explizit für ein bestimmtes Profil definiert ist, aus dem Standardprofil übernommen wird. Weitere Informationen finden Sie in der Dokumentation zu jedem SDK.

Beispielkonfiguration

Das folgende Beispiel (für Linux und Mac OS) zeigt Schlüsselwerte in einer Konfigurationsdatei und die Festlegung von Profilen für ein SDK, das die Profilvererbung unterstützt.

[DEFAULT]
user=ocid1.user.oc1..<unique_ID>
fingerprint=<your_fingerprint>
key_file=~/.oci/oci_api_key.pem
tenancy=ocid1.tenancy.oc1..<unique_ID>
region=us-ashburn-1

[ADMIN_USER]
user=ocid1.user.oc1..<unique_ID>
fingerprint=<your_fingerprint>
key_file=keys/admin_key.pem
pass_phrase=<your_passphrase>

Dieses Beispiel gilt für Windows:

[DEFAULT]
user=ocid1.user.oc1..<unique_ID>
fingerprint=<your_fingerprint>
key_file=%HOMEPATH%\.oci\oci_api_key.pem
tenancy=ocid1.tenancy.oc1..<unique_ID>
region=us-ashburn-1

[ADMIN_USER]
user=ocid1.user.oc1..<unique_ID>
fingerprint=<your_fingerprint>
key_file=keys\admin_key.pem
pass_phrase=<your_passphrase>