Object Storage Service:高レベルコマンド

コマンドの範囲

サポートされているオプション

すべての高レベルコマンド

• --encoding-type string: オブジェクト名またはファイル名のエンコーディング方式。有効な値: url。

• --request-payer string: リクエストの支払者。リクエスト元課金モードが有効な場合は、このパラメーターを指定します。有効な値: requester。

バッチ処理をサポートする高レベルコマンド

• --start-after/--end-with (, ]: クエリするオブジェクト名の範囲を指定します。範囲は左開右閉区間です。

• フィルターオプション: オブジェクト/ファイル名、オブジェクト/ファイルディレクトリ、オブジェクト/ファイルサイズ、オブジェクト/ファイル時間、およびオブジェクトメタデータのフィルター条件を設定できます。詳細については、「フィルターオプション」をご参照ください。

• --limited-num: 応答結果の数を制限します。

• --recursive/-r: ルートディレクトリ内のすべてのファイルまたはオブジェクト、およびすべてのサブディレクトリに対して操作を再帰的に実行することを指定します。

• --dirs/-d: ルートディレクトリ内のファイルまたはオブジェクトのみを照合し、サブディレクトリを無視します。

  説明

  このオプションがオブジェクトに適用される場合、デリミタを使用してディレクトリをシミュレートし、指定された名前のプレフィックスを持つすべてのオブジェクトがスキャンされます。オブジェクトのスキャンにかかる時間は、指定された名前のプレフィックスを持つオブジェクトの数に正比例します。

• --force/-f: 確認を必要とせずに操作を強制します。

• --list-objects: ListObjects 操作を呼び出してオブジェクトをリストします。

宛先オブジェクトによるフィルタリングをサポートする高レベルコマンド

• --update: ソースファイルまたはオブジェクトの最終更新日時が宛先オブジェクトの最終更新日時より新しい場合にのみ操作を実行します。

• --size-only: ソースファイルまたはオブジェクトのサイズが宛先オブジェクトまたはファイルのサイズと異なる場合にのみ操作を実行します。

• --checksum: 次のいずれかの条件が満たされた場合にのみ操作が実行されることを指定します: a. ソースオブジェクトのサイズが宛先オブジェクトのサイズと異なる。b. ソースオブジェクトの CRC-64 が宛先オブジェクトの CRC-64 と異なるが、ソースオブジェクトのサイズが宛先オブジェクトのサイズと同じである。片側に CRC-64 が存在しない場合、オブジェクトは不整合と見なされます。このオプションは、オブジェクト間のコピー操作でのみ有効です。

• --ignore-existing: 既存のファイルをスキップします。

単一オブジェクト操作をサポートするコマンド

--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

--end-with オプションの値以前に辞書順で名前が来るオブジェクトに一致します。

--page-size

int

バッチ処理中にページごとにリストするオブジェクトの最大数 (デフォルト値: 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

このオプションの値より最終更新日時が古いオブジェクトを除外します。デフォルトの単位は s (秒) です。数値に単位を付加できます: ms (ミリ秒)、s (秒)、m (分)、h (時間)、d (日)、w (週)、M (月)、または y (年)。デフォルト値: off。

--min-age

Duration

このオプションの値より最終更新日時が新しいオブジェクトを除外します。デフォルトの単位は s (秒) です。数値に単位を付加できます: ms (ミリ秒)、s (秒)、m (分)、h (時間)、d (日)、w (週)、M (月)、または y (年)。デフォルト値: off。

--max-mtime

Time

このオプションの値より最終更新日時が新しいオブジェクトを除外します。時刻は UTC である必要があります。デフォルト値: off。

--min-mtime

Time

このオプションの値より最終更新日時が古いオブジェクトを除外します。時刻は UTC である必要があります。デフォルト値: off。

--max-size

SizeSuffix

転送できるファイルまたはオブジェクトの最大サイズ。デフォルトでは、サイズはバイト (B) 単位です。数値に 1024 ベースの単位を付加できます: B (バイト)、K (KiB)、M (MiB)、G (GiB)、T (TiB)、または P (PiB)。

--min-size

SizeSuffix

転送できるファイルまたはオブジェクトの最小サイズ。デフォルトでは、サイズはバイト (B) 単位です。数値に 1024 ベースの単位を付加できます: B (バイト)、K (KiB)、M (MiB)、G (GiB)、T (TiB)、または P (PiB)。

--metadata-exclude

stringArray

オブジェクトメタデータの除外ルール。

--metadata-include

stringArray

オブジェクトメタデータの包含ルール。

--metadata-filter

stringArray

オブジェクトメタデータのフィルター ルール。

--metadata-filter-from

stringArray

ファイルからメタデータフィルター ルールを読み取ります。

--checksum

/

次のいずれかの条件が満たされた場合にのみ、ソースオブジェクトがコピーされることを指定します: a. ソースオブジェクトのサイズが宛先オブジェクトのサイズと異なる。b. ソースオブジェクトの CRC-64 が宛先オブジェクトの CRC-64 と異なるが、ソースオブジェクトのサイズが宛先オブジェクトのサイズと同じである。

--size-only

/

ソースオブジェクトのサイズが宛先オブジェクトと異なる場合にのみ、ソースオブジェクトをコピーします。

-u, --update

/

ソースオブジェクトの最終更新日時が宛先オブジェクトの最終更新日時より新しい場合にのみ、ソースオブジェクトをコピーします。

-r, --recursive

/

コマンドが操作を再帰的に実行することを指定します。このパラメーターが指定されている場合、コマンドはバケット内の条件を満たすすべてのオブジェクトに対して有効になります。それ以外の場合、コマンドは指定されたパス内のオブジェクトに対してのみ有効になります。

-d, --dirs

/

すべてのサブディレクトリ内のすべてのオブジェクトを再帰的に表示する代わりに、現在のディレクトリ内のオブジェクトとサブディレクトリを返します。

-f, --force

/

ユーザーの確認を必要とせずに操作を強制します。

--list-objects

/

ListObjects 操作を呼び出してオブジェクトをリストします。

--no-progress

/

プログレスバーを非表示にします。

-j, --job

int

複数のファイルまたはオブジェクトを処理するための同時ジョブの数。デフォルト値: 3。

--checkers

int

並行して実行できるチェッカーの数。デフォルト値: 16。

--parallel

int

単一オブジェクトに対する内部操作の同時タスク数。

--part-size

SizeSuffix

パートサイズ。デフォルトでは、ossutil はオブジェクトサイズに基づいて適切なパートサイズを計算します。パートサイズの範囲は 100 KiB から 5 GiB です。

--bigfile-threshold

int

マルチパートアップロード、ダウンロード、またはコピーを使用するためのオブジェクトサイズのしきい値。デフォルト値: 104857600。

--version-id

string

オブジェクトのバージョン ID。

--storage-class

string

オブジェクトのストレージクラス。有効な値: Standard、IA、Archive、ColdArchive、DeepColdArchive。

--acl

string

オブジェクトの ACL。有効な値: private、public-read、public-read-write、default。

--cache-control

string

オブジェクトがダウンロードされる際の Web ブラウザーでのキャッシュ動作。

--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 および inventory。

--list-manifest-from

string

リストファイル形式の説明情報をファイルから読み取ります。リストファイル形式が inventory の場合は、このパラメーターを設定する必要があります

項目

説明

フィルター ルール構文

• rule pattern: glob マッチングパターン

• rule filename: glob マッチングパターンを含むファイルへのパス

• rule modifiers pattern: 命令 glob マッチングパターン。命令 + は包含ルールを示し、ルールに一致するオブジェクトが結果に含まれることを意味します。- は除外ルールを示し、ルールに一致するオブジェクトが結果から除外されることを意味します。

フィルターオプション

• --include

• --include-from

• --exclude

• --exclude-from

• --filter

• --filter-from

オプション

説明

--include

--exclude

マッチングパターンはパラメーターに従います。各オプションは単一のルールを表します。オプションを繰り返すことで、コマンドで複数のマッチングパターンを指定できます。

たとえば、--include "*.txt" --include "*.js" --exclude "*.jpg" は、すべての .txt および .js ファイルを含みますが、すべての .jpg ファイルを除外します。

次のサンプルコマンドは、oss://examplebucket/exampledir/ ディレクトリからローカルの localdir/ ディレクトリにフィルター ルールに一致するファイルを再帰的にダウンロードします。フィルター ルールには、すべての .txt および .js ファイルが含まれますが、すべての .jpg ファイルは除外されます。

ossutil cp -r oss://examplebucket/exampledir/ localdir/ --include "*.txt" --include "*.js" --exclude "*.jpg"

--filter

命令マッチングパターンはパラメーターに従います。各オプション値は単一のルールを表します。オプションを繰り返すことで、コマンドで複数のマッチングパターンを指定できます。

たとえば、--filter "+ *.txt" --filter "+ *.js" --filter "- *.jpg" は、すべての .txt および .js ファイルを含みますが、すべての .jpg ファイルを除外します。

• + は包含ルールを示し、ルールに一致するオブジェクトが結果に含まれることを意味します。

• - は除外ルールを示し、ルールに一致するオブジェクトが結果から除外されることを意味します。

次のサンプルコマンドは、oss://examplebucket/exampledir/ ディレクトリからローカルの localdir/ ディレクトリにフィルター ルールに一致するファイルを再帰的にダウンロードします。フィルター ルールは .txt および .js ファイルを除外し、.png ファイルのみを含みます。

ossutil cp -r oss://examplebucket/exampledir/ localdir/ --filter "- *.txt" --filter "- *.js" --filter "+ *.png"

--include-from

--exclude-from

ルールファイルへのパスはパラメーターに従います。ルールファイル内の各行は、glob マッチングパターンを表します。オプションを繰り返すことで、コマンドで複数のルールファイルを指定できます。

--include-from オプションに続くルールファイルには、包含ルールのみが含まれます。--exclude-from オプションに続くルールファイルには、除外ルールのみが含まれます。

たとえば、--include-from include-file.txt --exclude-from exclude-file.txt は、すべての .txt および .js ファイルを含みますが、すべての .jpg ファイルを除外します。

include-file.txt ルールファイルの内容:

 *.txt
 *.js

include-file.txt ルールファイルの内容:

 *.jpg

--filter-from

ルールファイルへのパスはパラメーターに従います。ルールファイル内の各行は、命令 glob マッチングパターンを表します。

オプションを繰り返すことで、コマンドで複数のルールファイルを指定できます。

たとえば、--filter-from filter-file.txt で、filter-file.txt ルールファイルの内容は次のとおりです。

 # a filter rule file
 + *.txt
 + *.js
 - **

オプション

説明

--files-from

指定されたリストファイルからパス、ファイル名、またはオブジェクト名を読み取ります。オプションを繰り返すことで、コマンドで複数のリストファイルを指定できます。

リストファイル内の各行を処理する際、先頭または末尾のスペースは削除され、# または ; で始まる行はコメントとして扱われ、無視されます。

--files-from-raw

指定されたリストファイルからパス、ファイル名、またはオブジェクト名を読み取ります。オプションを繰り返すことで、コマンドで複数のリストファイルを指定できます。

リストファイル内の各行を処理する際、先頭または末尾のスペースは無視されず、# または ; で始まる行はコメントとして扱われません。

パラメーター

説明

--min-age

Duration

指定された時間間隔より前に変更されたファイルのみを処理します。デフォルトの単位は秒です。単位サフィックスを使用できます。たとえば、1h は 1 時間を示します。

--max-age

Duration

指定された時間間隔内に変更されたファイルのみを処理します。デフォルトの単位は秒です。単位サフィックスを使用できます。たとえば、1h は 1 時間を示します。

--min-mtime

Time

指定された時刻より後に変更されたファイルのみを処理します。時刻形式は UTC です。例: 2006-01-02T15:04:05。

--max-mtime

Time

指定された時刻より前に変更されたファイルのみを処理します。時刻形式は UTC です。例: 2006-01-02T15:04:05。

パラメーター

説明

--min-size

含めることができるファイルまたはオブジェクトの最小サイズ。デフォルトでは、サイズはバイト (B) 単位です。数値の後に 1024 ベースのサイズ単位を指定できます (例: 1K (1,024 バイト))。

--max-size

含めることができるファイルまたはオブジェクトの最大サイズ。デフォルトでは、サイズはバイト (B) 単位です。数値の後に 1024 ベースのサイズ単位を指定できます (例: 1K (1,024 バイト))。