Uso de CLI

Visualización de toda la ayuda de CLI

Puede ver la ayuda de la línea de comandos.

Transferencia de entrada compleja

La entrada compleja, como las matrices y los objetos con más de un valor, se transfieren en formato JSON y se pueden proporcionar como una cadena en la línea de comandos, como un archivo o como una cadena de línea de comandos y como un archivo.

MacOS, Linux o Unix

El siguiente comando muestra cómo transferir dos valores para el objeto --metadata.

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

Windows

Los siguientes comandos muestran cómo transferir dos valores para el objeto --metadata en Windows.

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

Para obtener más información sobre el uso de cadenas JSON, consulte Opciones de JSON avanzadas.

Formato de salida como una tabla

Por defecto, todas las respuestas a un comando se devuelven en formato JSON. Por ejemplo, se devuelve una respuesta como la siguiente cuando se emite el comando para obtener una lista de regiones.

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

En algunos casos, la legibilidad puede convertirse en un problema, que se puede resolver fácilmente mediante la aplicación de formato de tabla a una respuesta. Para obtener una respuesta a un comando con formato de tabla, ejecute el siguiente comando.

oci iam region list --output table

La siguiente lista de regiones de ejemplo se devuelve como una tabla de dos columnas.

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

Uso de consultas

Puede filtrar la salida utilizando la opción --query para JSON. Esta opción utiliza el lenguaje de consulta JMESPath para JSON.

El filtrado es muy útil al manejar grandes cantidades de salida. Por ejemplo, el siguiente comando devuelve una lista de todos los compartimentos:

oci iam compartment list --all

Este comando devuelve mucha información. Entre los campos devueltos se incluye el ID de compartimento, el nombre, el estado del ciclo de vida y las etiquetas definidas.

Selección de los campos que se deben mostrar

Para seleccionar solo los campos que desea, especifique el nombre de la matriz y el nombre de uno o más campos en forma de una matriz delimitada por comas:

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

Especificación de condiciones de búsqueda

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 obtener más información sobre el lenguaje de consulta de JMESPath para JSON, consulte JMESPath.

Orden de prioridad para la entrada de JSON

CLI soporta la combinación de argumentos en la línea de comandos con la entrada de archivo. Sin embargo, si se proporcionan los mismos valores en un archivo y en la línea de comandos, la línea de comandos tiene prioridad.

Uso de un archivo JSON para una entrada compleja

Puede transferir la entrada compleja desde un archivo haciendo referencia a ella desde la línea de comandos. Para usuarios de Windows, se elimina el requisito de tener que omitir el texto de JSON. Proporcione una ruta de acceso al archivo con el prefijo file://.

Tipos de ruta de acceso

Utilizando testfile.json como ejemplo, se soportan los siguientes tipos de ruta de acceso.

• Rutas de acceso relativas del mismo directorio, por ejemplo: file://testfile.json y file://relative/path/to/testfile.json
• Rutas de acceso absolutas en Linux, MacOS o Unix, por ejemplo: file:///absolute/path/to/testfile.json
• Rutas de acceso completas a archivos en Windows, por ejemplo: file://C:\path\to\testfile.json

Ubicaciones de archivo

Están soportadas las siguientes ubicaciones de archivo.

• Su directorio raíz.

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

• El directorio actual.

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

• El directorio /tmp (Linux, Unix o MacOS).

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

• El directorio C:\temp (Windows).

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

Ejemplos de uso de un archivo JSON como entrada

Los ejemplos de esta sección utilizan el JSON que se genera para una opción de comando y un comando entero. El JSON se guarda en un archivo, se edita y se utiliza como entrada de la línea de comandos.

Uso de la entrada de archivo para una opción de comando

En este ejemplo completo se muestra cómo generar el JSON para una opción de ID de lista de seguridad utilizada para crear una subred. El JSON se guarda en un archivo, se edita y se utiliza como entrada de la línea de comandos.

Trabajar con Object Storage

Puede usar CLI para varias operaciones de objeto con el servicio Object Storage.

Carga y Descarga de Archivos

Los objetos se pueden cargar desde un archivo o desde la línea de comandos (STDIN) y se pueden descargar en un archivo o la línea de comandos (STDOUT).

Cargue un objeto:

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

Cargue el contenido del objeto desde la línea de comandos (STDIN):

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

Descargue un objeto:

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

Imprima el contenido del objeto en la línea de comandos (STDOUT):

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

Operaciones en bloque en Object Storage

CLI soporta las siguientes operaciones en bloque en Object Storage:

• Carga de archivos de un directorio y todos sus subdirectorios en un cubo

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

• Descarga de todos los objetos, o todos los objetos que coinciden con un prefijo especificado, en un cubo

  # 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

• Supresión de todos los objetos, o todos los objetos que coinciden con un prefijo especificado, en un cubo

  # 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

Las operaciones en bloque soportan varias opciones que le permiten:

• Sobrescribir u omitir archivos/objetos con --overwrite o --no-overwrite. (Nota: Si no transfiere ninguna de estas opciones, se le solicitará confirmación cada vez que haya algo que sobrescribir).
• Limitar las operaciones de supresión, carga o descarga mediante --prefix y/o --delimiter
• Obtener una vista previa de una supresión en bloque con --dry-run

Para obtener más información sobre los comandos para operaciones en bloque, ejecute los siguientes comandos de ayuda:

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

Operaciones de varias partes en Object Storage

Las operaciones de varias partes para Object Storage incluyen cargas y descargas de objetos.

Cargas de varias partes

Se pueden cargar archivos de gran tamaño en Object Storage en varias partes para acelerar la carga. Por defecto, se cargan archivos con un tamaño superior a 128 MiB mediante operaciones de varias partes. Puede sustituir este valor por defecto mediante la opción --no-multipart.

Puede configurar las siguientes opciones para el comando oci os object put:

• --no-multipart anula una carga automática de varias partes si el objeto tiene un tamaño superior a 128 MiB. El objeto se carga como una sola parte, independientemente del tamaño.
• --part-size en MiB, para utilizar en una operación de varias partes. El tamaño de la parte por defecto es de 128 MiB y el tamaño de pieza que especifique debe ser superior a 10 MiB. Si el objeto es mayor que --part-size, se carga en varias partes.
• --parallel-upload-count para especificar el número de operaciones en paralelo que se deben realizar. Puede usar este valor para equilibrar recursos y tiempos de carga. Un valor más alto puede mejorar los tiempos, pero consume más recursos del sistema y ancho de banda de red. El valor por defecto es10.

El comando --resume-put permite reanudar la carga de archivos grandes en casos en los que se interrumpió la carga.

En el siguiente ejemplo se muestra el comando para una carga de varias partes si el objeto tiene un tamaño superior a 200 MiB.

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

Para obtener más información sobre cargas de varias partes, consulte Uso de cargas de varias partes.

Descargas de varias partes

Se pueden descargar archivos grandes de Object Storage en varias partes para acelerar la descarga.

Puede configurar las siguientes opciones para el comando oci os object get:

• --multipart-download-threshold permite especificar el tamaño, en MiB, en el que un objeto se debe descargar en varias partes. Este tamaño debe ser al menos de 128 MiB.
• --part-size, en MiB, que se utiliza para una parte de descarga. Esto proporciona flexibilidad para utilizar más (tamaño más pequeño) o menos (tamaño más grande) partes según sea necesario para sus requisitos. Por ejemplo, calcular la potencia y el ancho de banda de red. El tamaño mínimo por defecto de la parte es de 120 MiB.
• --parallel-download-count permite especificar el número de partes que se descargan al mismo tiempo. Un valor más alto puede mejorar los tiempos, pero consume más recursos del sistema y ancho de banda de red. El valor por defecto es10.

El siguiente ejemplo muestra el comando para descargar cualquier objeto con un tamaño superior a 500 MiB. El objeto se descarga en 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