Archivage et expiration des objets versionnés

Les configurations de cycle de vie sont autorisées dans un compartiment activé pour la version. Toutefois, contrairement à Amazon S3, les nouvelles versions sont soumises à la règle d'archivage de la même manière que les objets standard. Les objets reçoivent une date de transition lorsqu'ils sont créés et sont archivés à leur date de transition individuelle, qu'il s'agisse de versions en cours ou non. Le remplacement d'un objet n'affecte pas la date de transition de la version précédente, et une date de transition est attribuée à la nouvelle version (actuelle).

Il n'est pas possible d'utiliser des règles NoncurrentVersionTransition pour archiver uniquement les versions non actuelles des objets dans une configuration de cycle de vie.

Object Storage, stockage inaltérable (WORM)

L'implémentation IBM Cloud Object Storage du Object Storage immuables (c'est-à-dire les politiques de rétention) n'est pas autorisée dans les compartiments avec versionnage activé. Les tentatives de création d'une politique de conservation échouent, tout comme celles visant à activer la gestion des versions sur un compartiment soumis à une politique de conservation.

Activer la gestion des versions sur un compartiment

curl -X "PUT" "https://$BUCKET.s3.$REGION.cloud-object-storage.appdomain.cloud/?versioning" \
     -H 'Authorization: bearer $TOKEN' \
     -H 'Content-MD5: 8qj8HSeDu3APPMQZVG06WQ==' \
     -H 'Content-Type: text/plain; charset=utf-8' \
     -d $'<VersioningConfiguration>
            <Status>Enabled</Status>
          </VersioningConfiguration>'

Une demande réussie renvoie une réponse 200.

Suspension de la gestion des versions sur un compartiment

curl -X "PUT" "https://$BUCKET.s3.$REGION.cloud-object-storage.appdomain.cloud/?versioning" \
     -H 'Authorization: bearer $TOKEN' \
     -H 'Content-MD5: hxXDWuCDWB72Be0LG4XniQ==' \
     -H 'Content-Type: text/plain; charset=utf-8' \
     -d $'<VersioningConfiguration>
            <Status>Suspended</Status>
          </VersioningConfiguration>'

Une demande réussie renvoie une réponse 200.

Répertorier les versions des objets d'un compartiment

curl -X "GET" "https://$BUCKET.s3.$REGION.cloud-object-storage.appdomain.cloud/?versions" \
     -H 'Authorization: bearer $TOKEN'

Cette commande renvoie un corps de réponse XML:

<ListVersionsResult>
   <IsTruncated>boolean</IsTruncated>
   <KeyMarker>string</KeyMarker>
   <VersionIdMarker>string</VersionIdMarker>
   <NextKeyMarker>string</NextKeyMarker>
   <NextVersionIdMarker>string</NextVersionIdMarker>
   <Version>
      <ETag>string</ETag>
      <IsLatest>boolean</IsLatest>
      <Key>string</Key>
      <LastModified>timestamp</LastModified>
      <Owner>
         <DisplayName>string</DisplayName>
         <ID>string</ID>
      </Owner>
      <Size>integer</Size>
      <StorageClass>string</StorageClass>
      <VersionId>string</VersionId>
   </Version>
   ...
   <DeleteMarker>
      <IsLatest>boolean</IsLatest>
      <Key>string</Key>
      <LastModified>timestamp</LastModified>
      <Owner>
         <DisplayName>string</DisplayName>
         <ID>string</ID>
      </Owner>
      <VersionId>string</VersionId>
   </DeleteMarker>
   ...
   <Name>string</Name>
   <Prefix>string</Prefix>
   <Delimiter>string</Delimiter>
   <MaxKeys>integer</MaxKeys>
   <CommonPrefixes>
      <Prefix>string</Prefix>
   </CommonPrefixes>
   ...
   <EncodingType>string</EncodingType>
</ListVersionsResult>

delimiter: Un délimiteur est un caractère que vous spécifiez pour regrouper des clés. Toutes les clés qui contiennent la même chaîne entre le préfixe et la première occurrence du délimiteur sont regroupées sous un seul élément de résultat dans CommonPrefixes. Ces groupes sont comptés comme un résultat par rapport à la limitation max-keys. Ces clés ne sont pas renvoyées ailleurs dans la réponse.

encoding-type: Demande à Object Storage d'encoder en URL les clés d'objet dans la réponse. Les clés d'objet peuvent contenir n'importe quel caractère Unicode; toutefois, l'analyseur XML 1.0 ne peut pas analyser certains caractères, tels que ceux dont la valeur ASCII est comprise entre 0 et 10. Pour les caractères non pris en charge par XML 1.0, vous pouvez ajouter ce paramètre afin de demander à Object Storage d'encoder les clés dans la réponse. Valeur valide: url.

key-marker: Spécifie la clé à utiliser pour commencer la liste des objets d'un compartiment.

max-keys: Définit le nombre maximal de clés renvoyées dans la réponse. Par défaut, l'API renvoie jusqu'à 1000 noms de clé. La réponse peut contenir moins de clés, mais jamais plus.

prefix: Utilisez ce paramètre pour sélectionner uniquement les clés commençant par le préfixe spécifié.

version-id-marker: Spécifie la version de l'objet à partir de laquelle vous souhaitez commencer la liste.

Supprimer des versions d'objets dans un panier

Un appel normal à ListObjects ou ListObjectsV2 ne renvoie pas d'identifiant de version. Pour obtenir les identifiants de version nécessaires à toute opération de suppression, vous devez utiliser ListObjectVersions: une requête GET avec le paramètre de requête ?versions. Elle renvoie également les marqueurs de suppression et leurs identifiants de version. Sans cette étape, aucune des opérations de suppression ci-dessous n'est possible.

exemple curl :

curl -X "GET" "https://$BUCKET.s3.$REGION.cloud-object-storage.appdomain.cloud/?versions" \
  -H 'Authorization: bearer $TOKEN'

Exemple d'utilisation de l'interface de ligne de commande (CLI) d' IBM Cloud:

ibmcloud cos object-versions --bucket $BUCKET

Exemple Python :

pythonresponse = cosClient.list_object_versions(Bucket=BUCKET)
for version in response.get('Versions', []):
    print(version['Key'], version['VersionId'])
for marker in response.get('DeleteMarkers', []):
    print(marker['Key'], marker['VersionId'], '(delete marker)')

ibmcloud cos object-delete --bucket $BUCKET --key $OBJECT_KEY --version-id $VERSION_ID

pythoncosClient.delete_object(
    Bucket=BUCKET,
    Key='my-object.txt',
    VersionId='L4kqtJlcpXroDVBH40Nr8X8gdRQBpUMLUo'
)
Node.js:
javascriptawait cos.deleteObject({
  Bucket: 'my-versioning-bucket',
  Key: 'my-object.txt',
  VersionId: 'L4kqtJlcpXroDVBH40Nr8X8gdRQBpUMLUo'
}).promise();

curl -X "DELETE" "https://$BUCKET.s3.$REGION.cloud-object-storage.appdomain.cloud/$OBJECT_KEY?versionId=null" \
  -H 'Authorization: bearer $TOKEN'

cosClient.delete_object(
    Bucket=BUCKET,
    Key='my-object.txt',
    VersionId='null'
)

Opérations sur des versions spécifiques d'objets

Plusieurs API utilisent un nouveau paramètre de requête (?versionId=<VersionId>) qui indique la version de l'objet que vous demandez. Ce paramètre est utilisé de la même manière pour la lecture, la suppression, la vérification des métadonnées et des balises et la restauration des objets archivés. Par exemple, pour lire une version d'un objet foo avec l'ID de version L4kqtJlcpXroDVBH40Nr8X8gdRQBpUMLUo, la demande peut se présenter comme suit:

curl -X "GET" "https://$BUCKET.s3.$REGION.cloud-object-storage.appdomain.cloud/foo?versionId=L4kqtJlcpXroDVBH40Nr8X8gdRQBpUMLUo" \
     -H 'Authorization: bearer $TOKEN'

La suppression de cet objet s'effectue de la même manière.

curl -X "DELETE" "https://$BUCKET.s3.$REGION.cloud-object-storage.appdomain.cloud/foo?versionId=L4kqtJlcpXroDVBH40Nr8X8gdRQBpUMLUo" \
     -H 'Authorization: bearer $TOKEN'

Pour les demandes qui utilisent déjà un paramètre de requête, le paramètre versionId peut être ajouté à la fin.

curl -X "GET" "https://$BUCKET.s3.$REGION.cloud-object-storage.appdomain.cloud/foo?tagging&versionId=L4kqtJlcpXroDVBH40Nr8X8gdRQBpUMLUo" \
     -H 'Authorization: bearer $TOKEN'

La copie côté serveur des versions d'objet est prise en charge, mais utilise une syntaxe légèrement différente. Le paramètre de requête n'est pas ajouté à l' URL elle-même, mais est plutôt ajouté à x-amz-copy-source l'en-tête. Cette syntaxe est identique à la création d'une partie pour une partie à plusieurs parties à partir d'un objet source.

curl -X "PUT" "https://$BUCKET.s3.$REGION.cloud-object-storage.appdomain.cloud/<new-object-key>"
 -H "Authorization: bearer $TOKEN"
 -H "x-amz-copy-source: /<source-bucket>/<object-key>?versionId=L4kqtJlcpXroDVBH40Nr8X8gdRQBpUMLUo"

Python

L'activation de la gestion des versions à l'aide du SDK IBM Cloud Object Storage pour Python peut s'effectuer soit à l'aide de la syntaxe de ressources de haut niveau, soit à l'aide de la syntaxe client de bas niveau.

Utilisation d'une ressource:

#!/usr/bin/env python3
import ibm_boto3
from ibm_botocore.config import Config
from ibm_botocore.exceptions import ClientError
#Define constants
API_KEY = os.environ.get('IBMCLOUD_API_KEY')
SERVICE_INSTANCE = os.environ.get('SERVICE_INSTANCE_ID')
ENDPOINT = os.environ.get('ENDPOINT')
BUCKET = "my-versioning-bucket" # The bucket that will enable versioning.
#Create resource client with configuration info pulled from environment variables.
cos = ibm_boto3.resource("s3",
                         ibm_api_key_id=API_KEY,
                         ibm_service_instance_id=SERVICE_INSTANCE,
                         config=Config(signature_version="oauth"),
                         endpoint_url=ENDPOINT
                         )
versioning = cos.BucketVersioning(BUCKET)
versioning.enable()

La gestion des versions pour le compartiment peut ensuite être suspendue à l'aide de versioning.suspend()

A l'aide de cette même ressource cos, toutes les versions des objets peuvent être répertoriées à l'aide des éléments suivants:

versions = s3.Bucket(BUCKET).object_versions.filter(Prefix=key)
for version in versions:
    obj = version.get()
    print(obj.get('VersionId'), obj.get('ContentLength'), obj.get('LastModified'))

Utilisation d'un client:

#!/usr/bin/env python3
import ibm_boto3
from ibm_botocore.config import Config
from ibm_botocore.exceptions import ClientError
#Define constants
API_KEY = os.environ.get('IBMCLOUD_API_KEY')
SERVICE_INSTANCE = os.environ.get('SERVICE_INSTANCE_ID')
ENDPOINT = os.environ.get('ENDPOINT')
BUCKET = "my-versioning-bucket" # The bucket that will enable versioning.
#Create resource client with configuration info pulled from environment variables.
cosClient = ibm_boto3.client("s3",
                         ibm_api_key_id=API_KEY,
                         ibm_service_instance_id=SERVICE_INSTANCE,
                         config=Config(signature_version="oauth"),
                         endpoint_url=ENDPOINT
                         )
response = cosClient.put_bucket_versioning(
    Bucket=BUCKET,
    VersioningConfiguration={
        'Status': 'Enabled'
    }
)

Liste des versions d'un objet utilisant le même client:

resp = cosClient.list_object_versions(Prefix='some-prefix', Bucket=BUCKET)

Supprimer les versions d'un objet utilisant le même client :

Les API de Python sont très souples et il existe de nombreuses façons d'accomplir la même tâche.

Node.js

Activation de la gestion des versions à l'aide du IBM Cloud Object Storage SDK for Node.js:

const IBM = require('ibm-cos-sdk');
var config = {
    endpoint: '<endpoint>',
    apiKeyId: '<api-key>',
    serviceInstanceId: '<resource-instance-id>',
};
var cos = new IBM.S3(config);
var params = {
    Bucket: 'my-versioning-bucket', /* required */
    VersioningConfiguration: { /* required */
    Status: 'Enabled'
   },
};
s3.putBucketVersioning(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
});