Describe Job (GET JobID)

Beschreibung

Diese Operation gibt Informationen über einen Auftrag zurück, den Sie vorher initiiert haben, u. a. Datum der Initiierung des Auftrags, Benutzer, der den Auftrag initiiert hat, Auftragsstatuscode/-nachricht und Amazon Simple Notification Service (Amazon SNS)-Thema, das zu benachrichtigen ist, nachdem Amazon S3 Glacier (S3 Glacier) den Auftrag abgeschlossen hat. Weitere Informationen zur Initiierung eines Auftrags finden Sie unter Initiate Job (POST jobs).

Anmerkung

Mit dieser Operation können Sie den Status Ihres Auftrags prüfen. Wir empfehlen jedoch dringend, ein Amazon-SNS-Thema einzurichten und es in Ihrer Anforderung zur Auftragsinitiierung anzugeben, damit S3 Glacier das Thema benachrichtigen kann, nachdem der Auftrag abgeschlossen wurde.

Eine Auftrags-ID läuft mindestens 24 Stunden, nachdem S3 Glacier den Auftrag abgeschlossen hat, nicht ab.

Anforderungen

Syntax

Um Informationen zu einem Auftrag zu erhalten, verwenden Sie die HTTP-GET-Methode und beschränken Sie den Umfang der Anfrage auf den bestimmten Auftrag. Beachten Sie, dass der relative URI-Pfad derselbe ist wie der, den S3 Glacier zurückgegeben hat, als Sie den Auftrag initiiert haben.

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

Anmerkung

Der AccountId-Wert ist die AWS-Konto-ID des Kontos, dem der Tresor gehört. Sie können entweder eine AWS-Konto-ID oder optional einen einzelnen Bindestrich („-“) angeben. Bei Angabe eines Bindestrichs verwendet Amazon S3 Glacier die AWS-Konto-ID, die mit den zum Signieren der Anforderung verwendeten Anmeldeinformationen verknüpft ist. Wenn Sie eine Konto-ID verwenden, darf die ID keine Bindestriche („-“) enthalten.

Anmerkung

Wenn Sie in der Anfrage die JobID weglassen, gibt die Antwort eine Liste aller aktiven Aufträge für den angegebenen Tresor zurück. Weitere Informationen über das Auflisten von Aufträgen finden Sie unter Aufträge auflisten (GET jobs).

Anfrageparameter

Dieser Vorgang verwendet keine Anforderungsparameter.

Anforderungsheader

Für diesen Vorgang werden ausschließlich Anforderungs-Header verwendet, die für alle Vorgänge gelten. Weitere Informationen über allgemeine Anforderungs-Header finden Sie unter Häufig verwendete Anforderungsheader.

Anforderungstext

Dieser Vorgang besitzt keinen Anforderungstext.

Antworten

Syntax

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

Antwort-Header

Für diesen Vorgang werden ausschließlich Antwort-Header verwendet, die für die meisten Antworten gelten. Weitere Informationen über allgemeine Antwort-Header finden Sie unter Allgemeine Antwort-Header.

Antworttext

Der Antworttext enthält die folgenden JSON-Felder.

Action (Aktion)

Der Auftragstyp. Er ist entweder ArchiveRetrieval, InventoryRetrieval oder Select.

Typ: Zeichenfolge

ArchiveId

Die Archiv-ID, die für eine Auswahl oder einen Archivabruf angefordert wurde. Andernfalls ist dieses Feld null.

Typ: Zeichenfolge

ArchiveSHA256TreeHash

Der SHA256-Struktur-Hash des gesamten Archivs für einen Archivabrufauftrag. Für Inventarabrufaufträge ist dieses Feld null.

Typ: Zeichenfolge

ArchiveSizeInBytes

Für einen ArchiveRetrieval-Auftrag ist dies die Größe in Bytes des zum Herunterladen angeforderten Archivs. Für den InventoryRetrieval-Auftrag ist der Wert null.

Typ: Zahl

Completed

Der Auftragsstatus. Wenn ein Archiv- oder Inventarabrufauftrag abgeschlossen wurde, können Sie die Ausgabe des Auftrags über Get Job Output (GET output) abrufen.

Typ: Boolesch

CompletionDate

Uhrzeit der Fertigstellung der Auftragsanforderung in UTC (Universal Coordinated Time). Während der Auftrag in Bearbeitung ist, ist der Wert Null.

Typ: Zeichenfolge

CreationDate

Der Zeitpunkt (UTC) der Erstellung des Auftrags.

Typ: Eine Zeichenkettendarstellung im ISO 8601-Datumsformat, z. B. 2013-03-20T17:03:43.221Z.

InventoryRetrievalParameters

Die Eingabeparameter für die Inventarabfrage für einzelne Bereiche

Typ: InventoryRetrievalJobInput-Objekt

InventorySizeInBytes

Für einen InventoryRetrieval-Auftrag ist dies die Größe in Bytes des zum Herunterladen angeforderten Inventars. Für den ArchiveRetrieval- oder Select-Auftrag ist der Wert null.

Typ: Zahl

JobDescription

Die Auftragsbeschreibung, die Sie bei der Initiierung des Auftrags angegeben haben.

Typ: Zeichenfolge

JobId

Die ID, die den Auftrag in S3 Glacier identifiziert

Typ: Zeichenfolge

JobOutputPath

Enthält den Speicherort für die Auftragsausgabe.

Typ: Zeichenfolge

OutputLocation

Ein Objekt, das Informationen zum Speicherort der Ergebnisse und Fehler des ausgewählten Jobs enthält

Typ: OutputLocation-Objekt

RetrievalByteRange

Der abgerufene Bytebereich für Aufträge zum Abrufen von Archiven in der Form "StartByteValue-EndByteValue". Wenn Sie keinen Bereich angeben, wird das gesamte Archiv abgerufen. Auch ist der Wert StartByteValue gleich 0 und der Wert EndByteValue entspricht der Größe des Archivs minus 1. Für Inventarabruf- und Auswahlaufträge ist dieses Feld null.

Typ: Zeichenfolge

SelectParameters

Ein Objekt mit Informationen zu den Parametern für eine Auswahl

Typ: SelectParameters-Objekt

SHA256TreeHash

Der SHA256-Struktur-Hash-Wert für den angeforderten Bereich eines Archivs. Wenn in der Initiate Job (POST jobs)-Anfrage für ein Archiv ein mit dem Struktur-Hash abgeglichener Bereich angegeben wurde, gibt dieses Feld einen Wert zurück. Weitere Informationen zur Verwendung von mit dem Struktur-Hash abgeglichenen Bereichen beim Abrufen von Archivbereichen finden Sie unter Erhalten von Prüfsummen bei Daten-Download.

Wenn das gesamte Archiv abgerufen wird, ist dieser Wert mit dem ArchiveSHA256TreeHash-Wert identisch.

In den folgenden Situationen hat dieses Feld den Wert null.

• Aufträge zum Abruf von Archiven, die einen Bereich angeben, der nicht mit dem Struktur-Hash abgeglichen ist.

• Archivaufträge, die einen Bereich festlegen, der das gesamte Archiv einschließt, und deren Auftragsstatus InProgress lautet.

• Inventaraufträge.

• Wählen Sie die Aufträge aus.

Typ: Zeichenfolge

SNSTopic

Ein Amazon-SNS-Thema, das Benachrichtigungen empfängt

Typ: Zeichenfolge

StatusCode

Der Code, der den Status des Auftrags angibt

Zulässige Werte: InProgress | Succeeded | Failed

Typ: Zeichenfolge

StatusMessage

Eine freundliche Nachricht, die den Auftragsstatus beschreibt.

Typ: Zeichenfolge

Stufe

Das Datenzugriffskontingent, das für die Auswahl oder den Archivabruf verwendet wird

Zulässige Werte: Bulk | Expedited | Standard

Typ: Zeichenfolge

VaultARN

Der Amazon-Ressourcennamen (ARN) des Tresors, von dem der Auftrag eine Unterressource ist.

Typ: Zeichenfolge

Fehler

Weitere Informationen über Ausnahmen und Fehlermeldungen in Amazon S3 Glacier finden Sie unter Fehlermeldungen.

Beispiele

Das folgende Beispiel zeigt die Anfrage für einen Auftrag, der ein Archiv abruft.

Beispielanfrage: Auftragsbeschreibung abrufen

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

Beispielantwort

Der Antworttext enthält JSON zur Beschreibung des angegebenen Auftrags. Beachten Sie, dass für den Inventarabruf und für den Archivabruf die JSON-Felder gleich sind. Wenn jedoch ein Feld für den Auftragstyp nicht gültig ist, ist sein Wert null. Es folgt eine Beispielantwort auf einen Archivabrufauftrag. Beachten Sie Folgendes:

• Der Wert des Action-Felds ist ArchiveRetrieval.

• Das ArchiveSizeInBytes-Feld zeigt die Größe des im Archivabrufauftrag angeforderten Archivs.

• Das ArchiveSHA256TreeHash-Feld zeigt den SHA256-Struktur-Hash für das gesamte Archiv.

• Das RetrievalByteRange-Feld zeigt den in der Anfrage zur Auftragsinitiierung angeforderten Bereich. In diesem Beispiel wird das gesamte Archiv angefordert.

• Das SHA256TreeHash-Feld zeigt den SHA256-Struktur-Hash für den in der Anfrage zur Auftragsinitiierung angeforderten Bereich. In diesem Beispiel ist es gleich dem ArchiveSHA256TreeHash-Feld, das heißt, dass das gesamte Archiv angefordert wurde.

• Der Wert des InventorySizeInBytes-Felds ist null, weil es für einen Archivabrufauftrag nicht gültig ist.

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

Es folgt eine Beispielantwort auf einen Inventarabrufauftrag. Beachten Sie Folgendes:

• Der Wert des Action-Felds ist InventoryRetrieval.

• Die Werte der Felder ArchiveSizeInBytes, ArchiveSHA256TreeHash und RetrievalByteRange sind Null, weil diese Felder für einen Inventarabrufauftrag nicht gültig sind.

• Der Wert des InventorySizeInBytes-Felds ist null, weil der Auftrag noch in Bearbeitung ist und das Inventar noch nicht vollständig zum Herunterladen vorbereitet hat. Wenn der Auftrag vor Ihrer Anforderung zur Auftragsbeschreibung abgeschlossen war, zeigt dieses Feld Ihnen die Größe der Ausgabe an.

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

Es folgt eine Beispielantwort auf einen abgeschlossenen Inventarabrufauftrag mit einer Markierung, durch die die Paginierung des Tresorinventarabrufs fortgesetzt wird.

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

Zugehörige Abschnitte

• Get Job Output (GET output)

• Identitäts- und Zugriffsverwaltung für Amazon S3 Glacier