Describe Job (GET JobID)

Descrizione

Questa operazione restituisce informazioni su un processo avviato in precedenza, tra cui la data di avvio, l'utente che lo ha avviato, il codice/messaggio di stato del processo, e l'argomento di Amazon Simple Notification Service (Amazon SNS) a cui inviare la notifica dopo che Amazon S3 Glacier (S3 Glacier) ha completato il processo. Per ulteriori informazioni sull'avvio di un processo, consulta Initiate Job (POST jobs).

Nota

Questa operazione ti consente di verificare lo stato del processo. Tuttavia, consigliamo vivamente di configurare un argomento di Amazon SNS e specificarlo nella richiesta di avvio del processo, in modo che S3 Glacier possa inviare una notifica all'argomento dopo il completamento del processo.

Un ID processo è valido per almeno 24 ore dopo che S3 Glacier ha completato il processo.

Richieste

Sintassi

Per ottenere informazioni su un processo, utilizzi il metodo HTTP GET e definisci l'ambito della richiesta per il processo specifico. Nota che il percorso URI relativo è identico a quello che S3 Glacier ha restituito all'avvio del processo.

GET /AccountID/vaults/VaultName/jobs/JobID HTTP/1.1
Host: glacier.Region.amazonaws.com
Date: date
Authorization: signatureValue
x-amz-glacier-version: 2012-06-01

Nota

Il valore AccountId è l'ID dell'Account AWS dell'account proprietario del vault. Puoi specificare l'ID dell'Account AWS o eventualmente un "-" (trattino), nel qual caso Amazon S3 Glacier utilizza l'ID dell'Account AWS associato alle credenziali utilizzate per firmare la richiesta. Se utilizzi un ID account, non includere alcun trattino ("-") nell'ID.

Nota

Se ometti JobID nella richiesta, la risposta restituisce un elenco di tutti i processi attivi nel vault specificato. Per ulteriori informazioni sugli elenchi di processi, consulta List Jobs (GET jobs).

Parametri della richiesta

Questa operazione non utilizza parametri richiesta.

Intestazioni di richiesta

Questa operazione utilizza solo le intestazioni richiesta che sono comuni a tutte le operazioni. Per informazioni sulle intestazioni richiesta comuni, consulta Intestazioni di richiesta comuni.

Corpo della richiesta

Questa operazione non ha un corpo della richiesta.

Risposte

Sintassi

HTTP/1.1 201 Created
x-amzn-RequestId: x-amzn-RequestId
Date: Date
Content-Type: application/json
Content-Length: Length

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

Intestazioni di risposta

Questa operazione utilizza solo le intestazioni di risposta che sono comuni alla maggior parte delle risposte. Per informazioni sulle intestazioni di risposta comuni, consulta Intestazioni di risposta comuni.

Corpo della risposta

Il corpo della risposta contiene i campi JSON descritti di seguito.

Action

Il tipo di processo. Il valore è ArchiveRetrieval, InventoryRetrieval o Select.

Tipo: stringa

ArchiveId

L'ID archivio richiesto per un processo di recupero di archivio o Select. In caso contrario, il campo è null.

Tipo: stringa

ArchiveSHA256TreeHash

La struttura hash SHA256 dell'intero archivio per un processo di recupero di archivio. Per i processi di recupero di inventario, questo campo è null.

Tipo: stringa

ArchiveSizeInBytes

Per un processo ArchiveRetrieval, si tratta della dimensione in byte dell'archivio richiesto per il download. Per un processo InventoryRetrieval, il valore è null.

Tipo: numero

Completato

Stato del processo. Al completamento di un processo di recupero di archivio o inventario, puoi ottenere l'output del processo utilizzando Get Job Output (GET output).

Tipo: Booleano

CompletionDate

La data in formato UTC alla quale la richiesta di processo è stata completata. Quando il processo è in corso, il valore è null.

Tipo: stringa

CreationDate

La data di creazione del processo in formato UTC.

Tipo: una rappresentazione di stringa nel formato data ISO 8601, ad esempio 2013-03-20T17:03:43.221Z.

InventoryRetrievalParameters

I parametri di input utilizzati per un recupero di intervallo di inventario.

Tipo: oggetto InventoryRetrievalJobInput

InventorySizeInBytes

Per un processo InventoryRetrieval, si tratta della dimensione in byte dell'inventario richiesto per il download. Per un processo ArchiveRetrieval o Select, il valore è null.

Tipo: numero

JobDescription

La descrizione del processo che hai fornito all'avvio del processo.

Tipo: stringa

JobId

L'ID che identifica il processo in S3 Glacier.

Tipo: stringa

JobOutputPath

Contiene la posizione dell'output del processo.

Tipo: stringa

OutputLocation

Un oggetto che contiene informazioni sulla posizione in cui vengono archiviati i risultati e gli errori relativi al processo Select.

Tipo: oggetto OutputLocation

RetrievalByteRange

L'intervallo di byte recuperato per i processi di recupero di archivio nel formato "StartByteValue-EndByteValue". Se non specifichi un intervallo nel recupero dell'archivio, viene recuperato l'intero archivio; inoltre, StartByteValue è 0 e EndByteValue è uguale alla dimensione dell'archivio meno 1. Per i processi di recupero di inventario o Select, questo campo è null.

Tipo: stringa

SelectParameters

Un oggetto che contiene informazioni sui parametri utilizzati per una selezione.

Tipo: oggetto SelectParameters

SHA256TreeHash

Il valore della struttura hash SHA256 per l'intervallo richiesto di un archivio. Se nella richiesta Initiate Job (POST jobs) per un archivio è stato specificato un intervallo allineato alla struttura hash questo campo restituisce un valore. Per ulteriori informazioni sull'allineamento alla struttura hash per recuperi di intervallo di archivio, consulta Ottenimento di checksum durante il download di dati.

Per i casi in cui viene recuperato l'intero archivio, questo valore è identico al valore di ArchiveSHA256TreeHash.

Questo campo è null nei seguenti casi:

• Processi di recupero di archivio che specificano un intervallo non allineato alla struttura hash.

• Processi di archivio che specificano un intervallo corrispondente all'intero archivio e il cui stato è InProgress.

• ÄProcessi di inventario.

• Processi Select.

Tipo: stringa

SNSTopic

Un argomento di Amazon SNS che riceve notifiche.

Tipo: stringa

StatusCode

Il codice indicante lo stato del processo.

Valori validi: InProgress | Succeeded | Failed

Tipo: stringa

StatusMessage

Un messaggio che descrive lo stato del processo.

Tipo: stringa

Livello

Il livello di accesso ai dati da utilizzare per il processo di recupero di archivio o Select.

Valori validi: Bulk | Expedited | Standard

Tipo: stringa

VaultARN

L'ARN del vault di cui il processo è una sottorisorsa.

Tipo: stringa

Errori

Per informazioni sulle eccezioni e i messaggi di errore di Amazon S3 Glacier, consulta Risposte agli errori.

Esempi

L'esempio seguente mostra la richiesta per un processo che recupera un archivio.

Richiesta di esempio: ottenimento della descrizione di un processo

GET /-/vaults/examplevault/jobs/HkF9p6o7yjhFx-K3CGl6fuSm6VzW9T7esGQfco8nUXVYwS0jlb5gq1JZ55yHgt5vP54ZShjoQzQVVh7vEXAMPLEjobID 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

Risposta di esempio

Il corpo della risposta include codice JSON che descrive il processo specificato. Nota che per i processi di recupero di inventario e di archivio, i campi JSON sono identici. Tuttavia, quando un campo non si applica al tipo di processo, il relativo valore è null. Di seguito è riportata una risposta di esempio per un processo di recupero di archivio. Tieni presente quanto segue:

• Il valore del campo Action è ArchiveRetrieval.

• Il campo ArchiveSizeInBytes indica la dimensione dell'archivio richiesto nel processo di recupero di archivio.

• Il campo ArchiveSHA256TreeHash indica la struttura hash SHA256 dell'intero archivio.

• Il campo RetrievalByteRange indica l'intervallo desiderato nella richiesta Initiate Job. In questo esempio, viene richiesto l'intero archivio.

• Il campo SHA256TreeHash indica la struttura hash SHA256 dell'intervallo desiderato nella richiesta Initiate Job. In questo esempio, è identico al campo ArchiveSHA256TreeHash, il che significa che è stato richiesto l'intero archivio.

• Il valore del campo InventorySizeInBytes è null in quanto non si applica a un processo di recupero di archivio.

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: 419
{
  "Action": "ArchiveRetrieval",
  "ArchiveId": "NkbByEejwEggmBz2fTHgJrg0XBoDfjP4q6iu87-TjhqG6eGoOY9Z8i1_AUyUsuhPAdTqLHy8pTl5nfCFJmDl2yEZONi5L26Omw12vcs01MNGntHEQL8MBfGlqrEXAMPLEArchiveId",
  "ArchiveSizeInBytes": 16777216,
  "ArchiveSHA256TreeHash": "beb0fe31a1c7ca8c6c04d574ea906e3f97b31fdca7571defb5b44dca89b5af60",
  "Completed": false,
  "CompletionDate": null,
  "CreationDate": "2012-05-15T17:21:39.339Z",
  "InventorySizeInBytes": null,
  "JobDescription": "My ArchiveRetrieval Job",
  "JobId": "HkF9p6o7yjhFx-K3CGl6fuSm6VzW9T7esGQfco8nUXVYwS0jlb5gq1JZ55yHgt5vP54ZShjoQzQVVh7vEXAMPLEjobID",
  "RetrievalByteRange": "0-16777215",
  "SHA256TreeHash": "beb0fe31a1c7ca8c6c04d574ea906e3f97b31fdca7571defb5b44dca89b5af60",
  "SNSTopic": "arn:aws:sns:us-west-2:012345678901:mytopic",
  "StatusCode": "InProgress",
  "StatusMessage": "Operation in progress.",
  "Tier": "Bulk",
  "VaultARN": "arn:aws:glacier:us-west-2:012345678901:vaults/examplevault"
} 

Di seguito è riportata una risposta di esempio per un processo di recupero di inventario. Tieni presente quanto segue:

• Il valore del campo Action è InventoryRetrieval.

• I valori dei campi ArchiveSizeInBytes, ArchiveSHA256TreeHash e RetrievalByteRange sono null in quanto questi campi non si applicano a un processo di recupero di inventario.

• Il valore del campo InventorySizeInBytes è null in quanto il processo è ancora in corso e non ha preparato completamente l'inventario per il download. Se il processo fosse completato prima della richiesta Describe Job, questo campo indicherebbe la dimensione dell'output.

{
   "Action": "InventoryRetrieval",
   "ArchiveId": null,
   "ArchiveSizeInBytes": null,
   "ArchiveSHA256TreeHash": null,
   "Completed": false,
   "CompletionDate": null,
   "CreationDate": "2012-05-15T23:18:13.224Z",
   "InventorySizeInBytes": null,
   "JobDescription": "Inventory Description",
   "JobId": "HkF9p6o7yjhFx-K3CGl6fuSm6VzW9T7esGQfco8nUXVYwS0jlb5gq1JZ55yHgt5vP54ZShjoQzQVVh7vEXAMPLEjobID",
   "RetrievalByteRange": null,
   "SHA256TreeHash": null,
   "SNSTopic": "arn:aws:sns:us-west-2:012345678901:mytopic",
   "StatusCode": "InProgress",
   "StatusMessage": "Operation in progress.",
   "VaultARN": "arn:aws:glacier:us-west-2:012345678901:vaults/examplevault"
}

Di seguito viene fornita una risposta di esempio per un processo di recupero di archivio completato che contiene un contrassegno utilizzato per continuare la paginazione del recupero di inventario vault.

{ 
    "Action": "InventoryRetrieval", 
    "ArchiveId": null, 
    "ArchiveSHA256TreeHash": null, 
    "ArchiveSizeInBytes": null, 
    "Completed": true, 
    "CompletionDate": "2013-12-05T21:51:13.591Z", 
    "CreationDate": "2013-12-05T21:51:12.281Z", 
    "InventorySizeInBytes": 777062, 
    "JobDescription": null, 
    "JobId": "sCC2RZNBF2nildYD_roe0J9bHRdPQUbDRkmTdg-mXi2u3lc49uW6TcEhDF2D9pB2phx-BN30JaBru7PMyOlfXHdStzu8", 
    "NextInventoryRetrievalMarker": null, 
    "RetrievalByteRange": null, 
    "SHA256TreeHash": null, 
    "SNSTopic": null, 
    "StatusCode": "Succeeded", 
    "StatusMessage": "Succeeded", 
    "Tier": "Bulk",
    "VaultARN": "arn:aws:glacier-devo:us-west-2:836579025725:vaults/inventory-icecube-2", 
    "InventoryRetrievalParameters": {
        "StartDate": "2013-11-12T13:43:12Z",
        "EndDate": "2013-11-20T08:12:45Z", 
        "Limit": "120000",
        "Format": "JSON",
        "Marker": "vyS0t2jHQe5qbcDggIeD50chS1SXwYMrkVKo0KHiTUjEYxBGCqRLKaiySzdN7QXGVVV5XZpNVG67pCZ_uykQXFMLaxOSu2hO_-5C0AtWMDrfo7LgVOyfnveDRuOSecUo3Ueq7K0"
    },   
}

Sezioni correlate

• Get Job Output (GET output)

• Identity and Access Management per Amazon S3 Glacier