ossutil のバッチオペレーション、フィルタリング、メタデータ、転送コントロール用の詳細オプションを設定します。
コマンドの説明
|
コマンドの範囲 |
サポートされているオプション |
|
すべての高度なコマンド |
|
|
バッチ操作をサポートするコマンド |
|
|
宛先フィルタリングルールをサポートするコマンド |
|
|
単一のオブジェクトをサポートするコマンド |
--version-id string:オブジェクトのバージョン ID。 |
|
リストモードをサポートするコマンド |
--list-format:リストのフォーマット。 有効な値: plain および inventory。 --list-manifest-from:リストのマニフェストをファイルから読み取ります。 このパラメーターは、リストのフォーマットが inventory の場合に必要です。 |
ローカルオプション
|
ローカルオプション |
オプションタイプ |
説明 |
|
--encoding-type |
string |
入力オブジェクトまたはファイル名のエンコーディングを指定します。有効な値:url。 |
|
--request-payer |
string |
リクエスト元支払いを有効にします。有効な値:requester。 |
|
--start-after |
string |
指定された値の後 (その値を含まず) にアルファベット順でオブジェクトを返します。 |
|
--end-with |
string |
指定された値まで (その値を含む) アルファベット順でオブジェクトを返します。 |
|
--page-size |
int |
バッチ処理における 1 ページあたりの最大オブジェクト数。デフォルト:1000。範囲:1 ~ 1000。 |
|
--include |
stringArray |
パスまたはファイル名の包含ルールを指定します。 |
|
--include-from |
stringArray |
ルールファイルから包含ルールを読み取ります。 |
|
--exclude |
stringArray |
パスまたはファイル名の除外ルールを指定します。 |
|
--exclude-from |
stringArray |
ルールファイルから除外ルールを読み取ります。 |
|
--filter |
stringArray |
パスまたはファイル名のフィルタールールを指定します。 |
|
--files-from |
stringArray |
ファイルからソースファイル名のリストを読み取ります。空行またはコメント行は無視されます。ファイルのフィルタリング操作にのみ適用されます。 |
|
--files-from-raw |
stringArray |
ファイルからソースファイル名のリストを読み取ります。ファイルのフィルタリング操作にのみ適用されます。 |
|
--max-age |
Duration |
この期間よりも古いファイルをスキップします。デフォルト単位:秒。サポートされている接尾辞:ms、s、m、h、d、w、M、y。デフォルト:off。 |
|
--min-age |
Duration |
この期間よりも新しいファイルをスキップします。デフォルト単位:秒。サポートされている接尾辞:ms、s、m、h、d、w、M、y。デフォルト:off。 |
|
--max-mtime |
Time |
この UTC タイムスタンプよりも新しいファイルをスキップします。デフォルト:off。 |
|
--min-mtime |
Time |
この UTC タイムスタンプよりも古いファイルをスキップします。デフォルト:off。 |
|
--max-size |
SizeSuffix |
転送する最大ファイルサイズを指定します。デフォルト単位:バイト。サポートされている接尾辞:B、K、M、G、T、P。1 K (KiB) = 1024 B。 |
|
--min-size |
SizeSuffix |
転送する最小ファイルサイズを指定します。デフォルト単位:バイト。サポートされている接尾辞:B、K、M、G、T、P。1 K (KiB) = 1024 B。 |
|
--metadata-exclude |
stringArray |
オブジェクトメタデータの除外ルールを指定します。 |
|
--metadata-include |
stringArray |
オブジェクトメタデータの包含ルールを指定します。 |
|
--metadata-filter |
stringArray |
オブジェクトメタデータのフィルタールールを指定します。 |
|
--metadata-filter-from |
stringArray |
ルールファイルからオブジェクトメタデータのフィルタールールを読み取ります。 |
|
--checksum |
/ |
サイズとチェックサム (存在する場合) が不整合なソースファイルのみをコピーします。 |
|
--size-only |
/ |
サイズが不整合なソースファイルのみをコピーします。 |
|
-u, --update |
/ |
宛先ファイルよりも新しいソースファイルのみをコピーします。 |
|
-r, --recursive |
/ |
バケット内の一致するすべてのオブジェクトに対して再帰的に操作を実行します。このオプションを指定しない場合、指定されたパスに対してのみ操作を実行します。 |
|
-d, --dirs |
/ |
現在のフォルダー内のファイルとサブディレクトリのみをリストし、再帰的に処理しません。 |
|
-f, --force |
/ |
確認プロンプトなしで操作を強制実行します。 |
|
--list-objects |
/ |
ListObjects API を使用してオブジェクトをリストします。 |
|
--no-progress |
/ |
進行状況バーを表示しません。 |
|
-j, --job |
int |
複数ファイル操作の並行タスク数を指定します。デフォルト:3。 |
|
--checkers |
int |
並列チェッカー数を指定します。デフォルト:16。 |
|
--parallel |
int |
単一ファイルのマルチパート操作における並行タスク数を指定します。 |
|
--part-size |
SizeSuffix |
マルチパート操作のパートサイズを指定します。デフォルトでは自動計算されます。範囲:100 KiB ~ 5 GiB。 |
|
--bigfile-threshold |
int |
マルチパートアップロード、ダウンロード、またはコピーのサイズしきい値を指定します。デフォルト:104857600 (100 MiB)。 |
|
--version-id |
string |
オブジェクトのバージョン ID を指定します。 |
|
--storage-class |
string |
オブジェクトのストレージクラスを指定します。有効な値:Standard、IA、Archive、ColdArchive、DeepColdArchive。 |
|
--acl |
string |
オブジェクトのアクセス権限を指定します。有効な値:private、public-read、public-read-write、default。 |
|
--cache-control |
string |
オブジェクトのダウンロード時のブラウザーのキャッシュ動作を制御します。 |
|
--content-disposition |
string |
オブジェクトの表示フォーマットを指定します。 |
|
--content-encoding |
string |
オブジェクトのコンテンツエンコーディングを指定します。 |
|
--content-type |
string |
オブジェクトのコンテンツタイプを指定します。 |
|
--expires |
string |
キャッシュされたコンテンツの絶対有効期限を指定します。 |
|
--copy-props |
string |
ソースオブジェクトからコピーするプロパティを指定します。有効な値:none、metadata、default。 |
|
--tagging |
string |
オブジェクトタグを key=value フォーマットで指定します。 |
|
--tagging-directive |
string |
宛先オブジェクトタグの設定方法を指定します。有効な値:COPY、REPLACE。 |
|
--metadata |
string |
ユーザーメタデータを key=value フォーマットで指定します。 |
|
--metadata-directive |
string |
宛先オブジェクトメタデータの設定方法を指定します。有効な値:COPY、REPLACE。 |
|
--list-format |
string |
リストファイルのフォーマットを指定します。有効な値:plain、インベントリ。 |
|
--list-manifest-from |
string |
ファイルからリストファイルフォーマットの説明を読み取ります。リストファイルフォーマットがインベントリの場合、このパラメーターは必須です。 |
フィルターオプション
フィルターオプションは、バッチコマンド (ls、cp、sync、rm) に適用されます。パスやファイル名、ファイルリスト、変更時刻、ファイルサイズ、またはオブジェクトメタデータによってフィルタリングします。
フィルターオプションはコマンドラインでのみ使用でき、設定ファイルでは使用できません。
変更を適用する前に、ls または --dry-run/-n を使用してフィルター設定をテストしてください。
パスやファイル名によるフィルタリング
フィルター ルールを定義して、名前やパスに基づいて含めるファイルと除外するファイルを指定します。
--include および --exclude オプションを使用してルールを定義できます。例:--include="*.txt"、--exclude="*"。
コマンドラインオプションまたはルールファイルを使用してルールを指定します。複数のルールは順序付きのリストとなり、結果は次の原則に基づいてフィルタリングされます。
-
ルールは順番に処理されます。コマンド内のパラメータは左から右へ、ファイル内のルールは上から下へ処理されます。
-
各ファイルまたはパスはルールに照合され、含めるか除外するかが判定されます。
-
ルールは順番にチェックされます。ルールに一致した時点でチェックは停止します。
-
いずれのルールにも一致しない場合、ファイルまたはパスはデフォルトで含められます。
-
ローカルファイルシステムでは、フォルダーを除外すると、その配下のすべてのサブフォルダーとファイルも除外されます。
-
バケットにはフォルダー構造がないため、各オブジェクトは個別にフィルタリングされます。
glob パターンを使用します。glob パターンの一般的なルールは次のとおりです。
-
パターンが
/で始まる場合、パスの先頭に一致する必要があります。それ以外の場合、パスの任意のレベルで名前に一致できます。 -
パターンが
/で終わる場合はフォルダーにのみ一致し、それ以外の場合はフォルダーまたはファイルに一致します。たとえば、dir/. です。 -
/はパス区切り文字を表します。たとえば、subdir/test.txtです。 -
*は任意の文字列に一致しますが、/には一致しません。例: *.txt。 -
パターンが
**で終わる場合、/を含む任意の長さの文字列に一致します。たとえば、dir/** はパス "dir/subdir/xx/test.txt" に一致します。 -
?は、/ を除く任意の 1 文字に一致します。 -
[]は、特定の文字クラスに含まれる単一の文字に一致します。 たとえば、[a-z] は小文字の英字に一致し、[0-9] は数字に一致します。 -
デフォルトでは、パターンはファイル名またはフォルダー名全体に一致する必要があります。例:
fooは "foo" と "dir/foo" には一致しますが、"dir/foo1" や "foo/xx" には一致しません。 -
パターンは、名前の一部ではなく、フォルダー名またはファイル名の全体に一致する必要があります。例:
fooは "xxx/afoo" には一致せず、abc/fooは "subdir/aabc/foo" には一致しません。
Windows では、パス区切り文字として \ ではなく / を使用します。
コマンドラインで次の構文とパラメータを 1 つ以上指定することで、パスやファイル名のフィルター ルールの順序付きリストを作成できます。
|
項目 |
説明 |
|
フィルター ルールの構文 |
|
|
フィルター ルールのオプションパラメータ |
|
次の表では、一般的なオプションについて説明します。
|
オプション |
説明 |
|
--include --exclude |
パラメータの後に一致パターンを指定します。各オプションは 1 つのルールを表します。複数のルールを使用するには、これらのオプションを繰り返し指定します。 たとえば、 次のコマンド例では、Alibaba Cloud OSS の oss://examplebucket/exampledir/ フォルダーから localdir/ フォルダーに、フィルター条件に一致するファイルを再帰的にダウンロードします。 このルールには、すべての
|
|
--filter |
パラメータの後に命令付き一致パターンを指定します。各オプション値は 1 つのルールを表します。複数のルールを使用するには、これらのオプションを繰り返し指定します。 たとえば、
次のコマンド例では、Alibaba Cloud OSS の oss://examplebucket/exampledir/ フォルダーから localdir/ フォルダーに、フィルター条件に一致するファイルを再帰的にダウンロードします。このルールでは、
|
|
--include-from --exclude-from |
パラメータの後にルールファイルパスを指定します。ルールファイル内の各行は glob パターンを表します。複数のルールファイルを読み込むには、これらのオプションを繰り返し指定します。 --include-from で読み込んだルールはすべてインクルード ルールです。--exclude-from で読み込んだルールはすべてエクスクルード ルールです。 たとえば、 ルールファイル include-file.txt の内容は次のとおりです。
ルールファイル exclude-file.txt の内容は次のとおりです。
|
|
--filter-from |
パラメータの後にルールファイルパスを指定します。ルールファイル内の各行は命令付き glob パターンを表します。 複数のルールファイルを読み込むには、これらのオプションを繰り返し指定します。 たとえば、
|
補足情報:
-
ファイルからルールを読み込むと、ルールは上から下へ処理されます。空白行と、
#または;で始まるコメント行は無視されます。 -
ファイルパスが
-の場合、ルールは標準入力 (stdin) から読み込まれます。このオプションは一度だけ指定できます。 -
--includeまたは--include-fromルールを使用する場合、ルールリストの最後に- **ルールが追加されます。 -
--filter + パターンを使用する場合、
- **ルールはルールリストの末尾に追加されません。
例:--filter を使用して .jpg 拡張子のファイルのみを含めるルールを設定するには、--filter "+ *.jpg" --filter "- **" を指定する必要があります。
--filter または --filter-from オプションは、--include、--include-from、--exclude、--exclude-from オプションと併用できません。
パスやファイルリストによるフィルタリング
コマンドラインオプションを使用して、パスまたはファイル名のリストを指定できます。サポートされているオプションは次のとおりです。
|
オプション |
説明 |
|
--files-from |
ファイルからパスやファイル名のリストを読み取ります。複数のリストファイルを使用するには、このオプションを繰り返し指定できます。 リストファイルの各行を処理する際、先頭または末尾のスペースは削除され、 |
|
--files-from-raw |
ファイルからパスやファイル名のリストを読み取ります。複数のリストファイルを使用するには、このオプションを繰り返し指定できます。 リストファイルの各行を処理する際、先頭または末尾のスペース、および |
一致させるパスまたはファイルのリストを指定した場合、他のパターンマッチングルールは無視されます。
ファイルの変更時刻によるフィルタリング
最終変更時刻でフィルタリングし、特定の期間内のファイルのみを転送します。
時刻フィルターは、相対モードと絶対モードをサポートしています。
|
パラメータ |
説明 |
|
|
--min-age |
Duration |
指定した期間より前に変更されたファイルのみを処理します。デフォルトの単位は秒です。単位のサフィックス (例:1h) をサポートします。 説明
|
|
--max-age |
Duration |
指定した期間内に変更されたファイルのみを処理します。デフォルトの単位は秒です。単位のサフィックス (例:1h) をサポートします。 説明
|
|
--min-mtime |
Time |
指定した時刻より後に変更されたファイルのみを処理します。 説明
|
|
--max-mtime |
Time |
指定した時刻より前に変更されたファイルのみを処理します。 説明
|
補足情報:
-
--min-age および --max-age でサポートされている単位のサフィックス:ms (ミリ秒)、s (秒)、m (分)、h (時間)、d (日)、w (週)、M (月)、y (年)。
-
小数値をサポートします。例:1.5d は 1 日半を表します。
-
--min-mtime および --max-mtime でサポートされている時刻形式は、
2006-01-02T15:04:05Z07:00(RFC3339)、2006-01-02T15:04:05、2006-01-02 15:04:05、2006-01-02です。 -
時刻にタイムゾーンが含まれている場合 (末尾が Z または +08:00 など)、そのタイムゾーンが使用されます。タイムゾーンが指定されていない場合、解析にはランタイム環境のローカルタイムゾーンが使用されます。
例:3 日より古いファイルまたはオブジェクトを一覧表示します。
ossutil ls oss://bucket/ --min-age 3d
ファイルサイズによるフィルタリング
ファイルサイズでフィルタリングし、特定のサイズ範囲内のファイルのみを転送します。
設定パラメータ:
|
パラメータ |
説明 |
|
--min-size |
このサイズより小さいファイルをスキップします。デフォルトの単位はバイトです。例:1K (KiB) = 1024 バイト。 |
|
--max-size |
このサイズより大きいファイルをスキップします。デフォルトの単位はバイトです。例:1K (KiB) = 1024 バイト。 |
補足情報:
-
サポートされているサフィックス:K (KiB) = 1024 バイト、M (MiB)、G (GiB)、T (TiB)、P (PiB)、E (EiB)。
-
小数値をサポートします。例:0.5K。
例:1 MiB 以下のファイルまたはオブジェクトを一覧表示します。
ossutil ls oss://bucket/ --max-size 1M
オブジェクトメタデータの一致ルールによるフィルタリング
メタデータフィルターはパスやファイル名フィルターと同様に動作しますが、バケット内のオブジェクトにのみ適用されます。
メタデータは key=value として定義し、一致には glob パターンを使用します。
次の設定オプションをサポートしています。
-
--metadata-include
-
--metadata-exclude
-
--metadata-filter
-
--metadata-filter-from
次のオブジェクトメタデータをサポートしています。
-
ストレージクラス:
x-oss-storage-class=valueを使用します。valueの有効な値は Standard、IA、Archive、ColdArchive、DeepColdArchive です。 -
オブジェクトタイプ:
x-oss-object-type=valueを使用します。valueの有効な値は、Normal、Multipart、Appendable、Symlink です。 -
復元ステータス:
x-oss-restore=valueを使用します。必要に応じてvalueを設定します。 -
Content-Type:
content-type=valueを使用します。必要に応じてvalueを設定します。 -
ユーザー定義メタデータ:
x-oss-meta-aaa=valueを使用します。aaaは小文字です。必要に応じてvalueを設定します。
例:ストレージクラスが Archive、Cold Archive、または Deep Cold Archive のオブジェクトを一覧表示します。
ossutil ls oss://bucket/ --metadata-include "x-oss-storage-class=*Archive"