List Jobs (GET jobs) - Amazon S3 Glacier
DescriçãoSolicitaçõesRespostasExemplosSeções relacionadas

Esta página destina-se somente a clientes atuais do serviço S3 Glacier que usam cofres e a API REST original de 2012.

Se você estiver procurando soluções de armazenamento de arquivos, sugerimos usar as classes de armazenamento do S3 Glacier no Amazon S3: S3 Glacier Instant Retrieval, S3 Glacier Flexible Retrieval e S3 Glacier Deep Archive. Para saber mais sobre essas opções de armazenamento, consulte Classes de armazenamento do Amazon S3 Glacier e Noções básicas sobre as classes de armazenamento S3 Glacier para armazenamento de dados de longo prazo no Guia do usuário do Amazon S3. Essas classes de armazenamento usam a API do Amazon S3, estão disponíveis em todas as regiões e podem ser gerenciadas no console do Amazon S3. Elas oferecem análise de custos de armazenamento, Lente de Armazenamento, recursos avançados de criptografia opcionais e muito mais.

As traduções são geradas por tradução automática. Em caso de conflito entre o conteúdo da tradução e da versão original em inglês, a versão em inglês prevalecerá.

List Jobs (GET jobs)

Descrição

Essa operação lista trabalhos de um cofre, incluindo os trabalhos em andamento e os que foram concluídos recentemente.

nota

O Amazon S3 Glacier (S3 Glacier) mantém trabalhos concluídos recentemente por um período antes de excluí-los; no entanto, ele acaba removendo os trabalhos concluídos. A saída de trabalhos concluídos pode ser recuperada. Manter os trabalhos por um período após eles terem sido concluídos permite obter uma saída de trabalho caso você perca a notificação de conclusão do trabalho ou caso a primeira tentativa de download apresente falha. Por exemplo, suponhamos que você inicie um trabalho de recuperação de arquivo para fazer download de um arquivo. Depois que o trabalho é concluído, você começa a fazer download do arquivo, mas encontra um erro de rede. Nesse cenário, você poderá tentar novamente e fazer download do arquivo enquanto o trabalho existir.

A operação List Jobs oferece suporte à paginação. Você deve sempre verificar o campo de resposta Marker. Se não houver mais trabalhos a serem listados, o campo Marker será definido como null. Se houver mais trabalhos a serem listados, o campo Marker será definido como um valor não nulo, que você pode usar para continuar a paginação da lista. Para retornar uma lista de trabalhos que comece em um específico, defina o parâmetro de solicitação marker como o valor Marker para esse trabalho que você obteve de uma List Jobssolicitação anterior.

Você pode definir um limite máximo para o número de trabalhos retornados na resposta especificando o parâmetro limit na solicitação. O limite padrão é 50. O número de trabalhos retornados pode ser menor que o limite, mas o número de trabalhos retornados jamais excede o limite.

Além disso, você pode filtrar a lista de trabalhos retornados especificando o parâmetro statuscode opcional ou o parâmetro completed, ou ambos. Usando o parâmetro statuscode, você pode especificar para retornar somente trabalhos correspondentes ao status InProgress, Succeeded ou Failed. Usando o completed parâmetro, você pode especificar para retornar somente trabalhos que tenham sido concluídos (true) ou trabalhos que não tenham sido concluídos (false).

Solicitações

Sintaxe

Para retornar uma lista de trabalhos de todos os tipos, envie uma solicitação GET para o URI do sub-recurso jobs do cofre.

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

nota

O AccountId valor é o Conta da AWS ID da conta proprietária do cofre. Você pode especificar uma Conta da AWS ID ou, opcionalmente, um único '-' (hífen). Nesse caso, o Amazon S3 Glacier usa Conta da AWS a ID associada às credenciais usadas para assinar a solicitação. Se você usar um ID de conta, não inclua nenhum hífen ('-') no ID.

Parâmetros de solicitação

Nome Descrição Obrigatório
completed

O estado dos trabalhos a serem retornados. É possível especificar true ou false.

Tipo: booliano

Restrições: nenhuma

 Não
limit

O número máximo de trabalhos a serem retornados. O limite padrão é 50. O número de trabalhos retornados pode ser menor que o limite especificado, mas o número de trabalhos retornados jamais excede o limite.

Tipo: string

Restrições: valor do inteiro mínimo de 1. Valor do inteiro máximo de 50.

 Não
marker

Uma string invisível usada na paginação que especifica o trabalho no qual a listagem dos trabalhos deve começar. Você obtém o valor marker de uma List Jobsresposta anterior. Você somente precisará incluir o marker se continuar a paginação dos resultados iniciada em uma List Jobssolicitação anterior.

Tipo: string

Restrições: nenhuma

 Não
statuscode

O tipo de status do trabalho a ser retornado.

Tipo: string

Restrições: um dos valores InProgress, Succeeded ou Failed.

 Não

Cabeçalhos de solicitação

Essa operação usa somente os cabeçalhos de resposta que são comuns a maioria das respostas. Para informações sobre os cabeçalhos de resposta comuns, consulte Cabeçalhos de resposta comuns.

Corpo da Solicitação

Essa operação não tem um corpo de solicitação.

Respostas

Sintaxe

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

Cabeçalhos de resposta

Essa operação usa somente os cabeçalhos de resposta que são comuns a maioria das respostas. Para informações sobre os cabeçalhos de resposta comuns, consulte Cabeçalhos de resposta comuns.

Corpo da resposta

O corpo da resposta contém os seguintes campos JSON.

JobList

Uma lista de objetos de trabalho. Cada objeto de trabalho contém metadados que descrevem o trabalho.

Tipo: matriz de objetos GlacierJobDescription

Marker

Uma string invisível que representa onde continuar a paginação dos resultados. Você usa o valor marker em uma nova List Jobssolicitação para obter mais trabalhos na lista. Se não houver mais trabalhos a serem listados, esse valor será null.

Type: string

Erros

Para obter informações sobre exceções e mensagens de erro do Amazon S3 Glacier, consulte Respostas de erro.

Exemplos

Os exemplos a seguir demonstram como retornar informações sobre trabalhos de cofre. O primeiro exemplo retorna uma lista de dois trabalhos, e o segundo exemplo retorna um subconjunto de trabalhos.

Exemplo: retornar todos os trabalhos

Exemplo de solicitação

A solicitação GET a seguir retorna os trabalhos de um cofre. 

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

Exemplo de resposta

A resposta a seguir inclui um trabalho de recuperação de arquivo e um trabalho de recuperação de inventário que contém um marcador usado para continuar a paginação da recuperação do inventário de cofre. A resposta também mostra o campo Marker definido como null, o que indica que não há mais trabalhos a serem listados.

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  
}

Exemplo: retornar uma lista parcial de trabalhos

Exemplo de solicitação

A solicitação GET a seguir retorna o trabalho especificado pelo parâmetro marker. Definir o limitparâmetro como 2especifica que até dois trabalhos são retornados.

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

Exemplo de resposta

A resposta a seguir mostra dois trabalhos retornados e o campo Marker definido como um valor não nulo que pode ser usado para continuar a paginação da lista de trabalhos.

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