Uso dell'interfaccia CLI

Visualizzazione di tutta la Guida dell'interfaccia CLI

È possibile visualizzare la Guida della riga di comando.

Passaggio dell'input complesso

L'input complesso, come array e oggetti con più di un valore, viene passato in formato JSON e può essere fornito come stringa nella riga di comando, come file o come stringa della riga di comando e come file.

MacOS, Linux o Unix

Il comando seguente mostra come passare due valori per l'oggetto --metadata.

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

Windows

Il comando seguente mostra come passare due valori per l'oggetto --metadata in Windows.

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

Per ulteriori informazioni sull'uso delle stringhe JSON, vedere Opzioni JSON avanzate

Formatta output come tabella

Per impostazione predefinita, tutte le risposte a un comando vengono restituite in formato JSON. Ad esempio, viene restituita una risposta come la seguente quando si esegue il comando per ottenere un elenco di aree.

{
  "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 alcuni casi, la leggibilità può diventare un problema, che viene facilmente risolto formattando una risposta come tabella. Per ottenere una risposta a un comando formattato come tabella, eseguire il comando seguente:

oci iam region list --output table

L'elenco di esempio di aree riportato di seguito viene restituito come tabella a due colonne.

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

Utilizzo delle query

È possibile filtrare l'output utilizzando l'opzione --query per JSON. Questa opzione utilizza il linguaggio di query JMESPath per JSON.

Il filtraggio è molto utile quando si tratta di grandi quantità di output. Ad esempio, il comando seguente restituisce una lista di tutti i compartimenti:

oci iam compartment list --all

Questo comando restituisce molte informazioni. Alcuni dei campi restituiti includono ID compartimento, nome, stato del ciclo di vita e tag definiti.

Selezione dei campi da visualizzare

È possibile selezionare solo i campi desiderati specificando il nome dell'array e il nome di uno o più campi, passati come array delimitato da virgole:

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

Specifica delle condizioni di ricerca

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

Per ulteriori informazioni sul linguaggio di query JMESPath per JSON, vedere JMESPath.

Ordine di prevalenza per input JSON

L'interfaccia CLI supporta la combinazione di argomenti nella riga di comando e input di file. Tuttavia, se gli stessi valori vengono forniti in un file e nella riga di comando, la riga di comando ha la precedenza.

Uso di un file JSON per l'input complesso

È possibile passare un input complesso da un file facendo riferimento a tale input dalla riga di comando. Per gli utenti Windows, questo elimina il requisito di dover eseguire l'escape del testo JSON. Fornire un percorso al file utilizzando il prefisso file://.

Tipi di percorso

Utilizzando testfile.json come esempio, sono supportati i seguenti tipi di percorsi.

• Percorsi relativi dalla stessa directory, ad esempio: file://testfile.json e file://relative/path/to/testfile.json
• Percorsi assoluti su Linux, MacOS o Unix, ad esempio: file:///absolute/path/to/testfile.json
• Percorsi di file completi su Windows, ad esempio: file://C:\path\to\testfile.json

Posizioni file

Sono supportate le seguenti posizioni di file.

• La directory home.

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

• La directory corrente.

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

• La directory /tmp (Linux, Unix o MacOS).

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

• La directory C:\temp (Windows).

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

Esempi di utilizzo di un file JSON come input

Gli esempi in questa sezione utilizzano JSON generato per un'opzione di comando e un intero comando. Il file JSON viene salvato in un file, modificato e quindi utilizzato come input dalla riga di comando.

Utilizzare l'input file per un'opzione di comando

Questo esempio end-to-end mostra come generare la notazione JSON per un'opzione ID lista di sicurezza utilizzata per creare una subnet. Il file JSON viene salvato in un file, modificato e quindi utilizzato come input dalla riga di comando.

Utilizzo dello storage degli oggetti

Puoi utilizzare l'interfaccia CLI per diverse operazioni a oggetti con il servizio di storage degli oggetti.

Caricamento e scaricamento di file

Gli oggetti possono essere caricati da un file o dalla riga di comando (STDIN) e possono essere scaricati in un file o nella riga di comando (STDOUT).

Caricare un oggetto:

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

Caricare il contenuto dell'oggetto dalla riga di comando (STDIN):

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

Scarica un oggetto:

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

Stampa il contenuto dell'oggetto sulla riga di comando (STDOUT):

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

Operazioni in blocco nello storage degli oggetti

L'interfaccia CLI supporta le operazioni in blocco riportate di seguito nello storage degli oggetti.

• Caricamento di file in una directory e di tutte le relative sottodirectory in un bucket

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

• Download di tutti gli oggetti o di tutti gli oggetti che corrispondono a un prefisso specificato in un bucket

  # 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

• Eliminazione di tutti gli oggetti o di tutti gli oggetti che corrispondono a un prefisso specificato in un bucket

  # 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

Le operazioni di massa supportano diverse opzioni che consentono di:

• Sovrascrivi o salta file/oggetti utilizzando --overwrite o --no-overwrite. (Nota: se non si passa nessuna di queste opzioni, viene richiesta una conferma ogni volta che si verifica qualcosa da sovrascrivere).
• Limita le operazioni di eliminazione, caricamento o download utilizzando --prefix e/o --delimiter
• Anteprima di un'eliminazione di massa con --dry-run

Per ottenere ulteriori informazioni sui comandi per le operazioni in blocco, eseguire i seguenti comandi della Guida:

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

Operazioni multiparte nello storage degli oggetti

Le operazioni multiparte per lo storage degli oggetti includono caricamenti e download degli oggetti.

Caricamenti multiparte

I file di grandi dimensioni possono essere caricati nello storage degli oggetti in più parti per velocizzare il caricamento. Per impostazione predefinita, i file di dimensioni superiori a 128 MiB vengono caricati utilizzando operazioni multiparte. È possibile eseguire l'override di questa impostazione predefinita utilizzando l'opzione --no-multipart.

È possibile configurare le seguenti opzioni per il comando oci os object put:

• --no-multipart sostituisce un caricamento multiparte automatico se l'oggetto è più grande di 128 MiB. L'oggetto viene caricato come singola parte, indipendentemente dalle dimensioni.
• --part-size in MiB, da utilizzare in un'operazione multiparte. La dimensione predefinita della parte è 128 MiB e la dimensione specificata deve essere maggiore di 10 MiB. Se l'oggetto è più grande di --part-size, viene caricato in più parti.
• --parallel-upload-count, per specificare il numero di operazioni parallele da eseguire. È possibile utilizzare questo valore per bilanciare le risorse e i tempi di caricamento. Un valore più elevato può migliorare i tempi, ma consumare più risorse di sistema e larghezza di banda di rete. Il valore predefinito è 10.

Il comando --resume-put consente di riprendere il caricamento di file di grandi dimensioni nei casi in cui il caricamento è stato interrotto.

L'esempio seguente mostra il comando per un caricamento multiparte se l'oggetto è più grande di 200 MiB.

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

Per ulteriori informazioni sui caricamenti multiparte, vedere Utilizzo dei caricamenti multiparte.

Download multiparte

I file di grandi dimensioni possono essere scaricati dallo storage degli oggetti in più parti per velocizzare il download.

È possibile configurare le seguenti opzioni per il comando oci os object get:

• --multipart-download-threshold consente di specificare la dimensione, in MiB in cui un oggetto deve essere scaricato in più parti. La dimensione deve essere almeno 128 MiB.
• --part-size, in MiB, da utilizzare per una parte di download. Ciò ti offre la flessibilità di utilizzare più parti (dimensioni più piccole) o meno (dimensioni più grandi) in base alle tue esigenze. Ad esempio, potenza di calcolo e larghezza di banda di rete. La dimensione minima predefinita della parte è 120 MiB.
• --parallel-download-count consente di specificare il numero di parti scaricate contemporaneamente. Un valore più elevato può migliorare i tempi, ma consumare più risorse di sistema e larghezza di banda di rete. Il valore predefinito è 10.

L'esempio seguente mostra il comando per il download di qualsiasi oggetto con dimensioni superiori a 500 MiB. L'oggetto viene scaricato in 128 parti MiB.

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