IBM Cloud Object Storage CLI

Le plug-in IBM Cloud® Object Storage étend l'interface de ligne de commande IBM Cloud avec un encapsuleur d'API pour l'utilisation de ressources Object Storage.

Installation et configuration

Le plug-in est compatible avec les plateformes Linux (x86_64, arm64, ppc64le, s390x), Windows ® (x64) et macOS® (amd64, arm64) qui s'exécutent sur des processeurs 64 bits.

Installez le plug-in à l'aide de la commande plugin install.

ibmcloud plugin install cloud-object-storage

Une fois le plug-in installé, vous pouvez le configurer à l'aide de la commande ibmcloud cos config. Cela vous permet de configurer le plug-in en indiquant vos identifiants, l'emplacement de téléchargement par défaut, le mode d'authentification de votre choix, etc.

Pour des performances optimales, assurez-vous que la fonction de trace est désactivée en définissant la variable d'environnement IBMCLOUD_TRACE sur false.

Le programme vous permet également de définir le répertoire local par défaut pour les fichiers reçus par téléchargement, ainsi qu'une région par défaut. Pour définir l'emplacement de réception par téléchargement par défaut, tapez ibmcloud cos config ddl et entrez un chemin de fichier valide dans le programme. Pour définir une région par défaut, tapez ibmcloud cos config region et entrez un code de région dans le programme, par exemple, us-south. Par défaut, cette valeur est us-geo.

Vous pouvez consulter vos identifiants actuels pour IBM Cloud Object Storage en accédant à l'adresse ibmcloud cos config list. Etant donné que le fichier de configuration est généré par le plug-in, il est préférable de ne pas l'éditer manuellement.

$ ibmcloud cos config list
Key                     Value
Last Updated            Tuesday, April 28 2020 at 19:35:57
Default Region          us-south
Download Location       /home/ibmuser/Downloads
CRN                     8f275e7b-c076-49e2-b9c5-f985704cf678
AccessKeyID             9eib1eejar6HaezaohveV5hikei4aNg2ooV0qu
SecretAccessKey         ********************************************
Authentication Method   IAM
URL Style               VHost

Authentification IAM

Si vous utilisez l'authentification IAM, vous devez alors configurer votre client avec un ID d'instance pour utiliser certaines des commandes. Pour plus d'informations sur la création d'une instance de service, voir Création d'une instance de service. Pour récupérer l'ID de l'instance, vous pouvez saisir ibmcloud resource service-instance <INSTANCE_NAME> --id, en remplaçant <INSTANCE_NAME> par l'alias unique que vous avez attribué à votre instance de service. Dans les exemples ci-dessous, la valeur 8f275e7b-c076-49e2-b9c5-f985704cf678 est un exemple d'ID d'instance.

Tout d'abord, extrayez le CRN et l'ID avec le nom de votre instance. Veillez à utiliser des guillemets (') sur votre nom d'instance et à vous connecter à IBM Cloud. Seule la dernière partie du nom de ressource de cloud est nécessaire, c'est-à-dire la partie qui suit ::.

$ ibmcloud resource service-instance 'My Awesome Cloud Object Storage'  --id
Retrieving service instance My Awesome Cloud Object Storage in all resource groups under account IBM as ibmuser@us.ibm.com...
crn:v1:bluemix:public:cloud-object-storage:global:a/94400e98c553415c9599db39b9be9219:3b7d66c8-9fdf-4f81-b7e6-08d187f07288:: 8f275e7b-c076-49e2-b9c5-f985704cf678

Définissez le CRN à l'aide de la commande ibmcloud cos config crn. Il peut vous avertir de l'écrasement. Si vous ne souhaitez pas fournir le CRN de manière interactive, vous pouvez le fournir sur la même commande avec l'indicateur --crn.

$ ibmcloud cos config crn
Resource Instance ID CRN:  ()> 8f275e7b-c076-49e2-b9c5-f985704cf678
Saving new Service Instance ID...
OK
Successfully stored your service instance ID.

Vérifiez la configuration :

$ ibmcloud cos config crn --list
Key   Value
CRN   8f275e7b-c076-49e2-b9c5-f985704cf678

Vous pouvez aussi ouvrir la console Web, sélectionner Données d'identification pour le service dans la barre de navigation et créer un nouvel ensemble de données d'identification (ou afficher un fichier de données d'identification existant que vous avez déjà créé).

Données d'identification HMAC

Si vous préférez, vous pouvez utiliser les données d'identification HMAC d'un ID de service à la place de votre clé d'API. Exécutez la commande ibmcloud cos config hmac pour entrer les données d'identification HMAC, puis changez de méthodes d'autorisation à l'aide de la commande ibmcloud cos config auth.

Si vous choisissez d'utiliser l'authentification par jeton avec votre propre clé d'API, vous n'avez pas besoin de fournir des données d'identification car le programme vous authentifie automatiquement.

A tout moment, pour passer de l'authentification HMAC à l'authentification IAM, vous pouvez entrer ibmcloud cos config auth. Pour plus d'informations sur l'authentification et l'autorisation dans IBM Cloud, voir la documentationIdentity and Access Management.

Activation de la fonction de trace dans l'interface de ligne de commande

La fonction de trace peut être activée en affectant à la variable d'environnement IBMCLOUD_TRACE la valeur true (cas ignoré). Des informations de débogage supplémentaires seront alors imprimées sur le terminal.

Sur un terminal Linux/macOS :

export IBMCLOUD_TRACE=true

A l'invite Windows :

SET IBMCLOUD_TRACE=true

Pour désactiver la fonction de trace, affectez à la variable d'environnement IBMCLOUD_TRACE la valeur false (cas ignoré).

Index de commande

Chaque opération est accompagnée d'une explication décrivant son fonctionnement, son utilisation, ainsi que les paramètres facultatifs ou obligatoires. Tous les paramètres répertoriés sont obligatoires, sauf ceux mentionnés comme étant facultatifs.

Le plug-in CLI ne prend pas encore en charge l'ensemble des fonctionnalités disponibles sur Object Storage. Aspera High-Speed Transfer, Immutable Object Storage, créer Key Protect buckets, ou Bucket Firewalls ne peuvent pas être utilisés par la CLI.

Abandon d'un envoi par téléchargement en plusieurs parties

  • Action : permet d'abandonner une instance d'envoi par téléchargement en plusieurs parties en mettant fin à l'envoi par téléchargement vers le compartiment dans le compte IBM Cloud Object Storage de l'utilisateur.
  • Utilisation : ibmcloud cos multipart-upload-abort --bucket BUCKET_NAME --key KEY --upload-id ID [--region REGION] [--output FORMAT]
  • Paramètres à fournir :
    • Nom du compartiment.
      • Indicateur : --bucket BUCKET_NAME
    • Clé de l'objet.
      • Indicateur : --key KEY
    • ID d'envoi par téléchargement identifiant l'envoi par téléchargement en plusieurs parties.
      • Indicateur : --upload-id ID
    • Facultatif : la RÉGION dans laquelle se trouve le compartiment. Si cette option n'est pas fournie, le programme utilise l'option par défaut qui est spécifiée dans la configuration.
      • Indicateur : --region REGION
    • Facultatif : le FORMAT de sortie ne peut être que « json » ou « text ».
      • Indicateur : --output FORMAT

Configurer un site Web statique

  • Action: Configure un compartiment pour héberger un site Web statique.

  • Utilisation : ibmcloud cos bucket-website-put --bucket BUCKET_NAME [--region REGION] [--output FORMAT]

  • Paramètres à fournir :

    • Nom du compartiment.

      • Indicateur : --bucket BUCKET_NAME
    • Configuration du site Web sous la forme d'une structure JSON. Le préfixe file:// est utilisé pour charger la structure JSON à partir du fichier spécifié, tel que --website-configuration file://<filename.json>.

      • Indicateur : --website-configuration STRUCTURE Les paramètres suivants sont disponibles pour la configuration du comportement statique du site Web. Aucune n'est requise. Pour plus de détails, voir la documentation.

        {
          "ErrorDocument": {
            "Key": "string"
          },
          "IndexDocument": {
            "Suffix": "string"
          },
          "RoutingRules": [
            {
              "Condition": {
                "HttpErrorCodeReturnedEquals": "string",
                "KeyPrefixEquals": "string"
              },
              "Redirect": {
                "HostName": "string",
                "HttpRedirectCode": "string",
                "Protocol": "http"|"https",
                "ReplaceKeyPrefixWith": "string",
                "ReplaceKeyWith": "string"
              }
            }
            ...
          ]
        }
        

        Sinon, si le site Web de compartiment est configuré pour rediriger le trafic, il doit s'agir du seul paramètre configuré:

        	  "RedirectAllRequestsTo": {
        	    "HostName": "string",
        	    "Protocol": "http"|"https"
        	  }
        	  ```
        
        
        
    • Facultatif : la RÉGION dans laquelle se trouve le compartiment. Si cette option n'est pas fournie, le programme utilise l'option par défaut qui est spécifiée dans la configuration.

      • Indicateur : --region REGION
    • Facultatif : le FORMAT de sortie ne peut être que « json » ou « text ».

      • Indicateur : --output FORMAT

Copie d'un objet à partir d'un compartiment

Si vous souhaitez ajouter des métadonnées à un objet lors de la copie (à l'aide de la fonction --metadata ), vous devez ajouter l'attribut --metadata-directive REPLACE car les métadonnées sont copiées lors de l'opération par défaut ( --metadata-directive COPY implicite).

  • Action : permet de copier un objet d'un compartiment source vers un compartiment de destination.
  • Utilisation : ibmcloud cos object-copy --bucket BUCKET_NAME --key KEY --copy-source SOURCE [--cache-control CACHING_DIRECTIVES] [--content-disposition DIRECTIVES] [--content-encoding CONTENT_ENCODING] [--content-language LANGUAGE] [--content-type MIME] [--copy-source-if-match ETAG] [--copy-source-if-modified-since TIMESTAMP] [--copy-source-if-none-match ETAG] [--copy-source-if-unmodified-since TIMESTAMP] [--metadata MAP] [--metadata-directive DIRECTIVE] [--region REGION] [--output FORMAT]
  • Paramètres à fournir :
    • Le nom du compartiment de destination.
      • Indicateur : --bucket BUCKET_NAME
    • Clé de l'objet.
      • Indicateur : --key KEY
    • (SOURCE) Le nom du compartiment source et le nom de la clé de l'objet source, séparés par une barre oblique (/). Doit être encodé selon la norme « URL ».
      • Indicateur : --copy-source SOURCE
    • Facultatif : spécifie l' CACHING_DIRECTIVES s relatives à la chaîne de requêtes et de réponses.
      • Indicateur : --cache-control CACHING_DIRECTIVES
    • Facultatif : permet de définir des informations de présentation (DIRECTIVES).
      • Indicateur : --content-disposition DIRECTIVES
    • Facultatif : précise quels encodages de contenu (CONTENT_ENCODING) sont appliqués à l'objet et, par conséquent, quels mécanismes de décodage doivent être utilisés pour obtenir le type de média référencé par le champ d'en-tête Content-Type.
      • Indicateur : --content-encoding CONTENT_ENCODING
    • Facultatif : la LANGUE dans laquelle le contenu est rédigé.
      • Indicateur : --content-language LANGUAGE
    • Facultatif : un type MIME standard décrivant le format des données de l'objet.
      • Indicateur : --content-type MIME
    • Facultatif : copie l'objet si son identifiant d'entité (Etag) correspond à l'identifiant spécifié (ETAG).
      • Indicateur : --copy-source-if-match ETAG
    • Facultatif : copie l'objet s'il a été modifié depuis l'heure indiquée (TIMESTAMP).
      • Indicateur : --copy-source-if-modified-since TIMESTAMP
    • Facultatif : copie l'objet si son identifiant d'entité (ETag) est différent de l'identifiant spécifié (ETAG).
      • Indicateur : --copy-source-if-none-match ETAG
    • Facultatif : copie l'objet s'il n'a pas été modifié depuis l'heure indiquée (TIMESTAMP).
      • Indicateur : --copy-source-if-unmodified-since TIMESTAMP
    • Facultatif : une carte (MAP) des métadonnées à stocker.
      • Indicateur : --metadata MAP Syntaxe JSON : L'indicateur --metadata utilise le préfixe file:// qui est utilisé pour charger la structure JSON à partir du fichier spécifié.
      {
        "file_name": "file_20xxxxxxxxxxxx45.zip",
        "label": "texas",
        "state": "Texas",
        "Date_to": "2019-11-09T16:00:00.000Z",
        "Sha256sum": "9e39dxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx8ce6b68ede3a47",
        "Timestamp": "Thu, 17 Oct 2019 09:22:13 GMT"
      }
      ```

   * _Optional_: Specifies whether the metadata is copied from the source object or replaced with metadata provided in the request. DIRECTIVE values: COPY,REPLACE.
        * Flag: ` --metadata-directive DIRECTIVE`
    * _Optional_: The REGION where the bucket is present. If this flag is not provided, the program uses the default option that is specified in config.
        * Flag: `--region REGION`
    * _Optional_: Output FORMAT can be only json or text.
        * Flag: `--output FORMAT`

Créer un compartiment

  • Action : permet de créer un compartiment dans une instance IBM Cloud Object Storage.
  • Utilisation : ibmcloud cos bucket-create --bucket BUCKET_NAME [--class CLASS_NAME][--class onerate_active] [--ibm-service-instance-id ID] [--region REGION] [--output FORMAT]
    • Notez que vous devez fournir un CRN si vous utilisez l'authentification IAM. Vous pouvez le définir à l'aide de la commande ibmcloud cos config crn.
  • Paramètres à fournir :
    • Nom du compartiment.
      • Indicateur : --bucket BUCKET_NAME
    • Facultatif : le nom de la classe.
      • Indicateur : --class CLASS_NAME
    • L'utilisateur doit spécifier onerate_active lors de la création d'un compartiment.
      • Indicateur : --class onerate_active
    • Facultatif : permet de définir l'identifiant de l'instance du service « IBM » dans la requête.
      • Indicateur : --ibm-service-instance-id ID
    • Facultatif : la RÉGION dans laquelle se trouve le compartiment. Si cette option n'est pas fournie, le programme utilise l'option par défaut qui est spécifiée dans la configuration.
      • Indicateur : --region REGION
    • Facultatif : le FORMAT de sortie ne peut être que « json » ou « text ».
      • Indicateur : --output FORMAT

Créez un nouveau bucket avec Key Protect

  • Action : Créer un compartiment avec l' Key Protect dans une instance d' IBM Cloud Object Storage.
  • Utilisation : bucket-create --bucket BUCKET_NAME [--ibm-service-instance-id ID] [--class CLASS_NAME] [--region REGION] --kms-root-key-crn CUSTOMERROOTKEYCRN --kms-encryption-algorithm ALGORITHM [--output FORMAT] [--json]
    • Notez que vous devez fournir un CRN si vous utilisez l'authentification IAM. Vous pouvez le définir à l'aide de la commande ibmcloud cos config crn.
  • Paramètres à fournir :
    • Nom du compartiment.
      • Indicateur : --bucket BUCKET_NAME
    • La clé CUSTOMERROOTKEYCRN de la clé racine KMS à associer au compartiment pour le chiffrement des données.
      • Indicateur : --kms-root-key-crn CUSTOMERROOTKEYCRN
    • Facultatif : l'ALGORITHME et la TAILLE à utiliser avec la clé de chiffrement enregistrée à l'aide de la fonction « key protect ».
      • Indicateur : --kms-encryption-algorithm ALGORITHM
    • Facultatif : le nom de la classe.
      • Indicateur : --class CLASS_NAME
    • Facultatif : permet de définir l'identifiant de l'instance du service « IBM » dans la requête.
      • Indicateur : --ibm-service-instance-id ID
    • Facultatif : la RÉGION dans laquelle se trouve le compartiment. Si cette option n'est pas fournie, le programme utilise l'option par défaut qui est spécifiée dans la configuration.
      • Indicateur : --region REGION
    • Facultatif : le FORMAT de sortie ne peut être que « json » ou « text ».
      • Indicateur : --output FORMAT
    • (Obsolète): Résultat renvoyé au format JSON brut.
      • Indicateur : --json

Exemple :

ibmcloud cos bucket-create --bucket bucket-name --kms-root-key-crn crn:v1:staging:public:kms:us-south:a/9978e0xxxxxxxxxxxxxxxxxxxxxx8654:dfdxxxxx-xxxx-xxxx-xxxx-xxxxxxba6eb0:key:7cea005e-75d4-4a08-ad2f-5e56141f6a96 --kms-encryption-algorithm AES256

Créez un nouveau compartiment avec Hyper Protect Crypto Services

  • Action: Créez un nouveau compartiment avec Hyper Protect Crypto Services.
  • Utilisation : bucket-create --bucket BUCKET_NAME [--ibm-service-instance-id ID] [--class CLASS_NAME] [--region REGION] --kms-root-key-crn CUSTOMERROOTKEYCRN --kms-encryption-algorithm ALGORITHM [--output FORMAT] [--json]
  • Paramètres à fournir :
    • Nom du compartiment.
      • Indicateur : --bucket BUCKET_NAME
    • La clé CUSTOMERROOTKEYCRN de la clé racine KMS à associer au compartiment pour le chiffrement des données.
      • Indicateur : --kms-root-key-crn CUSTOMERROOTKEYCRN
    • Facultatif : l'ALGORITHME et la TAILLE à utiliser avec la clé de chiffrement enregistrée à l'aide de la fonction « key protect ».
      • Indicateur : --kms-encryption-algorithm ALGORITHM
    • Facultatif : le nom de la classe.
      • Indicateur : --class CLASS_NAME
    • Facultatif : permet de définir l'identifiant de l'instance du service « IBM » dans la requête.
      • Indicateur : --ibm-service-instance-id ID
    • Facultatif : la RÉGION dans laquelle se trouve le compartiment. Si cette option n'est pas fournie, le programme utilise l'option par défaut qui est spécifiée dans la configuration.
      • Indicateur : --region REGION
    • Facultatif : le FORMAT de sortie ne peut être que « json » ou « text ».
      • Indicateur : --output FORMAT
    • (Obsolète): Résultat renvoyé au format JSON brut.
      • Indicateur : --json

Exemple :

ibmcloud cos bucket-create --bucket bucket-name --kms-root-key-crn crn:v1:bluemix:public:hs-crypto:us-south:a/ee747e4xxxxxxxxxxxxxxxxxxxxxx7559:ac6xxxxx-xxxx-xxxx-xxxx-xxxxxx1bea99:key:e7451f36-d7ea-4f55-bc1c-ce4bcceb7018

Création d'un nouveau téléchargement en plusieurs parties

  • Action : permet de commencer le processus d'envoi par téléchargement de fichiers en plusieurs parties en créant une nouvelle instance d'envoi par téléchargement en plusieurs parties.

  • Utilisation : ibmcloud cos multipart-upload-create --bucket BUCKET_NAME --key KEY [--cache-control CACHING_DIRECTIVES] [--content-disposition DIRECTIVES] [--content-encoding CONTENT_ENCODING] [--content-language LANGUAGE] [--content-type MIME] [--metadata MAP] [--region REGION] [--output FORMAT]

  • Paramètres à fournir :

    • Nom du compartiment.
      • Indicateur : --bucket BUCKET_NAME
    • Clé de l'objet.
      • Indicateur : --key KEY
    • Facultatif : spécifie l' CACHING_DIRECTIVES s relatives à la chaîne de requêtes et de réponses.
      • Indicateur : --cache-control CACHING_DIRECTIVES
    • Facultatif : permet de définir des informations de présentation (DIRECTIVES).
      • Indicateur : --content-disposition DIRECTIVES
    • Facultatif : permet de spécifier l'encodage du contenu (CONTENT_ENCODING) de l'objet.
      • Indicateur : --content-encoding CONTENT_ENCODING
    • Facultatif : la LANGUE dans laquelle le contenu est rédigé.
      • Indicateur : --content-language LANGUAGE
    • Facultatif : un type MIME standard décrivant le format des données de l'objet.
      • Indicateur : --content-type MIME
    • Facultatif : une carte (MAP) des métadonnées à stocker.
      • Indicateur : --metadata MAP Syntaxe JSON : L'indicateur --metadata utilise le préfixe file:// qui est utilisé pour charger la structure JSON à partir du fichier spécifié.
    {
      "file_name": "file_20xxxxxxxxxxxx45.zip",
      "label": "texas",
      "state": "Texas",
      "Date_to": "2019-11-09T16:00:00.000Z",
      "Sha256sum": "9e39dxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx8ce6b68ede3a47",
      "Timestamp": "Thu, 17 Oct 2019 09:22:13 GMT"
    }
    
    • Facultatif : la RÉGION dans laquelle se trouve le compartiment. Si cette option n'est pas fournie, le programme utilise l'option par défaut qui est spécifiée dans la configuration.
      • Indicateur : --region REGION
    • Facultatif : le FORMAT de sortie ne peut être que « json » ou « text ».
      • Indicateur : --output FORMAT

Suppression d'un compartiment existant

  • Action : permet de supprimer un compartiment existant dans une instance IBM Cloud Object Storage.
  • Utilisation : ibmcloud cos bucket-delete --bucket BUCKET_NAME [--region REGION] [--force] [--output FORMAT]
  • Paramètres à fournir :
    • Nom du compartiment.
      • Indicateur : --bucket BUCKET_NAME
    • Facultatif : la RÉGION dans laquelle se trouve le compartiment. Si cette option n'est pas fournie, le programme utilise l'option par défaut qui est spécifiée dans la configuration.
      • Indicateur : --region REGION
    • Facultatif : l'opération ne demandera pas de confirmation.
      • Indicateur : --force
    • Facultatif : le FORMAT de sortie ne peut être que « json » ou « text ».
      • Indicateur : --output FORMAT

Suppression d'une configuration de partage de ressources d'origine croisée pour un compartiment

  • Action : permet de supprimer une configuration de partage de ressources d'origine croisée sur un compartiment dans le compte IBM Cloud Object Storage d'un utilisateur.
  • Utilisation : ibmcloud cos bucket-cors-delete --bucket BUCKET_NAME [--region REGION] [--output FORMAT]
  • Paramètres à fournir :
    • Nom du compartiment.
      • Indicateur : --bucket BUCKET_NAME
    • Facultatif : la RÉGION dans laquelle se trouve le compartiment. Si cette option n'est pas fournie, le programme utilise l'option par défaut qui est spécifiée dans la configuration.
      • Indicateur : --region REGION
    • Facultatif : le FORMAT de sortie ne peut être que « json » ou « text ».
      • Indicateur : --output FORMAT

Supprimer une configuration de site Web statique

  • Action: Supprime la configuration de site Web statique d'un compartiment.
  • Utilisation : ibmcloud cos bucket-website-delete --bucket BUCKET_NAME [--region REGION] [--output FORMAT]
  • Paramètres à fournir :
    • Nom du compartiment.

      • Indicateur : --bucket BUCKET_NAME
    • Facultatif : la RÉGION dans laquelle se trouve le compartiment. Si cette option n'est pas fournie, le programme utilise l'option par défaut qui est spécifiée dans la configuration.
      • Indicateur : --region REGION
    • Facultatif : le FORMAT de sortie ne peut être que « json » ou « text ».
      • Indicateur : --output FORMAT

Suppression d'un objet

  • Action : permet de supprimer un objet d'un compartiment dans le compte IBM Cloud Object Storage d'un utilisateur.
  • Utilisation : ibmcloud cos object-delete --bucket BUCKET_NAME --key KEY [--region REGION] [--force] [--output FORMAT]
  • Paramètres à fournir :
    • Nom du compartiment.
      • Indicateur : --bucket BUCKET_NAME
    • Clé de l'objet.
      • Indicateur : --key KEY
    • Facultatif : la RÉGION dans laquelle se trouve le compartiment. Si cette option n'est pas fournie, le programme utilise l'option par défaut qui est spécifiée dans la configuration.
      • Indicateur : --region REGION
    • Facultatif : l'opération ne demandera pas de confirmation.
      • Indicateur : --force
      • Facultatif : le FORMAT de sortie ne peut être que « json » ou « text ».
        • Indicateur : --output FORMAT

Suppression de plusieurs objets

  • Action : permet de supprimer plusieurs objets d'un compartiment dans le compte IBM Cloud Object Storage d'un utilisateur.

  • Utilisation : ibmcloud cos objects-delete --bucket BUCKET_NAME --delete STRUCTURE [--region REGION] [--output FORMAT]

  • Paramètres à fournir :

    • Nom du compartiment.
      • Indicateur : --bucket BUCKET_NAME
    • Structure qui utilise une syntaxe abrégée ou JSON.
      • Indicateur : --delete STRUCTURE
      • Syntaxe abrégée : --delete 'Objects=[{Key=string},{Key=string}],Quiet=boolean'
      • Syntaxe JSON : --delete file://<filename.json>

        La commande --delete utilise une structure JSON répertoriant les objets à supprimer. Dans cet exemple, le préfixe file:// est utilisé pour charger la structure JSON à partir du fichier spécifié.
    	{
    	"Objects": [
    	{
    	"Key": "string",
    	"VersionId": "string"
    	}
    ...
    	],
    	"Quiet": true|false
    	}
    
    • Facultatif : la RÉGION dans laquelle se trouve le compartiment. Si cette option n'est pas fournie, le programme utilise l'option par défaut qui est spécifiée dans la configuration.
      • Indicateur : --region REGION
    • Facultatif : le FORMAT de sortie ne peut être que « json » ou « text ».
      • Indicateur : --output FORMAT

Réception par téléchargement d'un objet

  • Action : permet de recevoir par téléchargement un objet d'un compartiment dans le compte IBM Cloud Object Storage d'un utilisateur.
  • Utilisation : ibmcloud cos object-get --bucket BUCKET_NAME --key KEY [--if-match ETAG] [--if-modified-since TIMESTAMP] [--if-none-match ETAG] [--if-unmodified-since TIMESTAMP] [--range RANGE] [--response-cache-control HEADER] [--response-content-disposition HEADER] [--response-content-encoding HEADER] [--response-content-language HEADER] [--response-content-type HEADER] [--response-expires HEADER] [--region REGION] [--output FORMAT] [OUTFILE]
  • Paramètres à fournir :
    • Nom du compartiment.
      • Indicateur : --bucket BUCKET_NAME
    • Clé de l'objet.
      • Indicateur : --key KEY
    • Facultatif : renvoie l'objet uniquement si son identifiant d'entité (ETag) correspond à celui spécifié par ETAG ; dans le cas contraire, renvoie un code 412 (échec de la condition préalable).
      • Indicateur : --if-match ETAG
    • Facultatif : renvoie l'objet uniquement s'il a été modifié depuis le TIMESTAMP spécifié; sinon, renvoie un code 304 (non modifié).
      • Indicateur : --if-modified-since TIMESTAMP
    • Facultatif : renvoie l'objet uniquement si son identifiant d'entité (ETag) est différent de celui spécifié ( ETAG ); sinon, renvoie un code 304 (non modifié).
      • Indicateur : --if-none-match ETAG
    • Facultatif : renvoie l'objet uniquement s'il n'a pas été modifié depuis le TIMESTAMP spécifié; sinon, renvoie un code d'erreur 412 (condition préalable non remplie).
      • Indicateur : --if-unmodified-since TIMESTAMP
    • Facultatif : télécharge les octets de la PLAGE spécifiée d'un objet.
      • Indicateur : --range RANGE
    • Facultatif : définit l'en-tête « Cache-Control » de la réponse.
      • Indicateur : --response-cache-control HEADER
    • Facultatif : définit l'en-tête Content-Disposition de la réponse.
      • Indicateur : --response-content-disposition HEADER
    • Facultatif : définit l'en-tête « Content-Encoding » de la réponse.
      • Indicateur : --response-content-encoding HEADER
    • Facultatif : définit l'en-tête « Content-Language » de la réponse.
      • Indicateur : --response-content-language HEADER
    • Facultatif : définit l'en-tête Content-Type de la réponse.
      • Indicateur : --response-content-type HEADER
    • Facultatif : définit l'en-tête « Expires » de la réponse.
      • Indicateur : --response-expires HEADER
    • Facultatif : la RÉGION dans laquelle se trouve le compartiment. Si cette option n'est pas fournie, le programme utilise l'option par défaut qui est spécifiée dans la configuration.
      • Indicateur : --region REGION
    • Facultatif : le FORMAT de sortie ne peut être que « json » ou « text ».
      • Indicateur : --output FORMAT
    • Facultatif : l'emplacement où enregistrer le contenu de l'objet. Si ce paramètre n'est pas fourni, le programme utilise l'emplacement par défaut.
      • Paramètre : OUTFILE

Télécharger des objets à l'aide de S3Manager

  • Action : permet de recevoir par téléchargement de façon simultanée des objets à partir de s3.
  • Utilisation : ibmcloud cos download --bucket BUCKET_NAME --key KEY [--concurrency value] [--part-size SIZE] [--if-match ETAG] [--if-modified-since TIMESTAMP] [--if-none-match ETAG] [--if-unmodified-since TIMESTAMP] [--range RANGE] [--response-cache-control HEADER] [--response-content-disposition HEADER] [--response-content-encoding HEADER] [--response-content-language HEADER] [--response-content-type HEADER] [--response-expires HEADER] [--region REGION] [--output FORMAT] [OUTFILE]
  • Paramètres à fournir :
    • Nom (BUCKET_NAME) du compartiment.
      • Indicateur : --bucket BUCKET_NAME
    • Clé de l'objet.
      • Indicateur : --key KEY
    • Facultatif : nombre de routines « go » à lancer en parallèle par appel de téléchargement lors de l'envoi de parties. La valeur par défaut est 5.
      • Indicateur : --concurrency value
    • Facultatif : la TAILLE (en octets) de la mémoire tampon à utiliser lors de la mise en mémoire tampon des données par blocs et de leur envoi par parties vers S3. La plus petite taille de partie autorisée est de 5 Mo.
      • Indicateur : --part-size SIZE
    • Facultatif : renvoie l'objet uniquement si son identifiant d'entité (ETag) correspond à celui spécifié par ETAG ; dans le cas contraire, renvoie un code 412 (échec de la condition préalable).
      • Indicateur : --if-match ETAG
    • Facultatif : renvoie l'objet uniquement s'il a été modifié depuis le TIMESTAMP spécifié; sinon, renvoie un code 304 (non modifié).
      • Indicateur : --if-modified-since TIMESTAMP
    • Facultatif : renvoie l'objet uniquement si son identifiant d'entité (ETag) est différent de celui spécifié ( ETAG ); sinon, renvoie un code 304 (non modifié).
      • Indicateur : --if-none-match ETAG
    • Facultatif : renvoie l'objet uniquement s'il n'a pas été modifié depuis le TIMESTAMP spécifié; sinon, renvoie un code d'erreur 412 (condition préalable non remplie).
      • Indicateur : --if-unmodified-since TIMESTAMP
    • Facultatif : télécharge les octets de la PLAGE spécifiée d'un objet. Pour plus d'informations sur l'en-tête de la plage HTTP, cliquez ici.
      • Indicateur : --range RANGE
    • Facultatif : définit l'en-tête « Cache-Control » de la réponse.
      • Indicateur : --response-cache-control HEADER
    • Facultatif : définit l'en-tête Content-Disposition de la réponse.
      • Indicateur : --response-content-disposition HEADER
    • Facultatif : définit l'en-tête « Content-Encoding » de la réponse.
      • Indicateur : --response-content-encoding HEADER
    • Facultatif : définit l'en-tête « Content-Language » de la réponse.
      • Indicateur : --response-content-language HEADER
    • Facultatif : définit l'en-tête Content-Type de la réponse.
      • Indicateur : --response-content-type HEADER
    • Facultatif : définit l'en-tête « Expires » de la réponse.
      • Indicateur : --response-expires HEADER
    • Facultatif : la RÉGION dans laquelle se trouve le compartiment. Si cette option n'est pas fournie, le programme utilisera l'option par défaut qui est spécifiée dans la configuration.
      • Indicateur : --region REGION
    • Facultatif : le FORMAT de sortie ne peut être que « json » ou « text ».
      • Indicateur : --output FORMAT
    • Facultatif : l'emplacement où enregistrer le contenu de l'objet. Si ce paramètre n'est pas fourni, le programme utilise l'emplacement par défaut.
      • Paramètre : OUTFILE

Recherche d'un compartiment

  • Action : permet de déterminer la région et la classe d'un compartiment dans une instance IBM Cloud Object Storage.
  • Utilisation : ibmcloud cos bucket-location-get --bucket BUCKET_NAME [--output FORMAT]
  • Paramètres à fournir :
    • Nom du compartiment.
      • Indicateur : --bucket BUCKET_NAME
    • Facultatif : le FORMAT de sortie ne peut être que « json » ou « text ».
      • Indicateur : --output FORMAT

Obtention d'une classe de compartiment

  • Action : permet de déterminer la classe d'un compartiment dans une instance IBM Cloud Object Storage.
  • Utilisation : ibmcloud cos bucket-class-get --bucket BUCKET_NAME [--output FORMAT]
  • Paramètres à fournir :
    • Nom du compartiment.
      • Indicateur : --bucket BUCKET_NAME
    • Facultatif : le FORMAT de sortie ne peut être que « json » ou « text ».
      • Indicateur : --output FORMAT

Obtention d'une configuration de partage de ressources d'origine croisée pour un compartiment

  • Action : permet de renvoyer la configuration de partage de ressources d'origine croisée pour un compartiment dans le compte IBM Cloud Object Storage d'un utilisateur.
  • Utilisation : ibmcloud cos bucket-cors-get --bucket BUCKET_NAME [--region REGION] [--output FORMAT]
  • Paramètres à fournir :
    • Nom du compartiment.
      • Indicateur : --bucket BUCKET_NAME
    • Facultatif : la RÉGION dans laquelle se trouve le compartiment. Si cette option n'est pas fournie, le programme utilise l'option par défaut qui est spécifiée dans la configuration.
      • Indicateur : --region REGION
    • Facultatif : le FORMAT de sortie ne peut être que « json » ou « text ».
      • Indicateur : --output FORMAT

Obtention en-têtes d'un compartiment

  • Action : permet de déterminer si un compartiment existe dans une instance IBM Cloud Object Storage.
  • Utilisation : ibmcloud cos bucket-head --bucket BUCKET_NAME [--region REGION] [--output FORMAT]
  • Paramètres à fournir :
    • Nom du compartiment.
      • Indicateur : --bucket BUCKET_NAME
    • Facultatif : la RÉGION dans laquelle se trouve le compartiment. Si cette option n'est pas fournie, le programme utilise l'option par défaut qui est spécifiée dans la configuration.
      • Indicateur : --region REGION
    • Facultatif : le FORMAT de sortie ne peut être que « json » ou « text ».
      • Indicateur : --output FORMAT

Achèvement d'un envoi par téléchargement en plusieurs parties

  • Action : permet de terminer une instance d'envoi par téléchargement en plusieurs parties en assemblant les parties envoyées par téléchargement et en envoyant par téléchargement le fichier vers le compartiment dans le compte IBM Cloud Object Storage de l'utilisateur.
  • Utilisation : ibmcloud cos multipart-upload-complete --bucket BUCKET_NAME --key KEY --upload-id ID --multipart-upload STRUCTURE [--region REGION] [--output FORMAT]
  • Paramètres à fournir :
    • Nom du compartiment.

      • Indicateur : --bucket BUCKET_NAME
    • Clé de l'objet.

      • Indicateur : --key KEY
    • ID d'envoi par téléchargement identifiant l'envoi par téléchargement en plusieurs parties.

      • Indicateur : --upload-id ID
    • Structure de l'envoi par téléchargement en plusieurs parties à définir.

      • Indicateur : --multipart-upload STRUCTURE
      • Syntaxe abrégée : --multipart-upload 'Parts=[{ETag=string,PartNumber=integer},{ETag=string,PartNumber=integer}]'
      • Syntaxe JSON : --multipart-upload file://<filename.json>

        La commande --multipart-upload prend une structure JSON qui décrit les parties de l'envoi par téléchargement en plusieurs parties qui doivent être réassemblées dans le fichier complet. Dans cet exemple, le préfixe file:// est utilisé pour charger la structure JSON à partir du fichier spécifié.
      		{
      		"Parts": [
      			{
      			 "ETag": "string",
      			 "PartNumber": integer
      			}
      			...
      			]
      		}
      
    • Facultatif : la RÉGION dans laquelle se trouve le compartiment. Si cette option n'est pas fournie, le programme utilise l'option par défaut qui est spécifiée dans la configuration.

      • Indicateur : --region REGION
    • Facultatif : le FORMAT de sortie ne peut être que « json » ou « text ».

      • Indicateur : --output FORMAT

Configuration du programme

  • Action : permet de configurer les préférences du programme.
  • Utilisation : ibmcloud cos config [COMMAND]
  • Commandes :
    • Passer de l'authentification HMAC à l'authentification IAM
      • Commande : auth
    • Stocker le CRN dans la configuration
      • Commande : crn
    • Stocker l'emplacement de réception par téléchargement par défaut dans la configuration
      • Commande : ddl
    • Stocker les identifiants HMAC dans la configuration
      • Commande : hmac
    • Créer la liste des éléments de configuration
      • Commande : list
    • Stocker la région par défaut dans la configuration
      • Commande : region
    • Basculer entre les styles « VHost » et «Path URL ».
      • Commande : url-style
    • Définir le noeud final de service par défaut.
      • Commande : endpoint-url
        • Paramètres :

          • --list affiche le noeud final de service par défaut en cours, s'il a été défini. Sinon, il sera vide.
          • --url some.end.point.url va remplacer le noeud final de service par la valeur indiquée.
          • --clear supprime le point de terminaison du service URL qui a été défini par défaut.

Obtention d'une configuration de site Web statique

  • Action: obtient la configuration de site Web statique d'un compartiment.
  • Utilisation : ibmcloud cos bucket-website-get --bucket BUCKET_NAME [--region REGION] [--output FORMAT]
  • Paramètres à fournir :
    • Nom du compartiment.

      • Indicateur : --bucket BUCKET_NAME
    • Facultatif : la RÉGION dans laquelle se trouve le compartiment. Si cette option n'est pas fournie, le programme utilise l'option par défaut qui est spécifiée dans la configuration.
      • Indicateur : --region REGION
    • Facultatif : le FORMAT de sortie ne peut être que « json » ou « text ».
      • Indicateur : --output FORMAT

Obtention des en-têtes d'un objet

  • Action : permet de déterminer si un fichier existe dans un compartiment dans le compte IBM Cloud Object Storage d'un utilisateur.
  • Utilisation : ibmcloud cos object-head --bucket BUCKET_NAME --key KEY [--if-match ETAG] [--if-modified-since TIMESTAMP] [--if-none-match ETAG] [--if-unmodified-since TIMESTAMP] [--range RANGE] [--region REGION] [--output FORMAT]
  • Paramètres à fournir :
    • Nom du compartiment.
      • Indicateur : --bucket BUCKET_NAME
    • Clé de l'objet.
      • Indicateur : --key KEY
    • Facultatif : renvoie l'objet uniquement si son identifiant d'entité (ETag) correspond à celui spécifié par ETAG ; dans le cas contraire, renvoie un code 412 (échec de la condition préalable).
      • Indicateur : --if-match ETAG
    • Facultatif : renvoie l'objet uniquement s'il a été modifié depuis le TIMESTAMP spécifié; sinon, renvoie un code 304 (non modifié).
      • Indicateur : --if-modified-since TIMESTAMP
    • Facultatif : renvoie l'objet uniquement si son identifiant d'entité (ETag) est différent de celui spécifié ( ETAG ); sinon, renvoie un code 304 (non modifié).
      • Indicateur : --if-none-match ETAG
    • Facultatif : renvoie l'objet uniquement s'il n'a pas été modifié depuis le TIMESTAMP spécifié; sinon, renvoie un code d'erreur 412 (condition préalable non remplie).
      • Indicateur : --if-unmodified-since TIMESTAMP
    • Permet de recevoir par téléchargement la plage d'octets spécifiée pour un objet.
      • Indicateur : --range RANGE
    • Facultatif : la RÉGION dans laquelle se trouve le compartiment. Si cette option n'est pas fournie, le programme utilise l'option par défaut qui est spécifiée dans la configuration.
      • Indicateur : --region REGION
    • Facultatif : le FORMAT de sortie ne peut être que « json » ou « text ».
      • Indicateur : --output FORMAT

Création de la liste de tous les compartiments

  • **Action : ** permet d'afficher une liste de tous les compartiments présents dans le compte IBM Cloud Object Storage d'un utilisateur. Les compartiments peuvent se trouver dans différentes régions.
  • Utilisation : ibmcloud cos buckets [--ibm-service-instance-id ID] [--output FORMAT]
    • Notez que vous devez fournir un CRN si vous utilisez l'authentification IAM. Vous pouvez le définir à l'aide de la commande ibmcloud cos config crn.
  • Paramètres à fournir :
    • Aucun paramètre à fournir.
      • Facultatif : permet de définir l'identifiant de l'instance du service « IBM » dans la requête.
        • Indicateur : --ibm-service-instance-id
      • Facultatif : le FORMAT de sortie ne peut être que « json » ou « text ».
        • Indicateur : --output FORMAT

Création d'une liste de compartiments étendue

  • **Action : ** permet d'afficher une liste de tous les compartiments présents dans le compte IBM Cloud Object Storage d'un utilisateur. Les compartiments peuvent se trouver dans différentes régions.
  • Utilisation : ibmcloud cos buckets-extended [--ibm-service-instance-id ID] [--marker KEY] [--prefix PREFIX] [--page-size SIZE] [--max-items NUMBER] [--output FORMAT]
    • Notez que vous devez fournir un CRN si vous utilisez l'authentification IAM. Vous pouvez le définir à l'aide de la commande ibmcloud cos config crn.
  • Paramètres à fournir :
    • Aucun paramètre à fournir.
      • Facultatif : permet de définir l'identifiant de l'instance du service « IBM » dans la requête.
        • Indicateur : --ibm-service-instance-id
      • Facultatif : permet de spécifier la CLÉ à partir de laquelle afficher la liste des objets d'un compartiment.
        • Indicateur : --marker KEY
      • Facultatif : limite la réponse aux clés commençant par le PRÉFIXE spécifié.
        • Indicateur : --prefix PREFIX
      • Facultatif : la TAILLE de chaque page à récupérer lors de l'appel de service. Cette valeur n'affecte pas le nombre d'éléments renvoyés dans le résultat de la commande. Si vous définissez une taille de page plus petite, un plus grand nombre d'appels est émis vers le service, avec moins d'éléments extraits dans chaque appel. Cela peut permettre d'éviter que les appels de service ne dépassent le délai d'expiration.
        • Indicateur : --page-size SIZE
      • Facultatif : le NOMBRE total d'éléments à afficher dans la sortie de la commande.
        • Indicateur : --max-items NUMBER
      • Facultatif : le FORMAT de sortie ne peut être que « json » ou « text ».
        • Indicateur : --output FORMAT

Création de la liste des envois par téléchargement en plusieurs parties qui sont en cours

  • Action : permet de répertorier les envois par téléchargement en plusieurs parties qui sont en cours.
  • Utilisation : ibmcloud cos multipart-uploads --bucket BUCKET_NAME [--delimiter DELIMITER] [--encoding-type METHOD] [--prefix PREFIX] [--key-marker value] [--upload-id-marker value] [--page-size SIZE] [--max-items NUMBER] [--region REGION] [--output FORMAT]
  • Paramètres à fournir :
    • Nom du compartiment.
      • Indicateur : --bucket BUCKET_NAME
    • Facultatif : un DÉLIMITEUR est un caractère qui sert à regrouper des clés.
      • Indicateur : --delimiter DELIMITER
    • Facultatif : permet de demander l'encodage des clés d'objet dans la réponse et de spécifier la MÉTHODE d'encodage à utiliser.
      • Indicateur : --encoding-type METHOD
    • Facultatif : limite la réponse aux clés commençant par le PRÉFIXE spécifié.
      • Indicateur : --prefix PREFIX
    • Facultatif : associé au paramètre « upload-id-marker », ce paramètre permet de spécifier à partir de quel téléchargement multipart la liste doit commencer.
      • Indicateur : --key-marker value
    • Facultatif : associé au marqueur « key », permet de préciser à partir de quel téléchargement en plusieurs parties la liste doit commencer. Si key-marker n'est pas spécifié, le paramètre upload-id-marker est ignoré.
      • Indicateur : --upload-id-marker value
    • Facultatif : la TAILLE de chaque page à récupérer lors de l'appel de service. Cette valeur n'affecte pas le nombre d'éléments renvoyés dans le résultat de la commande. Si vous définissez une taille de page plus petite, un plus grand nombre d'appels est émis vers le service, avec moins d'éléments extraits dans chaque appel. Cela peut permettre d'éviter que les appels de service n'expirent. (valeur par défaut : 1000).
      • Indicateur : --page-size SIZE
    • Facultatif : le NOMBRE total d'éléments à afficher dans la sortie de la commande. Si le nombre total d'éléments disponibles est supérieur à la valeur indiquée, un jeton NextToken est fourni dans le résultat de la commande. Pour reprendre la pagination, indiquez la valeur « NextToken » dans l'argument « starting-token » d'une commande suivante. (valeur par défaut : 0).
      • Indicateur : --max-items NUMBER
    • Facultatif : la RÉGION dans laquelle se trouve le compartiment. Si cette option n'est pas fournie, le programme utilise l'option par défaut qui est spécifiée dans la configuration.
      • Indicateur : --region REGION
    • Facultatif : le FORMAT de sortie ne peut être que « json » ou « text ».
      • Indicateur : --output FORMAT

Création d'une liste d'objets

  • Action : permet de répertorier les fichiers présents dans un compartiment dans le compte IBM Cloud Object Storage d'un utilisateur. Cette opération est actuellement limitée aux 1 000 objets créés le plus récemment et ne peut pas être filtrée.
  • Utilisation : ibmcloud cos objects --bucket BUCKET_NAME [--delimiter DELIMITER] [--encoding-type METHOD] [--prefix PREFIX] [--starting-token TOKEN] [--page-size SIZE] [--max-items NUMBER] [--region REGION] [--output FORMAT]
  • Paramètres à fournir :
    • Nom du compartiment.
      • Indicateur : --bucket BUCKET_NAME
    • Facultatif : un DÉLIMITEUR est un caractère qui sert à regrouper des clés.
      • Indicateur : --delimiter DELIMITER
    • Facultatif : permet de demander l'encodage des clés d'objet dans la réponse et de spécifier la MÉTHODE d'encodage à utiliser.
      • Indicateur : --encoding-type METHOD
    • Facultatif : limite la réponse aux clés commençant par le PRÉFIXE spécifié.
      • Indicateur : --prefix PREFIX
    • Facultatif : un TOKEN permettant de préciser à quel endroit commencer la pagination. Il s'agit du jeton NextToken issu d'une réponse précédemment tronquée.
      • Indicateur : --starting-token TOKEN
    • Facultatif : la TAILLE de chaque page à récupérer lors de l'appel de service. Cette valeur n'affecte pas le nombre d'éléments renvoyés dans le résultat de la commande. Si vous définissez une taille de page plus petite, un plus grand nombre d'appels est émis vers le service, avec moins d'éléments extraits dans chaque appel. Cela peut permettre d'éviter que les appels de service n'expirent. (valeur par défaut : 1000)
      • Indicateur : --page-size SIZE
    • Facultatif : le NOMBRE total d'éléments à afficher dans la sortie de la commande. Si le nombre total d'éléments disponibles est supérieur à la valeur indiquée, un jeton NextToken est fourni dans le résultat de la commande. Pour reprendre la pagination, indiquez la valeur « NextToken » dans l'argument « starting-token » d'une commande suivante. (valeur par défaut : 0)
      • Indicateur : --max-items NUMBER
    • Facultatif : la RÉGION dans laquelle se trouve le compartiment. Si cette option n'est pas fournie, le programme utilise l'option par défaut qui est spécifiée dans la configuration.
      • Indicateur : --region REGION
    • Facultatif : le FORMAT de sortie ne peut être que « json » ou « text ».
      • Indicateur : --output FORMAT

Répertorier les objets v2

  • Action : répertorier tous les objets d'un compartiment spécifique.
  • Utilisation : list-objects-v2 --bucket BUCKET_NAME [--starting-token Starting Token] [--delimiter DELIMITER] [--encoding-type METHOD] [--fetch-owner Boolean] [--max-items NUMBER] [--prefix PREFIX] [--start-after Start After] [--page-size SIZE] [--region REGION] [--output FORMAT] [--json]
  • Paramètres à fournir :
    • Nom du compartiment.
      • Indicateur : --bucket BUCKET_NAME
    • Facultatif : un DÉLIMITEUR est un caractère qui sert à regrouper des clés.
      • Indicateur : --delimiter DELIMITER
    • Facultatif : permet de demander l'encodage des clés d'objet dans la réponse et de spécifier la MÉTHODE d'encodage à utiliser.
      • Indicateur : --encoding-type METHOD
    • Facultatif : limite la réponse aux clés commençant par le PRÉFIXE spécifié.
      • Indicateur : --prefix PREFIX
    • Facultatif : un TOKEN permettant de préciser à quel endroit commencer la pagination. Il s'agit du jeton NextToken issu d'une réponse précédemment tronquée.
      • Indicateur : --starting-token TOKEN
    • Facultatif : la TAILLE de chaque page à récupérer lors de l'appel de service. Cette valeur n'affecte pas le nombre d'éléments renvoyés dans le résultat de la commande. Si vous définissez une taille de page plus petite, un plus grand nombre d'appels est émis vers le service, avec moins d'éléments extraits dans chaque appel. Cela peut permettre d'éviter que les appels de service n'expirent. (valeur par défaut : 1000)
      • Indicateur : --page-size SIZE
    • Facultatif : le NOMBRE total d'éléments à afficher dans la sortie de la commande. Si le nombre total d'éléments disponibles est supérieur à la valeur indiquée, un jeton NextToken est fourni dans le résultat de la commande. Pour reprendre la pagination, indiquez la valeur « NextToken » dans l'argument « starting-token » d'une commande suivante. (valeur par défaut : 0)
      • Indicateur : --max-items NUMBER
    • Facultatif : la RÉGION dans laquelle se trouve le compartiment. Si cette option n'est pas fournie, le programme utilise l'option par défaut qui est spécifiée dans la configuration.
      • Indicateur : --region REGION
    • Facultatif : le FORMAT de sortie ne peut être que « json » ou « text ».
      • Indicateur : --output FORMAT
    • Facultatif : la valeur booléenne n'est pas présente par défaut dans « listV2 »; si vous souhaitez que le champ « owner » soit renvoyé avec chaque clé dans le résultat, définissez le paramètre « fetch owner field » sur « true ».
      • Indicateur : --fetch-owner Boolean
    • Facultatif : le champ « Démarrer après » correspond au point à partir duquel vous souhaitez que S3 commence à afficher les résultats. S3 commence la liste après la clé spécifiée. StartAfter peut indiquer n'importe quelle clé dans le compartiment.
      • Indicateur : --start-after Start After
    • Obsolète : la sortie est renvoyée au format JSON brut.
      • Indicateur : --json

Création d'une liste de parties

  • Action : permet d'afficher des informations sur une instance d'envoi par téléchargement en plusieurs parties qui est en cours.
  • Utilisation : ibmcloud cos parts --bucket BUCKET_NAME --key KEY --upload-id ID --part-number-marker VALUE [--page-size SIZE] [--max-items NUMBER] [--region REGION] [--output FORMAT]
  • Paramètres à fournir :
    • Nom du compartiment.
      • Indicateur : --bucket BUCKET_NAME
    • Clé de l'objet.
      • Indicateur : --key KEY
    • ID d'envoi par téléchargement identifiant l'envoi par téléchargement en plusieurs parties.
      • Indicateur : --upload-id ID
    • Valeur de référence après laquelle la création de la liste commence (valeur par défaut : 1).
      • Indicateur : --part-number-marker VALUE
    • Facultatif : la TAILLE de chaque page à récupérer lors de l'appel de service. Cette valeur n'affecte pas le nombre d'éléments renvoyés dans le résultat de la commande. Si vous définissez une taille de page plus petite, un plus grand nombre d'appels est émis vers le service, avec moins d'éléments extraits dans chaque appel. Cela peut permettre d'éviter que les appels de service n'expirent. (valeur par défaut : 1000)
      • Indicateur : --page-size SIZE
    • Facultatif : le NOMBRE total d'éléments à afficher dans la sortie de la commande. Si le nombre total d'éléments disponibles est supérieur à la valeur indiquée, un jeton NextToken est fourni dans le résultat de la commande. Pour reprendre la pagination, indiquez la valeur « NextToken » dans l'argument « starting-token » d'une commande suivante. (valeur par défaut : 0)
      • Indicateur : --max-items NUMBER
    • Facultatif : la RÉGION dans laquelle se trouve le compartiment. Si cette option n'est pas fournie, le programme utilise l'option par défaut qui est spécifiée dans la configuration.
      • Indicateur : --region REGION
    • Facultatif : le FORMAT de sortie ne peut être que « json » ou « text ».
      • Indicateur : --output FORMAT

Définition d'une configuration de partage de ressources d'origine croisée pour un compartiment

  • Action : permet de définir la configuration de partage de ressources d'origine croisée pour un compartiment dans le compte IBM Cloud Object Storage d'un utilisateur.

  • Utilisation : ibmcloud cos bucket-cors-put --bucket BUCKET_NAME [--cors-configuration STRUCTURE] [--region REGION] [--output FORMAT]

  • Paramètres à fournir :

    • Nom du compartiment.
      • Indicateur : --bucket BUCKET_NAME
    • Facultatif : une STRUCTURE utilisant la syntaxe JSON dans un fichier.
      • Indicateur : --cors-configuration STRUCTURE
      • Syntaxe JSON : --cors-configuration file://<filename.json>

        La commande --cors-configuration prend une structure JSON qui décrit la configuration de CORS. Dans cet exemple, le préfixe file:// est utilisé pour charger la structure JSON à partir du fichier spécifié.
    	{
    	"CORSRules": [
    	{
      	"AllowedHeaders": ["*"],
      	"AllowedMethods": ["PUT", "GET", "DELETE"],
      	"AllowedOrigins": ["http://www.example.com"],
      	"ExposeHeaders": ["ExposeHeader7","ExposeHeader8"],
      	"MaxAgeSeconds": 75
    	}
    	...
    	]
    	}
    
    • Facultatif : la RÉGION dans laquelle se trouve le compartiment. Si cette option n'est pas fournie, le programme utilise l'option par défaut qui est spécifiée dans la configuration.
      • Indicateur : --region REGION
    • Facultatif : le FORMAT de sortie ne peut être que « json » ou « text ».
      • Indicateur : --output FORMAT

Insertion d'un objet

  • Action : permet d'envoyer par téléchargement un objet sur un compartiment dans le compte IBM Cloud Object Storage d'un utilisateur.

  • Utilisation : ibmcloud cos object-put --bucket BUCKET_NAME --key KEY [--body FILE_PATH] [--cache-control CACHING_DIRECTIVES] [--content-disposition DIRECTIVES] [--content-encoding CONTENT_ENCODING] [--content-language LANGUAGE] [--content-length SIZE] [--content-md5 MD5] [--content-type MIME] [--metadata MAP] [--region REGION] [--output FORMAT]

  • Paramètres à fournir :

    • Nom du compartiment.
      • Indicateur : --bucket BUCKET_NAME
    • Clé de l'objet.
      • Indicateur : --key KEY
    • Facultatif : emplacement des données de l'objet (FILE_PATH).
      • Indicateur : --body FILE_PATH
    • Facultatif : spécifie l' CACHING_DIRECTIVES s relatives à la chaîne de requêtes et de réponses.
      • Indicateur : --cache-control CACHING_DIRECTIVES
    • Facultatif : permet de définir des informations de présentation (DIRECTIVES).
      • Indicateur : --content-disposition DIRECTIVES
    • Facultatif : spécifie l'encodage du contenu (CONTENT_ENCODING) de l'objet.
      • Indicateur : --content-encoding CONTENT_ENCODING
    • Facultatif : la LANGUE dans laquelle le contenu est rédigé.
      • Indicateur : --content-language LANGUAGE
    • Facultatif : TAILLE du corps en octets. Ce paramètre est utile lorsque la taille du corps ne peut pas être déterminée automatiquement. (valeur par défaut : 0)
      • Indicateur : --content-length SIZE
    • Facultatif : le résumé des données généré par l'algorithme « base64-encoded » ( MD5 ) sur 128 bits.
      • Indicateur : --content-md5 MD5
    • Facultatif : un type MIME standard décrivant le format des données de l'objet.
      • Indicateur : --content-type MIME
    • Facultatif : une carte (MAP) des métadonnées à stocker.
      • Indicateur : --metadata MAP Syntaxe JSON : L'indicateur --metadata utilise le préfixe file:// qui est utilisé pour charger la structure JSON à partir du fichier spécifié.
    {
      "file_name": "file_20xxxxxxxxxxxx45.zip",
      "label": "texas",
      "state": "Texas",
      "Date_to": "2019-11-09T16:00:00.000Z",
      "Sha256sum": "9e39dxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx8ce6b68ede3a47",
      "Timestamp": "Thu, 17 Oct 2019 09:22:13 GMT"
    }
    
    • Facultatif : la RÉGION dans laquelle se trouve le compartiment. Si cette option n'est pas fournie, le programme utilise l'option par défaut qui est spécifiée dans la configuration.
      • Indicateur : --region REGION
    • Facultatif : le FORMAT de sortie ne peut être que « json » ou « text ».
      • Indicateur : --output FORMAT

Importez des objets à l'aide de S3Manager

  • Action: permet de télécharger simultanément des objets dans COS.

  • Utilisation : ibmcloud cos upload --bucket BUCKET_NAME --key KEY --file PATH [--concurrency value] [--max-upload-parts PARTS] [--part-size SIZE] [--leave-parts-on-errors] [--cache-control CACHING_DIRECTIVES] [--content-disposition DIRECTIVES] [--content-encoding CONTENT_ENCODING] [--content-language LANGUAGE] [--content-length SIZE] [--content-md5 MD5] [--content-type MIME] [--metadata MAP] [--region REGION] [--output FORMAT]

  • Paramètres à fournir :

    • Nom (BUCKET_NAME) du compartiment.
      • Indicateur : --bucket BUCKET_NAME
    • Clé de l'objet.
      • Indicateur : --key KEY
    • Chemin d'accès au fichier à envoyer par téléchargement.
      • Indicateur : --file PATH
    • Facultatif : nombre de routines « go » à lancer en parallèle par appel à la fonction « Upload » lors de l'envoi de parties. La valeur par défaut est 5.
      • Indicateur : --concurrency value
    • Facultatif : nombre maximal de PIÈCES qui seront téléchargées sur S3, site qui calcule la taille des pièces de l'objet à télécharger. La limite est fixée à 10 000 parties.
      • Indicateur : --max-upload-parts PARTS
    • Facultatif : la TAILLE (en octets) de la mémoire tampon à utiliser lors de la mise en mémoire tampon des données par blocs et de leur envoi par parties vers S3. La plus petite taille de partie autorisée est de 5 Mo.
      • Indicateur : --part-size SIZE
    • Facultatif : si vous définissez cette valeur sur « true », le SDK évitera d'appeler la méthode AbortMultipartUpload en cas d'échec, laissant toutes les parties téléchargées avec succès sur S3 afin de permettre une récupération manuelle.
      • Indicateur : --leave-parts-on-errors
    • Facultatif : définit les directives de mise en cache (CACHING_DIRECTIVES) pour la chaîne de requêtes/réponses.
      • Indicateur : --cache-control CACHING_DIRECTIVES
    • Facultatif : permet de définir des informations de mise en forme (DIRECTIVES).
      • Indicateur : --content-disposition DIRECTIVES
    • Facultatif : précise quels encodages de contenu (CONTENT_ENCODING) ont été appliqués à l'objet et, par conséquent, quels mécanismes de décodage doivent être utilisés pour obtenir le type de média référencé par le champ d'en-tête Content-Type.
      • Indicateur : --content-encoding CONTENT_ENCODING
    • Facultatif : la LANGUE dans laquelle le contenu est rédigé.
      • Indicateur : --content-language LANGUAGE
    • Facultatif : TAILLE du corps en octets. Ce paramètre est utile lorsque la taille du corps ne peut pas être déterminée automatiquement.
      • Indicateur : --content-length SIZE
    • Facultatif : le résumé des données généré par l'algorithme « base64-encoded » ( MD5 ) sur 128 bits.
      • Indicateur : --content-md5 MD5
    • Facultatif : un type MIME standard décrivant le format des données de l'objet.
      • Indicateur : --content-type MIME
    • Facultatif : une carte (MAP) des métadonnées à stocker.
      • Indicateur : --metadata MAP Syntaxe JSON : L'indicateur --metadata utilise le préfixe file:// qui est utilisé pour charger la structure JSON à partir du fichier spécifié.
    {
      "file_name": "file_20xxxxxxxxxxxx45.zip",
      "label": "texas",
      "state": "Texas",
      "Date_to": "2019-11-09T16:00:00.000Z",
      "Sha256sum": "9e39dxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx8ce6b68ede3a47",
      "Timestamp": "Thu, 17 Oct 2019 09:22:13 GMT"
    }
    
    • Facultatif : la RÉGION dans laquelle se trouve le compartiment. Si cette option n'est pas fournie, le programme utilisera l'option par défaut qui est spécifiée dans la configuration.
      • Indicateur : --region REGION
    • Facultatif : le FORMAT de sortie ne peut être que « json » ou « text ».
      • Indicateur : --output FORMAT

Contrôle manuel des envois par téléchargement en plusieurs parties

L'interface CLI d' IBM Cloud Object Storage permet aux utilisateurs de télécharger des fichiers volumineux en plusieurs parties grâce aux fonctions de téléchargement multipart de l' AWS. Pour lancer un nouveau téléchargement en plusieurs parties, exécutez la commande « multipart-upload-create », qui renvoie l'identifiant de téléchargement de la nouvelle instance de téléchargement. Afin de poursuivre le processus d'envoi par téléchargement, vous devez sauvegarder l'ID d'envoi par téléchargement pour chaque commande suivante. Cette commande vous demande de générer un hachage MD5:

{object data} | openssl dgst -md5 -binary | openssl enc -base64

Après avoir exécuté la commande multipart-upload-complete, exécutez part-upload pour chaque partie de fichier que vous souhaitez télécharger. Pour les téléchargements en plusieurs parties, chaque partie du fichier (à l'exception de la dernière) doit avoir une taille minimale de 5 Mo. Pour fractionner un fichier en plusieurs parties distinctes, vous pouvez exécuter split dans une fenêtre de terminal. Par exemple, si vous disposez d'un fichier de 13 Mo nommé TESTFILE sur votre bureau et que vous souhaitez le fractionner en plusieurs parties de 5 Mo chacune, vous pouvez exécuter la commande split -b 3m ~/Desktop/TESTFILE part-file-. Cette commande génère trois parties de fichier dans deux parties de fichier de 5 Mo chacune et une partie de fichier de 3 Mo, qu'elle nomme part-file-aa, part-file-ab et part-file-ac. As each file part is uploaded, the CLI print its ETag . You must save this ETag into a formatted JSON file, along with the part number. Use this template to create your own Fichier de données JSON ETag.

{
    "Parts": [
    {
      "PartNumber": 1,
      "ETag": "The ETag of the first file part goes here."
    },
    {
      "PartNumber": 2,
      "ETag": "The ETag of the second file part goes here."
    }
    ]
}

Ajoutez d'autres entrées à ce modèle JSON si nécessaire.

Pour connaître l'état de votre transfert en plusieurs parties, vous pouvez à tout moment exécuter la commande part-list en indiquant le nom du compartiment, la clé et l'identifiant du transfert. Cette commande affiche les informations brutes concernant votre instance de téléchargement en plusieurs parties. Une fois le téléchargement de chaque partie du fichier terminé, exécutez la commande « multipart-upload-complete » en lui passant les paramètres nécessaires. Si tout se passe bien, vous recevez un message vous confirmant que le fichier a bien été envoyé par téléchargement dans le compartiment souhaité.

Remonter une partie

  • Action : permet d'envoyer par téléchargement une partie d'un fichier dans une instance d'envoi par téléchargement en plusieurs parties existante.
  • Utilisation : ibmcloud cos part-upload --bucket BUCKET_NAME --key KEY --upload-id ID --part-number NUMBER [--body FILE_PATH] [--region REGION] [--output FORMAT]
    • Notez que vous devez enregistrer le numéro et l' ETag (que l'interface en ligne de commande vous indiquera) de chaque partie de fichier téléchargée dans un fichier JSON. Pour plus d'informations, voir la rubrique sur l'envoi par téléchargement en plusieurs parties.
  • Paramètres à fournir :
    • Nom du compartiment dans lequel s'effectue l'envoi par téléchargement en plusieurs parties.
      • Indicateur : --bucket BUCKET_NAME
    • Clé de l'objet.
      • Indicateur : --key KEY
    • ID d'envoi par téléchargement identifiant l'envoi par téléchargement en plusieurs parties.
      • Indicateur : --upload-id ID
    • Référence de la partie en cours d'envoi par téléchargement. Il s'agit d'un nombre entier positif compris entre 1 et 10 000. (valeur par défaut : 1)
      • Indicateur : --part-number NUMBER
    • Facultatif : emplacement des données de l'objet (FILE_PATH).
      • Indicateur : --body FILE_PATH
    • Facultatif : la RÉGION dans laquelle se trouve le compartiment. Si cette option n'est pas fournie, le programme utilise l'option par défaut qui est spécifiée dans la configuration.
      • Indicateur : --region REGION
    • Facultatif : le FORMAT de sortie ne peut être que « json » ou « text ».
      • Indicateur : --output FORMAT

Envoi par téléchargement d'une copie de partie

  • Action : permet d'envoyer par téléchargement une partie en copiant les données d'un objet existant.
  • Utilisation : ibmcloud cos part-upload-copy --bucket BUCKET_NAME --key KEY --upload-id ID --part-number NUMBER --copy-source SOURCE [--copy-source-if-match ETAG] [--copy-source-if-modified-since TIMESTAMP] [--copy-source-if-none-match ETAG] [--copy-source-if-unmodified-since TIMESTAMP] [--copy-source-range value] [--region REGION] [--output FORMAT]
    • Notez que vous devez enregistrer le numéro et l' ETag (que l'interface en ligne de commande vous indiquera) de chaque partie de fichier téléchargée dans un fichier JSON. Pour plus d'informations, voir la rubrique sur l'envoi par téléchargement en plusieurs parties.
  • Paramètres à fournir :
    • Nom du compartiment.
      • Indicateur : --bucket BUCKET_NAME
    • Clé de l'objet.
      • Indicateur : --key KEY
    • ID d'envoi par téléchargement identifiant l'envoi par téléchargement en plusieurs parties.
      • Indicateur : --upload-id ID
    • Référence de la partie en cours d'envoi par téléchargement. Il s'agit d'un entier positif compris entre 1 et 10 000.
      • Indicateur : --part-number PART_NUMBER
    • (SOURCE) Le nom du compartiment source et le nom de la clé de l'objet source, séparés par une barre oblique (/). Doit être encodé selon la norme « URL ».
      • Indicateur : --copy-source SOURCE
    • Facultatif : copie l'objet si son identifiant d'entité (Etag) correspond à l'identifiant spécifié (ETAG).
      • Indicateur : --copy-source-if-match ETAG
    • Facultatif : copie l'objet s'il a été modifié depuis l'heure indiquée (TIMESTAMP).
      • Indicateur : --copy-source-if-modified-since TIMESTAMP
    • Facultatif : copie l'objet si son identifiant d'entité (ETag) est différent de l'identifiant spécifié (ETAG).
      • Indicateur : --copy-source-if-none-match ETAG
    • Facultatif : copie l'objet s'il n'a pas été modifié depuis l'heure indiquée (TIMESTAMP).
      • Indicateur : --copy-source-if-unmodified-since TIMESTAMP
    • Facultatif : la plage d'octets à copier à partir de l'objet source. La valeur de la plage doit être au format bytes=fist-last, first et last étant les décalages comptés à partir de zéro. Par exemple, bytes=0-9 indique que vous souhaitez copier les dix premiers octets de la source. Vous ne pouvez copier une plage que si l'objet source fait plus de 5 Mo.
      • Indicateur : --copy-source-range value
    • Facultatif : la RÉGION dans laquelle se trouve le compartiment. Si cette option n'est pas fournie, le programme utilise l'option par défaut qui est spécifiée dans la configuration.
      • Indicateur : --region REGION
    • Facultatif : le FORMAT de sortie ne peut être que « json » ou « text ».
      • Indicateur : --output FORMAT

Configuration du verrouillage d'objet

Configuration du verrouillage d'insertion d'objet

Les jours et les années de conservation par défaut ne peuvent pas être fournis en même temps.

  • Action : Définir la configuration du verrouillage des objets sur un compartiment.
  • Utilisation : object-lock-configuration-put --bucket BUCKET_NAME [--object-lock-configuration STRUCTURE] [--region REGION] [--output FORMAT]
  • Paramètres à fournir :
    • Nom du compartiment.
      • Indicateur : --bucket BUCKET_NAME
    • Une STRUCTURE utilisant la syntaxe JSON. Voir la documentationIBM Cloud.
      • Indicateur : --object-lock-configuration STRUCTURE

        	{
        	"ObjectLockEnabled": "Enabled",
        	"Rule": {
        		"DefaultRetention": {
        		"Mode": "COMPLIANCE",
        		"Days": integer,
        		"Years": integer
        		}
        	}
        	}
        
    • Facultatif : la RÉGION dans laquelle se trouve le compartiment. Si cette option n'est pas fournie, le programme utilise l'option par défaut qui est spécifiée dans la configuration.
      • Indicateur : --region REGION
    • Facultatif : le FORMAT de sortie ne peut être que « json » ou « text ».
      • Indicateur : --output FORMAT

Exemple :

ibmcloud cos object-lock-configuration-put --bucket bucket-name --object-lock-configuration '{ "ObjectLockEnabled": "Enabled", "Rule": { "DefaultRetention": { "Mode": "COMPLIANCE", "Days": 30 }}}'

Obtenir la configuration du verrouillage d'objet

  • Action : Récupérer la configuration du verrouillage d'objet d'un compartiment.
  • Utilisation : object-lock-configuration-get --bucket BUCKET_NAME [--region REGION] [--output FORMAT]
  • Paramètres à fournir :
    • Nom du compartiment.
      • Indicateur : --bucket BUCKET_NAME
    • Une STRUCTURE utilisant la syntaxe JSON. Voir la documentationIBM Cloud.
      • Indicateur : --object-lock-configuration STRUCTURE

        	{
        	"ObjectLockEnabled": "Enabled",
        	"Rule": {
        		"DefaultRetention": {
        		"Mode": "COMPLIANCE",
        		"Days": integer,
        		"Years": integer
        		}
        	}
        	}
        
    • Facultatif : la RÉGION dans laquelle se trouve le compartiment. Si cette option n'est pas fournie, le programme utilise l'option par défaut qui est spécifiée dans la configuration.
      • Indicateur : --region REGION
    • Facultatif : le FORMAT de sortie ne peut être que « json » ou « text ».
      • Indicateur : --output FORMAT

        	{
        	"ObjectLockEnabled": "Enabled",
        	"Rule": {
        		"DefaultRetention": {
        		"Mode": "COMPLIANCE",
        		"Days": integer,
        		"Years": integer
        		}
        	}
        	}
        

Exemple :

ibmcloud cos object-lock-configuration-get --bucket bucket-name --region us-south

Conservation des objets

Conservation de l'objet d'insertion

  • Action : définir la durée de conservation d'un objet.
  • Utilisation : object-retention-put --bucket BUCKET_NAME --key KEY [--retention STRUCTURE] [--region REGION] [--output FORMAT]
  • Paramètres à fournir :
    • Nom du compartiment.
      • Indicateur : --bucket BUCKET_NAME
    • Clé de l'objet.
      • Indicateur : --key KEY
    • Une STRUCTURE utilisant la syntaxe JSON. Voir la documentationIBM Cloud.
      • Indicateur : --retention STRUCTURE

        	{
        	  "Mode": "COMPLIANCE",
        	  "RetainUntilDate": timestamp
        	}
        
    • Facultatif : la RÉGION dans laquelle se trouve le compartiment. Si cette option n'est pas fournie, le programme utilise l'option par défaut qui est spécifiée dans la configuration.
      • Indicateur : --region REGION
    • Facultatif : le FORMAT de sortie ne peut être que « json » ou « text ».
      • Indicateur : --output FORMAT

Exemple :

ibmcloud cos object-retention-put --bucket bucket-name --key file-name.txt --retention '{ "Mode": "COMPLIANCE", "RetainUntilDate": "2024-02-02T00:00:00"}’

Obtenir la conservation de l'objet

  • Action : obtenir la durée de rétention d'un objet.
  • Utilisation : object-retention-get --bucket BUCKET_NAME --key KEY [--region REGION] [--output FORMAT]
  • Paramètres à fournir :
    • Nom du compartiment.
      • Indicateur : --bucket BUCKET_NAME
    • Clé de l'objet.
      • Indicateur : --key KEY
    • Facultatif : la RÉGION dans laquelle se trouve le compartiment. Si cette option n'est pas fournie, le programme utilise l'option par défaut qui est spécifiée dans la configuration.
      • Indicateur : --region REGION
    • Facultatif : le FORMAT de sortie ne peut être que « json » ou « text ».
      • Indicateur : --output FORMAT

        	{
        		"Retention": {
        			"Mode": "COMPLIANCE",
        			"RetainUntilDate": "2024-02-02T00:00:00.000Z"
        		}
        	}
        

Exemple :

ibmcloud cos object-retention-put --bucket bucket-name --key file-name.txt --region us-south

Retenue légale de l'objet

Mettre la mise en attente juridique de l'objet

  • Action : Activer la conservation légale sur un objet.
  • Utilisation : object-legal-hold-put --bucket BUCKET_NAME --key KEY [--legal-hold STRUCTURE] [--region REGION] [--output FORMAT]
  • Paramètres à fournir :
    • Nom du compartiment.
      • Indicateur : --bucket BUCKET_NAME
    • Clé de l'objet.
      • Indicateur : --key KEY
    • Une STRUCTURE utilisant la syntaxe JSON. Voir la documentationIBM Cloud.
      • Indicateur : --legalhold STRUCTURE

        	{
        	   "Status": "ON"|"OFF"
        	}
        
    • Facultatif : la RÉGION dans laquelle se trouve le compartiment. Si cette option n'est pas fournie, le programme utilise l'option par défaut qui est spécifiée dans la configuration.
      • Indicateur : --region REGION
    • Facultatif : le FORMAT de sortie ne peut être que « json » ou « text ».
      • Indicateur : --output FORMAT

Exemple :

ibmcloud cos object-legal-hold-put --bucket bucket-name --key file-name.txt --legal-hold ‘{"Status": "ON"}’

Obtenir la mise en attente légale de l'objet

  • Action : Obtenir une mise sous séquestre pour un objet.
  • Utilisation : object-legal-hold-get --bucket BUCKET_NAME --key KEY [--region REGION] [--output FORMAT]
  • Paramètres à fournir :
    • Nom du compartiment.
      • Indicateur : --bucket BUCKET_NAME
    • Clé de l'objet.
      • Indicateur : --key KEY
    • Facultatif : la RÉGION dans laquelle se trouve le compartiment. Si cette option n'est pas fournie, le programme utilise l'option par défaut qui est spécifiée dans la configuration.
      • Indicateur : --region REGION
    • Facultatif : le FORMAT de sortie ne peut être que « json » ou « text ».
      • Indicateur : --output FORMAT

        	{
        		"LegalHold": {
        			"Status": "ON"
        		}
        	}
        

Exemple :

ibmcloud cos object-retention-get --bucket bucket-name --key file-name.txt --region us-south

Configurer la réplication de compartiment

Configuration d'un compartiment répliqué.

Réplication de compartiment d'insertion

  • Action : Définir la configuration de réplication d'un compartiment.
  • Utilisation : bucket-replication-put --bucket BUCKET_NAME --replication-configuration STRUCTURE [--region REGION] [--output FORMAT]
  • Paramètres à fournir :
    • Nom du compartiment.
      • Indicateur : --bucket BUCKET_NAME
    • Facultatif : la RÉGION dans laquelle se trouve le compartiment. Si cette option n'est pas fournie, le programme utilise l'option par défaut qui est spécifiée dans la configuration.
      • Indicateur : --region REGION
    • Facultatif : le FORMAT de sortie ne peut être que « json » ou « text ».
      • Indicateur : --output FORMAT
    • Une STRUCTURE utilisant la syntaxe JSON.
      • Indicateur : --replication-configuration STRUCTURE

        	{
        		"Rules": [
        			{
        				"Status": "Enabled",
        				"Priority": 1,
        				"Filter" : { "Prefix": ""},
        				"DeleteMarkerReplication": {
        					"Status": "Disabled"
        				},
        				"Destination": {
        					"Bucket": "DEST-BUCKET-NAME"
        				}
        			}
        		]
        	}
        

Exemple :

ibmcloud cos bucket-replication-put --bucket SOURCE-BUCKET-NAME --replication-configuration file://replication.json

Obtenir la réplication de compartiment

  • Action : Récupérer la configuration de réplication d'un compartiment.
  • Utilisation : bucket-replication-get --bucket BUCKET_NAME [--region REGION] [--output FORMAT]
  • Paramètres à fournir :
    • Nom du compartiment.
      • Indicateur : --bucket BUCKET_NAME
    • Facultatif : la RÉGION dans laquelle se trouve le compartiment. Si cette option n'est pas fournie, le programme utilise l'option par défaut qui est spécifiée dans la configuration.
      • Indicateur : --region REGION
    • Facultatif : le FORMAT de sortie ne peut être que « json » ou « text ».
      • Indicateur : --output FORMAT

        	{
        		"ReplicationConfiguration": {
        			"Rules": [
        				{
        					"Status": "Enabled",
        					"Prefix": "",
        					"Destination": {
        						"Bucket": "DEST-BUCKET-NAME",
        						"StorageClass": "STANDARD"
        					},
        				}
        			],
        		}
        	}
        

Exemple :

 ibmcloud cos bucket-replication-get --bucket SOURCE-BUCKET-NAME

Supprimer la réplication de compartiment

  • Action : Supprimer la configuration de réplication d'un compartiment.
  • Utilisation : bucket-replication-delete --bucket BUCKET_NAME [--region REGION] [--output FORMAT]
  • Paramètres à fournir :
    • Nom du compartiment.
      • Indicateur : --bucket BUCKET_NAME
    • Facultatif : la RÉGION dans laquelle se trouve le compartiment. Si cette option n'est pas fournie, le programme utilise l'option par défaut qui est spécifiée dans la configuration.
      • Indicateur : --region REGION
    • Facultatif : le FORMAT de sortie ne peut être que « json » ou « text ».
      • Indicateur : --output FORMAT

Exemple :

 ibmcloud cos bucket-replication-delete --bucket SOURCE-BUCKET-NAME

Etapes suivantes

Comme chaque procédure se déroule toujours exactement comme prévu, il se peut que vous n'ayez pas vu l'un des codes d'erreur et d'en-tête communs. Pour plus d'informations, consultez la référence d'API.