Utilisation de l'interface de ligne de commande

Consultation de toutes les rubriques d'aide de l'interface de ligne de commande

Vous pouvez consulter l'aide sur la ligne de commande.

Entrée complexe réussie

Une entrée complexe, par exemple des tableaux et des objets ayant plus d'une valeur, est transmise au format JSON et peut être fournie en tant que chaîne à la ligne de commande et/ou en tant que fichier.

MacOS, Linux ou Unix

La commande suivante montre comment transmettre deux valeurs pour l'objet --metadata.

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

Windows

La commande suivante montre comment transmettre deux valeurs pour l'objet --metadata sous Windows.

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

Pour plus d'informations sur l'utilisation des chaînes JSON, voir Options JSON avancées

Formater la sortie sous forme de table

Par défaut, toutes les réponses d'une commande sont retournées dans le format JSON. Par exemple, une réponse similaire à la suivante est retournée lorsque vous émettez la commande pour obtenir une liste de régions.

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

Dans certains cas, la lisibilité peut devenir problématique, ce qui est facile à résoudre en formatant une réponse en tant que table. Pour obtenir une réponse à une commande formatée en tant que table, exécutez la commande suivante.

oci iam region list --output table

L'exemple de liste de régions suivant est retourné dans une table à deux colonnes.

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

Utilisation d'interrogations

Vous pouvez filtrer la sortie à l'aide de l'option --query pour JSON. Cette option utilise le langage d'interrogation JMESPath pour JSON.

Le filtrage s'avère très utile pour traiter de grandes quantités de sortie. Par exemple, la commande suivante retourne une liste de tous les compartiments :

oci iam compartment list --all

Cette commande retourne une quantité importante d'informations. Parmi les champs retournés figurent compartment-id, name, lifecycle-state et defined-tags.

Sélection des champs à afficher

Vous pouvez sélectionner uniquement les champs voulus en spécifiant le nom du tableau et le nom d'un ou plusieurs champs, transmis sous forme de tableau délimité par des virgules :

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

Définition de conditions de recherche

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

Pour plus d'informations sur le langage d'interrogation JMESPath pour JSON, voir JMESPath.

Ordre de priorité de l'entrée JSON

L'interface de ligne de commande prend en charge la combinaison d'arguments sur la ligne de commande avec entrée de fichier. Cependant, si les mêmes valeurs sont fournies dans un fichier et dans la ligne de commande, la ligne de commande a la priorité.

Utilisation d'un fichier JSON pour une entrée complexe

Vous pouvez transmettre une entrée complexe à partir d'un fichier en le référençant depuis la ligne de commande. Pour les utilisateurs Windows, cela supprime le critère d'échappement obligatoire du texte JSON. Vous indiquez un chemin pour le fichier à l'aide du préfixe file://.

Types de chemin

À l'aide de testfile.json comme exemple, les types de chemin suivants sont pris en charge.

• Chemins relatifs provenant du même répertoire, par exemple : file://testfile.json et file://relative/path/to/testfile.json
• Chemins absolus sous Linux, MacOS ou Unix, par exemple : file:///absolute/path/to/testfile.json
• Chemins complets de fichier sous Windows, par exemple : file://C:\path\to\testfile.json

Emplacements de fichier

Les emplacements de fichier suivants sont pris en charge.

• Votre répertoire de base.

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

• Le répertoire courant.

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

• Le répertoire /tmp (Linux, Unix ou MacOS).

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

• Le répertoire C:\temp (Windows).

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

Exemples d'utilisation d'un fichier JSON en tant qu'entrée

Les exemples de cette section utilisent du code JSON généré pour une option de commande et une commande complète. Le JSON est enregistré dans un fichier, modifié, puis utilisé comme entrée de ligne de commande.

Utiliser une entrée de fichier pour une option de commande

Cet exemple de bout en bout montre comment générer le JSON pour une option d'ID liste de sécurité utilisée pour créer un sous-réseau. Le JSON est enregistré dans un fichier, modifié, puis utilisé comme entrée de ligne de commande.

Utilisation du service de stockage d'objets

Vous pouvez utiliser l'interface de ligne de commande pour plusieurs opérations d'objet avec le service Stockage d'objets.

Chargement et téléchargement de fichiers

Les objets peuvent être chargés à partir d'un fichier ou de la ligne de commande (STDIN) et peuvent être téléchargés dans un fichier ou vers la ligne de commande (STDOUT).

Charger un objet :

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

Charger le contenu de l'objet à partir de la ligne de commande (STDIN) :

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

Télécharger un objet :

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

Imprimer le contenu de l'objet dans la ligne de commande (STDOUT) :

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

Opérations en masse dans le stockage d'objets

L'interface de ligne de commande prend en charge les opérations en masse suivantes dans le stockage d'objets :

• Chargement des fichiers dans un répertoire et tous ses sous-répertoires vers un seau

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

• Téléchargement de tous les objets ou de tous les objets correspondant à un préfixe spécifié dans un seau

  # 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

• Suppression de tous les objets ou de tous les objets correspondant à un préfixe spécifié dans un seau

  # 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

Les opérations en masse prennent en charge plusieurs options qui vous permettent de :

• Remplacer ou ignorer des fichiers et des objets à l'aide de --overwrite ou --no-overwrite. (Note : Si vous ne transmettez aucune de ces options, vous êtes invité à confirmer l'opération chaque fois qu'il y a un élément à remplacer.)
• Limiter les opérations de suppression, de chargement ou de téléchargement à l'aide de --prefix et/ou --delimiter
• Prévisualiser une suppression en masse avec --dry-run

Pour obtenir plus d'informations sur les commandes d'opérations en masse, exécutez les commandes d'aide suivantes :

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

Opérations en plusieurs parties dans le stockage d'objets

Les opérations en plusieurs parties pour le service Stockage d'objets comprennent les chargements et les téléchargements d'objets.

Chargements en plusieurs parties

Les fichiers volumineux peuvent être chargés dans le Stockage d'objets en plusieurs parties pour accélérer le chargement. Par défaut, les fichiers dont la taille est supérieure à 128 Mio sont chargés au moyen d'opérations en plusieurs parties. Vous pouvez remplacer cette valeur par défaut à l'aide de l'option --no-multipart.

Vous pouvez configurer les options suivantes pour la commande oci os object put :

• --no-multipart remplace un chargement en plusieurs parties automatique si l'objet est supérieur à 128 Mio. L'objet est chargé en une seule partie, quelle que soit sa taille.
• --part-size en Mio, à utiliser dans une opération en plusieurs parties. La taille par défaut de la partie est de 128 Mio et une taille de partie que vous spécifiez doit être supérieure à 10 Mio. Si l'objet est plus volumineux que la valeur de --part-size, il est chargé en plusieurs parties.
• --parallel-upload-count, pour indiquer le nombre d'opérations parallèles à exécuter. Vous pouvez utiliser cette valeur pour équilibrer les ressources et les temps de chargement. Une valeur plus élevée peut améliorer le temps de chargement, mais consommer plus de ressources système et de bande passante de réseau. La valeur par défaut est de 10.

La commande --resume-put permet de reprendre un chargement de fichiers volumineux dans les cas où le chargement a été interrompu.

L'exemple suivant présente la commande pour un chargement en plusieurs parties si l'objet est supérieur à 200 Mio.

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

Pour plus d'informations sur les chargements en plusieurs parties, voir Utilisation de chargements en plusieurs parties.

Téléchargements en plusieurs parties

Des fichiers volumineux peuvent être téléchargés à partir du Stockage d'objets en plusieurs parties pour accélérer le téléchargement.

Vous pouvez configurer les options suivantes pour la commande oci os object get :

• --multipart-download-threshold permet de spécifier la taille, en Mio, en fonction de laquelle un objet doit être téléchargé en plusieurs parties. Cette taille doit être d'au moins 128 Mio.
• --part-size, en Mio, à utiliser pour une partie de téléchargement. Vous bénéficiez ainsi de la flexibilité nécessaire pour utiliser plus de (taille plus petite) ou moins de (taille plus grande) parties, selon vos besoins. Par exemple, la puissance de calcul et la bande passante de réseau. La taille minimale de la partie par défaut est 120 Mio.
• --parallel-download-count permet de spécifier le nombre de parties qui sont téléchargées en même temps. Une valeur plus élevée peut améliorer le temps de chargement, mais consommer plus de ressources système et de bande passante de réseau. La valeur par défaut est de 10.

L'exemple suivant présente la commande de téléchargement d'un objet dont la taille est supérieure à 500 Mio. L'objet est téléchargé en parties de 128 Mio.

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