Object Storage Service:ossutil の設定

ossutil 2.0 へのアップグレード

ossutil 2.0 へのアップグレードを推奨します。ツールを迅速にインストールして使用する方法については、「ossutil のインストール」をご参照ください。

ossutil 2.0 の主な特徴は以下の通りです。

• 新しいコマンド構造：ossutil 2.0 は、ossutil api put-bucket-acl のような API レベルのコマンドや、ossutil config のような高レベルのコマンドを含む、複数レベルのコマンドをサポートします。

• 改善された構成管理：初期設定プロセスが簡素化されました。インストール後、AccessKey ID、AccessKey Secret、リージョンを提供するだけで基本設定を完了できます。また、--profile パラメーターを使用して複数の設定ファイルを指定することで、柔軟性を高めることができます。

• 豊富なフィルタリングパラメーター：ls、cp、rm などのバッチ処理コマンドに対して、複数のフィルター条件のサポートが追加されました。パス、ファイルサイズ、変更時刻、またはオブジェクトのメタデータでフィルタリングできます。これにより、操作の精度と効率が向上します。

• 柔軟な出力フォーマット：新しい --output-format パラメーターを使用すると、さまざまなデータ処理のニーズに合わせて出力フォーマットを JSON、YAML、または XML に設定できます。また、--output-query オプションも導入され、出力をフィルタリングして特定の情報を取得できます。

• 強化されたセキュリティ：セキュリティを向上させるため、ossutil 2.0 では環境変数を使用して機密パラメーターを設定できます。この方法により、キーがコマンドラインに表示されるのを防ぎ、漏洩のリスクを低減します。さらに、新しい --dry-run オプションを使用すると、コマンドを実行する前にその動作を検証でき、操作の正しさを確認できます。

config コマンドによるクイック設定

ほとんどの場合、config コマンドを使用して ossutil を迅速に設定できます。このコマンドは対話形式で設定ファイルを生成します。

以下の手順では、Linux 環境を例として使用します。

1. 設定コマンドを実行します。

   ossutil config

2. プロンプトに従って、設定ファイルのパスを設定します。

   要件に応じて設定ファイルのパスを設定できます。デフォルトでは、設定ファイルは ~/.ossutilconfig に保存されます。Enter キーを押してデフォルトを受け入れます。

   Please enter the config file name, the file name can be with a path (default is: /home/user/.ossutilconfig, press enter to use the default path. If you set it to another path, you should specify the path with --config-file option when you use other commands):

3. プロンプトに従って、ツールの言語を設定します。

   中国語の場合は CH、英語の場合は EN を入力します。デフォルトでは、ツールはご利用のオペレーティングシステムの言語を使用します。この設定は、config コマンドが完了した後に有効になります。

4. プロンプトに従って、endpoint、AccessKey ID、AccessKey Secret、stsToken パラメーターを設定します。Security Token Service (STS) からの一時トークンを使用して OSS にアクセスする場合は、stsToken パラメーターを設定する必要があります。それ以外の場合は、空のままにします。

   次の表にパラメーターを示します。

   パラメーター	必須	説明
   endpoint	はい	バケットが配置されているリージョンのエンドポイント。たとえば、シンガポール リージョンのパブリックエンドポイントを使用するには、値を https://oss-ap-southeast-1.aliyuncs.com に設定します。 同じリージョン内の他の Alibaba Cloud サービスから OSS にアクセスするには、内部エンドポイントを使用します。たとえば、値を https://oss-ap-southeast-1-internal.aliyuncs.com に設定します。 リージョンとエンドポイントの詳細については、「リージョンとエンドポイント」をご参照ください。 重要 コンプライアンスとセキュリティを向上させるためのポリシー変更により、2025年3月20日以降、新規の OSS ユーザーは、中国本土リージョンにある OSS バケットでデータ API オペレーションを実行するためにカスタムドメイン名 (CNAME ドメイン名) を使用する必要があります。これらの操作では、デフォルトのパブリックエンドポイントは制限されます。影響を受ける操作の完全なリストについては、公式発表をご参照ください。HTTPS 経由でデータにアクセスする場合は、カスタムドメインに有効な SSL 証明書をバインドする必要があります。これは、コンソールが HTTPS を強制するため、OSS コンソールへのアクセスには必須です。
   accessKeyID	はい	ご利用のアカウントの AccessKey ペア。AccessKey ペアの作成方法の詳細については、「AccessKey ペアの作成」をご参照ください。 Resource Orchestration Service (ROS) スクリプトを使用して、OSS 管理権限を持つ RAM ユーザーの AccessKey ペアを迅速に作成できます。 ROS コンソールの [スタックの作成] ページで、[セキュリティ確認] の下の確認チェックボックスを選択し、[作成] をクリックします。 スタックが作成されたら、[出力] タブに移動し、AccessKey ペアをコピーします。
   accessKeySecret	はい
   stsToken	いいえ	このパラメーターは、STS からの一時トークンを使用して OSS にアクセスする場合にのみ必須です。それ以外の場合は、空のままにします。stsToken の生成方法の詳細については、「AssumeRole」をご参照ください。

5. ステップ 2 で設定ファイルにカスタムパスを指定した場合、コマンドを実行するたびに -c オプションを追加して設定ファイルを指定する必要があります。

   たとえば、設定ファイルが /home/config に保存されている場合、ls コマンドを実行するときは次の形式を使用します。

   ossutil -c /home/config ls oss://examplebucket

設定ファイル

頻繁に使用する認証情報や設定情報を設定ファイルに保存すると便利です。設定ファイルは INI 形式を使用し、セクションとキーと値のペアで構成されます。設定パラメーターは特定のセクションに保存されます。次の表に、一般的な設定パラメーターを示します。

[Credentials]
language = CH

[Credentials]
accessKeyID = your_accesskey_id

[Credentials]
accessKeySecret = your_accesskey_secret

[Credentials]
stsToken = your_sts_token

[Credentials]
mode = RamRoleArn

[Credentials]
ramRoleArn = your_ram_role_arn

[Credentials]
roleSessionName = your_ram_role_session_name

[Credentials]
tokenTimeout = your_token_timeout

[Credentials]
ecsRoleName = your_ecs_role_name

設定パラメーターの詳細については、「設定ファイルの編集」をご参照ください。

コマンドラインオプション

コマンドラインオプションを使用して設定を指定することもできます。これは設定ファイルの設定よりも優先されます。

ossutil64 commandname options --loglevel debug

ossutil64 commandname options --connect-timeout 60

ossutil64 commandname options --read-timeout 60

ossutil64 commandname options --retry-times 20

ossutil64 commandname options -i your_access_key_id

ossutil64 commandname options -k your_access_key_secret

ossutil64 commandname options -i your_sts_token_accesskey_id -k your_sts_token_accesskey_secret -t your_sts_token

ossutil64 commandname options -i your_accesskey_id -k your_accesskey_secret --mode AK

ossutil64 commandname options --ram-role-arn your_ram_role_arn

ossutil64 commandname options --role-session-name your_ram_session_name

ossutil64 commandname options --token-timeout 1800

ossutil64 commandname options --ecs-role-name your_ecs_role_name

設定オプションの詳細については、「共通オプション」をご参照ください。

アクセス認証情報の設定

設定ファイルやコマンドラインオプションなど、複数の方法でアクセス認証情報を設定できます。

バケットごとの個別エンドポイントの設定

ossutil を使用して異なるリージョンにある複数のバケットを管理する場合、各バケットに個別のエンドポイントを設定する必要があります。これには 2 つの方法があります。

• 設定ファイルの使用

  設定ファイルに [Bucket-Endpoint] セクションを追加して、指定された各バケットに個別のエンドポイントを設定します。フォーマットは次のとおりです。

  [Bucket-Endpoint]
  bucket1 = endpoint1
  bucket2 = endpoint2
  ...

  次の例は、シンガポールリージョンのバケット (example-bucket-sg) と日本 (東京) リージョンのバケット (example-bucket-jp) のエンドポイントを設定する方法を示しています。

  次の設定ファイルを作成し、~/.myossutilconfig に保存します。

  [Credentials]
  endpoint = oss-ap-southeast-1.aliyuncs.com
  accessKeyID = yourAccessKeyID
  accessKeySecret = yourAccessKeySecret
  [Bucket-Endpoint]
  example-bucket-sg=oss-ap-southeast-1.aliyuncs.com
  example-bucket-jp=oss-ap-northeast-1.aliyuncs.com

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

  ossutil64 -c ~/.myossutilconfig ls oss://example-bucket-sg
  ossutil64 -c ~/.myossutilconfig ls oss://example-bucket-jp

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

  次の例は、シンガポールリージョンのバケット (example-bucket-sg) と日本 (東京) リージョンのバケット (example-bucket-jp) のエンドポイントを設定する方法を示しています。

  ~/.myossutilconfig でアカウント情報を設定します。

  [Credentials]
  endpoint = oss-ap-southeast-1.aliyuncs.com
  accessKeyID = yourAccessKeyID
  accessKeySecret = yourAccessKeySecret

  -e パラメーターを使用してエンドポイントを指定します。

  ossutil64 -c ~/.myossutilconfig ls oss://example-bucket-sg
  ossutil64 -c ~/.myossutilconfig -e oss-ap-northeast-1.aliyuncs.com ls oss://example-bucket-jp

カスタムドメイン名の設定

ossutil では、カスタムドメイン名を使用して OSS リソースにアクセスできます。この機能を使用する前に、設定ファイルでバケットをカスタムドメイン名にマップする必要があります。

設定ファイルに [Bucket-Cname] セクションを追加して、バケットをカスタムドメイン名にマップします。フォーマットは次のとおりです。

[Bucket-Cname]
bucket1 = cname1
bucket2 = cname2
...

次の例は、カスタムドメイン名 cname.example-***.com を使用して、シンガポール リージョンにある example-bucket という名前のバケットにアクセスする方法を示しています。

次の設定ファイルを作成し、~/.myossutilconfig に保存します。

[Credentials]
accessKeyID = yourAccessKeyID
accessKeySecret = yourAccessKeySecret
[Bucket-Cname]
example-bucket=cname.example-***.com

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

ossutil64 -c ~/.myossutilconfig ls oss://example-bucket