Oracle Cloud Infrastructureドキュメント

SDKおよびCLI構成ファイル

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

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

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

CLIには構成ファイルが必要です。--regionは、CLI操作のパラメータとして渡すことができる唯一の構成値です。

ファイル名と位置

デフォルトの構成ファイル名とロケーションは~/.oci/configです。

ノート

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

ファイル・エントリ

次の表に、構成ファイルに必要な基本エントリと、必要な情報の入手先を示します。

エントリ 説明と値の入手場所 必須?
user

APIを呼び出すユーザーのOCID。 値を取得するには、「必要なキーとOCID」を参照してください。

例: ocid1.user.oc1..aaaaaaaa65vwl75tewwm32rgqvm6i34unq (簡略化のために短縮)

はい
fingerprint

使用されているキー・ペアのフィンガープリント。 値を取得するには、「必要なキーとOCID」を参照してください。

例: 20:3b:97:13:55:1c:5b:0d:d3:37:d8:50:4e:c5:3a:34

はい
key_file

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

重要: キー・ペアはPEM形式でなければなりません。 PEM形式でキー・ペアを生成する方法については、「必要なキーとOCID」を参照してください。

パスフレーズでキーを暗号化した場合は、構成ファイルにpass_phraseエントリも含める必要があります。

例: ~/.oci/oci_api_key.pem

はい
pass_phrase

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

例: examplephrase

キーが暗号化されている場合
テナンシ

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

例: ocid1.tenancy.oc1..aaaaaaaaba3pv6wuzr4h25vqstifsfdsq (簡略化のために短縮)

はい
region

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

例: us-ashburn-1

はい

カスタム値

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

警告

構成ファイルに機密情報を保存しないでください。

プロファイルと継承

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

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

構成例

次の例は、構成ファイル内のキー値と、プロファイル継承をサポートするSDKに対してプロファイルを設定する方法を示しています。

[DEFAULT]
user=ocid1.user.oc1..aaaaaaaat5nvwcna5j6aqzjcaty5eqbb6qt2jvpkanghtgdaqedqw3rynjq
fingerprint=20:3b:97:13:55:1c:5b:0d:d3:37:d8:50:4e:c5:3a:34
key_file=~/.oci/oci_api_key.pem
tenancy=ocid1.tenancy.oc1..aaaaaaaaba3pv6wkcr4jqae5f15p2b2m2yt2j6rx32uzr4h25vqstifsfdsq
region=us-ashburn-1

[ADMIN_USER]
user=ocid1.user.oc1..aaaaaaaa65vwl7zut55hiavppn4nbfwyccuecuch5tewwm32rgqvm6i34unq
fingerprint=72:00:22:7f:d3:8b:47:a4:58:05:b8:95:84:31:dd:0e
key_file=keys/admin_key.pem
pass_phrase=mysecretphrase