ossutil -h を実行して、ossutil でサポートされるすべてのオプションを表示します。
ossutil バージョン 1.6.16 以降では、すべてのオペレーティングシステムでバイナリ名として ossutil を使用します。それ以前のバージョンでは、OS 固有のバイナリ名が必要です。詳細については、「ossutil コマンドリファレンス」をご参照ください。コマンド構文
ossutil -h特定のコマンドについてのオプションを表示するには、ossutil help [command] を実行します。例:
ossutil help cp共通オプション
以下のオプションは、ほとんどの ossutil コマンドに適用されます。
| オプション | 説明 |
|---|---|
-c, --config-file | ossutil 構成ファイルのパス。ossutil は起動時にこのファイルを読み込みます。複数の Alibaba Cloud アカウント間でバケットを管理する場合は、複数の構成ファイルを作成し、本オプションで指定してください。 |
-e, --endpoint | バケットのエンドポイント。本オプションを使用して、リージョン間のバケット管理を行います。詳細については、「リージョンとエンドポイント」をご参照ください。 |
-i, --access-key-id | Object Storage Service (OSS) へのアクセスに使用する AccessKey ID。本オプションを使用して、異なる Alibaba Cloud アカウントに属するバケットを管理します。 |
-k, --access-key-secret | Object Storage Service (OSS) へのアクセスに使用する AccessKey Secret。本オプションを使用して、異なる Alibaba Cloud アカウントに属するバケットを管理します。 |
-p, --password | Object Storage Service (OSS) へのアクセスに使用する AccessKey Secret をキーボードから対話形式で入力します。本値は、他の方法で設定された AccessKey Secret をオーバーライドします。 |
--loglevel | 現在の作業ディレクトリに生成される ossutil.log ファイルのログレベル。デフォルト:ログファイルは生成されません。有効な値:info — 操作をログ記録します。例:ossutil [command] --loglevel=info。debug — HTTP リクエスト、応答、およびトラブルシューティング用の生の署名文字列をログ記録します。例:ossutil [command] --loglevel=debug。 |
--proxy-host、--proxy-user、--proxy-pwd | プロキシサーバーの設定。ossutil のトラフィックをプロキシ経由でルーティングするには、これら 3 つのオプションをすべて指定します。--proxy-host:プロキシ URL。HTTP、HTTPS、SOCKS5 をサポートします。--proxy-user:プロキシユーザー名。デフォルト:空。--proxy-pwd:プロキシパスワード。デフォルト:空。例:ossutil ls oss://bucket1 --proxy-host http://47.88.**:3128 --proxy-user test --proxy-pwd test |
--mode | 認証に使用する資格情報の種類。有効な値:AK — AccessKey ID および AccessKey Secret。StsToken — セキュリティトークンサービス (STS) トークン。RamRoleArn — Resource Access Management (RAM) を介した AssumeRole。EcsRamRole — Elastic Compute Service (ECS) インスタンスからのパスワード不要認証。デフォルト:デフォルトの認証ロジック。 |
--ecs-role-name | EcsRamRole 認証用の RAM ロール名。 |
--token-timeout | RamRoleArn 認証における AssumeRole で取得したトークンの有効期間。デフォルト:3600。単位:秒。 |
--ram-role-arn | RamRoleArn 認証用の RAM ロールの Alibaba Cloud リソースネーム (ARN)。 |
--role-session-name | RamRoleArn 認証用のセッション名。 |
--read-timeout | クライアントの読み取りタイムアウト。デフォルト:1200。単位:秒。 |
--connect-timeout | クライアントの接続タイムアウト。デフォルト:120。単位:秒。 |
--sts-region | STS エンドポイントのリージョン。例:cn-hangzhou。サポートされているすべてのリージョンについては、「エンドポイント」をご参照ください。デフォルト:sts.aliyuncs.com。 |
--skip-verify-cert | サーバー証明書の検証をスキップします。 |
--ua | カスタム User-Agent ヘッダー値。指定した値は、ossutil のデフォルト User-Agent 文字列に追加されます。完全な User-Agent 値を確認するには、--loglevel debug を使用します。 |
コマンド固有のオプション
以下のオプションは、特定の ossutil コマンドで利用できます。
| オプション | 説明 |
|---|---|
-s, --short-format | アイテムを短縮形式で表示します。デフォルト:長形式。 |
--bigfile-threshold | 再開可能なアップロードのオブジェクトサイズしきい値。デフォルト:104857600(100 MB)。有効な値:0 ~ 9223372036854775807。単位:バイト。 |
--acl | 適用するアクセス制御リスト (ACL)。 |
--range | ダウンロード対象のオブジェクトのバイト範囲。バイト番号は 0 から始まります。フォーマット:3-9 — バイト 3 から 9 まで(両端含む)。3- — バイト 3 からオブジェクト末尾まで。-9 — バイト 0 からバイト 9 まで(両端含む)。 |
--all-versions | オブジェクトのすべてのバージョンに対して操作を適用します。 |
--type | データ検証に使用するアルゴリズム。デフォルト:crc64。有効な値:crc64、md5。 |
-v, --version | ossutil のバージョンを表示します。 |
-u, --update | 増分操作を実行します。 |
--origin | HTTP リクエストにおける Origin ヘッダーの値。 |
--upmode | probe コマンドのアップロード方式。デフォルト:normal。有効な値:normal — シンプルアップロード。append — 追加アップロード。multipart — マルチパートアップロード。 |
--sse-algorithm | バケットのサーバー側暗号化アルゴリズム。有効な値:KMS — Key Management Service (KMS) が管理するキーによる暗号化(SSE-KMS)。AES256 — OSS が管理するキーによる暗号化(SSE-OSS)。 |
--include | 指定したパターンに一致するオブジェクトのみを含めます。例:*.jpg はすべての JPG オブジェクトを含めます。「--include および --exclude のパターン動作」をご参照ください。 |
--exclude | 指定したパターンに一致するオブジェクトを除外します。例:*.txt はすべての TXT オブジェクトを除外します。「--include および --exclude のパターン動作」をご参照ください。 |
-r, --recursive | バケット内の該当するすべてのオブジェクトに対して操作を再帰的に実行します。本オプションを指定しない場合、URL で指定されたオブジェクトのみが対象となります。 |
--addr | 接続性チェック用のネットワークアドレス。ossutil はこのアドレスに対して ping を実行します。デフォルト:www.aliyun.com。 |
--kms-masterkey-id | KMS 暗号化用のカスタマーマスターキー (CMK) ID。 |
--version-id | オブジェクトのバージョン ID。 |
--version-id-marker | オブジェクトバージョンの一覧表示の開始位置。この値よりアルファベット順で後ろにある ID を持つバージョンを一覧表示します。バケットでバージョン管理が有効になっている必要があります。 |
-m, --multipart | バケット内の未完了のマルチパートアップロードタスクに対して操作を適用します。 |
-d, --directory | 現在のディレクトリ内のオブジェクトおよびサブディレクトリのみを返します。 |
--payer | リクエスト発行者。リクエスト元支払いモードを有効にするには、requester を設定します。 |
--maxupspeed | 最大アップロード速度。デフォルト:0(無制限)。単位:KB/s。 |
--maxdownspeed | 最大ダウンロード速度。デフォルト:0(無制限)。単位:KB/s。 |
--retry-times | エラー発生時のリトライ回数。デフォルト:10。有効な値:1 ~ 500。エラー直後に即時リトライが実行されます。 |
--download | バケット内のオブジェクトの URL を使用してダウンロードを行い、ネットワーク接続性を確認します。 |
-j, --jobs | 複数のオブジェクトに対する同時タスク数。デフォルト:3。有効な値:1 ~ 10000。 |
-a, --all-type | バケット内のオブジェクトおよび未完了のマルチパートアップロードタスクの両方に対して操作を適用します。 |
--disable-empty-referer | 空の Referer ヘッダーを持つリクエストをブロックします。 |
--method | HTTP リクエストメソッド。有効な値:PUT、GET、DELETE。 |
--output-dir | 出力ファイル(例:cp コマンドのバッチ操作中に生成されるエラーレポートなど)の保存先ディレクトリ。デフォルト:ossutil_output(現在のディレクトリ内)。 |
--meta | ヘッダー形式 [header:value#header:value...] のオブジェクトメタデータ。例:Cache-Control:no-cache#Content-Encoding:gzip。 |
--object | probe コマンドのオブジェクト名。 |
--end-time | Linux/UNIX タイムスタンプ。最終更新時刻が本値より後のオブジェクトは無視されます。 |
--limited-num | 返される結果の最大数。 |
-L, --language | ossutil の出力言語。デフォルト:CH。有効な値:CH — 中国語(UTF-8 エンコーディングが必要)。EN — 英語。 |
--delete | 指定されたバケット、オブジェクト、またはパーツを削除します。 |
-b, --bucket | 削除操作の対象がバケットであることを指定します。 |
--disable-crc64 | データ転送時の CRC-64 検証を無効化します。デフォルトでは CRC-64 が有効です。 |
--upload | ローカルファイルをバケットにアップロードして、ネットワーク接続性を確認します。 |
--part-size | マルチパート操作のパーツサイズ。デフォルトでは、ossutil がオブジェクトに基づいて適切なサイズを自動計算します。有効な値:1 ~ 9223372036854775807。単位:バイト。 |
--timeout | 署名付き URL の有効期間。デフォルト:60。有効な値:0 ~ 9223372036854775807。単位:秒。 |
--checkpoint-dir | 再開可能なアップロード、ダウンロード、またはコピー操作中のチェックポイントデータの保存先ディレクトリ。タスクが失敗した場合、ossutil は .ossutil_checkpoint ディレクトリを作成し、そこにチェックポイントデータを保存します。成功した場合、ossutil はそのディレクトリを削除します。カスタムディレクトリを指定する場合は、削除可能であることを確認してください。 |
--url | オブジェクトの URL。 |
--marker | 一覧表示操作の開始位置。本値よりアルファベット順で後ろにある名前のアイテム(バケット、オブジェクト、またはパーツ)が一覧表示されます。 |
-f, --force | 確認プロンプトを表示せずに操作を強制実行します。 |
--snapshot-path | アップロードまたはダウンロードされたオブジェクトのスナップショットを保存するディレクトリ。本オプションを指定すると、ossutil はスナップショットデータを読み取り、増分アップロードまたはダウンロードを実行します。使用上の注意点:多数のオブジェクトに対する増分アップロードまたはダウンロードを高速化するために本オプションを使用します。コピー操作ではサポートされていません。本オプションでは、オブジェクトの最終更新時刻がローカルに記録されます。実行間において、OSS 上のオブジェクトは他のユーザーによって変更されてはなりません。実行間でオブジェクトが変更される可能性がある場合は、代わりに増分操作に --update を使用してください。スナップショットデータは自動的に削除されません。古くなったスナップショットは手動で削除してください。スナップショットデータの読み書きにはオーバーヘッドが伴います。小規模なオブジェクト数や良好なネットワーク環境では、代わりに --update を使用してください。--update と --snapshot-path の両方を組み合わせて使用できます。ossutil はまずスナップショットを確認し、その後 --update のロジックにフォールバックします。 |
--start-time | Linux/UNIX タイムスタンプ。最終更新時刻が本値より前のオブジェクトは無視されます。 |
--storage-class | オブジェクトのストレージクラス。デフォルト:Standard。有効な値:Standard — 頻繁にアクセスされるデータ向け。IA — 低頻度アクセス。最小保存期間:30 日、最小課金サイズ:64 KB。リアルタイムアクセスをサポートしますが、データ取得料金が発生します。Archive — 長期保存向け。最小保存期間:60 日、最小課金サイズ:64 KB。復元が必要(約 1 分程度)であり、データ取得料金が発生します。ColdArchive — まれにアクセスされる長期保存向け。最小保存期間:180 日、最小課金サイズ:64 KB。復元が必要(オブジェクトサイズおよび復元モードにより所要時間が異なります)であり、データ取得料金が発生します。 |
-t, --sts-token | OSS への一時アクセスに使用する STS トークン。STS を使用した認証の場合のみ必須です。本値は構成ファイル内のトークンをオーバーライドします。詳細については、「承認済みサードパーティによるアップロード」をご参照ください。 |
--parallel | 単一オブジェクトに対する同時操作数。デフォルト:操作タイプおよびオブジェクトサイズに基づき自動計算されます。有効な値:1 ~ 10000。 |
--partition-download | ダウンロード対象のパーティション(partition_number:total_partitions 形式)。例:1:5 は 5 個のパーティションのうち 1 番目のパーティションをダウンロードします。パーティションは 1 から始まる番号で識別され、パーティション分割は ossutil が決定します。本オプションを使用して、オブジェクトを複数の同時 ossutil コマンドに分割し、各コマンドが自身のパーティションをダウンロードできるようにします。 |
--bucketname | バケット名。 |
--encoding-type | oss://bucket_name の後に続くオブジェクトキーのエンコーディングタイプ。有効な値:url。デフォルト:エンコーディングなし。 |
--origin | HTTP リクエストにおける Origin ヘッダーの値。クロスオリジンリクエストのソースドメインを指定します。 |
--acr-method | Access-Control-Request-Method ヘッダーの値。有効な値:GET、PUT、POST、DELETE、HEAD。 |
--acr-headers | Access-Control-Request-Headers ヘッダーの値。標準外のリクエストヘッダーを指定します。複数のヘッダーをカンマで区切り、二重引用符で囲みます。例:--acr-headers "header1,header2,header3"。 |
--upload-id-marker | マルチパートアップロードタスクの一覧表示の開始位置。本値よりアルファベット順で後ろにあるアップロード ID を持つタスクを一覧表示します。 |
-h, --help | コマンドのヘルプ情報を表示します。 |
--trafic-limit | 署名付き URL の HTTP アクセス速度制限。デフォルト:0(無制限)。有効な値:819200 ~ 838860800(100 KB/s ~ 100 MB/s)。単位:bit/s。 |
--local-host | cp コマンドで ossutil が使用するローカル IP アドレス。 |
--enable-symlink-dir | シンボリックリンクが指すサブディレクトリをアップロードします。デフォルトでは、これらのサブディレクトリはアップロードされません。「probe」コマンドを使用して、シンボリックリンク先がさらにシンボリックリンクであるかを確認できます。 |
--only-current-dir | 現在のディレクトリ内のオブジェクトのみをアップロード、ダウンロード、またはコピーします。サブディレクトリおよびその内容は無視されます。 |
--disable-dir-object | アップロードされたディレクトリに対して OSS オブジェクトを生成しないようにします。ディレクトリ構造は OSS コンソール上で維持されますが、ディレクトリ内のすべてのオブジェクトを削除すると、ディレクトリ自体も削除されます。 |
--probe-item | probe コマンドでチェックする項目。有効な値:upload-speed — アップロード帯域幅をチェックします。download-speed — ダウンロード帯域幅をチェックします。cycle-symlink — ローカルのシンボリックリンクが自己参照しているかをチェックします。 |
--redundancy-type | バケットのデータ冗長性タイプ。デフォルト:LRS。有効な値:LRS — ローカル冗長ストレージ。各オブジェクトのコピーを同一ゾーン内の異なるデバイスに保存します。ZRS — ゾーン冗長ストレージ。同一リージョン内の複数のゾーンにコピーを保存し、ゾーン障害時でも可用性を確保します。 |
--disable-encode-slash | URL 内のスラッシュ (/) のエンコーディングを防止します。 |
--disable-all-symlink | アップロード時にすべてのシンボリックリンクおよびそのターゲットサブディレクトリを無視します。 |
--tagging | アップロードまたはコピー時に適用するオブジェクトタグ。例:"abc=1&bcd=2&..."。 |
--disable-ignore-error | エラー発生時にバッチ操作を停止し、エラーを無視しないようにします。 |
--block-size | バケットまたはディレクトリ内の合計オブジェクトサイズを表示する際の単位。有効な値:KB、MB、GB、TB。デフォルト:バイト。重要 ossutil バージョン 1.7.3 以降で利用可能です。 |
--include および --exclude のパターン動作
左から右への評価
ルールには複数の --include および --exclude 条件を含めることができます。ossutil は、最終的な結果を判断するために条件を左から右へ評価します。たとえば、対象ディレクトリに test.txt オブジェクトがある場合:
ルール 1:
--include "*test*" --exclude "*.txt"ossutil はまず--include "*test*"を評価し、test.txtがパターンに一致するためこれを含めます。次に ossutil は--exclude "*.txt"を評価し、test.txtが*.txtに一致するためこれを除外します。結果:除外。ルール 2:
--exclude "*.txt" --include "*test*"ossutil はまず--exclude "*.txt"を評価し、test.txtを除外します。次に ossutil は--include "*test*"を評価し、test.txtがパターンに一致するためこれを含めます。結果:含める。ルール 3:
--include "*test*" --exclude "*.txt" --include "te?t.txt"ossutil は--include "*test*"を評価(含める)、次に--exclude "*.txt"を評価(除外)、最後に--include "te?t.txt"を評価(含める)します。結果:含める。
ワイルドカードパターン
| パターン | 説明 | 例 |
|---|---|---|
* | 任意の数の文字に一致します。 | *.txt はすべての TXT ファイルに一致します。 |
? | 1 文字に一致します。 | abc?.jpg は abc1.jpg、abcX.jpg などに一致します。 |
[sequence] | シーケンス内のいずれかの文字に一致します。 | abc[1-5].jpg は abc1.jpg から abc5.jpg までに一致します。 |
[!sequence] | シーケンス内にない文字に一致します。 | abc[!0-7].jpg は abc8.jpg や abc9.jpg に一致しますが、abc0.jpg から abc7.jpg には一致しません。 |
制限事項
--include および --exclude のパターンではディレクトリパスを指定できません。たとえば、以下のコマンドは --include または --exclude はディレクトリ情報を含むフォーマットをサポートしていません というエラーを発生させます:
ossutil cp oss://examplebucket/destfolder/ localfolder/ --include "dir/"