Usando a CLI

Exibindo toda a Ajuda da CLI

Você pode exibir a ajuda da linha de comando.

Especificando uma Entrada Complexa

Entradas complexas, como arrays e objetos com mais de um valor, são especificadas no formato JSON e podem ser fornecidas como uma string na linha de comando, como um arquivo ou como uma string de linha de comando e como um arquivo.

MacOS, Linux ou Unix

O comando a seguir mostra como especificar dois valores para o objeto --metadata.

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

Windows

O comando a seguir mostra como especificar dois valores para o objeto --metadata no Windows.

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

Para obter mais informações sobre o uso de strings JSON, consulte Opções Avançadas para JSON

Saída de Formato como uma Tabela

Por padrão, todas as respostas a um comando são retornadas no formato JSON. Por exemplo, uma resposta como mostrada a seguir é retornada quando você executa o comando para obter uma lista de regiões.

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

Em alguns casos, a legibilidade pode se tornar um problema, que é facilmente resolvido quando se formata uma resposta como uma tabela. Para obter uma resposta a um comando formatado como uma tabela, execute o comando a seguir.

oci iam region list --output table

O exemplo de lista de regiões a seguir é retornado como uma tabela de duas colunas.

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

Usando Consultas

Você pode filtrar a saída usando a opção --query para JSON. Esta opção usa a linguagem de consulta JMESPath para JSON.

A filtragem é muito útil para lidar com grandes volumes de saída. Por exemplo, o comando a seguir retorna uma lista de todos os compartimentos:

oci iam compartment list --all

Esse comando retorna muitas informações. Alguns dos campos retornados incluem id do compartimento, nome, estado do ciclo de vida e tags definidas.

Selecionando Campos para Exibição

Você pode selecionar apenas os campos desejados especificando o nome do array e o nome de um ou mais campos, informados como um array delimitado por vírgulas:

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

Especificando Condições de Pesquisa

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

Para obter mais informações sobre a linguagem de consulta JMESPath para JSON, consulte JMESPath.

Ordem de Precedência para Entradas JSON

A CLI oferece suporte à combinação de argumentos com entradas de arquivo na linha de comando. No entanto, se os mesmos valores forem fornecidos em um arquivo e na linha de comando, a linha de comando terá precedência.

Usando um Arquivo JSON para Entrada Complexa

É possível especificar uma entrada complexa por meio de um arquivo fazendo referência a ela na linha de comando. Para usuários do Windows, isso remove a necessidade de ter um caractere de escape para texto JSON. Você fornece um caminho para o arquivo usando o prefixo file://.

Tipos de Caminho

Usando testfile.json como um exemplo, os tipos de caminhos a seguir são suportados.

• Caminhos relativos do mesmo diretório, por exemplo: file://testfile.json e file://relative/path/to/testfile.json
• Caminhos absolutos no Linux, MacOS ou Unix; por exemplo: file:///absolute/path/to/testfile.json
• Caminhos de arquivos completos no Windows; por exemplo: file://C:\path\to\testfile.json

Localização dos Arquivos

São suportadas as localizações a seguir para os arquivos.

• O seu diretório home.

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

• O diretório atual.

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

• O diretório/tmp (Linux, Unix ou MacOS).

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

• O diretório C:\temp (Windows).

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

Exemplos do Uso de um Arquivo JSON como Entrada

Os exemplos nesta seção usam o formato JSON gerado para uma opção de comando e um comando inteiro. O formato JSON é salvo em um arquivo, editado e usado como entrada de linha de comando.

Usar Entrada de Arquivo para uma Opção de Comando

Este exemplo detalhado mostra como gerar o formato JSON para uma opção de id da lista de segurança usada para criar uma sub-rede. O formato JSON é salvo em um arquivo, editado e usado como entrada de linha de comando.

Como Trabalhar com o Serviço Object Storage

Você pode usar a CLI para várias operações de objeto com o serviço Object Storage.

Fazendo o Upload e o Download de Arquivos

É possível fazer o upload de objetos de um arquivo ou da linha de comandos (STDIN). Também é possível baixá-los por download para um arquivo ou para a linha de comandos (STDOUT).

Upload de um objeto:

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

Upload do conteúdo do objeto da linha de comandos (STDIN):

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

Download de um objeto:

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

Impressão do conteúdo do objeto na linha de comandos (STDOUT):

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

Operações em Massa no Serviço Object Storage

A CLI suporta as seguintes operações em massa no serviço Object Storage:

• Fazendo o upload de arquivos de um diretório e de todos os seus subdiretórios em um bucket

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

• Fazendo o download de todos os objetos, ou de todos os objetos que correspondem a um prefixo especificado, em um 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

• Excluindo todos os objetos, ou todos os objetos que correspondem a um prefixo especificado, em um 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

As operações em massa suportam várias opções que permitem:

• Substituir ou ignorar arquivos/objetos usando --overwrite ou --no-overwrite. ( Observação: se você não especificar essas opções, deverá confirmar cada vez que houver algo a ser substituído.)
• Limitar as operações de exclusão, upload ou download usando --prefix e/ou --delimiter
• Visualizar uma exclusão em massa com --dry-run

Para obter mais informações sobre os comandos para operações em massa, execute os seguintes comandos de ajuda:

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

Operações com Várias Partes no Serviço Object Storage

As operações com várias partes do serviço Object Storage incluem uploads e downloads de objetos.

Uploads em Várias Partes

É possível fazer upload de arquivos grandes no serviço Object Storage em várias partes para acelerar a operação. Por padrão, o upload de arquivos com mais de 128 MiB utiliza operações com várias partes. É possível substituir esse padrão usando a opção --no-multipart.

Você pode configurar as seguintes opções para o comando oci os object put:

• --no-multipart substitui um upload de várias partes automático se o objeto for maior que 128 MiB. O objeto é carregado como uma única parte, independentemente do tamanho.
• --part-size em MiB, para ser usado em uma operação com várias partes. O tamanho padrão da parte é 128 MiB, e o tamanho de parte especificado deve ser maior que 10 MiB. Se o objeto for maior que --part-size, o upload ocorrerá em várias partes.
• --parallel-upload-count, para especificar o número de operações paralelas a serem executadas. Você pode usar esse valor para equilibrar recursos e tempos de upload. Um valor mais alto pode melhorar o tempo das operações, mas consome mais recursos do sistema e largura de banda da rede. O valor padrão é 10.

O comando --resume-put permite retomar o upload de um arquivo grande que tenha sido interrompido.

O exemplo a seguir mostra o comando para um upload em várias partes se o objeto for maior que 200 MiB.

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

Para obter mais informações sobre uploads em várias partes, consulte Usando Uploads em Várias Partes.

Downloads em Várias Partes

É possível fazer o download de arquivos grandes do Object Storage em várias partes para acelerar a operação.

Você pode configurar as seguintes opções para o comando oci os object get:

• --multipart-download-threshold permite especificar o tamanho, em MiB, para que o download de um objeto ocorra em várias partes. Esse tamanho deve ser pelo menos 128 MiB.
• --part-size, em MiB, a ser usado para uma parte do download. Isso proporciona a flexibilidade de usar mais (tamanho menor) ou menos partes (tamanho maior), conforme apropriado para os seus requisitos. Por exemplo, poder de computação e largura de banda da rede. O tamanho mínimo padrão da parte é 120 MiB.
• --parallel-download-count permite especificar quantas partes terão download ao mesmo tempo. Um valor mais alto pode melhorar o tempo das operações, mas consome mais recursos do sistema e largura de banda da rede. O valor padrão é 10.

O exemplo a seguir mostra o comando para fazer o download de qualquer objeto com um tamanho maior que 500 MiB. O download do objeto é feito em partes de 128 MiB.

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