すべてのプロダクト
Search
ドキュメントセンター

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

最終更新日:Sep 24, 2024

コマンドラインオプションが最も優先され、構成ファイルと環境変数の設定が上書きされます。 コマンドラインオプションは、グローバルオプションとローカルオプションに分かれています。 グローバルコマンドラインオプションはすべてのコマンドに適用されますが、ローカルコマンドラインオプションは特定のコマンドにのみ適用されます。

コマンドラインオプションの照会

次のサンプルコマンドを実行して、特定のコマンドのオプションを照会します。

ossutil cp -h

コマンド出力:

Flags:
      --acl string                         The access control list (ACL) of the object, valid value(s): "private","public-read","public-read-write","default"
      --bandwidth-limit SizeSuffix         Bandwidth limit in B/s, or use suffix B|K|M|G|T|P
      --bigfile-threshold SizeSuffix       The threshold of file size, the file size larger than the threshold will use multipart upload, download or copy, or use suffix B|K|M|G|T|P (default 100Mi)
      --cache-control string               The caching behavior of the web page when the object is downloaded
      --checkers int                       Number of checkers to run in parallel (default 16)
      --checkpoint-dir string              The specified directory for breakpoint continuation information
      --checksum                           Only copy the source file with different size and checksum(if available)
      --content-disposition string         The method that is used to access the object
      --content-encoding string            The method that is used to encode the object
      --content-type string                The mime type of object
      --copy-props string                  Determines which properties are copied from the source object, valid value(s): "none","metadata","default"
  -d, --dirs                               Return matching subdirectory names instead of contents of the subdirectory
      --encoding-type string               The encoding type of object name or file name that user inputs, valid value(s): "url"
      --end-with string                    The name of the object from which the list operation ends, include
      --exclude stringArray                Exclude files matching pattern
      --exclude-from stringArray           Read exclude patterns from file
      --expires string                     The expiration time of the cache in UTC
      --files-from stringArray             Read list of source-file names from file, ignores blank and comment line
      --files-from-raw stringArray         Read list of source-file names from file without any processing of lines
      --filter stringArray                 A file-filtering rule
      --filter-from stringArray            Read file filtering rules from a file
  -f, --force                              Operate silently without asking user to confirm the operation
      --include stringArray                Don't exclude files matching pattern
      --include-from stringArray           Read include patterns from file
  -j, --job int                            Amount of concurrency tasks between multi-files (default 3)
      --list-objects                       Use ListObjects instead of ListObjectsV2 to list objects
      --max-age Duration                   Don't transfer any file older than this, in s or suffix ms|s|m|h|d|w|M|y (default off)
      --max-mtime Time                     Don't transfer any file younger than this, UTC time format (default off)
      --max-size SizeSuffix                Don't transfer any file larger than size, in B or suffix B|K|M|G|T|P, 1K(KiB)=1024B
      --metadata strings                   Specifies the object's user metadata, in key=value foramt
      --metadata-directive string          The method that is used to configure the metadata of the destination object, valid value(s): "COPY","REPLACE"
      --metadata-exclude stringArray       Exclude metadata matching pattern
      --metadata-filter stringArray        A metadata-filtering rule
      --metadata-filter-from stringArray   Read metadata filtering rules from a file
      --metadata-include stringArray       Don't exclude metadata matching pattern
      --min-age Duration                   Don't transfer any file younger than this, in s or suffix ms|s|m|h|d|w|M|y (default off)
      --min-mtime Time                     Don't transfer any file older than this, UTC time format (default off)
      --min-size SizeSuffix                Don't transfer any file smaller than size, in B or suffix B|K|M|G|T|P, 1K(KiB)=1024B
      --no-error-report                    Don't generate error report file during batch operation
      --no-progress                        The progress is not displayed
      --output-dir string                  Specifies the directory to place output file in, output file contains: error report file generated during batch operation (default "ossutil_output")
      --page-size int                      The number of results to return in each response to a list operation (default 1000), in the range 1 - 1000
      --parallel int                       Amount of concurrency tasks when work with a file
      --part-size SizeSuffix               The part size, calculated the suitable size according to file size by default, or use suffix B|K|M|G|T|P, in the range 100Ki - 5Gi
  -r, --recursive                          Operate recursively, if the option is specified, the command will operate on all match objects under the bucket, else operate on the single object.
      --request-payer string               The payer of the request. set this value if you want pay for requester, valid value(s): "requester"
      --size-only                          Only copy the source file with different size
      --start-after string                 The name of the object from which the list operation starts, not include
      --storage-class string               The storage class of the object, valid value(s): "Standard","IA","Archive","ColdArchive","DeepColdArchive"
      --tagging strings                    Specifies the tag of the destination object, in key=value foramt
      --tagging-directive string           The method that is used to configure tags for the destination object, valid value(s): "COPY","REPLACE"
  -u, --update                             Only copy when the source file is newer than the destination file

Global Flags:
  -i, --access-key-id string        AccessKeyID while access oss
  -k, --access-key-secret string    AccessKeySecret while access oss
      --addressing-style string     The style in which to address endpoints (default "virtual"), valid value(s): "virtual","path","cname"
  -c, --config-file string          The path of the configuration file (default "~/.ossutilconfig")
      --connect-timeout int         The client connection timed out, the unit is: s (default 10)
  -n, --dry-run                     Do a trial run with no permanent changes
  -e, --endpoint string             The domain names that other services can use to access OSS.
  -h, --help                        help for the command
      --language string             The display text language
      --log-file string             Specifies the log output file. When -, outputs to Stdout
      --loglevel string             The debug message level (default "off"), valid value(s): "off","info","debug"
      --mode string                 Specifies the authentication mode, valid value(s): "AK","StsToken","EcsRamRole","Anonymous"
      --output-format string        The formatting style for command output (default "raw")
      --output-properties strings   The properties of output format
      --output-query string         A JMESPath query to use in filtering the response data
      --profile string              Specific profile from your config file.
      --proxy string                Specifies the proxy server. When 'env', use HTTP_PROXY and HTTPS_PROXY environment variables
  -q, --quiet                       Quiet mode, print as little stuff as possible
      --read-timeout int            The client read timed out, the unit is: s (default 20)
      --region string               The region in which the bucket is located.
      --retry-times int             Retry times when fail (default 10)
      --role-arn string             Specifies the ARN of role
      --role-session-name string    Specifies the session name
      --sign-version string         The version of the signature algorithm (default "v4"), valid value(s): "v1","v4"
      --skip-verify-cert            Specifies that the oss server's digital certificate file will not be verified
  -t, --sts-token string            STSToken while access oss

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

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

ossutil ls --profile dev

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

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

パラメーター

データ型

説明

-i, --access-key-id

String

Object Storage Service (OSS) へのアクセスに使用されるAccessKey ID。

-k, --access-key-secret

String

OSSへのアクセスに使用されるAccessKeyシークレット。

-- アドレッシングスタイル

String

アドレス指定スタイル。 有効な値:

  • virtual (デフォルト): 仮想ホスティングモード。

  • path: パスモード。

  • cname: カスタムドメイン名モード。

-c, --config-file

String

設定ファイルのパス。 デフォルト値: ~\\.ossutilconfig

-- connect-timeout

int

クライアント接続のタイムアウト時間 (秒) 。 デフォルト値は 10 です。 単位は秒です。

-n、-- ドライラン

/

変更を加えずにトライアルランを実行します。

-e, --endpoint

String

エンドポイント。

-h、-- ヘルプ

/

特定のコマンドのヘルプ情報を表示します。

-- 言語

String

表示言語。

-- loglevel

String

ログレベル。 有効な値:

  • off (デフォルト)

  • info

  • デバッグ

-- モード

String

認証モードです。 有効な値:

  • AK: AccessKeyペア。

  • StsToken: 一時的なアクセス資格情報。

  • EcsRamRole: Elastic Compute Service (ECS) インスタンスにアタッチされたRAMロール。

  • 匿名: 匿名アクセス。

-- output-format

String

出力形式。 デフォルト値: raw。

-- output-query

String

JMESPathクエリ条件。

-プロフィール

String

構成ファイル内のプロファイルを指定します。

-q、-- 静か

/

最小限の情報を印刷するためのクワイエットモードを有効にします。

-- read-timeout

int

クライアントの読み取りおよび書き込み要求のタイムアウト時間 (秒) 。 単位は秒です。 デフォルト値は 20 です。

-- region

String

データセンターが配置されているリージョン。 例:cn-hangzhou。

-- retry-times

int

エラーが発生したときのリトライ回数。 デフォルト値は 10 です。

-- sign-version

String

署名アルゴリズムのバージョン。 有効な値:

  • v1

  • v4 (デフォルト)

-- skip-verify-cert

/

サーバーによって提供されたデジタル証明書が検証されないことを指定します。

-t, --sts-token

String

Security token Service (STS) によって発行されたトークン。

-- プロキシ

String

プロキシサーバー。

設定方法:

  • 直接設定: プロキシサーバーを直接指定できます。 例:

    • http://proxy.example.com:8080

    • https://proxy.example.com:8443

  • env: HTTP_PROXYおよびHTTPS_PROXY環境変数を使用して、プロキシサーバー情報を取得します。 これらの環境変数は、オペレーティングシステムで設定する必要があります。 例:

    • HTTP_PROXY=http://proxy.example.com:8080

    • HTTPS_PROXY=https://proxy.example.com:8443

    これらの環境変数を設定した後、プロキシサーバーオプションの値をenvに設定できます。 その後、システムはこれらの環境変数で指定されたプロキシ設定を自動的に使用します。

-- ログファイル

String

ログ出力ファイル。 有効な値:

  • -: ログはstdoutにエクスポートされます。

  • ファイルパス: 特定のファイルパスを指定すると、ログがファイルにエクスポートされます。

特定のファイルパスを指定しない場合、ログはデフォルトの構成ファイルにエクスポートされます。