Description Requêtes Réponses Exemples Sections connexes

Si vous débutez dans le stockage d'archives dans Amazon Simple Storage Service (Amazon S3), nous vous recommandons dans un premier temps de vous familiariser avec les classes de stockage S3 Glacier dans Amazon S3, S3 Glacier Instant Retrieval, S3 Glacier Flexible Retrieval et S3 Glacier Deep Archive. Pour plus d'informations, consultez les sections Classes de stockage S3 Glacier et Classes de stockage pour l'archivage d'objets dans le guide de l'utilisateur Amazon S3.

Les traductions sont fournies par des outils de traduction automatique. En cas de conflit entre le contenu d'une traduction et celui de la version originale en anglais, la version anglaise prévaudra.

Affichage des tâches (GET jobs)

Description

Cette opération affiche la liste des tâches relatives à un coffre, y compris les tâches en cours et les tâches récemment terminées.

Note

Amazon S3 Glacier (S3 Glacier) conserve les tâches terminées depuis peu pendant un certain temps avant de les supprimer. La sortie des tâches terminées peut être extraite. Les tâches terminées étant conservées pendant un certain temps, vous pouvez ainsi obtenir les sorties correspondantes si vous manquez la notification d'achèvement de ces tâches ou si votre première tentative de téléchargement de ces tâches échoue. Par exemple, imaginons que vous démarriez une tâche d'extraction d'archive afin de télécharger une archive. Une fois la tâche terminée, vous commencez à télécharger l'archive, mais une erreur réseau se produit. Dans ce scénario, vous pouvez réessayer de télécharger l'archive tant que la tâche existe.

L'opération List Jobs prend en charge la pagination. Vous devez toujours vérifier le champ Marker de la réponse. S'il n'y a pas d'autres tâches à afficher, le champ Marker est défini sur null. S'il y a d'autres tâches à afficher, le champ Marker est défini sur une valeur non null que vous pouvez utiliser afin de poursuivre la pagination de la liste. Pour renvoyer une liste de tâches à partir d'une tâche donnée, définissez le paramètre de demande marker sur la valeur Marker pour la tâche que vous avez obtenue à partir d'une demande List Jobs précédente.

Vous pouvez définir une limite maximale pour le nombre de tâches renvoyées dans la réponse en spécifiant le paramètre limit dans la demande. La limite par défaut est de 50. Il peut arriver que le nombre de tâches renvoyées soit inférieur à la limite, mais il ne sera jamais supérieur à cette valeur.

En outre, vous pouvez filtrer la liste des tâches renvoyées en spécifiant le paramètre facultatif statuscode ou completed, ou les deux. Le paramètre statuscode vous permet de demander à ce que seules les tâches qui correspondent à l'état InProgress, Succeeded ou Failed soient retournées. Le paramètre completed vous permet de demander à ce que seules les tâches terminées (true) ou non terminées (false) soient retournées.

Requêtes

Syntaxe

Pour renvoyer une liste de tâches de tous types, envoyez une demande GET à l'URI de la sous-ressource jobs du coffre.


GET /AccountId/vaults/VaultName/jobs HTTP/1.1
Host: glacier.Region.amazonaws.com
Date: Date
Authorization: SignatureValue
x-amz-glacier-version: 2012-06-01

Note

La valeur de AccountId est l'ID de Compte AWS du compte propriétaire du coffre. Vous pouvez spécifier un ID de Compte AWS ou éventuellement un simple « - » (trait d'union), auquel cas Amazon S3 Glacier utilise l'ID de Compte AWS associé aux informations d'identification utilisées pour signer la demande. Si vous utilisez un ID de compte, évitez d'y inclure des traits d'union (« - »).

Paramètres de demande

Name (Nom)	Description	Obligatoire
`completed`	L'état des tâches à renvoyer. Vous pouvez spécifier `true` ou `false`. Type : booléen Contraintes: Aucune	Non
`limit`	Le nombre maximum de tâches à renvoyer. La limite par défaut est de 50. Il peut arriver que le nombre de tâches renvoyées soit inférieur à la limite spécifiée, mais il ne sera jamais supérieur à cette valeur. Type : chaîne Contraintes : la valeur d'entier minimale est 1. La valeur d'entier maximale est 50.	Non
`marker`	Chaîne opaque utilisée pour la pagination afin de spécifier la tâche à partir de laquelle l'affichage de la liste de tâches doit débuter. Vous obtenez la valeur du paramètre `marker` à partir d'une réponse à une demande `List Jobs` précédente. Vous ne devez inclure la valeur `marker` que si vous poursuivez la pagination de résultats commencée dans une demande `List Jobs` précédente. Type : chaîne Contraintes: Aucune	Non
`statuscode`	Le type de l'état de tâche à renvoyer. Type : chaîne Contraintes : l'une des valeurs suivantes : `InProgress`, `Succeeded` ou`Failed`.	Non

En-têtes de demande

Cette opération utilise uniquement les en-têtes de réponse qui sont communs à la plupart des réponses. Pour plus d'informations sur les en-têtes de réponse communs, consultez En-têtes de réponse communs.

Corps de la requête

Cette opération n'a pas de corps de demande.

Réponses

Syntaxe


HTTP/1.1 200 OK
x-amzn-RequestId: x-amzn-RequestId
Date: Date
Location: Location 
Content-Type: application/json
Content-Length: Length

{
    "JobList": [
        {
            "Action": "string",
            "ArchiveId": "string",
            "ArchiveSHA256TreeHash": "string",
            "ArchiveSizeInBytes": number,
            "Completed": boolean,
            "CompletionDate": "string",
            "CreationDate": "string",
            "InventoryRetrievalParameters": {
                "EndDate": "string",
                "Format": "string",
                "Limit": "string",
                "Marker": "string",
                "StartDate": "string"
            },
            "InventorySizeInBytes": number,
            "JobDescription": "string",
            "JobId": "string",
            "JobOutputPath": "string",
            "OutputLocation": {
                "S3": {
                    "AccessControlList": [
                        {
                            "Grantee": {
                                "DisplayName": "string",
                                "EmailAddress": "string",
                                "ID": "string",
                                "Type": "string",
                                "URI": "string"
                            },
                            "Permission": "string"
                        }
                    ],
                    "BucketName": "string",
                    "CannedACL": "string",
                    "Encryption": {
                        "EncryptionType": "string",
                        "KMSContext": "string",
                        "KMSKeyId": "string"
                    },
                    "Prefix": "string",
                    "StorageClass": "string",
                    "Tagging": {
                        "string": "string"
                    },
                    "UserMetadata": {
                        "string": "string"
                    }
                }
            },
            "RetrievalByteRange": "string",
            "SelectParameters": {
                "Expression": "string",
                "ExpressionType": "string",
                "InputSerialization": {
                    "csv": {
                        "Comments": "string",
                        "FieldDelimiter": "string",
                        "FileHeaderInfo": "string",
                        "QuoteCharacter": "string",
                        "QuoteEscapeCharacter": "string",
                        "RecordDelimiter": "string"
                    }
                },
                "OutputSerialization": {
                    "csv": {
                        "FieldDelimiter": "string",
                        "QuoteCharacter": "string",
                        "QuoteEscapeCharacter": "string",
                        "QuoteFields": "string",
                        "RecordDelimiter": "string"
                    }
                }
            },
            "SHA256TreeHash": "string",
            "SNSTopic": "string",
            "StatusCode": "string",
            "StatusMessage": "string",
            "Tier": "string",
            "VaultARN": "string"
        }
    ],
    "Marker": "string"
}

En-têtes de réponse

Corps de la réponse

Le corps de la réponse contient les champs JSON suivants.

JobList

Liste d'objets de tâche. Chaque objet de tâche contient des métadonnées décrivant la tâche.

Type : tableau d'objets GlacierJobDescription

Marker

Chaîne opaque représentant l'endroit à partir duquel poursuivre la pagination des résultats. Vous utilisez la valeur marker dans une nouvelle demande List Jobs afin d'obtenir davantage de tâches dans la liste. S'il n'y a pas d'autres tâches à afficher, cette valeur est null.

Type : chaîne

Erreurs

Pour en savoir plus sur les exceptions et les messages d'erreur Amazon S3 Glacier, consultez Réponses d'erreur.

Exemples

Les exemples suivants décrivent comment renvoyer des informations relatives à des tâches de coffre. Le premier exemple renvoie une liste comprenant deux tâches et le deuxième exemple renvoie un sous-ensemble de tâches.

Exemple : Renvoi de toutes les tâches

Exemple de requête

La demande GET suivante renvoie les tâches associées à un coffre.


GET /-/vaults/examplevault/jobs  HTTP/1.1
Host: glacier.us-west-2.amazonaws.com
x-amz-Date: 20170210T120000Z
x-amz-glacier-version: 2012-06-01
Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20141123/us-west-2/glacier/aws4_request,SignedHeaders=host;x-amz-date;x-amz-glacier-version,Signature=9257c16da6b25a715ce900a5b45b03da0447acf430195dcb540091b12966f2a2

Exemple de réponse

La réponse suivante inclut une tâche d'extraction d'archive et une tâche d'extraction d'inventaire qui contient un marqueur permettant de poursuivre la pagination de l'extraction d'inventaire de coffre. La réponse illustre également le champ Marker défini sur null, ce qui signifie qu'il n'y a pas d'autres tâches à afficher.


HTTP/1.1 200 OK
x-amzn-RequestId: AAABZpJrTyioDC_HsOmHae8EZp_uBSJr6cnGOLKp_XJCl-Q
Date: Wed, 10 Feb 2017 12:00:00 GMT 
Content-Type: application/json
Content-Length: 1444

{
  "JobList": [
    {
      "Action": "ArchiveRetrieval",
      "ArchiveId": "BDfaUQul0dVzYwAMr8YSa_6_8abbhZq-i1oT69g8ByClfJyBgAGBkWl2QbF5os851P7Y7KdZDOHWJIn4rh1ZHaOYD3MgFhK_g0oDPesW34uHQoVGwoIqubf6BgUEfQm_wrU4Jlm3cA",
      "ArchiveSizeInBytes": 1048576,
      "ArchiveSHA256TreeHash": "25499381569ab2f85e1fd0eb93c5406a178ab77c5933056eb5d6e7d4adda609b",
      "Completed": true,
      "CompletionDate": "2012-05-01T00:00:09.304Z",
      "CreationDate": "2012-05-01T00:00:06.663Z",
      "InventorySizeInBytes": null,
      "JobDescription": null,
      "JobId": "hDe9t9DTHXqFw8sBGpLQQOmIM0-JrGtu1O_YFKLnzQ64548qJc667BRWTwBLZC76Ygy1jHYruqXkdcAhRsh0hYv4eVRU",
      "RetrievalByteRange": "0-1048575",
      "SHA256TreeHash": "25499381569ab2f85e1fd0eb93c5406a178ab77c5933056eb5d6e7d4adda609b",
      "SNSTopic": null,
      "StatusCode": "Succeeded",
      "StatusMessage": "Succeeded",
      "Tier": "Bulk",
      "VaultARN": "arn:aws:glacier:us-west-2:012345678901:vaults/examplevault"
    },
    {
      "Action": "InventoryRetrieval",
      "ArchiveId": null,
      "ArchiveSizeInBytes": null,
      "ArchiveSHA256TreeHash": null,
      "Completed": true,
      "CompletionDate": "2013-05-11T00:25:18.831Z",
      "CreationDate": "2013-05-11T00:25:14.981Z",
      "InventorySizeInBytes": 1988,
      "JobDescription": null,
      "JobId": "2cvVOnBL36btzyP3pobwIceiaJebM1bx9vZOOUtmNAr0KaVZ4WkWgVjiPldJ73VU7imlm0pnZriBVBebnqaAcirZq_C5",
      "RetrievalByteRange": null,
      "SHA256TreeHash": null,
      "SNSTopic": null,
      "StatusCode": "Succeeded",
      "StatusMessage": "Succeeded",
      "VaultARN": "arn:aws:glacier:us-west-2:012345678901:vaults/examplevault"
      "InventoryRetrievalParameters": {
          "StartDate": "2013-11-12T13:43:12Z",
          "EndDate": "2013-11-20T08:12:45Z", 
          "Limit": "120000",
          "Format": "JSON",
          "Marker": "vyS0t2jHQe5qbcDggIeD50chS1SXwYMrkVKo0KHiTUjEYxBGCqRLKaiySzdN7QXGVVV5XZpNVG67pCZ_uykQXFMLaxOSu2hO_-5C0AtWMDrfo7LgVOyfnveDRuOSecUo3Ueq7K0"
    }
  ],
  "Marker": null  
}

Exemple : Renvoi d'une liste partielle de tâches

Exemple de requête

La demande GET suivante renvoie la tâche spécifiée par le paramètre marker. Définir le paramètre limit avec la valeur permet de spécifier que deux tâches au maximum peuvent être renvoyées.2


GET /-/vaults/examplevault/jobs?marker=HkF9p6o7yjhFx-K3CGl6fuSm6VzW9T7esGQfco8nUXVYwS0jlb5gq1JZ55yHgt5vP54ZShjoQzQVVh7vEXAMPLEjobID&limit=2  HTTP/1.1
Host: glacier.us-west-2.amazonaws.com
x-amz-Date: 20170210T120000Z
x-amz-glacier-version: 2012-06-01
Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20141123/us-west-2/glacier/aws4_request,SignedHeaders=host;x-amz-date;x-amz-glacier-version,Signature=9257c16da6b25a715ce900a5b45b03da0447acf430195dcb540091b12966f2a2

Exemple de réponse

La réponse suivante illustre deux tâches renvoyées et le champ Marker défini sur une valeur non null qui peut être utilisée afin de poursuivre la pagination de la liste de tâches.


HTTP/1.1 200 OK
x-amzn-RequestId: AAABZpJrTyioDC_HsOmHae8EZp_uBSJr6cnGOLKp_XJCl-Q
Date: Wed, 10 Feb 2017 12:00:00 GMT 
Content-Type: application/json
Content-Length: 1744

{
  "JobList": [
    {
      "Action": "ArchiveRetrieval",
      "ArchiveId": "58-3KpZfcMPUznvMZNPaKyJx9wODCsWTnqcjtx2CjKZ6b-XgxEuA8yvZOYTPQfd7gWR4GRm2XR08gcnWbLV4VPV_kDWtZJKi0TFhKKVPzwrZnA4-FXuIBfViYUIVveeiBE51FO4bvg",
      "ArchiveSizeInBytes": 8388608,
      "ArchiveSHA256TreeHash": "106086b256ddf0fedf3d9e72f461d5983a2566247ebe7e1949246bc61359b4f4",
      "Completed": true,
      "CompletionDate": "2012-05-01T00:25:20.043Z",
      "CreationDate": "2012-05-01T00:25:16.344Z",
      "InventorySizeInBytes": null,
      "JobDescription": "aaabbbccc",
      "JobId": "s4MvaNHIh6mOa1f8iY4ioG2921SDPihXxh3Kv0FBX-JbNPctpRvE4c2_BifuhdGLqEhGBNGeB6Ub-JMunR9JoVa8y1hQ",
      "RetrievalByteRange": "0-8388607",
      "SHA256TreeHash": "106086b256ddf0fedf3d9e72f461d5983a2566247ebe7e1949246bc61359b4f4",
      "SNSTopic": null,
      "StatusCode": "Succeeded",
      "StatusMessage": "Succeeded",
      "Tier": "Bulk",
      "VaultARN": "arn:aws:glacier:us-west-2:012345678901:vaults/examplevault"
    },
    {
      "Action": "ArchiveRetrieval",
      "ArchiveId": "2NVGpf83U6qB9M2u-Ihh61yoFLRDEoh7YLZWKBn80A2i1xG8uieBwGjAr4RkzOHA0E07ZjtI267R03Z-6Hxd8pyGQkBdciCSH1-Lw63Kx9qKpZbPCdU0uTW_WAdwF6lR6w8iSyKdvw",
      "ArchiveSizeInBytes": 1048576,
      "ArchiveSHA256TreeHash": "3d2ae052b2978727e0c51c0a5e32961c6a56650d1f2e4ceccab6472a5ed4a0",
      "Completed": true,
      "CompletionDate": "2012-05-01T16:59:48.444Z",
      "CreationDate": "2012-05-01T16:59:42.977Z",
      "InventorySizeInBytes": null,
      "JobDescription": "aaabbbccc",
      "JobId": "CQ_tf6fOR4jrJCL61Mfk6VM03oY8lmnWK93KK4gLig1UPAbZiN3UV4G_5nq4AfmJHQ_dOMLOX5k8ItFv0wCPN0oaz5dG",
      "RetrievalByteRange": "0-1048575",
      "SHA256TreeHash": "3d2ae052b2978727e0c51c0a5e32961c6a56650d1f2e4ceccab6472a5ed4a0",
      "SNSTopic": null,
      "StatusCode": "Succeeded",
      "StatusMessage": "Succeeded",
      "Tier": "Standard",
      "VaultARN": "arn:aws:glacier:us-west-2:012345678901:vaults/examplevault"
    }
  ],
  "Marker": "CQ_tf6fOR4jrJCL61Mfk6VM03oY8lmnWK93KK4gLig1UPAbZiN3UV4G_5nq4AfmJHQ_dOMLOX5k8ItFv0wCPN0oaz5dG"
}

Avertissement JavaScript est désactivé ou n'est pas disponible dans votre navigateur.

Pour que vous puissiez utiliser la documentation AWS, Javascript doit être activé. Vous trouverez des instructions sur les pages d'aide de votre navigateur.

Conventions de rédaction

Lancement d'une tâche

Types de données utilisés dans les opérations de tâche