StartSearchJob - AWS Backup
AnforderungssyntaxURI-AnfrageparameterAnforderungstextAntwortsyntaxAntwortelementeFehlerWeitere Informationen finden Sie unter:

Die vorliegende Übersetzung wurde maschinell erstellt. Im Falle eines Konflikts oder eines Widerspruchs zwischen dieser übersetzten Fassung und der englischen Fassung (einschließlich infolge von Verzögerungen bei der Übersetzung) ist die englische Fassung maßgeblich.

StartSearchJob

Dieser Vorgang erstellt einen Suchauftrag, der Wiederherstellungspunkte, gefiltert nach, SearchScope und Elemente, nach denen gefiltert wurde, zurückgibt ItemFilters.

Sie können optional ClientToken, EncryptionKeyArn, Name und and/or Tags angeben.

Anforderungssyntax

PUT /search-jobs HTTP/1.1
Content-type: application/json

{
   "ClientToken": "string",
   "EncryptionKeyArn": "string",
   "ItemFilters": { 
      "EBSItemFilters": [ 
         { 
            "CreationTimes": [ 
               { 
                  "Operator": "string",
                  "Value": number
               }
            ],
            "FilePaths": [ 
               { 
                  "Operator": "string",
                  "Value": "string"
               }
            ],
            "LastModificationTimes": [ 
               { 
                  "Operator": "string",
                  "Value": number
               }
            ],
            "Sizes": [ 
               { 
                  "Operator": "string",
                  "Value": number
               }
            ]
         }
      ],
      "S3ItemFilters": [ 
         { 
            "CreationTimes": [ 
               { 
                  "Operator": "string",
                  "Value": number
               }
            ],
            "ETags": [ 
               { 
                  "Operator": "string",
                  "Value": "string"
               }
            ],
            "ObjectKeys": [ 
               { 
                  "Operator": "string",
                  "Value": "string"
               }
            ],
            "Sizes": [ 
               { 
                  "Operator": "string",
                  "Value": number
               }
            ],
            "VersionIds": [ 
               { 
                  "Operator": "string",
                  "Value": "string"
               }
            ]
         }
      ]
   },
   "Name": "string",
   "SearchScope": { 
      "BackupResourceArns": [ "string" ],
      "BackupResourceCreationTime": { 
         "CreatedAfter": number,
         "CreatedBefore": number
      },
      "BackupResourceTags": { 
         "string" : "string" 
      },
      "BackupResourceTypes": [ "string" ],
      "SourceResourceArns": [ "string" ]
   },
   "Tags": { 
      "string" : "string" 
   }
}

URI-Anfrageparameter

Die Anforderung verwendet keine URI-Parameter.

Anforderungstext

Die Anforderung akzeptiert die folgenden Daten im JSON-Format.

ClientToken

Fügen Sie diesen Parameter hinzu, um mehrere identische Aufrufe für Idempotenz zuzulassen.

Ein Client-Token ist 8 Stunden lang gültig, nachdem die erste Anfrage, die es verwendet, abgeschlossen wurde. Nach Ablauf dieser Zeit wird jede Anfrage mit demselben Token als neue Anfrage behandelt.

Typ: Zeichenfolge

Erforderlich: Nein

EncryptionKeyArn

Der Verschlüsselungsschlüssel für den angegebenen Suchauftrag.

Typ: Zeichenfolge

Erforderlich: Nein

ItemFilters

Elementfilter stellen alle Eigenschaften des Eingabeelements dar, die bei der Erstellung der Suche angegeben wurden.

Enthält entweder EBSItem Filter oder S3 ItemFilters

Typ: ItemFilters Objekt

Erforderlich: Nein

Name

Fügen Sie alphanumerische Zeichen ein, um einen Namen für diesen Suchauftrag zu erstellen.

Typ: Zeichenfolge

Längenbeschränkungen: Minimale Länge von 0. Maximale Länge beträgt 500 Zeichen.

Erforderlich: Nein

SearchScope

Dieses Objekt kann BackupResourceTypes,, BackupResourceArns, und enthalten BackupResourceCreationTime BackupResourceTags, SourceResourceArns um die vom Suchauftrag zurückgegebenen Wiederherstellungspunkte zu filtern.

Typ: SearchScope Objekt

Erforderlich: Ja

Tags

Liste der von der Operation zurückgegebenen Tags.

Typ: Abbildung einer Zeichenfolge auf eine Zeichenfolge

Erforderlich: Nein

Antwortsyntax

HTTP/1.1 200
Content-type: application/json

{
   "CreationTime": number,
   "SearchJobArn": "string",
   "SearchJobIdentifier": "string"
}

Antwortelemente

Wenn die Aktion erfolgreich ist, sendet der Service eine HTTP 200-Antwort zurück.

Die folgenden Daten werden vom Service im JSON-Format zurückgegeben.

CreationTime

Datum und Uhrzeit der Erstellung eines Jobs im Unix-Format und in koordinierter Weltzeit (UTC). Der Wert von CompletionTime ist auf Millisekunden genau. Der Wert 1516925490.087 steht beispielsweise für Freitag, 26. Januar 2018, 12:11:30.087 Uhr.

Typ: Zeitstempel

SearchJobArn

Die eindeutige Zeichenfolge, die den Amazon-Ressourcennamen (ARN) des angegebenen Suchauftrags identifiziert.

Typ: Zeichenfolge

SearchJobIdentifier

Die eindeutige Zeichenfolge, die den Suchauftrag spezifiziert.

Typ: Zeichenfolge

Fehler

Weitere Informationen zu den allgemeinen Fehlern, die bei allen Aktionen zurückgegeben werden, finden Sie unter Häufige Fehler.

AccessDeniedException

Sie haben keinen ausreichenden Zugriff zum Durchführen dieser Aktion.

message

Der Benutzer verfügt nicht über ausreichende Zugriffsrechte, um diese Aktion auszuführen.

HTTP Status Code: 403

ConflictException

Diese Ausnahme tritt auf, wenn ein Konflikt mit einem vorherigen erfolgreichen Vorgang erkannt wird. Dies tritt im Allgemeinen auf, wenn der vorherige Vorgang keine Zeit hatte, sich an den Host zu übertragen, der die aktuelle Anforderung bedient.

Ein erneuter Versuch (mit entsprechender Backoff-Logik) ist die empfohlene Reaktion auf diese Ausnahme.

message

Das Aktualisieren oder Löschen einer Ressource kann zu einem inkonsistenten Zustand führen.

resourceId

Kennung der betroffenen Ressource.

resourceType

Typ der betroffenen Ressource.

HTTP-Statuscode: 409

InternalServerException

Es ist ein interner Serverfehler aufgetreten. Wiederholen Sie Ihre Anforderung.

message

Unerwarteter Fehler bei der Bearbeitung der Anfrage.

retryAfterSeconds

Versuchen Sie den Anruf nach einigen Sekunden erneut.

HTTP Status Code: 500

ResourceNotFoundException

Die Ressource wurde für diese Anfrage nicht gefunden.

Vergewissern Sie sich, dass die Ressourceninformationen, wie z. B. der ARN oder der Typ, korrekt und vorhanden sind, und versuchen Sie dann erneut, die Anfrage zu starten.

message

Die Anfrage verweist auf eine Ressource, die nicht existiert.

resourceId

Hypothetischer Identifier der betroffenen Ressource.

resourceType

Hypothetischer Typ der betroffenen Ressource.

HTTP Status Code: 404

ServiceQuotaExceededException

Die Anfrage wurde aufgrund der Überschreitung der zulässigen Kontingentgrenzen abgelehnt.

message

Diese Anfrage war nicht erfolgreich, da ein Dienstkontingent die Grenzwerte überschritten hat.

quotaCode

Dies ist der Code, der für den Kontingenttyp spezifisch ist.

resourceId

Bezeichner der Ressource.

resourceType

Typ der Ressource.

serviceCode

Dies ist der eindeutige Code für den ursprünglichen Dienst mit dem Kontingent.

HTTP-Statuscode: 402

ThrottlingException

Die Anforderung wurde aufgrund der Drosselung von Anforderungen abgelehnt.

message

Die Anfrage war aufgrund der Drosselung der Anfrage nicht erfolgreich.

quotaCode

Dies ist der eindeutige Code für den ursprünglichen Dienst mit dem Kontingent.

retryAfterSeconds

Versuchen Sie den Anruf nach einigen Sekunden erneut.

serviceCode

Dies ist der eindeutige Code für den ursprünglichen Dienst.

HTTP-Statuscode: 429

ValidationException

Die Eingabe erfüllt nicht die von einem Dienst angegebenen Einschränkungen.

message

Die Eingabe erfüllt nicht die von einem Amazon-Service angegebenen Einschränkungen.

HTTP Status Code: 400

Weitere Informationen finden Sie unter:

Weitere Informationen zur Verwendung dieser API in einer der sprachspezifischen Sprachen AWS SDKs finden Sie im Folgenden: