View a markdown version of this page

GetSearchJob - AWS Backup

Las traducciones son generadas a través de traducción automática. En caso de conflicto entre la traducción y la version original de inglés, prevalecerá la version en inglés.

GetSearchJob

Esta operación obtiene los metadatos de un trabajo de búsqueda, incluido su progreso.

Sintaxis de la solicitud

GET /search-jobs/SearchJobIdentifier HTTP/1.1

Parámetros de solicitud del URI

La solicitud utiliza los siguientes parámetros URI.

SearchJobIdentifier

Cadena única requerida que especifica el trabajo de búsqueda.

Obligatorio: sí

Cuerpo de la solicitud

La solicitud no tiene un cuerpo de la solicitud.

Sintaxis de la respuesta

HTTP/1.1 200 Content-type: application/json { "CompletionTime": number, "CreationTime": number, "CurrentSearchProgress": { "ItemsMatchedCount": number, "ItemsScannedCount": number, "RecoveryPointsScannedCount": number }, "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", "SearchJobArn": "string", "SearchJobIdentifier": "string", "SearchScope": { "BackupResourceArns": [ "string" ], "BackupResourceCreationTime": { "CreatedAfter": number, "CreatedBefore": number }, "BackupResourceTags": { "string" : "string" }, "BackupResourceTypes": [ "string" ], "SourceResourceArns": [ "string" ] }, "SearchScopeSummary": { "TotalItemsToScanCount": number, "TotalRecoveryPointsToScanCount": number }, "Status": "string", "StatusMessage": "string" }

Elementos de respuesta

Si la acción se realiza correctamente, el servicio devuelve una respuesta HTTP 200.

El servicio devuelve los datos siguientes en formato JSON.

CompletionTime

Fecha y hora en que se completó el trabajo de búsqueda, en formato Unix y en la hora universal coordinada (UTC). El valor de CompletionTime tiene una precisión de milisegundos. Por ejemplo, el valor 1516925490.087 representa el viernes 26 de enero de 2018 a las 12:11:30.087 h.

Tipo: marca temporal

CreationTime

Fecha y hora en que se creó el trabajo de búsqueda, en formato Unix y en la hora universal coordinada (UTC). El valor de CompletionTime tiene una precisión de milisegundos. Por ejemplo, el valor 1516925490.087 representa el viernes 26 de enero de 2018 a las 12:11:30.087 h.

Tipo: marca temporal

CurrentSearchProgress

Devuelve números que representan BackupsScannedCount ItemsScanned, y ItemsMatched.

Tipo: objeto CurrentSearchProgress

EncryptionKeyArn

Es la clave de cifrado del trabajo de búsqueda especificado.

Ejemplo: arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab.

Tipo: cadena

ItemFilters

Son los filtros de elementos que representan todas las propiedades de los elementos de entrada especificados al crear la búsqueda.

Tipo: objeto ItemFilters

Name

Nombre devuelto del trabajo de búsqueda especificado.

Tipo: cadena

SearchJobArn

Cadena única que identifica el nombre de recurso de Amazon (ARN) del trabajo de búsqueda especificado.

Tipo: cadena

SearchJobIdentifier

Cadena única que identifica el trabajo de búsqueda especificado.

Tipo: cadena

SearchScope

Ámbito de búsqueda que incluye todas las propiedades de copia de seguridad introducidas en una búsqueda.

Tipo: objeto SearchScope

SearchScopeSummary

Devuelve un resumen del ámbito del trabajo de búsqueda especificado, que incluye:

  • TotalBackupsToScanCount, el número de puntos de recuperación devueltos por la búsqueda.

  • TotalItemsToScanCount, el número de elementos devueltos por la búsqueda.

Tipo: objeto SearchScopeSummary

Status

Estado actual del trabajo de búsqueda especificado.

Un trabajo de búsqueda puede tener uno de los siguientes estados: RUNNING; COMPLETED; STOPPED; FAILED TIMED_OUT o EXPIRED.

Tipo: cadena

Valores válidos: RUNNING | COMPLETED | STOPPING | STOPPED | FAILED

StatusMessage

Se devolverá un mensaje de estado para cada trabajo de búsqueda con un estado ERRORED o un estado de trabajos COMPLETED con problemas.

Por ejemplo, un mensaje puede indicar que una búsqueda contiene puntos de recuperación que no se han podido analizar debido a un problema con permisos.

Tipo: cadena

Errores

Para obtener información acerca de los errores comunes a todas las acciones, consulte Tipos de errores comunes.

AccessDeniedException

No tiene acceso suficiente para realizar esta acción.

message

El usuario no tiene acceso suficiente para realizar esta acción.

Código de estado HTTP: 403

InternalServerException

Se ha producido un error interno del servidor. Vuelva a enviar la solicitud.

message

Error inesperado durante el procesamiento de la solicitud.

retryAfterSeconds

Vuelva a intentar la llamada pasados varios segundos.

Código de estado HTTP: 500

ResourceNotFoundException

No se ha encontrado el recurso para esta solicitud.

Confirme que la información del recurso, como el ARN o el tipo, es correcta y existe y, a continuación, vuelva a intentar la solicitud.

message

La solicitud hace referencia a un recurso que no existe.

resourceId

Identificador hipotético del recurso afectado.

resourceType

Tipo hipotético del recurso afectado.

Código de estado HTTP: 404

ThrottlingException

La solicitud fue denegada debido a una limitación de la solicitud.

message

La solicitud ha dado error debido a la limitación de la solicitud.

quotaCode

Este es el código unívoco del servicio de origen con la cuota.

retryAfterSeconds

Vuelva a intentar la llamada pasados varios segundos.

serviceCode

Este es el código unívoco del servicio de origen.

Código de estado HTTP: 429

ValidationException

La entrada no satisface las limitaciones que especifica un servicio.

message

La entrada no satisface las limitaciones que especifica un servicio de Amazon.

Código de estado HTTP: 400

Véase también

Para obtener más información sobre el uso de esta API en uno de los idiomas específicos AWS SDKs, consulta lo siguiente: