CLI verwenden

Gesamte CLI-Hilfe anzeigen

Sie können die Befehlszeilenhilfe anzeigen.

Komplexe Eingabe übergeben

Komplexe Eingaben, wie Arrays und Objekte mit mehr als einem Wert, werden im JSON-Format übergeben und können als Zeichenfolge in der Befehlszeile, als Datei oder als Befehlszeilenzeichenfolge und als Datei angegeben werden.

MacOS, Linux oder Unix

Der folgende Befehl zeigt, wie zwei Werte für das Objekt --metadata übergeben werden.

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

Windows

Der folgende Befehl zeigt, wie zwei Werte für das --metadata-Objekt unter Windows übergeben werden.

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

Weitere Informationen zur Verwendung von JSON-Zeichenfolgen finden Sie unter Erweiterte JSON-Optionen.

Ausgabe als Tabelle formatieren

Standardmäßig werden alle Antworten auf einen Befehl im JSON-Format zurückgegeben. Beispiel: Eine Antwort wie die folgende wird zurückgegeben, wenn Sie mit dem Befehl eine Liste der Regionen abrufen.

{
  "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"
    }				
  ]
}

In einigen Fällen kann die Lesbarkeit zu einem Problem werden, das sich einfach beheben lässt, indem eine Antwort als Tabelle formatiert wird. Um eine Antwort im Tabellenformat auf einen Befehl zu erhalten, führen Sie den folgenden Befehl aus.

oci iam region list --output table

Die folgende Beispielliste von Regionen wird als Tabelle mit zwei Spalten zurückgegeben.

+-----+----------------+
| 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   |  
+-----+----------------+

Abfragen verwenden

Sie können die Ausgabe mit der --query-Option für JSON filtern. Diese Option verwendet die Abfragesprache JMESPath für JSON.

Bei umfangreichen Ausgaben ist eine Filterung hilfreich. Der folgende Befehl gibt beispielsweise eine Liste aller Compartments zurück:

oci iam compartment list --all

Dieser Befehl liefert umfangreiche Informationen. Zurückgegeben werden unter anderem die Felder compartment-id, name, lifecycle-state und defined-tags.

Felder für die Anzeige auswählen

Sie können die gewünschten Felder zum Anzeigen auswählen, indem Sie den Namen des Arrays sowie die Namen eines oder mehrerer Felder in Form eines Arrays mit Kommas als Trennzeichen übergeben:

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"
  }
]

Suchbedingungen angeben

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"
  ]
]

Weitere Informationen zur JMESPath-Abfragesprache für JSON finden Sie unter JMESPath.

Prioritätsfolge für JSON-Eingabe

Die CLI unterstützt die Kombination von Argumenten in der Befehlszeile mit Dateieingaben. Wenn jedoch dieselben Werte in einer Datei und in der Befehlszeile angegeben werden, hat die Befehlszeile Vorrang.

JSON-Datei für komplexe Eingaben verwenden

Sie können komplexe Eingaben aus einer Datei übergeben, indem Sie sie von der Befehlszeile referenzieren. Bei Windows-Benutzern sind daher im JSON-Text keine Escapezeichen erforderlich. Sie geben einen Pfad zur Datei mit dem Präfix file:// an.

Pfadtypen

Ausgehend von testfile.json als Beispiel werden die folgenden Pfadtypen unterstützt.

• Relative Pfade aus demselben Verzeichnis, z.B. file://testfile.json und file://relative/path/to/testfile.json
• Absolute Pfade unter Linux, MacOS oder Unix, z.B. file:///absolute/path/to/testfile.json
• Vollständige Dateipfade unter Windows, z.B. file://C:\path\to\testfile.json

Dateispeicherorte

Folgende Dateispeicherorte werden unterstützt.

• Ihr Home-Verzeichnis.

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

• Das aktuelle Verzeichnis.

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

• Das /tmp-Verzeichnis (Linux, Unix oder MacOS).

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

• Das C:\temp-Verzeichnis (Windows).

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

Beispiele für die Verwendung einer JSON-Datei als Eingabe

Die Beispiele in diesem Abschnitt verwenden JSON, das für eine Befehlsoption und einen ganzen Befehl generiert wurde. Der JSON-Inhalt wird in einer Datei gespeichert, bearbeitet und dann als Befehlszeileneingabe verwendet.

Dateieingabe für eine Befehlsoption verwenden

In diesem End-to-End-Beispiel wird gezeigt, wie JSON für eine Sicherheitslisten-ID-Option generiert wird, mit der ein Subnetz erstellt wird. Der JSON-Inhalt wird in einer Datei gespeichert, bearbeitet und dann als Befehlszeileneingabe verwendet.

Mit Object Storage arbeiten

Sie können die CLI für verschiedene Objektvorgänge mit dem Object Storage-Service verwenden.

Dateien hoch- und herunterladen

Objekte können aus einer Datei oder der Befehlszeile (STDIN) hochgeladen und in eine Datei oder in die Befehlszeile (STDOUT) heruntergeladen werden.

Objekt hochladen:

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

Objektinhalt aus der Befehlszeile hochladen (STDIN):

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

Objekt herunterladen:

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

Objektinhalt in die Befehlszeile ausgeben (STDOUT):

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

Bulkvorgänge in Object Storage

Die CLI unterstützt die folgenden Bulkvorgänge in Object Storage:

• Dateien in einem Verzeichnis und alle zugehörigen Unterverzeichnisse in einen Bucket hochladen

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

• Alle Objekte oder alle Objekte, die einem bestimmten Präfix entsprechen, in einem Bucket herunterladen

  # 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

• Alle Objekte oder alle Objekte, die einem bestimmten Präfix entsprechen, in einem Bucket löschen

  # 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

Bulkvorgänge unterstützen mehrere Optionen, mit denen Sie folgende Möglichkeiten haben:

• Dateien/Objekte mit --overwrite oder --no-overwrite überschreiben oder überspringen. (Hinweis: Wenn Sie keine dieser Optionen übergeben, werden Sie jedes Mal zur Bestätigung aufgefordert, wenn ein zu überschreibendes Element vorhanden ist.)
• Lösch-, Upload- oder Downloadvorgänge mit --prefix und/oder --delimiter begrenzen
• Bulklöschvorgang mit --dry-run in der Vorschau anzeigen

Um weitere Informationen zu den Befehlen für Bulkvorgänge zu erhalten, führen Sie die folgenden Hilfebefehle aus:

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

Mehrteilige Vorgänge in Object Storage

Zu mehrteiligen Vorgängen für Object Storage gehören Objektuploads und -downloads.

Multipart-Uploads

Große Dateien können in mehreren Teilen in Object Storage hochgeladen werden, um den Upload zu beschleunigen. Standardmäßig werden Dateien mit mehr als 128 MiB in mehrteiligen Vorgängen hochgeladen. Sie können diese Standardeinstellung mit der Option --no-multipart außer Kraft setzen.

Sie können die folgenden Optionen für den Befehl oci os object put konfigurieren:

• --no-multipart setzt einen automatischen Multipart-Upload außer Kraft, wenn das Objekt größer als 128 MiB ist. Das Objekt wird unabhängig von der Größe im Ganzen hochgeladen.
• --part-size in MiB zur Verwendung in mehrteiligen Vorgängen. Die standardmäßige Teilgröße ist 128 MiB, und eine Teilgröße, die Sie angeben, muss größer als 10 MiB sein. Wenn das Objekt größer als --part-size ist, wird es in mehreren Teilen hochgeladen.
• --parallel-upload-count, um die Anzahl der auszuführenden Parallelvorgänge anzugeben. Mit diesem Wert können Sie Ressourcen und Uploadzeiten ausgleichen. Ein höherer Wert kann die Zeiten verkürzen, aber mehr Systemressourcen und Netzwerkbandbreite belegen. Der Standardwert lautet 10.

Mit dem Befehl --resume-put können Sie einen großen Dateiupload wiederaufnehmen, wenn der Upload unterbrochen wurde.

Das folgende Beispiel zeigt den Befehl für einen Multipart-Upload, wenn das Objekt größer als 200 MiB ist.

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

Weitere Informationen zu mehrteiligen Uploads finden Sie unter Multipart-Uploads verwenden.

Mehrteilige Downloads

Um den Download zu beschleunigen, können große Dateien aus Object Storage in mehreren Teilen heruntergeladen werden.

Sie können die folgenden Optionen für den Befehl oci os object get konfigurieren:

• Mit --multipart-download-threshold können Sie die Größe in MiB angeben, bei der ein Objekt in mehreren Teilen heruntergeladen werden soll. Diese Größe muss mindestens 128 MiB betragen.
• --part-size in MiB für einen Downloadteil. Dadurch können Sie mehr (kleinere) oder weniger (größere) Teile verwenden, abhängig von Ihren Anforderungen. Beispiel: Rechenleistung und Netzwerkbandbreite. Die standardmäßige Mindestteilgröße beträgt 120 MiB.
• Mit --parallel-download-count können Sie angeben, wie viele Teile gleichzeitig heruntergeladen werden. Ein höherer Wert kann die Zeiten verkürzen, aber mehr Systemressourcen und Netzwerkbandbreite belegen. Der Standardwert lautet 10.

Das folgende Beispiel zeigt den Befehl zum Herunterladen eines Objekts mit einer Größe von mehr als 500 MiB. Das Objekt wird in Teilen von jeweils 128 MiB heruntergeladen.

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