このトピックでは、-hコマンドを実行してossutilでサポートされているすべてのオプションを表示する方法について説明します。
ossutil 1.6.16以降の場合、コマンドラインでossutilをバイナリ名として直接使用できます。 オペレーティングシステムに基づいてバイナリ名を更新する必要はありません。 1.6.16より前のossutilの場合、オペレーティングシステムに基づいてバイナリ名を更新する必要があります。 詳細は、「ossutilコマンドリファレンス」をご参照ください。
コマンド構文
ossutil -hossutil -h
コマンドでサポートされているオプションを表示するには、ossutil help [command] コマンド (ossutil help cpなど) を実行します。
一般的なオプション
ossutilでサポートされているほとんどのコマンドに追加できる共通オプションを次の表に示します。
オプション | 説明 |
-c, -- config-file | ossutilの設定ファイルのパス。 ossutilが起動されると、構成ファイルが読み込まれます。 異なるAlibaba Cloudアカウントに属するバケットを管理する場合、複数の設定ファイルを生成し、その設定ファイルの1つをデフォルトの設定ファイルとして指定できます。 別のAlibaba Cloudアカウントに属するバケットを管理する場合、-cオプションを使用して設定ファイルを指定できます。 |
-e, -- endpoint | バケットのエンドポイント。 リージョン間でバケットを管理する場合、このオプションを使用してバケットのエンドポイントを指定できます。 各リージョンのエンドポイントの詳細については、「リージョンとエンドポイント」をご参照ください。 |
-i, -- access-key-id | Object Storage Service (OSS) へのアクセスに使用されるAccessKey ID。 異なるAlibaba Cloudアカウントに属するバケットを管理する場合、このオプションを使用してAccessKey IDを指定できます。 |
-k, -- access-key-secret | OSSへのアクセスに使用されるAccessKeyシークレット。 異なるAlibaba Cloudアカウントに属するバケットを管理する場合、このオプションを使用してAccessKeyシークレットを指定できます。 |
-p, -- password | OSSへのアクセスに使用されるAccessKeyシークレット。 コマンドでこのオプションを使用すると、ossutilはキーボードを使用して入力されたAccessKeyシークレットを読み取り、他の方法を使用して指定されたAccessKeyシークレットを無視します。 |
-- loglevel | 現在の作業ディレクトリにossutil.logファイルを生成します。 このオプションはデフォルトでは空で、ログファイルが生成されないことを指定します。 有効な値:
|
-- proxy-host、-- proxy-user、および -- proxy-pwd | 環境でサービスにアクセスするためにプロキシサーバーが必要な場合は、3つのオプションを使用してプロキシサーバーの情報を指定する必要があります。
3つのオプションを使用してプロキシサーバーの情報を指定すると、ossutilはプロキシサーバーを使用してOSSにアクセスします。
|
-- mode | 資格情報のタイプ。 有効な値:
このオプションを設定しない場合、デフォルトの認証ロジックが使用されます。 |
-- ecs-role-name | 認証用のEcsRamRoleモードのロール名。 |
-- 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が接続されているリージョン。 例: このオプションを設定しない場合、RamRoleArnモードでの認証に使用されるSTSエンドポイントは |
-- 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) 。 |
-- 範囲 | ダウンロードするオブジェクトのバイト範囲。 バイトは0から始まる番号が付けられます。
|
-すべてのバージョン | オブジェクトのすべてのバージョンを指定します。 |
-- type | データ検証に使用されるアルゴリズム。 有効な値:
|
-v, -- version | ossutilのバージョンを表示します。 |
-u, -- update | 更新操作を指定します。 |
-- 起源 | HTTPリクエストのOriginヘッダーの値。 |
-- upmode | probeコマンドで使用されるアップロード方法。 有効な値:
|
-- sseアルゴリズム | バケットの暗号化方法。 有効な値:
|
-含める | 指定された条件を満たすオブジェクトを一覧表示します。 たとえば、 詳細については、「オプション -- includeおよび -- exclude」をご参照ください。 |
-除外 | 指定された条件を満たさないオブジェクトを一覧表示します。 たとえば、 詳細については、「オプション -- includeおよび -- exclude」をご参照ください。 |
-r, -- recursive | 再帰操作を指定します。 このオプションを設定すると、バケット内のすべての条件が一致したオブジェクトに対して操作が実行されます。 このオプションを設定しない場合、操作はURLで指定されたオブジェクトに対してのみ実行されます。 |
-- addr | 接続を確認するネットワークのアドレス。 ossutilはpingコマンドを実行して、ローカルコンピューターと指定されたアドレス間のネットワーク接続を確認します。 デフォルト値: |
-- kms-masterkey-id | KMSで暗号化に使用する顧客マスターキー (CMK) ID。 |
-- version-id | オブジェクトのバージョンID。 |
-- version-id-marker | リスト操作の開始位置。 IDがmarkerの値の後にアルファベット順になっているオブジェクトバージョンが一覧表示されます。 このオプションは、バケットのバージョン管理が有効になっている場合にのみ設定できます。 |
-m, -- multipart | バケット内の不完全なマルチパートアップロードタスクに対して操作を実行することを指定します。 |
-d, -- directory | 現在のディレクトリ内のオブジェクトとサブディレクトリのみが返されるように指定します。 |
-- 支払人 | リクエストの支払人。 このオプションをrequesterに設定すると、pay-by-requesterモードが有効になります。 |
-- maxupspeed | 最大アップロード速度。 デフォルト値: 0 (無制限) 。 単位: KB/s。 |
-- maxdownspeed | 最大ダウンロード速度。 デフォルト値: 0 (無制限) 。 単位: KB/s。 |
-- retry-times | コマンドの実行時にエラーが発生した後のリトライ回数。 デフォルト値は 10 です。 有効な値: 1 ~ 500 説明 エラーが発生すると、すぐにリトライが実行されます。 |
-- ダウンロード | ossutilが、オブジェクトのURLを使用してバケットからオブジェクトをダウンロードすることにより、ローカルコンピューターとバケット間のネットワーク接続をチェックすることを指定します。 |
-j, -- jobs | 複数のオブジェクトで実行できる同時タスクの数。 有効な値: 1 ~ 10000 デフォルト値: 3。 |
-a, -- all-type | バケット内のオブジェクトおよび不完全なマルチパートアップロードタスクに対して操作を実行することを指定します。 |
-- disable-empty-referer | Refererフィールドを空にできないことを指定します。 |
-- メソッド | HTTP リクエストの方式。 有効な値: PUT、GET、およびDELETE。 |
-- output-dir | 出力オブジェクトが配置されているディレクトリを指定します。 出力オブジェクトには、cpコマンドを実行して複数のオブジェクトを同時にコピーするときに発生するエラーによって生成されるレポートオブジェクトが含まれます。 デフォルトでは、出力オブジェクトのディレクトリは現在のディレクトリのossutil_outputです。 |
-メタ | オブジェクトのメタデータを [header:value#header:value...] 形式で指定します。 例: |
-- object | probeコマンドのオブジェクト名。 |
-終了時間 | LinuxまたはUNIXのタイムスタンプ。 最後に変更された時刻がタイムスタンプより後のオブジェクトは無視されます。 |
-- 限られたnum | 返される結果の最大数。 |
-L、-- language | ossutilが使用する言語。 デフォルト値: CH。 有効な値:
|
-- 削除 | バケット、オブジェクト、またはパーツを削除します。 |
-b, -- bucket | コマンドを実行してバケットを削除することを指定します。 このオプションは、バケットを削除する場合にのみ適用されます。 |
-- disable-crc64 | データ送信のCRC-64を無効にします。 デフォルトでは、ossutilを使用してデータを転送するときにCRC-64が有効になります。 |
-- upload | ローカルファイルをバケットにアップロードして、ローカルコンピューターとバケット間のネットワーク接続を確認します。 |
-- 部分サイズ | 部品サイズ (バイト単位) 。 デフォルトでは、ossutilはオブジェクトサイズに基づいて適切な部品サイズを計算します。 このオプションを設定して、パフォーマンスを最適化したり、特別な要件を満たしたりできます。 有効な値: 1 ~ 9223372036854775807 |
-- timeout | 署名付きURLのタイムアウト期間。 有効な値: 0 ~ 9223372036854775807 デフォルト値: 60。 単位は秒です。 |
-- checkpoint-dir | 再開可能なアップロード、ダウンロード、またはコピータスクのチェックポイント情報が格納されるディレクトリ。 タスクが失敗すると、ossutilは自動的にという名前のディレクトリを作成します。 |
-- url | オブジェクトURL。 |
-- マーカー | リスト操作の開始位置。 バケット、オブジェクト、または部品の名前がマーカーの後にアルファベット順に表示されます。 |
-f, -- force | 確認のプロンプトなしで操作を強制的に実行するように指定します。 |
-- snapshot-path | アップロードされたオブジェクトとダウンロードされたオブジェクトのスナップショットを保存するディレクトリ。 このオプションを設定すると、ossutilは指定されたディレクトリからスナップショット情報を読み取り、オブジェクトがアップロードまたはダウンロードされたときに増分アップロードまたはダウンロードを実行します。
|
-- 開始時間 | LinuxまたはUNIXのタイムスタンプを指定します。 このオプションを設定すると、最終変更時刻がタイムスタンプより前のオブジェクトは無視されます。 |
-- ストレージクラス | オブジェクトのストレージクラス。 有効な値:
|
-t, -- sts-token | OSSへのアクセスに使用されるSTSトークンを指定します。 このオプションは、STSを使用してOSSへの一時アクセスを許可する場合にのみ必要です。 このオプションの値は、構成ファイルの構成を上書きします。 STSトークンを生成する方法の詳細については、「許可されたサードパーティのアップロード」をご参照ください。 |
-- 平行 | 1つのオブジェクトに対して実行する同時操作の数。 有効な値: 1 ~ 10000 既定では、ossutilは操作タイプとオブジェクトサイズに基づいてこのオプションの値を自動的に設定します。 |
-- partition-download | ダウンロードするパーティション。 このオプションの値は、 |
-- bucketname | バケットの名前です。 |
-- encoding-type |
|
-- 起源 | HTTPリクエストのOriginヘッダーの値。 このオプションの値は、クロスオリジンリクエストの送信元となるソースドメインを指定します。 |
-- acr-method | HTTPリクエストのAccess-Control-Request-Methodヘッダーの値。 有効な値: GET、PUT、POST、DELETE、およびHEAD。 |
-- acr-headers | HTTPリクエストのAccess-Control-Request-Headersヘッダーの値。 このオプションの値は、リクエストに追加する必要があるヘッダーを指定します。 ヘッダーには、共通リクエストヘッダーは含まれません。 複数のヘッダーを指定するには、ヘッダーをコンマ (,) で区切り、ヘッダーを二重引用符 ("") で囲みます。 例: -- acr-headers "header1,header2,header3" |
-- upload-id-marker | リスト操作の開始位置。 アップロードIDがマーカーの後にアルファベット順である部品が一覧表示されます。 |
-h、-- ヘルプ | 指定したコマンドのヘルプ情報を表示します。 |
-- trafic-limit | signコマンドでのHTTPによるアクセス速度。 単位:bit/s。 デフォルト値:0 0の値は、アクセス速度が無制限であることを指定します。 有効な値: 819200〜838860800 (100 KB/s〜100メガバイト/秒) 。 |
-- local-host | cpコマンド内のossutilのローカルIPアドレス。 このオプションを設定すると、指定されたIPアドレスを使用してOSSにアクセスします。 |
-- enable-symlink-dir | シンボリックリンクポイントがアップロードされるサブディレクトリ。 デフォルトでは、サブディレクトリはアップロードされません。 probeコマンドを使用して、シンボリックリンクが指すオブジェクトまたはディレクトリもシンボリックリンクであるかどうかを確認できます。 |
-- only-current-dir | 現在のディレクトリ内のオブジェクトのみをアップロード、ダウンロード、またはコピーすることを指定します。 現在のディレクトリ内のサブディレクトリおよびサブディレクトリ内のオブジェクトは無視されます。 |
-- disable-dir-object | アップロードするディレクトリに対してOSSオブジェクトが生成されないことを指定しますが、ディレクトリはOSSコンソールのディレクトリ構造に保持されます。 ディレクトリ内のすべてのオブジェクトを削除すると、ディレクトリも削除されます。 |
-- probe-item | probeコマンドを使用して確認する項目。 有効な値:
|
-- redundancyタイプ | バケットの冗長タイプ。 有効な値:
|
-- disable-encode-スラッシュ | URLのスラッシュ (/) をエンコードしないように指定します。 |
-- disable-all-symlink | シンボリックリンクが指すサブディレクトリおよびシンボリックリンクが指すサブディレクトリ内のすべてのオブジェクトが、オブジェクトのアップロード中に無視されることを指定します。 |
-- タグ付け | オブジェクトをアップロードまたはコピーするときのオブジェクトタグ。 例: |
-- disable-無視-エラー | エラーによって例外がスローされ、コマンドが終了します。 バッチ操作でエラーが無視されないように指定します。 |
-- ブロックサイズ | 指定されたバケットまたはディレクトリ内のオブジェクトの取得された合計サイズの単位。 有効な値: 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"
条件を評価し、オブジェクト名に ".txt" が含まれているため、test.txtオブジェクトが一致していることを確認し、結果からオブジェクトを除外します。 test.txtオブジェクトは最終結果から除外されます。ルール2:
-- exclude "*.txt" -- include "* test *"
。 ossutilは最初に-- exclude "*.txt"
条件を評価し、オブジェクトが一致するため、結果からtest.txtオブジェクトを除外します。 次に、ossutilは-- include "* test *"
条件を評価し、オブジェクト名に "test" が含まれているため、test.txtオブジェクトが一致していることを確認し、そのオブジェクトを結果に含めます。 test.txtオブジェクトが最終結果に含まれます。ルール3:
-- include "* test *" -- exclude "*.txt" -- include "te?t.txt"
。 ossutilは最初に-- include "* test *"
条件を評価し、test.txtオブジェクトが一致することを確認してから、そのオブジェクトを結果に含めます。 次に、ossutilは-- exclude "*.txt"
条件を評価し、オブジェクト名に "txt" が含まれているため、test.txtオブジェクトが一致していることを確認し、結果からオブジェクトを除外します。 最後に、ossutilは-- include "te?t.txt"
条件を評価し、test.txtオブジェクトが一致していることを確認し、そのオブジェクトを結果に含めます。 test.txtオブジェクトが最終結果に含まれます。
使用上の注意
アスタリスク (*): 任意の数の文字に一致します。 たとえば、*.txtはすべてのTXTファイルと一致します。
疑問符 (?): 1文字に一致します。 たとえば、abc?.jpgは、abc1.jpgのように、名前が「abc」の後に1文字が続くすべてのJPGオブジェクトと一致します。
[sequence]: シーケンス内の文字に一致します。 たとえば、abc[1-5].jpgは、名前が "abc" の後に [1-5] の数字が続くJPGオブジェクトと一致します。 オブジェクトには、abc1.jpg、abc2.jpg、abc3.jpg、abc4.jpg、およびabc5.jpgが含まれます。
[!sequence]: シーケンス外の文字に一致します。 たとえば、abc[!0-7].jpgは、abc0.jpg、abc1.jpg、abc2.jpg、abc3.jpg、abc4.jpg、およびabc5.jpg、abc6.jpg、abc7.jpg以外のオブジェクトに一致します。
制限事項
-- includeまたは -- excludeオプションにディレクトリを指定できません。 たとえば、ossutil cp oss:// examplebucket/destfolder/ localfolder/ -- include dir //
は、-- includeまたは -- exclude does not support format containing dir infoエラーをトリガーします。