Object Storage Service:ossutil の設定

前提条件

• ossutilがインストールされています。 詳細については、「ossutilのインストール」をご参照ください。

• Object Storage Service (OSS) が有効化されています。 詳細については、「OSSの使用を開始する」をご参照ください。

設定方法

設定ファイル、環境変数、コマンドラインオプションなど、複数の方法を使用してossutilを設定できます。

• 設定ファイル: ossutilの設定ファイルはINIファイル形式で、パラメーターを指定できます。

• 環境変数: ossutilは、構成ファイルよりも優先される複数の環境変数をサポートします。 これらの変数を使用してossutilを設定できます。

• コマンドラインオプション: ossutilには複数のコマンドラインオプションがあります。 これらのオプションを使用してossutilを設定できます。

構成ファイルの設定

一般的に使用されるossutil構成設定とアクセス資格情報を構成ファイルに保存できます。 設定ファイルの設定はセクションに分類されます。 -- profileオプションを使用して、ossutilが使用する特定のセクションを指定できます。 デフォルトでは、ossutilは構成ファイルのデフォルトセクションの設定を使用します。 他の設定を作成および参照できます。

設定ファイルの形式

ossutilの設定ファイルはINIファイル形式です。 INI設定ファイルはセクションで構成されています。

• セクション内のパラメータは、key=value形式です。

• セクション名とキー名は大文字と小文字を区別しません。

• キーは小文字と小さなラクダのケースにすることができます。 キー内の単語は、ハイフン文字 (-) またはアンダースコア文字 (_) で区切ることができます。 たとえば、accesskeyid、accessKeyId、access-key-ID、またはaccess_key_idを使用して、構成ファイルにAccessKey idを設定できます。

• コメントは数字記号 (#) で始まります。

サポートされているセクションタイプ

[buckets name]
bucket-name = 
  key=value

[buckets dev-bucket]
bucket-hz-01 = 
  region=cn-hangzhou
bucket-hz-02 = 
  region=cn-hangzhou
  endpoint=test.com
  addressing-style=cname
bucket-bj-01 = 
  region=cn-beijing

環境変数

ossutilでサポートされている環境変数を次の表に示します。

アクセス資格情報の設定

次の方法を使用して、さまざまな種類のアクセス資格情報を設定できます。

一時的なアクセス資格情報の設定

• 設定ファイルを使用して

  次の設定を含む構成ファイル ~/.myossutilconfigを作成します。

  [default]
  accessKeyID = STS.LTAI4Fw2NbDUCV8z********
  accessKeySecret = 67DLVBkH7EamOjy2W5RVAH********
  stsToken = yourSecurityToken
  region=cn-hangzhou

  次のコマンドを実行して、examplebucketのオブジェクトを一覧表示します。

  ossutil ls oss://examplebucket -c ~/.myossutilconfig

• 環境変数の使用

  export OSS_ACCESS_KEY_ID=STS.LTAI4Fw2NbDUCV8z********
  export OSS_ACCESS_KEY_SECRET=67DLVBkH7EamOjy2W5RVAH********
  export OSS_SESSION_TOKEN=yourSecurityToken
  ossutil ls oss://examplebucket

• コマンドラインオプションの使用 (非推奨)

  次のコマンドを実行して、examplebucketバケット内のオブジェクトを一覧表示します。

  ossutil ls oss://examplebucket -i STS.LTAI4Fw2NbDUCV8z******** -k 67DLVBkH7EamOjy2W5RVAH******** -t yourSecurityToken

長期アクセス資格情報の設定

• 設定ファイルを使用して

  次の設定を含む構成ファイル ~/.myossutilconfigを作成します。

  [default]
  accessKeyID = LTAI4Fw2NbDUCV8z********
  accessKeySecret = 67DLVBkH7EamOjy2W5RVAH********
  region=cn-hangzhou

  次のコマンドを実行して、examplebucketのオブジェクトを一覧表示します。

  ossutil ls oss://examplebucket -c ~/.myossutilconfig

• 環境変数の使用

  export OSS_ACCESS_KEY_ID=LTAI4Fw2NbDUCV8z********
  export OSS_ACCESS_KEY_SECRET=67DLVBkH7EamOjy2W5RVAH********
  ossutil ls oss://examplebucket

• コマンドラインオプションの使用 (非推奨)

  次のコマンドを実行して、examplebucketのオブジェクトを一覧表示します。

  ossutil ls oss://examplebucket -i LTAI4Fw2NbDUCV8z******** -k 67DLVBkH7EamOjy2W5RVAH********

RAMユーザーのアクセス資格情報

設定ファイルを使用して

次の設定を含む構成ファイル ~/.myossutilconfigを作成します。

[default]
accessKeyID = LTAI4Fw2NbDUCV8z********
accessKeySecret = 67DLVBkH7EamOjy2W5RVAH********
mode = RamRoleArn
roleArn = acs:ram::137918634953****:role/Alice
roleSessionName = session_name_example
region=cn-hangzhou

次のコマンドを実行して、examplebucketのオブジェクトを一覧表示します。

ossutil ls oss://examplebucket -c ~/.myossutilconfig

ECSインスタンスのRAMロールのアクセス資格情報

• 設定ファイルを使用して

  次の設定を含む構成ファイル ~/.myossutilconfigを作成します。

  [default]
  mode = EcsRamRole
  # The ecsRoleName parameter is optional. If you do not set this parameter, the value is automatically obtained. 
  ecsRoleName = EcsRamRoleOss 
  region=cn-hangzhou

  次のコマンドを実行して、examplebucketのオブジェクトを一覧表示します。

  ossutil ls oss://examplebucket -c ~/.myossutilconfig

• コマンドラインオプションを使用

  次のコマンドを実行して、examplebucketのオブジェクトを一覧表示します。

  ossutil ls oss://examplebucket --mode EcsRamRole

OIDCアクセス資格情報

OIDCロールベースSSOの詳細については、「OIDCベースSSOの概要」をご参照ください。

設定ファイルを使用して

次の設定を含む構成ファイル ~/.myossutilconfigを作成します。

[default]
mode = oidcRoleArn
# Provide the ARN of the OIDC IdP in the format of acs:ram::account-id:oidc-provider/provider-name. 
OIDCProviderArn=acs:ram::113511544585****:oidc-provider/TestOidcProvider
# Specify the path to the OIDC token.
OIDCTokenFilePath=OIDCTokenFilePath
# Specify the ARN of the role, that is, the ID of the role. The ARN is in the acs:ram::113511544585****:oidc-provider/TestOidcProvider format.
roleArn=acs:ram::113511544585****:role/testoidc
# Specify the session name, which is used to differentiate tokens. 
roleSessionName= TestOidcAssumedRoleSession
region=cn-hangzhou

次のコマンドを実行して、examplebucketのオブジェクトを一覧表示します。

ossutil ls oss://examplebucket -c ~/.myossutilconfig

外部プロセスを使用したアクセス資格情報の取得

ossutilは、外部コマンドを使用して、ossutilプロセスとは別の外部プロセスを開始します。 外部プロセスは、標準出力を使用して出力をossutilに返します。 外部プロセスを使用してアクセス資格情報を取得できます。

外部コマンドは、長期および一時的なアクセス資格情報を返すことができます。

• 長期的な資格情報

  {
  	"AccessKeyId" : "ak",
  	"AccessKeySecret" : "sk",
  }

• 一時的な資格情報

  {
  	"AccessKeyId" : "ak",
  	"AccessKeySecret" : "sk",
  	"Expiration" : "2023-12-29T07:45:02Z",
  	"SecurityToken" : "token",
  }

設定ファイルを使用して

次の設定を含む構成ファイル ~/.myossutilconfigを作成します。

[default]
mode = Process
credentialProcess = user-cmd
region=cn-hangzhou

次のコマンドを実行して、examplebucketのオブジェクトを一覧表示します。

ossutil ls oss://examplebucket -c ~/.myossutilconfig