StartSearchJob - AWS Backup

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.

StartSearchJob

Cette opération crée une tâche de recherche qui renvoie les points de récupération filtrés par SearchScope et les éléments filtrés par ItemFilters.

Vous pouvez éventuellement inclure ClientToken EncryptionKeyArn, Nom, and/or Tags.

Syntaxe de la demande

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

Paramètres de demande URI

La demande n’utilise pas de paramètres URI.

Corps de la demande

Cette demande accepte les données suivantes au format JSON.

ClientToken

Incluez ce paramètre pour autoriser plusieurs appels identiques pour l'idempuissance.

Un jeton client est valide pendant 8 heures après la fin de la première demande l'utilisant. Passé ce délai, toute demande comportant le même jeton est traitée comme une nouvelle demande.

Type : chaîne

Obligatoire : non

EncryptionKeyArn

La clé de chiffrement pour la tâche de recherche spécifiée.

Type : chaîne

Obligatoire : non

ItemFilters

Les filtres d'éléments représentent toutes les propriétés des éléments d'entrée spécifiées lors de la création de la recherche.

Contient soit des EBSItem filtres, soit du S3 ItemFilters

Type : objet ItemFilters

Obligatoire : non

Name

Incluez des caractères alphanumériques pour créer un nom pour cette tâche de recherche.

Type : String

Contraintes de longueur : longueur minimum de 0. Longueur maximale de 500.

Obligatoire : non

SearchScope

Cet objet peut contenir BackupResourceTypes,, BackupResourceArns BackupResourceCreationTime BackupResourceTags, et SourceResourceArns pour filtrer les points de récupération renvoyés par la tâche de recherche.

Type : objet SearchScope

Obligatoire : oui

Tags

Liste des balises renvoyées par l'opération.

Type : mappage chaîne/chaîne

Obligatoire : non

Syntaxe de la réponse

HTTP/1.1 200 Content-type: application/json { "CreationTime": number, "SearchJobArn": "string", "SearchJobIdentifier": "string" }

Eléments de réponse

Si l’action aboutit, le service renvoie une réponse HTTP 200.

Les données suivantes sont renvoyées au format JSON par le service.

CreationTime

Date et heure de création d'une tâche, au format Unix et en temps universel coordonné (UTC). La valeur de CompletionTime est précise en millisecondes. Par exemple, la valeur 1516925490,087 représente le vendredi 26 janvier 2018 à 00 h 11 m 30,087 s.

Type : Timestamp

SearchJobArn

Chaîne unique qui identifie le nom de ressource Amazon (ARN) de la tâche de recherche spécifiée.

Type : String

SearchJobIdentifier

Chaîne unique qui spécifie la tâche de recherche.

Type : String

Erreurs

Pour plus d'informations sur les erreurs courantes pour toutes les actions, consultez Erreurs courantes.

AccessDeniedException

Vous ne disposez pas d’un accès suffisant pour effectuer cette action.

message

L'utilisateur ne dispose pas d'un accès suffisant pour effectuer cette action.

Code d’état HTTP : 403

ConflictException

Cette exception se produit lorsqu'un conflit avec une opération précédente réussie est détecté. Cela se produit généralement lorsque l'opération précédente n'a pas eu le temps de se propager à l'hôte qui répond à la demande en cours.

Une nouvelle tentative (avec une logique d'interruption appropriée) est la réponse recommandée à cette exception.

message

La mise à jour ou la suppression d'une ressource peut entraîner un état incohérent.

resourceId

Identifiant de la ressource affectée.

resourceType

Type de ressource affectée.

Code d’état HTTP : 409

InternalServerException

Une erreur interne du serveur s'est produite. Réessayez votre demande.

message

Erreur inattendue lors du traitement de la demande.

retryAfterSeconds

Réessayez l'appel après quelques secondes.

Code d’état HTTP : 500

ResourceNotFoundException

La ressource n'a pas été trouvée pour cette demande.

Vérifiez que les informations sur la ressource, telles que l'ARN ou le type, sont correctes et existent, puis réessayez la demande.

message

La requête fait référence à une ressource qui n'existe pas.

resourceId

Identifiant hypothétique de la ressource affectée.

resourceType

Type hypothétique de la ressource affectée.

Code d’état HTTP : 404

ServiceQuotaExceededException

La demande a été refusée en raison du dépassement des limites de quotas autorisées.

message

Cette demande n'a pas abouti en raison d'un quota de service dépassant les limites.

quotaCode

Il s'agit du code spécifique au type de quota.

resourceId

Identifiant de la ressource.

resourceType

Type de ressource.

serviceCode

Il s'agit du code propre au service d'origine avec le quota.

Code d'état HTTP : 402

ThrottlingException

La demande a été refusée suite à une limitation des demandes.

message

La demande a échoué en raison d'une limitation des demandes.

quotaCode

Il s'agit du code propre au service d'origine avec le quota.

retryAfterSeconds

Réessayez l'appel après quelques secondes.

serviceCode

Il s'agit du code propre au service d'origine.

Code d’état HTTP : 429

ValidationException

L'entrée ne satisfait pas les contraintes spécifiées par un service.

message

L'entrée ne répond pas aux contraintes spécifiées par un service Amazon.

Code d’état HTTP : 400

consultez aussi

Pour plus d'informations sur l'utilisation de cette API dans l'un des langages spécifiques AWS SDKs, consultez ce qui suit :