インストールおよび構成

このプラグインは、64 ビット・プロセッサーで稼働する Linux (x86_64、 arm64、 ppc64le、 s390x)、Windows ® (x64)、および macOS® (amd64、 arm64) プラットフォームと互換性があります。

plugin install コマンドを使用してプラグインをインストールします。

ibmcloud plugin install cloud-object-storage

プラグインがインストールされたら、 ibmcloud cos config コマンドを使用してプラグインを構成できます。 これを使用して、プラグインに認証情報、デフォルトのダウンロード先、認証方法の選択などを設定することができます。

最適なパフォーマンスを得るには、 IBMCLOUD_TRACE 環境変数を false に設定して、トレースを無効にします。

このプログラムは、ダウンロードしたファイルのデフォルト・ローカル・ディレクトリーを設定したり、デフォルト地域を設定したりする機能も備えています。 デフォルトのダウンロード場所を設定するには、ibmcloud cos config ddl と入力し、プログラムに有効なファイル・パスを入力します。 デフォルト地域を設定するには、ibmcloud cos config region と入力し、us-south などの地域コードをプログラムに入力します。 デフォルトでは、この値は us-geo に設定されます。

ibmcloud cos config list にアクセスすると、現在の IBM Cloud Object Storage の認証情報を確認できます。 構成ファイルはプラグインによって生成されるため、ファイルを手動で編集しないことをお勧めします。

$ ibmcloud cos config list
Key                     Value
Last Updated            Tuesday, April 28 2020 at 19:35:57
Default Region          us-south
Download Location       /home/ibmuser/Downloads
CRN                     8f275e7b-c076-49e2-b9c5-f985704cf678
AccessKeyID             9eib1eejar6HaezaohveV5hikei4aNg2ooV0qu
SecretAccessKey         ********************************************
Authentication Method   IAM
URL Style               VHost

$ ibmcloud resource service-instance 'My Awesome Cloud Object Storage'  --id
Retrieving service instance My Awesome Cloud Object Storage in all resource groups under account IBM as ibmuser@us.ibm.com...
crn:v1:bluemix:public:cloud-object-storage:global:a/94400e98c553415c9599db39b9be9219:3b7d66c8-9fdf-4f81-b7e6-08d187f07288:: 8f275e7b-c076-49e2-b9c5-f985704cf678

$ ibmcloud cos config crn
Resource Instance ID CRN:  ()> 8f275e7b-c076-49e2-b9c5-f985704cf678
Saving new Service Instance ID...
OK
Successfully stored your service instance ID.

$ ibmcloud cos config crn --list
Key   Value
CRN   8f275e7b-c076-49e2-b9c5-f985704cf678

コマンド・ライン・インターフェースでトレースを使用可能にする

トレースを有効にするには、IBMCLOUD_TRACE環境変数をtrue に設定します(大/小文字は無視されます)。 トレースを有効にすると、追加のデバッグ情報が端末に出力されます。

Linux/macOS 端末の場合:

export IBMCLOUD_TRACE=true

Windows プロンプトの場合:

SET IBMCLOUD_TRACE=true

トレースを無効にするには、IBMCLOUD_TRACE環境変数をfalse に設定します(大/小文字は無視されます)。

コマンド索引

各操作には、その機能、使用方法、およびオプションまたは必須のパラメータに関する説明が記載されています。 リストされているすべてのパラメーターは、オプションと示されていない限り、必須です。

CLIプラグインは、 Object Storage で利用可能な機能一式をまだサポートしていない。 Aspera High-Speed Transfer 不変 Object Storage、 Key Protect バケットの作成、バケットファイアウォールはCLIでは使用できない。

マルチパート・アップロードの中止

• アクション: ユーザーの IBM Cloud Object Storage アカウント内のバケットへのアップロードを終了して、マルチパート・アップロード・インスタンスを中止します。
• 使用法: ibmcloud cos multipart-upload-abort --bucket BUCKET_NAME --key KEY --upload-id ID [--region REGION] [--output FORMAT]
• 指定するパラメーター:
  • バケットの名前。
    • フラグ: --bucket BUCKET_NAME
  • オブジェクトのキー。
    • フラグ: --key KEY
  • マルチパート・アップロードを識別するアップロード ID。
    • フラグ: --upload-id ID
  • オプション ：バケットが存在するREGION。 このフラグを設定しなかった場合、プログラムは構成に指定されたデフォルト・オプションを使用します。
    • フラグ: --region REGION
  • オプション ：出力形式は、json または text のいずれかのみです。
    • フラグ: --output FORMAT

静的 Web サイトの構成

• アクション: 静的 Web サイトをホストするようにバケットを構成します。

• 使用法: ibmcloud cos bucket-website-put --bucket BUCKET_NAME [--region REGION] [--output FORMAT]

• 指定するパラメーター:

  • バケットの名前。

    • フラグ: --bucket BUCKET_NAME

  • JSON 構造の形式での Web サイト構成。 file:// 接頭部は、指定されたファイル ( --website-configuration file://<filename.json> など) から JSON 構造をロードするために使用されます。

    • フラグ: --website-configuration STRUCTURE Web サイトの静的動作を構成するために、以下のパラメーターを使用できます。 何も必要ありません。 詳しくは、 資料を参照してください。

      {
        "ErrorDocument": {
          "Key": "string"
        },
        "IndexDocument": {
          "Suffix": "string"
        },
        "RoutingRules": [
          {
            "Condition": {
              "HttpErrorCodeReturnedEquals": "string",
              "KeyPrefixEquals": "string"
            },
            "Redirect": {
              "HostName": "string",
              "HttpRedirectCode": "string",
              "Protocol": "http"|"https",
              "ReplaceKeyPrefixWith": "string",
              "ReplaceKeyWith": "string"
            }
          }
          ...
        ]
      }
      

      あるいは、バケット Web サイトがトラフィックをリダイレクトするように構成されている場合は、構成されている唯一のパラメーターでなければなりません。

      	  "RedirectAllRequestsTo": {
      	    "HostName": "string",
      	    "Protocol": "http"|"https"
      	  }
      	  ```
      
      
      

  • オプション ：バケットが存在するREGION。 このフラグを設定しなかった場合、プログラムは構成に指定されたデフォルト・オプションを使用します。

    • フラグ: --region REGION

  • オプション ：出力形式は、json または text のいずれかのみです。

    • フラグ: --output FORMAT

バケットからのオブジェクトのコピー

( --metadata フィーチャーを使用して) コピー中にメタデータをオブジェクトに追加する場合は、属性 --metadata-directive REPLACE を追加する必要があります。これは、操作中にデフォルトでメタデータがコピーされるためです (暗黙的な --metadata-directive COPY)。

• アクション: オブジェクトをソース・バケットから宛先バケットにコピーします。
• 使用法: ibmcloud cos object-copy --bucket BUCKET_NAME --key KEY --copy-source SOURCE [--cache-control CACHING_DIRECTIVES] [--content-disposition DIRECTIVES] [--content-encoding CONTENT_ENCODING] [--content-language LANGUAGE] [--content-type MIME] [--copy-source-if-match ETAG] [--copy-source-if-modified-since TIMESTAMP] [--copy-source-if-none-match ETAG] [--copy-source-if-unmodified-since TIMESTAMP] [--metadata MAP] [--metadata-directive DIRECTIVE] [--region REGION] [--output FORMAT]
• 指定するパラメーター:
  • 宛先バケットの名前。
    • フラグ: --bucket BUCKET_NAME
  • オブジェクトのキー。
    • フラグ: --key KEY
  • (SOURCE) ソースバケット名とソースオブジェクトのキー名をスラッシュ (/) で区切ったもの。 URL-encoded で指定する必要があります。
    • フラグ: --copy-source SOURCE
  • オプション ：リクエストおよびレスポンスのチェーンに対して、 CACHING_DIRECTIVES を指定します。
    • フラグ: --cache-control CACHING_DIRECTIVES
  • オプション ：表示情報を指定します（DIRECTIVES ）。
    • フラグ: --content-disposition DIRECTIVES
  • オプション ：オブジェクトにどのコンテンツエンコーディング（CONTENT_ENCODING）が適用されるかを指定し、それによって、Content-Typeヘッダーフィールドで参照されるメディアタイプを取得するために、どのようなデコード処理を適用する必要があるかを示します。
    • フラグ: --content-encoding CONTENT_ENCODING
  • 任意 ：コンテンツの言語。
    • フラグ: --content-language LANGUAGE
  • オプション ：オブジェクトデータの形式を表す標準のMIMEタイプ。
    • フラグ: --content-type MIME
  • オプション ：オブジェクトのエンティティタグ（Etag ）が指定されたタグ（ETAG ）と一致する場合、そのオブジェクトをコピーします。
    • フラグ: --copy-source-if-match ETAG
  • オプション ：指定された時刻（TIMESTAMP）以降に変更が加えられている場合、そのオブジェクトをコピーします。
    • フラグ: --copy-source-if-modified-since TIMESTAMP
  • オプション ：オブジェクトのエンティティタグ（ETag ）が、指定されたタグ（ETAG ）と異なる場合、そのオブジェクトをコピーします。
    • フラグ: --copy-source-if-none-match ETAG
  • オプション ：指定された時刻（TIMESTAMP）以降、オブジェクトに変更が加えられていない場合、そのオブジェクトをコピーします。
    • フラグ: --copy-source-if-unmodified-since TIMESTAMP
  • オプション ：保存するメタデータのMAP。
    • フラグ: --metadata MAP JSON 構文: --metadata フラグは、指定されたファイルから JSON 構造をロードするために使用される file:// 接頭部を取ります。

      {
        "file_name": "file_20xxxxxxxxxxxx45.zip",
        "label": "texas",
        "state": "Texas",
        "Date_to": "2019-11-09T16:00:00.000Z",
        "Sha256sum": "9e39dxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx8ce6b68ede3a47",
        "Timestamp": "Thu, 17 Oct 2019 09:22:13 GMT"
      }
      ```

   * _Optional_: Specifies whether the metadata is copied from the source object or replaced with metadata provided in the request. DIRECTIVE values: COPY,REPLACE.
        * Flag: ` --metadata-directive DIRECTIVE`
    * _Optional_: The REGION where the bucket is present. If this flag is not provided, the program uses the default option that is specified in config.
        * Flag: `--region REGION`
    * _Optional_: Output FORMAT can be only json or text.
        * Flag: `--output FORMAT`

新規バケットの作成

• アクション: IBM Cloud Object Storage インスタンスにバケットを作成します。
• 使用法: ibmcloud cos bucket-create --bucket BUCKET_NAME [--class CLASS_NAME][--class onerate_active] [--ibm-service-instance-id ID] [--region REGION] [--output FORMAT]
  • なお、IAM 認証を使用する場合は CRN を指定する必要があります。 これは、 ibmcloud cos config crn コマンドを使用して設定できます。
• 指定するパラメーター:
  • バケットの名前。
    • フラグ: --bucket BUCKET_NAME
  • 任意 ：クラスの名前。
    • フラグ: --class CLASS_NAME
  • ユーザーはバケットを作成するときに onerate_active を指定する必要があります。
    • フラグ: --class onerate_active
  • オプション ：リクエスト内に IBM サービスインスタンスIDを設定します。
    • フラグ: --ibm-service-instance-id ID
  • オプション ：バケットが存在するREGION。 このフラグを設定しなかった場合、プログラムは構成に指定されたデフォルト・オプションを使用します。
    • フラグ: --region REGION
  • オプション ：出力形式は、json または text のいずれかのみです。
    • フラグ: --output FORMAT

ibmcloud cos bucket-create --bucket bucket-name --kms-root-key-crn crn:v1:staging:public:kms:us-south:a/9978e0xxxxxxxxxxxxxxxxxxxxxx8654:dfdxxxxx-xxxx-xxxx-xxxx-xxxxxxba6eb0:key:7cea005e-75d4-4a08-ad2f-5e56141f6a96 --kms-encryption-algorithm AES256

ibmcloud cos bucket-create --bucket bucket-name --kms-root-key-crn crn:v1:bluemix:public:hs-crypto:us-south:a/ee747e4xxxxxxxxxxxxxxxxxxxxxx7559:ac6xxxxx-xxxx-xxxx-xxxx-xxxxxx1bea99:key:e7451f36-d7ea-4f55-bc1c-ce4bcceb7018

新規マルチパート・アップロードの作成

• アクション: 新規マルチパート・アップロード・インスタンスを作成して、マルチパート・ファイル・アップロード・プロセスを開始します。

• 使用法: ibmcloud cos multipart-upload-create --bucket BUCKET_NAME --key KEY [--cache-control CACHING_DIRECTIVES] [--content-disposition DIRECTIVES] [--content-encoding CONTENT_ENCODING] [--content-language LANGUAGE] [--content-type MIME] [--metadata MAP] [--region REGION] [--output FORMAT]

• 指定するパラメーター:

  • バケットの名前。
    • フラグ: --bucket BUCKET_NAME
  • オブジェクトのキー。
    • フラグ: --key KEY
  • オプション ：リクエストおよびレスポンスのチェーンに対して、 CACHING_DIRECTIVES を指定します。
    • フラグ: --cache-control CACHING_DIRECTIVES
  • オプション ：表示情報を指定します（DIRECTIVES ）。
    • フラグ: --content-disposition DIRECTIVES
  • オプション ：オブジェクトのコンテンツエンコーディング（CONTENT_ENCODING ）を指定します。
    • フラグ: --content-encoding CONTENT_ENCODING
  • 任意 ：コンテンツの言語。
    • フラグ: --content-language LANGUAGE
  • オプション ：オブジェクトデータの形式を表す標準のMIMEタイプ。
    • フラグ: --content-type MIME
  • オプション ：保存するメタデータのMAP。
    • フラグ: --metadata MAP JSON 構文: --metadata フラグは、指定されたファイルから JSON 構造をロードするために使用される file:// 接頭部を取ります。

  {
    "file_name": "file_20xxxxxxxxxxxx45.zip",
    "label": "texas",
    "state": "Texas",
    "Date_to": "2019-11-09T16:00:00.000Z",
    "Sha256sum": "9e39dxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx8ce6b68ede3a47",
    "Timestamp": "Thu, 17 Oct 2019 09:22:13 GMT"
  }
  

  • オプション ：バケットが存在するREGION。 このフラグを設定しなかった場合、プログラムは構成に指定されたデフォルト・オプションを使用します。
    • フラグ: --region REGION
  • オプション ：出力形式は、json または text のいずれかのみです。
    • フラグ: --output FORMAT

既存のバケットの削除

• アクション: IBM Cloud Object Storage インスタンス内の既存のバケットを削除します。
• 使用法: ibmcloud cos bucket-delete --bucket BUCKET_NAME [--region REGION] [--force] [--output FORMAT]
• 指定するパラメーター:
  • バケットの名前。
    • フラグ: --bucket BUCKET_NAME
  • オプション ：バケットが存在するREGION。 このフラグを設定しなかった場合、プログラムは構成に指定されたデフォルト・オプションを使用します。
    • フラグ: --region REGION
  • オプション ：この操作では確認のメッセージは表示されません。
    • フラグ: --force
  • オプション ：出力形式は、json または text のいずれかのみです。
    • フラグ: --output FORMAT

バケット CORS の削除

• アクション: ユーザーの IBM Cloud Object Storage アカウント内のバケットの CORS 構成を削除します。
• 使用法: ibmcloud cos bucket-cors-delete --bucket BUCKET_NAME [--region REGION] [--output FORMAT]
• 指定するパラメーター:
  • バケットの名前。
    • フラグ: --bucket BUCKET_NAME
  • オプション ：バケットが存在するREGION。 このフラグを設定しなかった場合、プログラムは構成に指定されたデフォルト・オプションを使用します。
    • フラグ: --region REGION
  • オプション ：出力形式は、json または text のいずれかのみです。
    • フラグ: --output FORMAT

静的 Web サイト構成の削除

• アクション: バケットの静的 Web サイト構成を削除します。
• 使用法: ibmcloud cos bucket-website-delete --bucket BUCKET_NAME [--region REGION] [--output FORMAT]
• 指定するパラメーター:

  • バケットの名前。

    • フラグ: --bucket BUCKET_NAME
  • オプション ：バケットが存在するREGION。 このフラグを設定しなかった場合、プログラムは構成に指定されたデフォルト・オプションを使用します。
    • フラグ: --region REGION
  • オプション ：出力形式は、json または text のいずれかのみです。
    • フラグ: --output FORMAT

オブジェクトの削除

• アクション: ユーザーの IBM Cloud Object Storage アカウント内のバケットから 1 つのオブジェクトを削除します。
• 使用法: ibmcloud cos object-delete --bucket BUCKET_NAME --key KEY [--region REGION] [--force] [--output FORMAT]
• 指定するパラメーター:
  • バケットの名前。
    • フラグ: --bucket BUCKET_NAME
  • オブジェクトのキー。
    • フラグ: --key KEY
  • オプション ：バケットが存在するREGION。 このフラグを設定しなかった場合、プログラムは構成に指定されたデフォルト・オプションを使用します。
    • フラグ: --region REGION
  • オプション ：この操作では確認のメッセージは表示されません。
    • フラグ: --force
    • オプション ：出力形式は、json または text のいずれかのみです。
      • フラグ: --output FORMAT

複数のオブジェクトの削除

• アクション: ユーザーの IBM Cloud Object Storage アカウント内のバケットから複数のオブジェクトを削除します。

• 使用法: ibmcloud cos objects-delete --bucket BUCKET_NAME --delete STRUCTURE [--region REGION] [--output FORMAT]

• 指定するパラメーター:

  • バケットの名前。
    • フラグ: --bucket BUCKET_NAME
  • 省略構文または JSON 構文のいずれかを使用する構造 (STRUCTURE)。
    • フラグ: --delete STRUCTURE
    • 省略構文: --delete 'Objects=[{Key=string},{Key=string}],Quiet=boolean'

    • JSON 構文: --delete file://<filename.json>

      --delete コマンドは、削除するオブジェクトをリストする JSON 構造を取ります。 この例では、file:// 接頭部を使用して、指定したファイルから JSON 構造をロードします。

  	{
  	"Objects": [
  	{
  	"Key": "string",
  	"VersionId": "string"
  	}
  ...
  	],
  	"Quiet": true|false
  	}
  

  • オプション ：バケットが存在するREGION。 このフラグを設定しなかった場合、プログラムは構成に指定されたデフォルト・オプションを使用します。
    • フラグ: --region REGION
  • オプション ：出力形式は、json または text のいずれかのみです。
    • フラグ: --output FORMAT

オブジェクトのダウンロード

• アクション: ユーザーの IBM Cloud Object Storage アカウント内のバケットから 1 つのオブジェクトをダウンロードします。
• 使用法: ibmcloud cos object-get --bucket BUCKET_NAME --key KEY [--if-match ETAG] [--if-modified-since TIMESTAMP] [--if-none-match ETAG] [--if-unmodified-since TIMESTAMP] [--range RANGE] [--response-cache-control HEADER] [--response-content-disposition HEADER] [--response-content-encoding HEADER] [--response-content-language HEADER] [--response-content-type HEADER] [--response-expires HEADER] [--region REGION] [--output FORMAT] [OUTFILE]
• 指定するパラメーター:
  • バケットの名前。
    • フラグ: --bucket BUCKET_NAME
  • オブジェクトのキー。
    • フラグ: --key KEY
  • オプション ：オブジェクトのエンティティタグ（ETag ）が指定された ETAG と一致する場合にのみそのオブジェクトを返し、そうでない場合は412（前提条件を満たさない）を返す。
    • フラグ: --if-match ETAG
  • オプション ：指定されたTIMESTAMP以降に変更が加えられている場合にのみオブジェクトを返し、そうでない場合は304（変更なし）を返す。
    • フラグ: --if-modified-since TIMESTAMP
  • オプション ：オブジェクトのエンティティタグ（ETag ）が指定された ETAG と異なる場合にのみそのオブジェクトを返し、それ以外の場合は304（変更なし）を返す。
    • フラグ: --if-none-match ETAG
  • オプション ：指定されたTIMESTAMP以降に変更が加えられていない場合のみ、そのオブジェクトを返す。そうでない場合は、412（前提条件を満たさない）を返す。
    • フラグ: --if-unmodified-since TIMESTAMP
  • オプション ：オブジェクトの指定された範囲（RANGE）のバイト数をダウンロードします。
    • フラグ: --range RANGE
  • オプション ：レスポンスの Cache-Control ヘッダーを設定します。
    • フラグ: --response-cache-control HEADER
  • オプション ：レスポンスの Content-Disposition ヘッダーを設定します。
    • フラグ: --response-content-disposition HEADER
  • オプション ：レスポンスの Content-Encoding ヘッダーを設定します。
    • フラグ: --response-content-encoding HEADER
  • オプション ：レスポンスの Content-Language ヘッダーを設定します。
    • フラグ: --response-content-language HEADER
  • オプション ：レスポンスの Content-Type ヘッダーを設定します。
    • フラグ: --response-content-type HEADER
  • オプション ：レスポンスの「Expires」ヘッダーを設定します。
    • フラグ: --response-expires HEADER
  • オプション ：バケットが存在するREGION。 このフラグを設定しなかった場合、プログラムは構成に指定されたデフォルト・オプションを使用します。
    • フラグ: --region REGION
  • オプション ：出力形式は、json または text のいずれかのみです。
    • フラグ: --output FORMAT
  • オプション ：オブジェクトの内容を保存する場所。 このパラメーターが指定されていない場合、プログラムはデフォルトの場所を使用します。
    • パラメーター: OUTFILE

バケットの検出

• アクション: IBM Cloud Object Storage インスタンス内のバケットの地域およびクラスを判別します。
• 使用法: ibmcloud cos bucket-location-get --bucket BUCKET_NAME [--output FORMAT]
• 指定するパラメーター:
  • バケットの名前。
    • フラグ: --bucket BUCKET_NAME
  • オプション ：出力形式は、json または text のいずれかのみです。
    • フラグ: --output FORMAT

バケットのクラスの取得

• アクション: IBM Cloud Object Storage インスタンス内のバケットのクラスを判別します。
• 使用法: ibmcloud cos bucket-class-get --bucket BUCKET_NAME [--output FORMAT]
• 指定するパラメーター:
  • バケットの名前。
    • フラグ: --bucket BUCKET_NAME
  • オプション ：出力形式は、json または text のいずれかのみです。
    • フラグ: --output FORMAT

バケット CORS の取得

• アクション: ユーザーの IBM Cloud Object Storage アカウント内のバケットの CORS 構成を返します。
• 使用法: ibmcloud cos bucket-cors-get --bucket BUCKET_NAME [--region REGION] [--output FORMAT]
• 指定するパラメーター:
  • バケットの名前。
    • フラグ: --bucket BUCKET_NAME
  • オプション ：バケットが存在するREGION。 このフラグを設定しなかった場合、プログラムは構成に指定されたデフォルト・オプションを使用します。
    • フラグ: --region REGION
  • オプション ：出力形式は、json または text のいずれかのみです。
    • フラグ: --output FORMAT

バケットのヘッダーの取得

• アクション: IBM Cloud Object Storage インスタンス内にバケットが存在しているかどうかを判別します。
• 使用法: ibmcloud cos bucket-head --bucket BUCKET_NAME [--region REGION] [--output FORMAT]
• 指定するパラメーター:
  • バケットの名前。
    • フラグ: --bucket BUCKET_NAME
  • オプション ：バケットが存在するREGION。 このフラグを設定しなかった場合、プログラムは構成に指定されたデフォルト・オプションを使用します。
    • フラグ: --region REGION
  • オプション ：出力形式は、json または text のいずれかのみです。
    • フラグ: --output FORMAT

マルチパート・アップロードの完了

• アクション: 現在アップロードされているパートをアセンブルし、そのファイルをユーザーの IBM Cloud Object Storage アカウント内のバケットにアップロードして、マルチパート・アップロード・インスタンスを完了します。
• 使用法: ibmcloud cos multipart-upload-complete --bucket BUCKET_NAME --key KEY --upload-id ID --multipart-upload STRUCTURE [--region REGION] [--output FORMAT]
• 指定するパラメーター:

  • バケットの名前。

    • フラグ: --bucket BUCKET_NAME

  • オブジェクトのキー。

    • フラグ: --key KEY

  • マルチパート・アップロードを識別するアップロード ID。

    • フラグ: --upload-id ID

  • 設定する MultipartUpload の構造 (STRUCTURE)。

    • フラグ: --multipart-upload STRUCTURE
    • 省略構文: --multipart-upload 'Parts=[{ETag=string,PartNumber=integer},{ETag=string,PartNumber=integer}]'

    • JSON 構文: --multipart-upload file://<filename.json>

      --multipart-upload コマンドは、完全なファイルに再アセンブルする必要があるマルチパート・アップロードのパートを記述する JSON 構造を取ります。 この例では、file:// 接頭部を使用して、指定したファイルから JSON 構造をロードします。

    		{
    		"Parts": [
    			{
    			 "ETag": "string",
    			 "PartNumber": integer
    			}
    			...
    			]
    		}
    

  • オプション ：バケットが存在するREGION。 このフラグを設定しなかった場合、プログラムは構成に指定されたデフォルト・オプションを使用します。

    • フラグ: --region REGION

  • オプション ：出力形式は、json または text のいずれかのみです。

    • フラグ: --output FORMAT

プログラムの構成

• アクション: プログラムの設定を構成します。
• 使用法: ibmcloud cos config [COMMAND]
• コマンド:
  • HMAC と IAM の認証の間で切り替えます。
    • コマンド: auth
  • CRN を構成に保管します。
    • コマンド: crn
  • デフォルトのダウンロード場所を構成に保管します。
    • コマンド: ddl
  • HMAC 資格情報を構成に保管します。
    • コマンド: hmac
  • 構成をリストします。
    • コマンド: list
  • デフォルト地域を構成に保管します。
    • コマンド: region
  • 「 VHost 」と「Path URL 」のスタイルを切り替える。
    • コマンド: url-style
  • デフォルトのサービス・エンドポイントを設定します。
    • コマンド: endpoint-url

      • パラメーター:

        • --list は、現在のデフォルトのサービス・エンドポイントを表示します (設定されている場合)。 それ以外の場合は、空になります。
        • --url some.end.point.url は、サービス・エンドポイントを指定された値に変更します。
        • --clear は、設定されているデフォルトの Service Endpoint を削除します。 URL

静的 Web サイト構成の取得

• アクション: バケットの静的 Web サイト構成を取得します。
• 使用法: ibmcloud cos bucket-website-get --bucket BUCKET_NAME [--region REGION] [--output FORMAT]
• 指定するパラメーター:

  • バケットの名前。

    • フラグ: --bucket BUCKET_NAME
  • オプション ：バケットが存在するREGION。 このフラグを設定しなかった場合、プログラムは構成に指定されたデフォルト・オプションを使用します。
    • フラグ: --region REGION
  • オプション ：出力形式は、json または text のいずれかのみです。
    • フラグ: --output FORMAT

オブジェクトのヘッダーの取得

• アクション: ユーザーの IBM Cloud Object Storage アカウント内のバケットにファイルが存在しているかどうかを判別します。
• 使用法: ibmcloud cos object-head --bucket BUCKET_NAME --key KEY [--if-match ETAG] [--if-modified-since TIMESTAMP] [--if-none-match ETAG] [--if-unmodified-since TIMESTAMP] [--range RANGE] [--region REGION] [--output FORMAT]
• 指定するパラメーター:
  • バケットの名前。
    • フラグ: --bucket BUCKET_NAME
  • オブジェクトのキー。
    • フラグ: --key KEY
  • オプション ：オブジェクトのエンティティタグ（ETag ）が指定された ETAG と一致する場合にのみそのオブジェクトを返し、そうでない場合は412（前提条件を満たさない）を返す。
    • フラグ: --if-match ETAG
  • オプション ：指定されたTIMESTAMP以降に変更が加えられている場合にのみオブジェクトを返し、そうでない場合は304（変更なし）を返す。
    • フラグ: --if-modified-since TIMESTAMP
  • オプション ：オブジェクトのエンティティタグ（ETag ）が指定された ETAG と異なる場合にのみそのオブジェクトを返し、それ以外の場合は304（変更なし）を返す。
    • フラグ: --if-none-match ETAG
  • オプション ：指定されたTIMESTAMP以降に変更が加えられていない場合のみ、そのオブジェクトを返す。そうでない場合は、412（前提条件を満たさない）を返す。
    • フラグ: --if-unmodified-since TIMESTAMP
  • オブジェクトの指定した RANGE バイトをダウンロードします。
    • フラグ: --range RANGE
  • オプション ：バケットが存在するREGION。 このフラグを設定しなかった場合、プログラムは構成に指定されたデフォルト・オプションを使用します。
    • フラグ: --region REGION
  • オプション ：出力形式は、json または text のいずれかのみです。
    • フラグ: --output FORMAT

すべてのバケットのリスト表示

• アクション: ユーザーの IBM Cloud Object Storage アカウント内のすべてのバケットのリストを出力します。 バケットは、異なる地域に存在している可能性があります。
• 使用法: ibmcloud cos buckets [--ibm-service-instance-id ID] [--output FORMAT]
  • なお、IAM 認証を使用する場合は CRN を指定する必要があります。 これは、 ibmcloud cos config crn コマンドを使用して設定できます。
• 指定するパラメーター:
  • 指定するパラメーターはありません。
    • オプション ：リクエスト内に IBM サービスインスタンスIDを設定します。
      • フラグ: --ibm-service-instance-id
    • オプション ：出力形式は、json または text のいずれかのみです。
      • フラグ: --output FORMAT

進行中のマルチパート・アップロードのリスト表示

• アクション: 進行中のマルチパート・アップロードをリストします。
• 使用法: ibmcloud cos multipart-uploads --bucket BUCKET_NAME [--delimiter DELIMITER] [--encoding-type METHOD] [--prefix PREFIX] [--key-marker value] [--upload-id-marker value] [--page-size SIZE] [--max-items NUMBER] [--region REGION] [--output FORMAT]
• 指定するパラメーター:
  • バケットの名前。
    • フラグ: --bucket BUCKET_NAME
  • オプション ：DELIMITER（区切り文字）とは、キーをグループ化するために使用する文字のことです。
    • フラグ: --delimiter DELIMITER
  • オプション ：レスポンス内のオブジェクトキーをエンコードするよう要求し、使用するエンコード方式を指定します。
    • フラグ: --encoding-type METHOD
  • オプション ：指定された PREFIX で始まるキーに対してのみ応答を返すように制限します。
    • フラグ: --prefix PREFIX
  • オプション ：このパラメータは、upload-id-marker と合わせて、どのマルチパートアップロードの後に一覧表示を開始するかを指定します。
    • フラグ: --key-marker value
  • オプション ：key-marker と組み合わせて、リストの表示を開始すべきマルチパートアップロードの開始位置を指定します。 key-marker が指定されていない場合、upload-id-marker パラメーターは無視されます。
    • フラグ: --upload-id-marker value
  • オプション ：サービス呼び出しで取得する各ページのサイズ。 これは、コマンドの出力として返される項目の数には影響しません。 ページ・サイズをより小さく設定することで、各呼び出しで取得する項目が少なくなり、サービスに送られる呼び出し数が増えることになります。 これにより、サービス呼び出しがタイムアウトするのを防ぐことができます（デフォルト：1000）。
    • フラグ: --page-size SIZE
  • オプション ：コマンドの出力に含める項目の総数。 対象項目の合計数が指定した値を超える場合、コマンドの出力に NextToken が提供されます。 ページネーションを再開するには、次のコマンドの starting-token 引数に NextToken の値を指定してください（デフォルト：0）。
    • フラグ: --max-items NUMBER
  • オプション ：バケットが存在するREGION。 このフラグを設定しなかった場合、プログラムは構成に指定されたデフォルト・オプションを使用します。
    • フラグ: --region REGION
  • オプション ：出力形式は、json または text のいずれかのみです。
    • フラグ: --output FORMAT

オブジェクトのリスト表示

• アクション: ユーザーの IBM Cloud Object Storage アカウント内のバケットに存在するファイルをリストします。 この操作は現在、最近作成された 1000 個のオブジェクトに制限されており、フィルタリングできません。
• 使用法: ibmcloud cos objects --bucket BUCKET_NAME [--delimiter DELIMITER] [--encoding-type METHOD] [--prefix PREFIX] [--starting-token TOKEN] [--page-size SIZE] [--max-items NUMBER] [--region REGION] [--output FORMAT]
• 指定するパラメーター:
  • バケットの名前。
    • フラグ: --bucket BUCKET_NAME
  • オプション ：DELIMITER（区切り文字）とは、キーをグループ化するために使用する文字のことです。
    • フラグ: --delimiter DELIMITER
  • オプション ：レスポンス内のオブジェクトキーをエンコードするよう要求し、使用するエンコード方式を指定します。
    • フラグ: --encoding-type METHOD
  • オプション ：指定された PREFIX で始まるキーに対してのみ応答を返すように制限します。
    • フラグ: --prefix PREFIX
  • オプション ：ページネーションの開始位置を指定するための TOKEN。 これは以前に切り捨てられた応答からの NextToken です。
    • フラグ: --starting-token TOKEN
  • オプション ：サービス呼び出しで取得する各ページのサイズ。 これは、コマンドの出力として返される項目の数には影響しません。 ページ・サイズをより小さく設定することで、各呼び出しで取得する項目が少なくなり、サービスに送られる呼び出し数が増えることになります。 これにより、サービス呼び出しがタイムアウトするのを防ぐことができます。（デフォルト：1000）
    • フラグ: --page-size SIZE
  • オプション ：コマンドの出力に含める項目の総数。 対象項目の合計数が指定した値を超える場合、コマンドの出力に NextToken が提供されます。 ページネーションを再開するには、次のコマンドの starting-token 引数に「 NextToken 」という値を指定してください。（デフォルト：0）
    • フラグ: --max-items NUMBER
  • オプション ：バケットが存在するREGION。 このフラグを設定しなかった場合、プログラムは構成に指定されたデフォルト・オプションを使用します。
    • フラグ: --region REGION
  • オプション ：出力形式は、json または text のいずれかのみです。
    • フラグ: --output FORMAT

オブジェクトのリスト v2

• アクション： 特定のバケット内のすべてのオブジェクトを一覧表示する。
• 使用法: list-objects-v2 --bucket BUCKET_NAME [--starting-token Starting Token] [--delimiter DELIMITER] [--encoding-type METHOD] [--fetch-owner Boolean] [--max-items NUMBER] [--prefix PREFIX] [--start-after Start After] [--page-size SIZE] [--region REGION] [--output FORMAT] [--json]
• 指定するパラメーター:
  • バケットの名前。
    • フラグ: --bucket BUCKET_NAME
  • オプション ：DELIMITER（区切り文字）とは、キーをグループ化するために使用する文字のことです。
    • フラグ: --delimiter DELIMITER
  • オプション ：レスポンス内のオブジェクトキーをエンコードするよう要求し、使用するエンコード方式を指定します。
    • フラグ: --encoding-type METHOD
  • オプション ：指定された PREFIX で始まるキーに対してのみ応答を返すように制限します。
    • フラグ: --prefix PREFIX
  • オプション ：ページネーションの開始位置を指定するための TOKEN。 これは以前に切り捨てられた応答からの NextToken です。
    • フラグ: --starting-token TOKEN
  • オプション ：サービス呼び出しで取得する各ページのサイズ。 これは、コマンドの出力として返される項目の数には影響しません。 ページ・サイズをより小さく設定することで、各呼び出しで取得する項目が少なくなり、サービスに送られる呼び出し数が増えることになります。 これにより、サービス呼び出しがタイムアウトするのを防ぐことができます。（デフォルト：1000）
    • フラグ: --page-size SIZE
  • オプション ：コマンドの出力に含める項目の総数。 対象項目の合計数が指定した値を超える場合、コマンドの出力に NextToken が提供されます。 ページネーションを再開するには、次のコマンドの starting-token 引数に「 NextToken 」という値を指定してください。（デフォルト：0）
    • フラグ: --max-items NUMBER
  • オプション ：バケットが存在するREGION。 このフラグを設定しなかった場合、プログラムは構成に指定されたデフォルト・オプションを使用します。
    • フラグ: --region REGION
  • オプション ：出力形式は、json または text のいずれかのみです。
    • フラグ: --output FORMAT
  • オプション ：デフォルトでは、 listV2 にはこのブール値は含まれていません。結果の各キーとともに所有者フィールドを返したい場合は、fetch owner field を true に設定してください。
    • フラグ: --fetch-owner Boolean
  • オプション ：「Start After」には、 S3 がリストの表示を開始する位置を指定します。 S3 は、この指定されたキーの後からリストを開始します。 StartAfter は、バケット内の任意のキーにすることができます。
    • フラグ: --start-after Start After
  • 非推奨 : 出力が生の JSON 形式で返されました。
    • フラグ: --json

パートのリスト

• アクション: 進行中のマルチパート・アップロード・インスタンスに関する情報を出力します。
• 使用法: ibmcloud cos parts --bucket BUCKET_NAME --key KEY --upload-id ID --part-number-marker VALUE [--page-size SIZE] [--max-items NUMBER] [--region REGION] [--output FORMAT]
• 指定するパラメーター:
  • バケットの名前。
    • フラグ: --bucket BUCKET_NAME
  • オブジェクトのキー。
    • フラグ: --key KEY
  • マルチパート・アップロードを識別するアップロード ID。
    • フラグ: --upload-id ID
  • リスト表示を開始する前のパート番号値 (VALUE) (デフォルト: 1)
    • フラグ: --part-number-marker VALUE
  • オプション ：サービス呼び出しで取得する各ページのサイズ。 これは、コマンドの出力として返される項目の数には影響しません。 ページ・サイズをより小さく設定することで、各呼び出しで取得する項目が少なくなり、サービスに送られる呼び出し数が増えることになります。 これにより、サービス呼び出しがタイムアウトするのを防ぐことができます。（デフォルト：1000）
    • フラグ: --page-size SIZE
  • オプション ：コマンドの出力に含める項目の総数。 対象項目の合計数が指定した値を超える場合、コマンドの出力に NextToken が提供されます。 ページネーションを再開するには、次のコマンドの starting-token 引数に「 NextToken 」という値を指定してください。（デフォルト：0）
    • フラグ: --max-items NUMBER
  • オプション ：バケットが存在するREGION。 このフラグを設定しなかった場合、プログラムは構成に指定されたデフォルト・オプションを使用します。
    • フラグ: --region REGION
  • オプション ：出力形式は、json または text のいずれかのみです。
    • フラグ: --output FORMAT

バケット CORS の設定

• アクション: ユーザーの IBM Cloud Object Storage アカウント内のバケットの CORS 構成を設定します。

• 使用法: ibmcloud cos bucket-cors-put --bucket BUCKET_NAME [--cors-configuration STRUCTURE] [--region REGION] [--output FORMAT]

• 指定するパラメーター:

  • バケットの名前。
    • フラグ: --bucket BUCKET_NAME
  • オプション ：ファイル内のJSON構文を使用したSTRUCTURE。
    • フラグ: --cors-configuration STRUCTURE

    • JSON 構文: --cors-configuration file://<filename.json>

      --cors-configuration コマンドは、 CORS のコンフィギュレーションを記述したJSON構造体を受け取る。 この例では、file:// 接頭部を使用して、指定したファイルから JSON 構造をロードします。

  	{
  	"CORSRules": [
  	{
    	"AllowedHeaders": ["*"],
    	"AllowedMethods": ["PUT", "GET", "DELETE"],
    	"AllowedOrigins": ["http://www.example.com"],
    	"ExposeHeaders": ["ExposeHeader7","ExposeHeader8"],
    	"MaxAgeSeconds": 75
  	}
  	...
  	]
  	}
  

  • オプション ：バケットが存在するREGION。 このフラグを設定しなかった場合、プログラムは構成に指定されたデフォルト・オプションを使用します。
    • フラグ: --region REGION
  • オプション ：出力形式は、json または text のいずれかのみです。
    • フラグ: --output FORMAT

オブジェクトの配置

• アクション: ユーザーの IBM Cloud Object Storage アカウント内のバケットにオブジェクトをアップロードします。

• 使用法: ibmcloud cos object-put --bucket BUCKET_NAME --key KEY [--body FILE_PATH] [--cache-control CACHING_DIRECTIVES] [--content-disposition DIRECTIVES] [--content-encoding CONTENT_ENCODING] [--content-language LANGUAGE] [--content-length SIZE] [--content-md5 MD5] [--content-type MIME] [--metadata MAP] [--region REGION] [--output FORMAT]

• 指定するパラメーター:

  • バケットの名前。
    • フラグ: --bucket BUCKET_NAME
  • オブジェクトのキー。
    • フラグ: --key KEY
  • オプション ：オブジェクトデータの保存場所（FILE_PATH ）。
    • フラグ: --body FILE_PATH
  • オプション ：リクエストおよびレスポンスのチェーンに対して、 CACHING_DIRECTIVES を指定します。
    • フラグ: --cache-control CACHING_DIRECTIVES
  • オプション ：表示情報を指定します（DIRECTIVES ）。
    • フラグ: --content-disposition DIRECTIVES
  • オプション ：オブジェクトのコンテンツエンコーディング（CONTENT_ENCODING ）を指定します。
    • フラグ: --content-encoding CONTENT_ENCODING
  • 任意 ：コンテンツの言語。
    • フラグ: --content-language LANGUAGE
  • オプション ： 本文のサイズ（バイト単位）。 このパラメータは、ボディのサイズを自動的に判別できない場合に役立ちます。（デフォルト：0）
    • フラグ: --content-length SIZE
  • オプション ：データの base64-encoded による128ビット MD5 ダイジェスト。
    • フラグ: --content-md5 MD5
  • オプション ：オブジェクトデータの形式を表す標準のMIMEタイプ。
    • フラグ: --content-type MIME
  • オプション ：保存するメタデータのMAP。
    • フラグ: --metadata MAP JSON 構文: --metadata フラグは、指定されたファイルから JSON 構造をロードするために使用される file:// 接頭部を取ります。

  {
    "file_name": "file_20xxxxxxxxxxxx45.zip",
    "label": "texas",
    "state": "Texas",
    "Date_to": "2019-11-09T16:00:00.000Z",
    "Sha256sum": "9e39dxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx8ce6b68ede3a47",
    "Timestamp": "Thu, 17 Oct 2019 09:22:13 GMT"
  }
  

  • オプション ：バケットが存在するREGION。 このフラグを設定しなかった場合、プログラムは構成に指定されたデフォルト・オプションを使用します。
    • フラグ: --region REGION
  • オプション ：出力形式は、json または text のいずれかのみです。
    • フラグ: --output FORMAT

マルチパート・アップロードの手動制御

IBM Cloud Object Storage のCLIでは、 AWS のマルチパートアップロード機能を利用して、大容量ファイルを複数のパートに分けてアップロードすることができます。 新しいマルチパートアップロードを開始するには、 multipart-upload-create コマンドを実行します。これにより、新しいアップロードインスタンスのアップロードIDが返されます。 アップロード・プロセスを続行するには、後続の各コマンドのためにアップロード ID を保存する必要があります。 このコマンドでは、 MD5 ハッシュを生成する必要がある：

{object data} | openssl dgst -md5 -binary | openssl enc -base64

multipart-upload-complete コマンドを実行した後、アップロードするファイル・パートごとに part-upload を実行します。 複数ファイルのアップロードの場合、最後のファイルを除くすべてのファイルは、それぞれ5 MB以上である必要があります。 ファイルを別々のパートに分割するには、端末ウィンドウで split を実行します。 例えば、デスクトップ上に TESTFILE という名前の 13 MB のファイルがあり、それぞれ 5 MB のファイル・パートに分割する場合は、split -b 3m ~/Desktop/TESTFILE part-file- を実行できます。 このコマンドは、3 つのファイル・パート (それぞれ 5 MB の 2 つのファイル・パートと、1 つの 3 MB のファイル・パート) を part-file-aa、part-file-ab、および part-file-ac という名前で生成します。 As each file part is uploaded, the CLI print its ETag . You must save this ETag into a formatted JSON file, along with the part number. Use this template to create your own ETag JSON データ・ファイル。

{
    "Parts": [
    {
      "PartNumber": 1,
      "ETag": "The ETag of the first file part goes here."
    },
    {
      "PartNumber": 2,
      "ETag": "The ETag of the second file part goes here."
    }
    ]
}

必要に応じて、この JSON テンプレートにさらに項目を追加します。

マルチパートアップロードのステータスを確認するには、バケット名、キー、およびアップロードIDを指定して、いつでも part-list コマンドを実行できます。 これは、マルチパートアップロードのインスタンスに関する生の情報を出力します。 ファイルの各部分のアップロードが完了したら、必要なパラメータを指定して「 multipart-upload-complete 」コマンドを実行してください。 すべてが正常に行われた場合、ファイルが目的のバケットに正常にアップロードされたことを示す確認が返されます。

オブジェクト・ロック構成

ibmcloud cos object-lock-configuration-put --bucket bucket-name --object-lock-configuration '{ "ObjectLockEnabled": "Enabled", "Rule": { "DefaultRetention": { "Mode": "COMPLIANCE", "Days": 30 }}}'

ibmcloud cos object-lock-configuration-get --bucket bucket-name --region us-south

オブジェクト保存

ibmcloud cos object-retention-put --bucket bucket-name --key file-name.txt --retention '{ "Mode": "COMPLIANCE", "RetainUntilDate": "2024-02-02T00:00:00"}’

ibmcloud cos object-retention-put --bucket bucket-name --key file-name.txt --region us-south

オブジェクトの訴訟ホールド

ibmcloud cos object-legal-hold-put --bucket bucket-name --key file-name.txt --legal-hold ‘{"Status": "ON"}’

ibmcloud cos object-retention-get --bucket bucket-name --key file-name.txt --region us-south

バケット複製の構成

複製されたバケットを構成するためのセットアップ。

ibmcloud cos bucket-replication-put --bucket SOURCE-BUCKET-NAME --replication-configuration file://replication.json

 ibmcloud cos bucket-replication-get --bucket SOURCE-BUCKET-NAME

 ibmcloud cos bucket-replication-delete --bucket SOURCE-BUCKET-NAME

次のステップ

すべてのプロシージャーは常に計画どおりに実行されるため、 共通ヘッダーおよびエラー・コード は表示されていない可能性があります。 詳しくは、 API リファレンス を参照してください。