Object Storage Service:ossutilコマンド

コマンド構造

ossutilは、コマンドタイプに応じて、次のコマンド構造を使用します。

ossutil command [argument] [flags]  

ossutil command subcommond [argument] [flags]  

ossutil topic

• argument: 引数 引数はstring型です。

• flags: オプション。 オプションは、-o[=value] または-o [ value] の短縮形式で指定することも、-- options[=value] または -- options[ value] の完全形式で指定することもできます。 排他オプションを複数回指定した場合、最後の値のみが有効になります。

例：

• 上位コマンド: ossutil cat oss:// bucket/object

• マルチレベルコマンド: ossutil api get-bucket-cors -- bucket bucketexample

• ヘルパーコマンド: ossutil filter

コマンド

ossutilは3種類のコマンドを提供します。

• 高レベルのコマンド

  高レベルコマンドは、バケットの作成、バケットの削除、データのコピー、オブジェクト属性の変更など、一般的なバケットとオブジェクトのタスクを実行します。

  コマンド	説明
  mb	バケットを作成します。
  rb	バケットを削除します。
  du	指定されたバケットまたはディレクトリ (プレフィックス) のストレージサイズを照会します。
  統計	Displays the description of a bucket or object.
  mkdir	名前がスラッシュ文字 (/) で終わるオブジェクトを作成します。
  append	追加可能なオブジェクトにコンテンツを追加します。
  猫	オブジェクトコンテンツを標準出力に送信します。
  ls	Lists buckets or objects.
  cp	オブジェクトのアップロード、ダウンロード、またはコピー。
  rm	オブジェクトを削除します。
  set-props	オブジェクト属性を設定します。
  事前署名	オブジェクトの署名付きURLを生成します。
  復元	凍結オブジェクトを復元します。
  元に戻す	オブジェクトを指定したバージョンに戻します。
  同期	ディレクトリまたはオブジェクトをソースから宛先に同期します。
  ハッシュ	ファイルまたはオブジェクトのハッシュを計算します。

• APIレベルのコマンド

  APIレベルのコマンドは、Object Storage Service (OSS) API操作への直接アクセスを提供します。 OSS API操作のパラメーターは、対応するossutilコマンドで指定できます。

• ヘルパーコマンド

  ヘルパーコマンドは、設定の管理やヘルプ情報の表示などの補助サポートを提供します。

オプションタイプ

ファイルからデータを読み込む

ほとんどの場合、コマンドラインでパラメーター値を直接指定します。 複雑な値を処理する必要がある場合は、ファイルから値をロードする方が効率的です。 コマンドをチェーンするときは、標準入力を使用してパラメーター値を指定する必要があります。 パラメータが異なるメソッドを使用して値を取ることができる場合:

• 値がfile:// で始まる場合、データは指定されたファイルからロードされます。

• 値が-の場合、データは標準入力から読み込まれます。

次のサンプルコマンドは、cors-configuration.jsonファイルからCORS設定を読み込んでCORSルールを作成します。

{
  "CORSRule": {
    "AllowedOrigin": ["www.aliyun.com"],
    "AllowedMethod": ["PUT","GET"],
    "MaxAgeSeconds": 10000
  }
}

ossutil api put-bucket-cors --bucket examplebucket --cors-configuration file://cors-configuration.json

次のサンプルコマンドは、コマンドラインでJSON設定データを取得してCORSルールを作成します。

{"CORSRule":{"AllowedOrigin":["www.aliyun.com"],"AllowedMethod":["PUT","GET"],"MaxAgeSeconds":10000}}

ossutil api put-bucket-cors --bucket examplebucket --cors-configuration  "{\"CORSRule\":{\"AllowedOrigin\":[\"www.aliyun.com\"],\"AllowedMethod\":[\"PUT\",\"GET\"],\"MaxAgeSeconds\":10000}}"

次のサンプルコマンドは、標準入力から設定を取得してCORSルールを作成します。

cat cors-configuration.json | ossutil api put-bucket-cors --bucket examplebucket --cors-configuration -

コマンド出力制御

出力フォーマット

-- output-formatパラメーターは、duコマンド、statコマンド、lsコマンド、およびapiコマンドのサブコマンドで使用して、出力をフォーマットできます。 -- output-formatオプションの有効な値を次の表に示します。

次の例では、get-bucket-corsコマンドの出力はraw形式です。

ossutil api get-bucket-cors --bucket bucketexample
<?xml version="1.0" encoding="UTF-8"?>
<CORSConfiguration>
  <CORSRule>
    <AllowedOrigin>www.aliyun.com</AllowedOrigin>
    <AllowedMethod>PUT</AllowedMethod>
    <AllowedMethod>GET</AllowedMethod>
    <MaxAgeSeconds>10000</MaxAgeSeconds>
  </CORSRule>
  <ResponseVary>false</ResponseVary>
</CORSConfiguration>

次の例では、出力はJSON形式です。

ossutil api get-bucket-cors --bucket bucketexample --output-format json
{
  "CORSRule": {
    "AllowedMethod": [
      "PUT",
      "GET"
    ],
    "AllowedOrigin": "www.aliyun.com",
    "MaxAgeSeconds": "10000"
  },
  "ResponseVary": "false"
}

出力クエリ

ossutilは、組み込みのJSONベースの出力クエリメカニズムを提供します。 -- output-query valueオプションを使用して出力をクエリできます。

出力クエリ機能はJMESPathに基づいています。 出力クエリ機能を使用すると、出力はJSON形式になり、JMESPathクエリ式に基づいてフィルタリングされ、指定された形式で返されます。 JMEPathの詳細については、「JMESPath仕様」をご参照ください。

次の例では、get-bucket-corsコマンドはAllowedMethodパラメーターの値のみを返します。

ossutil api get-bucket-cors --bucket bucketexample --output-query CORSRule.AllowedMethod --output-format json
[
  "PUT",
  "GET"
]

フレンドリーな出力ディスプレイ

ossutilには -- human-readableオプションが用意されており、duコマンドとstatコマンドの出力のデータサイズと量をより人間が読めるように表示できます。 具体的には、1024単位のKiB、MiB、GiB、TiB、PiBでデータサイズを表示し、1000単位の略号k、m、g、t、pで数量を表示する。

生の出力表示の例

ossutil stat oss://bucketexample
ACL                         : private
AccessMonitor               : Disabled
ArchiveObjectCount          : 2
ArchiveRealStorage          : 10
ArchiveStorage              : 131072
...
StandardObjectCount         : 119212
StandardStorage             : 66756852803
Storage                     : 66756852813
StorageClass                : Standard
TransferAcceleration        : Disabled

フレンドリーな出力表示の例

ossutil stat oss://bucketexample --human-readable
ACL                         : private
AccessMonitor               : Disabled
ArchiveObjectCount          : 2
ArchiveRealStorage          : 10
ArchiveStorage              : 131.072k
...
StandardObjectCount         : 119.212k
StandardStorage             : 66.757G
Storage                     : 66.757G
StorageClass                : Standard
TransferAcceleration        : Disabled

リターンコード

プロセスを使用してossutilを呼び出すと、エコー情報をリアルタイムで表示できません。 プロセスの実行が完了すると、結果に基づいてリターンコードが表示されます。 次のコマンドを実行して、以前に実行したコマンドの終了コードを表示し、その終了コードをトラブルシューティングに使用できます。