Oracle Cloud Infrastructureドキュメント

SDKおよびCLIの構成ファイル

Oracle Cloud InfrastructureのSDKおよびCLIでは、ユーザー資格証明やテナンシOCIDなどの基本構成情報が必要です。この情報は次のように提供できます:

  • 構成ファイルの使用
  • 実行時の構成の宣言
ノート

コンソールを使用すると、構成ファイルを簡単に生成できます。詳細は、API署名キーの生成(コンソール)を参照してください。

SDKは両方のオプションを完全にサポートしています。構成オブジェクトの詳細および構成ファイルの使用時の例外については、各SDKのドキュメントを参照してください:

CLIには構成ファイルが必要ですが、環境変数を設定して特定の情報を提供することもできます。詳細は、CLI環境変数を参照してください。

ファイルの名前と場所

デフォルトの構成ファイルの名前と場所は、~/.oci/configです。

ノート

Windowsでは、PowerShellでコマンドmkdir %HOMEDRIVE%%HOMEPATH%\.ociを使用してこのフォルダを作成できます。ファイル・エクスプローラでは、ピリオドから始まるフォルダ名の作成はサポートされていません。

ファイルのエントリ

次の表に、構成ファイルで必要な基本エントリと、必要な情報を取得する場所を示します。

エントリ 説明および値の取得場所 必須?
user

APIをコールするユーザーのOCID。この値を取得するには、必要なキーとOCIDを参照してください。

例: ocid1.user.oc1..<unique_ID>(簡潔にするために省略)

 はい
fingerprint

このユーザーに追加された公開キーのフィンガープリント。この値を取得するには、必要なキーとOCIDを参照してください。

 はい
key_file

秘密キーのフルパスとファイル名。

重要: キー・ペアはPEMフォーマットである必要があります。PEMフォーマットのキー・ペアを生成する手順は、必要なキーとOCIDを参照してください。

例(Linux/Mac OS): ~/.oci/oci_api_key.pem

例(Windows): ~/.oci/oci_api_key.pem

これは、ファイル%HOMEDRIVE%%HOMEPATH%\.oci\oci_api_key.pemに対応します。

 はい
pass_phrase

キーに使用されるパスフレーズ(キーが暗号化されている場合)。

注意: このエントリは非推奨であり、下位互換性のためにのみ含まれています。機密情報を構成ファイルに保存しないでください。セキュリティを強化するには、実行時にSDK/CLIにパスフレーズを渡します。

 はい(キーが暗号化されており、実行時に渡されるようにパスフレーズが構成されていない場合)
tenancy

テナンシのOCID。この値を取得するには、必要なキーとOCIDを参照してください。

例: ocid1.tenancy.oc1..<unique_ID>

はい
region

Oracle Cloud Infrastructureリージョン。リージョンおよび可用性ドメインを参照してください。

例: us-ashburn-1

 はい
security_token_file

セッション・トークン認証を使用している場合は、このパラメータが必要です。

この認証方法を使用すると、fingerprint、userおよびpass_phraseは不要になります。OCI CLIでセッションを開始すると、この認証方法に必要なすべてのパラメータが移入されます。トークンベースのCLIセッションの開始を参照してください。

 条件付き

カスタム値

一部のOracle Cloud Infrastructure SDKでは、構成ファイルでのカスタム値の定義がサポートされています。詳細は、各SDKのドキュメントを参照してください。

プロファイルと継承

これらのエントリに対して様々な値の複数のプロファイルを作成し、ロードするプロファイルを指定できます。

一部のOracle Cloud Infrastructure SDKにはDEFAULTプロファイルが必要であり、プロファイルの継承がサポートされます。つまり、特定のプロファイルで明示的に定義されていない値はすべてDEFAULTプロファイルから継承されます。詳細は、各SDKのドキュメントを参照してください。

構成例

次の例(LinuxおよびMac OS用)は、構成ファイルのキー値と、プロファイル継承をサポートするSDKのプロファイルの設定方法を示しています。

[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>
この例は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>