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 recupera 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
-
La fecha y la hora en que se completó un trabajo de búsqueda, en formato Unix y en hora universal coordinada (UTC). El valor de
CompletionTimetiene 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
-
La fecha y la hora en que se creó un trabajo de búsqueda, en formato Unix y en hora universal coordinada (UTC). El valor de
CompletionTimetiene 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
-
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
-
Los filtros de elementos representan todas las propiedades de los elementos de entrada especificadas al crear la búsqueda.
Tipo: objeto ItemFilters
- Name
-
Se devolvió el nombre del trabajo de búsqueda especificado.
Tipo: cadena
- SearchJobArn
-
La cadena única que identifica el nombre de recurso de Amazon (ARN) del trabajo de búsqueda especificado.
Tipo: cadena
- SearchJobIdentifier
-
La cadena única que identifica el trabajo de búsqueda especificado.
Tipo: cadena
- SearchScope
-
El ámbito de búsqueda incluye todas las propiedades de respaldo introducidas en una búsqueda.
Tipo: objeto SearchScope
- SearchScopeSummary
-
Se devolvió 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
-
El estado actual del trabajo de búsqueda especificado.
Un trabajo de búsqueda puede tener uno de los siguientes estados:
RUNNING;COMPLETED;STOPPED;FAILEDTIMED_OUT; oEXPIRED.Tipo: cadena
Valores válidos:
RUNNING | COMPLETED | STOPPING | STOPPED | FAILED - StatusMessage
-
Se devolverá un mensaje de estado para un trabajo de búsqueda con un estado igual
ERROREDo un estado deCOMPLETEDtrabajos 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 de permisos.
Tipo: cadena
Errores
Para obtener información acerca de los errores comunes a todas las acciones, consulte 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 después de varios segundos.
Código de estado HTTP: 500
- ResourceNotFoundException
-
No se encontró 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 no se ha realizado correctamente debido a una limitación de la solicitud.
- quotaCode
-
Este es el código exclusivo del servicio de origen con la cuota.
- retryAfterSeconds
-
Vuelva a intentar la llamada después de varios segundos.
- serviceCode
-
Este es el código exclusivo del servicio de origen.
Código de estado HTTP: 429
- ValidationException
-
La entrada no cumple las restricciones especificadas por un servicio.
- message
-
La entrada no cumple las restricciones especificadas por 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:
