CLIの使用

CLIのすべてのヘルプの確認

コマンドラインのヘルプを参照してください。

複雑な入力を渡す

複数の値を含む配列やオブジェクトなどの複雑な入力はJSONフォーマットで渡されます。これは、コマンドラインで文字列として、またはファイルとして、指定できます。あるいは、コマンドラインの文字列とファイルの両方として渡すこともできます。

MacOS、LinuxまたはUnix

次のコマンドは、--metadataオブジェクトの2つの値を渡す方法を示しています。

oci os bucket create -ns mynamespace --name mybucket --metadata '{"key1":"value1","key2":"value2"}' --compartment-id ocid1.compartment.oc1..<example>

Windows

次のコマンドは、Windowsで--metadataオブジェクトの2つの値を渡す方法を示しています。

oci os bucket create -ns mynamespace --name mybucket --metadata "{\"key1\":\"value1\",\"key2\":\"value2\"}" --compartment-id ocid1.compartment.oc1..<example>

JSON文字列の使用の詳細は、JSONの拡張オプションを参照してください

出力を表としてフォーマット

デフォルトでは、コマンドに対するすべての応答はJSONフォーマットで返されます。たとえば、リージョンのリストを取得するコマンドを発行すると、次のような応答が返されます。

{
  "data": [
    {
      "key": "FRA",
      "name": "eu-frankfurt-1"
    },
    {
      "key": "IAD",
      "name": "us-ashburn-1"
    },
    {
      "key": "ICN",
      "name": "ap-seoul-1"
    },
    {
      "key": "PHX",
      "name": "us-phoenix-1"
    },
    {
      "key": "LHR",
      "name": "uk-london-1"
    },
    {
      "key": "NRT",
      "name": "ap-tokyo-1"
    },			
    {
      "key": "YYZ",
      "name": "ca-toronto-1"
    }				
  ]
}

場合によっては、読みやすいかどうかが問題になりますが、これは応答を表としてフォーマットすることで簡単に解決できます。コマンドの応答を表フォーマットにするには、次のコマンドを実行します。

oci iam region list --output table

次のリージョン・リストのサンプルは、2列の表として返されます。

+-----+----------------+
| key | name           |
+-----+----------------+
| FRA | eu-frankfurt-1 |
| IAD | us-ashburn-1   |
| ICN | ap-seoul-1     |
| PHX | us-phoenix-1   |
| NRT | ap-tokyo-1     |				
| LHR | uk-london-1    |
| YYZ | ca-toronto-1   |  
+-----+----------------+

問合せの使用

JSONの--queryオプションを使用して出力をフィルタリングできます。このオプションでは、JSONのJMESPath問合せ言語を使用します。

大量の出力を処理する場合はフィルタリングが非常に便利です。たとえば、次のコマンドはすべてのコンパートメントのリストを返します:

oci iam compartment list --all

このコマンドは多くの情報を返します。返されるフィールドの一部には、compartment-id、name、lifecycle-stateおよびdefined-tagsが含まれます。

表示するフィールドの選択

配列の名前および1つ以上のフィールドの名前を指定して(カンマ区切り配列として渡されます)、必要なフィールドのみを選択できます:

oci iam compartment list --all --query "data[].[name, \"lifecycle-state\"]"

[ 
  [
    "ATestCompartment",
    "ACTIVE"
  ],
  
  [
    "blocktest",
    "ACTIVE"
  ],
  [
    "ZestyTest",
    "ACTIVE"
  ]
]

<name of the array>[].{<your custom name>:<the name of the field>}

oci iam compartment list --all --query "data[].{Name:name, \"LifecycleState\":\"lifecycle-state\"}"

[
  {
    "LifecycleState": "ACTIVE",
    "Name": "ATestCompartment"
  },
  {
    "LifecycleState": "ACTIVE",
    "Name": "blocktest"
  },
  {
    "LifecycleState": "ACTIVE",
    "Name": "ZestyTest"
  }
]

検索条件の指定

oci iam compartment list --all --query "data[?name=='blocktest']"

[
  {
    "compartment-id": "ocid1.tenancy.oc1..<example_value>",
    "defined-tags": {
      "MySpecialTag": {
        "Phonebook": "software-development-kit"
      }
    },
    "description": "Compartment used by integration tests. 10000",
    "freeform-tags": {},
    "id": "ocid1.compartment.oc1..<example>",
    "inactive-status": null,
    "is-accessible": null,
    "lifecycle-state": "ACTIVE",
    "name": "blocktest",
    "time-created": "2018-06-19T17:08:46.059000+00:00"
  }
]

oci iam compartment list --all --query "data[?\"time-created\"<'2019'&&\"defined-tags\".MySpecialTag!=null].[name, \"lifecycle-state\"]"

[
  [
    "blocktest",
    "ACTIVE"
  ]
]

JSONのJMESPath問合せ言語の詳細は、JMESPathを参照してください。

JSON入力の優先順位

CLIでは、コマンドライン上の引数とファイル入力を組み合せることができます。ただし、同じ値がファイルとコマンドラインで指定された場合は、コマンドラインが優先されます。

複雑な入力でのJSONファイルの使用

ファイルをコマンドラインで参照することで、複雑な入力をファイルから渡すことができます。Windowsユーザーの場合は、こうすると、JSONテキストをエスケープする必要がなくなります。ファイルのパスは、file://接頭辞を使用して指定します。

パス・タイプ

testfile.jsonを例として使用した場合、次のタイプのパスがサポートされます。

• 同じディレクトリからの相対パスの例: file://testfile.jsonおよびfile://relative/path/to/testfile.json
• Linux、MacOSまたはUnixの絶対パスの例: file:///absolute/path/to/testfile.json
• Windowsのフル・ファイル・パスの例: file://C:\path\to\testfile.json

ファイルの場所

サポートされているファイルの場所は次のとおりです。

• ホーム・ディレクトリ。

  oci os bucket create -ns mynamespace --name mybucket --compartment-id ocid1.compartment.oc1..aaaaaaaarhifmvrvuqtye5q66rck6copzqck3ukc5fldrwpp2jojdcypxfga --metadata file://~/testfile.json

• 現在のディレクトリ。

  oci os bucket create -ns mynamespace --name mybucket --compartment-id ocid1.compartment.oc1..aaaaaaaarhifmvrvuqtye5q66rck6copzqck3ukc5fldrwpp2jojdcypxfga --metadata file://testfile.json

• /tmpディレクトリ(Linux、UnixまたはMacOS)。

  oci os bucket create -ns mynamespace --name mybucket --compartment-id ocid1.compartment.oc1..aaaaaaaarhifmvrvuqtye5q66rck6copzqck3ukc5fldrwpp2jojdcypxfga --metadata file:///tmp/testfile.json

• C:\tempディレクトリ(Windows)。

  oci os bucket create -ns mynamespace --name mybucket --compartment-id ocid1.compartment.oc1..aaaaaaaarhifmvrvuqtye5q66rck6copzqck3ukc5fldrwpp2jojdcypxfga --metadata file://C:\temp\testfile.json

JSONファイルを入力として使用する例

この項の例では、コマンド・オプションおよびコマンド全体に対して生成されるJSONを使用しています。JSONをファイルに保存して編集してから、コマンドライン入力として使用します。

コマンド・オプションに対するファイル入力の使用

この詳しい例では、サブネットの作成に使用されるセキュリティ・リストIDオプションのためのJSONを生成する方法を説明します。JSONをファイルに保存して編集してから、コマンドライン入力として使用します。

オブジェクト・ストレージの使用

オブジェクト・ストレージ・サービスのいくつかのオブジェクト操作でCLIを使用できます。

ファイルのアップロードとダウンロード

オブジェクトは、ファイルまたはコマンドライン(STDIN)からアップロードでき、ファイルまたはコマンドライン(STDOUT)にダウンロードできます。

オブジェクトをアップロード:

oci os object put -ns mynamespace -bn mybucket --name myfile.txt --file /Users/me/myfile.txt --metadata '{"key1":"value1","key2":"value2"}'

コマンドライン(STDIN)からオブジェクトの内容をアップロード:

oci os object put -ns mynamespace -bn mybucket --name myfile.txt --file <--'object content'

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

oci os object get -ns mynamespace -bn mybucket --name myfile.txt --file /Users/me/myfile.txt

オブジェクトの内容をコマンドライン(STDOUT)に出力:

oci os object get -ns mynamespace -bn mybucket --name myfile.txt --file -

オブジェクト・ストレージでの一括操作

CLIでは、オブジェクト・ストレージの次の一括操作がサポートされています:

• ディレクトリとそのすべてのサブディレクトリ内のファイルのバケットへのアップロード

  # Upload all the files in a directory.
  oci os object bulk-upload -ns mynamespace -bn mybucket --src-dir path/to/upload/directory

• バケット内のすべてのオブジェクト(または指定した接頭辞と一致するすべてのオブジェクト)のダウンロード

  # Download all the objects.
  oci os object bulk-download -ns mynamespace -bn mybucket --download-dir path/to/download/directory
  						
  # Download all the objects that match the specified prefix.
  oci os object bulk-download -ns mynamespace -bn mybucket --download-dir path/to/download/directory --prefix myprefix

• バケット内のすべてのオブジェクト(または指定した接頭辞と一致するすべてのオブジェクト)の削除

  # Delete all the objects.
  oci os object bulk-delete -ns mynamespace -bn mybucket
  			
  # Delete objects that match the specified prefix.
  oci os object bulk-delete -ns mynamespace -bn mybucket --prefix myprefix

一括操作では、次のことができるいくつかのオプションがサポートされています:

• --overwriteまたは--no-overwriteを使用してファイル/オブジェクトを上書きまたはスキップします。(ノート: これらのオプションをどちらも渡さない場合、上書きするものがあるたびに確認を求められます。)
• --prefixまたは--delimiter (あるいは両方)を使用して、削除、アップロードまたはダウンロードの操作を制限します
• --dry-runを使用して一括削除をプレビューします

一括操作のコマンドに関する詳細情報を取得するには、次のヘルプ・コマンドを実行します:

# bulk-upload
oci os object bulk-upload -h
				
# bulk-download
oci os object bulk-download -h
				
# bulk-delete
oci os object bulk-delete -h

オブジェクト・ストレージでのマルチパート操作

オブジェクト・ストレージのマルチパート操作には、オブジェクトのアップロードとダウンロードが含まれます。

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

大きなファイルは、複数のパートでオブジェクト・ストレージにアップロードすることでアップロードを高速化できます。デフォルトでは、128MiBよりも大きいファイルはマルチパート操作を使用してアップロードされます。--no-multipartオプションを使用すると、このデフォルトをオーバーライドできます。

oci os object putコマンドで次のオプションを構成できます:

• --no-multipartは、オブジェクトが128MiBを超える場合に、自動マルチパート・アップロードをオーバーライドします。オブジェクトはサイズに関係なく、単一のパートとしてアップロードされます。
• マルチパート操作で使用する--part-size (MiB単位)。デフォルトのパート・サイズは128MiBで、指定するパート・サイズは10MiBより大きくする必要があります。オブジェクトが--part-sizeより大きい場合、複数のパートでアップロードされます。
• 実行する並列操作の数を指定する--parallel-upload-count。この値を使用して、リソースとアップロード時間のバランスを調整します。値が大きいほど時間は短縮されますが、システム・リソースおよびネットワーク帯域幅の消費量が増加します。デフォルトの値は10です。

--resume-putコマンドを使用すると、大規模なファイルのアップロードが中断した場合にアップロードを再開できます。

次の例は、オブジェクトが200MiBより大きい場合のマルチパート・アップロードのコマンドを示しています。

oci os object put -ns my-namespace -bn my-bucket --file path/to/large/file --part-size 200

マルチパート・アップロードの詳細は、マルチパート・アップロードの使用を参照してください。

マルチパート・ダウンロード

大きなファイルは、複数のパートでオブジェクト・ストレージにダウンロードすることでダウンロードを高速化できます。

oci os object getコマンドで次のオプションを構成できます:

• --multipart-download-thresholdを使用して、複数パートでダウンロードすべきオブジェクトのサイズ(MiB単位)を指定できます。このサイズは128MiB以上にする必要があります。
• ダウンロード・パートで使用する--part-size (MiB単位)。これを使用すると、要件に合せて柔軟に、パート数を多くする(小さいサイズ)か少なくする(大きいサイズ)ことができます。たとえば、コンピューティング性能とネットワーク帯域幅です。デフォルトの最小パート・サイズは120MiBです。
• --parallel-download-countを使用すると、同時にダウンロードされるパート数を指定できます。値が大きいほど時間は短縮されますが、システム・リソースおよびネットワーク帯域幅の消費量が増加します。デフォルトの値は10です。

次の例は、サイズが500MiBを超える任意のオブジェクトをダウンロードするコマンドを示しています。オブジェクトは、128MiBのパートでダウンロードされます。

oci os object get -ns my-namespace -bn my-bucket --name my-large-object --multipart-download-threshold 500 --part-size 128