Object Storage Service:ヘルプ（ヘルプ情報の取得）

親コマンド

親コマンドのヘルプには、以下の 5 つのセクションが含まれます。

例：ossutil -h

ossutil は、OSS（Object Storage Service）データを管理するためのツールです。

使用方法： ossutil [コマンド]

利用可能なコマンド：
  api         API レベルのコマンド
  append      追加可能オブジェクトにコンテンツを追加
  cat         オブジェクトの内容を標準出力に連結
  config      設定ファイルを作成し、設定と認証情報を保存
  cp          オブジェクトのアップロード、ダウンロード、またはコピー
  du          バケットまたは指定されたプレフィックス（ディレクトリ）のストレージサイズを取得
  hash        ファイルのハッシュ値を取得
  help        任意のコマンドに関するヘルプ
  ls          バケットまたはオブジェクトの一覧表示
  mb          バケットを作成
  mkdir       名前末尾に '/' を持つオブジェクトを作成
  presign     オブジェクト用の署名付き URL を生成
  probe       検出コマンド
  rb          バケットを削除
  restore     凍結ステータスのオブジェクトを読み取り可能状態に復元
  revert      削除されたオブジェクトを最新のバージョン管理状態に復元
  rm          オブジェクトを削除
  set-props   オブジェクトのプロパティを設定
  stat        バケットまたはオブジェクトのメタ情報を表示
  sync        ローカルファイルディレクトリまたはソースから送信先へのオブジェクトの同期
  update      ossutil を更新
  version     バージョンを表示

追加のヘルプトピック：
  filter      フィルターフラグの詳細およびコマンド内での使用方法

「ossutil [コマンド] --help」を実行すると、各コマンドの詳細なヘルプを参照できます。
「ossutil [トピック]」を実行すると、各トピックの詳細なヘルプを参照できます。

サブコマンド

サブコマンドのヘルプには、以下の 6 つのセクションが含まれます。

「使用方法」行において、角括弧で囲まれた引数（[flags]）は省略可能です。ブール値フラグ（例：--dry-run）は値を取らず、フラグを指定すると有効化され、未指定だと無効化されます。

例 1: ossutil cat -h --language en

オブジェクトの内容を標準出力に連結します。
このコマンドを実行するには、oss:GetObject 権限が必要です。

使用方法： ossutil cat oss://bucket/object [flags]

使用例：

1) examplebucket バケット内の example.txt オブジェクトの内容を表示します。
  ossutil cat oss://examplebucket/example.txt

2) examplebucket バケット内の example.txt オブジェクト（バージョン ID：CAEQARiBgID8rumR2h***）の内容を表示します。
  ossutil cat oss://examplebucket/example.txt --version-id CAEQARiBgID8rumR2h***

3) 範囲を指定して examplebucket バケット内の example.txt オブジェクトの内容を表示します。
  先頭 10 文字のみ出力：
  ossutil cat oss://examplebucket/example.txt --head 10

  末尾 10 文字のみ出力：
  ossutil cat oss://examplebucket/example.txt --tail 10

  オフセット 10 以降のすべての文字を出力：
  ossutil cat oss://examplebucket/example.txt --offset 10

  オフセット 10 から 20 文字を出力：
  ossutil cat oss://examplebucket/example.txt --offset 10 --count 20

フラグ：
      --count int              N 文字のみ出力（デフォルト：-1）
      --encoding-type string   ユーザーが入力するオブジェクト名またはファイル名のエンコーディング方式。有効な値： "url"
      --head int               先頭 N 文字のみ出力
      --offset int             オフセット N から出力を開始
      --request-payer string   リクエストの支払者。リクエスト者による支払いを指定する場合に設定。有効な値： "requester"
      --tail int               末尾 N 文字のみ出力
      --version-id string      オブジェクトのバージョン ID を指定

グローバルフラグ：
  -i, --access-key-id string        OSS へのアクセス時に使用する AccessKeyID
  -k, --access-key-secret string    OSS へのアクセス時に使用する AccessKeySecret
      --addressing-style string     エンドポイントのアドレス指定方式（デフォルト："virtual"）。有効な値： "virtual"、"path"、"cname"
  -c, --config-file string          設定ファイルのパス（デフォルト："~\\.ossutilconfig"）
      --connect-timeout int         クライアント接続タイムアウト（単位：秒）（デフォルト：10）
  -n, --dry-run                     変更を伴わない試行実行
  -e, --endpoint string             OSS にアクセスする他のサービスが使用するドメイン名
  -h, --help                        コマンドのヘルプ
      --language string             表示言語
      --loglevel string             デバッグメッセージのレベル（デフォルト："off"）。有効な値： "off"、"info"、"debug"
      --mode string                 認証モードを指定（有効な値： "AK"、"StsToken"、"EcsRamRole"、"Anonymous"）
      --output-format string        コマンド出力のフォーマット形式（デフォルト："raw"）
      --output-properties strings   出力フォーマットのプロパティ
      --output-query string         応答データのフィルタリングに使用する JMESPath クエリ
      --profile string              設定ファイルから特定のプロファイルを選択
      --read-timeout int            クライアント読み取りタイムアウト（単位：秒）（デフォルト：20）
      --region string               バケットが配置されているリージョン
      --retry-times int             失敗時の再試行回数（デフォルト：10）
      --sign-version string         署名アルゴリズムのバージョン（デフォルト："v4"）。有効な値： "v1"、"v4"
      --skip-verify-cert            OSS サーバーのデジタル証明書を検証しないことを指定
  -t, --sts-token string            OSS へのアクセス時に使用する STSToken

例 2: ossutil api put-bucket-cors -h --language en

バケットに対してクロスオリジンリソース共有（CORS）ルールを設定します。
*   この操作を呼び出すには、oss:PutBucketCors 権限が必要です。
*   初期状態では無効化されています
    バケットに対して CORS はデフォルトで無効化されており、すべてのクロスオリジンリクエストは許可されません。

*   上書きセマンティクス
    既に CORS ルールが設定済みのバケットに対して PutBucketCors 操作を呼び出して新しい CORS ルールを設定すると、既存のルールが上書きされます。

*   アプリケーションにおける CORS の使用
    アプリケーションで CORS を使用する前に、CORS を有効化するために PutBucketCors 操作を呼び出して CORS ルールを設定する必要があります。
    たとえば、ブラウザの XMLHttpRequest 機能を使用して example.com から Object Storage Service（OSS）アプリケーションにアクセスする場合、CORS ルールを設定する必要があります。CORS ルールは XML 形式で設定します。

*   CORS ルールのマッチング
    OSS がクロスリージョンリクエストまたは OPTIONS リクエストを受信すると、対応するバケットに設定された CORS ルールを読み取り、権限チェックを実行します。OSS はルールを順次チェックし、最初に一致したルールに対応するヘッダーフィールドを応答に含めます。リクエストが CORS ルールに一致しなかった場合、CORS 関連のヘッダーフィールドは応答に含まれません。
    OSS は、以下の条件をすべて満たす場合にのみ、クロスオリジンリクエストまたは OPTIONS リクエストが CORS ルールに一致したと見なします。

    *   クロスオリジンリクエストの送信元オリジンが CORS ルールの AllowedOrigin のいずれかの値と一致する。
    *   クロスオリジンリクエストのメソッド（GET や PUT など）または OPTIONS リクエストの Access-Control-Request-Method に対応するメソッドが、CORS ルールの AllowedMethod のいずれかの値と一致する。
    *   OPTIONS リクエストの Access-Control-Request-Headers に含まれる各ヘッダーが、CORS ルールの AllowedHeader のいずれかの値と一致する。

この API の詳細については、「https://www.alibabacloud.com/help/oss/developer-reference/putbucketcors」をご参照ください。

使用方法： ossutil api put-bucket-cors --bucket value --cors-configuration value [flags]

使用例：

--cors-configuration は XML および JSON の両方の構文をサポートしており、オプション値に file:// 接頭辞が含まれる場合は、設定がファイルから読み込まれることを意味します。

XML 構文：
<CORSConfiguration>
  <CORSRule>
    <AllowedOrigin>string</AllowedOrigin>
    ...
    <AllowedMethod>string</AllowedMethod>
    ...
    <AllowedHeader>string</AllowedHeader>
    <ExposeHeader>string</ExposeHeader>
    ...
    <MaxAgeSeconds>integer</MaxAgeSeconds>
  </CORSRule>
  ...
  <ResponseVary>boolean</ResponseVary>
</CORSConfiguration>

JSON 構文：
{
  "CORSRule": [
    {
      "AllowedOrigin": ["string", ...],
      "AllowedMethod": ["string", ...],
      "AllowedHeader": "string",
      "ExposeHeader": ["string", ...],
      "MaxAgeSeconds": integer
    },
    ...
  ],
  "ResponseVary": boolean
}

1) www.aliyun.com からのクロスオリジン PUT および GET リクエストを許可し、ブラウザがリクエストに対する応答を 10,000 秒間キャッシュすることを指定します。

XML 設定ファイル（cors-configuration.xml）を使用：
<CORSConfiguration>
  <CORSRule>
    <AllowedOrigin>www.aliyun.com</AllowedOrigin>
    <AllowedMethod>PUT</AllowedMethod>
    <AllowedMethod>GET</AllowedMethod>
    <MaxAgeSeconds>10000</MaxAgeSeconds>
  </CORSRule>
</CORSConfiguration>

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

JSON 設定ファイル（cors-configuration.json）を使用：
{
  "CORSRule": {
    "AllowedOrigin": ["www.aliyun.com"],
    "AllowedMethod": ["PUT","GET"],
    "MaxAgeSeconds": 10000
  }
}
ossutil api put-bucket-cors --bucket examplebucket --cors-configuration file://cors-configuration.json

コマンドラインで JSON 文字列を使用：
ossutil api put-bucket-cors --bucket examplebucket --cors-configuration  "{\"CORSRule\":{\"AllowedOrigin\":[\"www.aliyun.com\"],\"AllowedMethod\":[\"PUT\",\"GET\"],\"MaxAgeSeconds\":10000}}"


フラグ：
      --bucket string               バケット名
      --cors-configuration string   バケットの CORS ルール情報を格納するコンテナ

グローバルフラグ：
  -i, --access-key-id string        OSS へのアクセス時に使用する AccessKeyID
  -k, --access-key-secret string    OSS へのアクセス時に使用する AccessKeySecret
      --addressing-style string     エンドポイントのアドレス指定方式（デフォルト："virtual"）。有効な値： "virtual"、"path"、"cname"
  -c, --config-file string          設定ファイルのパス（デフォルト："~\\.ossutilconfig"）
      --connect-timeout int         クライアント接続タイムアウト（単位：秒）（デフォルト：10）
  -n, --dry-run                     変更を伴わない試行実行
  -e, --endpoint string             OSS にアクセスする他のサービスが使用するドメイン名
  -h, --help                        コマンドのヘルプ
      --language string             表示言語
      --loglevel string             デバッグメッセージのレベル（デフォルト："off"）。有効な値： "off"、"info"、"debug"
      --mode string                 認証モードを指定（有効な値： "AK"、"StsToken"、"EcsRamRole"、"Anonymous"）
      --output-format string        コマンド出力のフォーマット形式（デフォルト："raw"）
      --output-properties strings   出力フォーマットのプロパティ
      --output-query string         応答データのフィルタリングに使用する JMESPath クエリ
      --profile string              設定ファイルから特定のプロファイルを選択
      --read-timeout int            クライアント読み取りタイムアウト（単位：秒）（デフォルト：20）
      --region string               バケットが配置されているリージョン
      --retry-times int             失敗時の再試行回数（デフォルト：10）
      --sign-version string         署名アルゴリズムのバージョン（デフォルト："v4"）。有効な値： "v1"、"v4"
      --skip-verify-cert            OSS サーバーのデジタル証明書を検証しないことを指定
  -t, --sts-token string            OSS へのアクセス時に使用する STSToken