Object Storage Service:コマンドラインオプション

コマンドラインオプションのクエリ

特定のコマンドのオプションをクエリするには、次のサンプルコマンドを実行します。

ossutil cp -h

コマンド出力:

Flags:
      --acl string                         オブジェクトのアクセス制御リスト（ACL）、有効値："private","public-read","public-read-write","default" // オブジェクトのアクセス制御リスト (ACL)。有効な値: "private"、"public-read"、"public-read-write"、"default"
      --bandwidth-limit SizeSuffix         B/s 単位の帯域幅制限、またはサフィックス B|K|M|G|T|P を使用 // B/s 単位の帯域幅制限、または接尾辞 B|K|M|G|T|P を使用
      --bigfile-threshold SizeSuffix       ファイルサイズのしきい値。しきい値より大きいファイルサイズは、マルチパートアップロード、ダウンロード、またはコピーを使用します。または、サフィックス B|K|M|G|T|P を使用します (デフォルト 100Mi) // ファイルサイズのしきい値。しきい値よりも大きいファイルサイズは、マルチパートアップロード、ダウンロード、またはコピーを使用します。または、接尾辞 B|K|M|G|T|P を使用します (デフォルトは 100Mi)
      --cache-control string               オブジェクトのダウンロード時の Web ページのキャッシュ動作 // オブジェクトのダウンロード時の Web ページのキャッシュ動作
      --checkers int                       並列実行するチェッカーの数 (デフォルト 16) // 並列実行するチェッカーの数 (デフォルトは 16)
      --checkpoint-dir string              ブレークポイント継続情報用の指定ディレクトリ // ブレークポイント継続情報用の指定ディレクトリ
      --checksum                           サイズとチェックサム (使用可能な場合) が異なるソースファイルのみをコピーします // サイズとチェックサム (使用可能な場合) が異なるソースファイルのみをコピーします
      --content-disposition string         オブジェクトへのアクセス方法 // オブジェクトへのアクセス方法
      --content-encoding string            オブジェクトのエンコード方法 // オブジェクトのエンコード方法
      --content-type string                オブジェクトの MIME タイプ // オブジェクトの MIME タイプ
      --copy-props string                  ソースオブジェクトからコピーされるプロパティを決定します。有効値："none","metadata","default" // ソースオブジェクトからどのプロパティをコピーするかを決定します。有効な値: "none"、"metadata"、"default"
  -d, --dirs                               サブディレクトリのコンテンツではなく、一致するサブディレクトリ名を返します // サブディレクトリのコンテンツではなく、一致するサブディレクトリ名を返します
      --encoding-type string               ユーザーが入力するオブジェクト名またはファイル名のエンコードタイプ、有効値："url" // ユーザーが入力するオブジェクト名またはファイル名のエンコードタイプ。有効な値: "url"
      --end-with string                    リスト操作が終了するオブジェクトの名前 (含む) // リスト操作が終了するオブジェクトの名前 (含まれる)
      --exclude stringArray                パターンに一致するファイルを除外します // パターンに一致するファイルを除外します
      --exclude-from stringArray           ファイルから除外パターンを読み取ります // ファイルから除外パターンを読み取ります
      --expires string                     UTC でのキャッシュの有効期限 // UTC でのキャッシュの有効期限
      --files-from stringArray             ファイルからソースファイル名のリストを読み取ります。空白行とコメント行は無視されます // ファイルからソースファイル名のリストを読み取ります。空白行とコメント行は無視されます
      --files-from-raw stringArray         行を処理せずにファイルからソースファイル名のリストを読み取ります // 行を処理せずにファイルからソースファイル名のリストを読み取ります
      --filter stringArray                 ファイルフィルタリングルール // ファイルフィルタリングルール
      --filter-from stringArray            ファイルからファイルフィルタリングルールを読み取ります // ファイルからファイルフィルタリングルールを読み取ります
  -f, --force                              ユーザーに操作の確認を求めずにサイレント操作を実行します // ユーザーに操作の確認を求めずにサイレント操作を実行します
      --ignore-existing                    宛先に既に存在するすべてのファイルをスキップします // 宛先に既に存在するすべてのファイルをスキップします
      --include stringArray                パターンに一致するファイルを除外しません // パターンに一致するファイルを除外しません
      --include-from stringArray           ファイルから包含パターンを読み取ります // ファイルから包含パターンを読み取ります
  -j, --job int                            複数ファイル間の同時タスク数 (デフォルト 3) // 複数ファイル間の同時タスク数 (デフォルトは 3)
      --list-objects                       オブジェクトをリストするために ListObjectsV2 の代わりに ListObjects を使用します // オブジェクトをリストするために ListObjectsV2 の代わりに ListObjects を使用します
      --max-age Duration                   これより古いファイルは転送しません。s またはサフィックス ms|s|m|h|d|w|M|y (デフォルト off) // これより古いファイルは転送しません。s または接尾辞 ms|s|m|h|d|w|M|y (デフォルトは off)
      --max-mtime Time                     これより新しいファイルは転送しません。UTC 時間形式 (デフォルト off) // これより新しいファイルは転送しません。UTC 時間形式 (デフォルトは off)
      --max-size SizeSuffix                このサイズより大きいファイルは転送しません。B またはサフィックス B|K|M|G|T|P、1K(KiB)=1024B // このサイズより大きいファイルは転送しません。B または接尾辞 B|K|M|G|T|P、1K(KiB)=1024B
      --metadata strings                   オブジェクトのユーザーメタデータを key=value 形式で指定します // オブジェクトのユーザーメタデータを key=value 形式で指定します
      --metadata-directive string          宛先オブジェクトのメタデータの構成方法、有効値："COPY","REPLACE" // 宛先オブジェクトのメタデータの構成方法。有効な値: "COPY"、"REPLACE"
      --metadata-exclude stringArray       パターンに一致するメタデータを除外します // パターンに一致するメタデータを除外します
      --metadata-filter stringArray        メタデータフィルタリングルール // メタデータフィルタリングルール
      --metadata-filter-from stringArray   ファイルからメタデータフィルタリングルールを読み取ります // ファイルからメタデータフィルタリングルールを読み取ります
      --metadata-include stringArray       パターンに一致するメタデータを除外しません // パターンに一致するメタデータを除外しません
      --min-age Duration                   これより新しいファイルは転送しません。s またはサフィックス ms|s|m|h|d|w|M|y (デフォルト off) // これより新しいファイルは転送しません。s または接尾辞 ms|s|m|h|d|w|M|y (デフォルトは off)
      --min-mtime Time                     これより古いファイルは転送しません。UTC 時間形式 (デフォルト off) // これより古いファイルは転送しません。UTC 時間形式 (デフォルトは off)
      --min-size SizeSuffix                このサイズより小さいファイルは転送しません。B またはサフィックス B|K|M|G|T|P、1K(KiB)=1024B // このサイズより小さいファイルは転送しません。B または接尾辞 B|K|M|G|T|P、1K(KiB)=1024B
      --no-error-report                    バッチ操作中にエラーレポートファイルを生成しません // バッチ操作中にエラーレポートファイルを生成しません
      --no-progress                        進捗状況は表示されません // 進捗状況は表示されません
      --output-dir string                  出力ファイルを配置するディレクトリを指定します。出力ファイルには、バッチ操作中に生成されたエラーレポートファイルが含まれます (デフォルト "ossutil_output") // 出力ファイルを配置するディレクトリを指定します。出力ファイルには、バッチ操作中に生成されたエラーレポートファイルが含まれます (デフォルトは "ossutil_output")
      --page-size int                      リスト操作への各応答で返される結果の数 (デフォルト 1000)、1 ～ 1000 の範囲 // リスト操作への各応答で返される結果の数 (デフォルトは 1000)、1 から 1000 の範囲
      --parallel int                       ファイル操作時の同時タスク数 // ファイル操作時の同時タスク数
      --part-size SizeSuffix               パートサイズ。デフォルトではファイルサイズに応じて適切なサイズが計算されます。または、サフィックス B|K|M|G|T|P を使用します。100Ki ～ 5Gi の範囲 // パートサイズ。デフォルトではファイルサイズに応じて適切なサイズが計算されます。または、接尾辞 B|K|M|G|T|P を使用します。100Ki から 5Gi の範囲
  -r, --recursive                          再帰的に操作します。このオプションが指定されている場合、コマンドはバケット下のすべての一致オブジェクトに対して操作を実行します。それ以外の場合は、単一オブジェクトに対して操作を実行します。 // 再帰的に操作します。このオプションが指定されている場合、コマンドはバケットの下にあるすべての一致するオブジェクトに対して操作を実行します。それ以外の場合は、単一のオブジェクトに対して操作を実行します。
      --request-payer string               リクエストの支払者。リクエスト元の支払いを希望する場合は、この値を設定します。有効値："requester" // リクエストの支払者。リクエスト元の支払いを希望する場合は、この値を設定します。有効な値: "requester"
      --size-only                          サイズが異なるソースファイルのみをコピーします // サイズが異なるソースファイルのみをコピーします
      --start-after string                 リスト操作が開始するオブジェクトの名前 (含まない) // リスト操作が開始するオブジェクトの名前 (含まれない)
      --storage-class string               オブジェクトのストレージクラス、有効値："Standard","IA","Archive","ColdArchive","DeepColdArchive" // オブジェクトのストレージクラス。有効な値: "Standard"、"IA"、"Archive"、"ColdArchive"、"DeepColdArchive"
      --tagging strings                    宛先オブジェクトのタグを key=value 形式で指定します // 宛先オブジェクトのタグを key=value 形式で指定します
      --tagging-directive string           宛先オブジェクトのタグの構成方法、有効値："COPY","REPLACE" // 宛先オブジェクトのタグの構成方法。有効な値: "COPY"、"REPLACE"
  -u, --update                             ソースファイルが宛先ファイルより新しい場合にのみコピーします // ソースファイルが宛先ファイルよりも新しい場合にのみコピーします

Global Flags:
  -i, --access-key-id string        OSS アクセス時の AccessKeyID // OSS アクセス時の AccessKey ID
  -k, --access-key-secret string    OSS アクセス時の AccessKeySecret // OSS アクセス時の AccessKey シークレット
      --addressing-style string     エンドポイントのアドレス指定スタイル (デフォルト "virtual")、有効値："virtual","path","cname" // エンドポイントのアドレス指定スタイル (デフォルトは "virtual")。有効な値: "virtual"、"path"、"cname"
      --cloudbox-id string          クラウドボックスの ID。クラウドボックスシナリオに適用可能です // クラウドボックスの ID。クラウドボックスのシナリオに適用可能です
  -c, --config-file string          構成ファイルのパス (デフォルト "~/.ossutilconfig") // 構成ファイルのパス (デフォルトは "~/.ossutilconfig")
      --connect-timeout int         クライアント接続のタイムアウト、単位：秒 (デフォルト 10) // クライアント接続のタイムアウト。単位: 秒 (デフォルトは 10)
  -n, --dry-run                     永続的な変更を行わないトライアルランを実行します // 永続的な変更を行わないトライアルランを実行します
  -e, --endpoint string             他のサービスが OSS にアクセスするために使用できるドメイン名。 // 他のサービスが OSS にアクセスするために使用できるドメイン名。
  -h, --help                        コマンドのヘルプ // コマンドのヘルプ
      --language string             表示テキスト言語 // 表示テキスト言語
      --log-file string             ログ出力ファイルを指定します。- の場合、Stdout に出力します // ログ出力ファイルを指定します。- の場合、Stdout に出力します
      --loglevel string             デバッグメッセージレベル (デフォルト "off")、有効値："off","info","debug" // デバッグメッセージレベル (デフォルトは "off")。有効な値: "off"、"info"、"debug"
      --mode string                 認証モードを指定します。有効値："AK","StsToken","EcsRamRole","Anonymous" // 認証モードを指定します。有効な値: "AK"、"StsToken"、"EcsRamRole"、"Anonymous"
      --output-format string        コマンド出力のフォーマットスタイル (デフォルト "raw") // コマンド出力のフォーマットスタイル (デフォルトは "raw")
      --output-properties strings   出力フォーマットのプロパティ // 出力フォーマットのプロパティ
      --output-query string         レスポンスデータをフィルタリングするために使用する JMESPath クエリ // レスポンスデータをフィルタリングするために使用する JMESPath クエリ
      --profile string              構成ファイルの特定のプロファイル。 // 構成ファイルの特定のプロファイル。
      --proxy string                プロキシサーバーを指定します。"env" の場合は、HTTP_PROXY および HTTPS_PROXY 環境変数を使用します // プロキシサーバーを指定します。"env" の場合は、HTTP_PROXY および HTTPS_PROXY 環境変数を使用します
  -q, --quiet                       クワイエットモード。可能な限り少ない情報を出力します // クワイエットモード。可能な限り少ない情報を出力します
      --read-timeout int            クライアント読み取りのタイムアウト、単位：秒 (デフォルト 20) // クライアント読み取りのタイムアウト。単位: 秒 (デフォルトは 20)
      --region string               バケットが配置されているリージョン。 // バケットが配置されているリージョン。
      --retry-times int             失敗時のリトライ回数 (デフォルト 10) // 失敗時のリトライ回数 (デフォルトは 10)
      --role-arn string             ロールの ARN を指定します // ロールの ARN を指定します
      --role-session-name string    セッション名を指定します // セッション名を指定します
      --sign-version string         署名アルゴリズムのバージョン (デフォルト "v4")、有効値："v1","v4" // 署名アルゴリズムのバージョン (デフォルトは "v4")。有効な値: "v1"、"v4"
      --skip-verify-cert            OSS サーバーのデジタル証明書ファイルが検証されないように指定します // OSS サーバーのデジタル証明書ファイルが検証されないように指定します
  -t, --sts-token string            OSS アクセス時の STSToken // OSS アクセス時の STS トークン

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

コマンドライン操作では、特定のコマンドは操作オブジェクトを指定したりオプションを構成したりするために追加のパラメーターが必要です。これらのコマンドでは、特定の要件に基づいて追加のパラメーターを適切な値に設定して、期待される目標を達成できます。例:

ossutil ls --profile dev

ossutil ls --profile dev は、dev パラメーター値が構成ファイルを構成することを指定します。パラメーター値を持つ各オプションでは、オプション名とパラメーター値の間にスペースまたは等号（=）が必要です。例: --profile dev または --profile=dev。パラメーター値にスペースが含まれている場合は、コマンドが正しく解析されるように、パラメーター値を引用符で囲む必要があります。例: --description "OSS bucket list"。

グローバルコマンドラインオプション