DescribeBackupJob
Devuelve los detalles del trabajo de copia de seguridad para el BackupJobId especificado.
Sintaxis de la solicitud
GET /backup-jobs/backupJobId HTTP/1.1
Parámetros de solicitud del URI
La solicitud utiliza los siguientes parámetros URI.
- backupJobId
-
Identifica de forma exclusiva una solicitud de AWS Backup para hacer una copia de seguridad de un recurso.
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
{
"AccountId": "string",
"BackupJobId": "string",
"BackupOptions": {
"string" : "string"
},
"BackupSizeInBytes": number,
"BackupType": "string",
"BackupVaultArn": "string",
"BackupVaultName": "string",
"BytesTransferred": number,
"ChildJobsInState": {
"string" : number
},
"CompletionDate": number,
"CreatedBy": {
"BackupPlanArn": "string",
"BackupPlanId": "string",
"BackupPlanVersion": "string",
"BackupRuleId": "string"
},
"CreationDate": number,
"ExpectedCompletionDate": number,
"IamRoleArn": "string",
"InitiationDate": number,
"IsParent": boolean,
"MessageCategory": "string",
"NumberOfChildJobs": number,
"ParentJobId": "string",
"PercentDone": "string",
"RecoveryPointArn": "string",
"ResourceArn": "string",
"ResourceName": "string",
"ResourceType": "string",
"StartBy": number,
"State": "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.
- AccountId
-
Devuelve el ID de la cuenta a la que pertenece el trabajo de copia de seguridad.
Tipo: cadena
Patrón:
^[0-9]{12}$ - BackupJobId
-
Identifica de forma exclusiva una solicitud de AWS Backup para hacer una copia de seguridad de un recurso.
Tipo: cadena
- BackupOptions
-
Representa las opciones especificadas como parte del plan de copia de seguridad o del trabajo de copia de seguridad bajo demanda.
Tipo: mapa de cadena a cadena
Patrón de clave:
^[a-zA-Z0-9\-\_\.]{1,50}$Patrón de valores:
^[a-zA-Z0-9\-\_\.]{1,50}$ - BackupSizeInBytes
-
El tamaño de una copia de seguridad, en bytes.
Tipo: largo
- BackupType
-
Representa el tipo de copia de seguridad real seleccionado para un trabajo de copia de seguridad. Por ejemplo, si se realizó una copia de seguridad correcta de Volume Shadow Copy Service (VSS) de Windows,
BackupTypedevuelve"WindowsVSS". SiBackupTypeestá vacío, significa que el tipo de copia de seguridad era una copia de seguridad normal.Tipo: cadena
- BackupVaultArn
-
Un nombre de recurso de Amazon (ARN) que identifica de forma exclusiva un almacén de copia de seguridad; por ejemplo,
arn:aws:backup:us-east-1:123456789012:backup-vault:aBackupVault.Tipo: cadena
- BackupVaultName
-
El nombre de un contenedor lógico donde se almacenan las copias de seguridad. Los almacenes de copia de seguridad se identifican con nombres que son exclusivos de la cuenta usada para crearlos y de la región de AWS donde se crearon.
Tipo: cadena
Patrón:
^[a-zA-Z0-9\-\_]{2,50}$ - BytesTransferred
-
El tamaño en bytes transferido a un almacén de copias de seguridad en el momento en que se consultó el estado del trabajo.
Tipo: largo
- ChildJobsInState
-
Devuelve las estadísticas de los trabajos de copia de seguridad secundarios (anidados) incluidos.
Tipo: mapa de cadena a largo
Claves válidas:
CREATED | PENDING | RUNNING | ABORTING | ABORTED | COMPLETED | FAILED | EXPIRED | PARTIAL - CompletionDate
-
La fecha y la hora en que se completó un trabajo para crear un trabajo de copia de seguridad, en formato Unix y horario universal coordinado (UTC). El valor de
CompletionDatetiene 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
- CreatedBy
-
Contiene información de identificación sobre la creación de un trabajo de copia de seguridad, que incluye los valores de
BackupPlanArn,BackupPlanId,BackupPlanVersionyBackupRuleIddel plan de copia de seguridad utilizado para crearlo.Tipo: objeto RecoveryPointCreator
- CreationDate
-
La fecha y la hora en que se creó el trabajo de copia de seguridad, en formato Unix y horario universal coordinado (UTC). El valor de
CreationDatetiene 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
- ExpectedCompletionDate
-
La fecha y la hora en que se espera completar un trabajo de copia de seguridad de recursos, en formato Unix y horario universal coordinado (UTC). El valor de
ExpectedCompletionDatetiene 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
- IamRoleArn
-
Especifica el ARN del rol de IAM utilizado para crear el punto de recuperación de destino; por ejemplo,
arn:aws:iam::123456789012:role/S3Access.Tipo: cadena
- InitiationDate
-
La fecha en que se inició un trabajo de copia de seguridad.
Tipo: marca temporal
- IsParent
-
Esto devuelve el valor booleano de que un trabajo de copia de seguridad es un trabajo principal (compuesto).
Tipo: Booleano
- MessageCategory
-
El recuento de trabajos de la categoría de mensajes especificada.
Las cadenas de ejemplo pueden ser
AccessDenied,SUCCESS,AGGREGATE_ALLyINVALIDPARAMETERS. Consulte en Monitorización una lista de cadenas de MessageCategory aceptadas.Tipo: cadena
- NumberOfChildJobs
-
Esto devuelve el número de trabajos de copia de seguridad secundarios (anidados).
Tipo: largo
- ParentJobId
-
Esto devuelve el ID del trabajo de copia de seguridad del recurso principal (compuesto).
Tipo: cadena
- PercentDone
-
Contiene el porcentaje estimado que se ha completado de un trabajo en el momento en que se consultó el estado del trabajo.
Tipo: cadena
- RecoveryPointArn
-
Un ARN que identifica de forma exclusiva un punto de recuperación; por ejemplo,
arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.Tipo: cadena
- ResourceArn
-
Un ARN que identifica de forma exclusiva un recurso guardado. El formato del ARN depende del tipo de recurso.
Tipo: cadena
- ResourceName
-
El nombre no exclusivo del recurso que pertenece a la copia de seguridad especificada.
Tipo: cadena
- ResourceType
-
El tipo de recurso de AWS del que se va a hacer la copia de seguridad; por ejemplo, un volumen de Amazon Elastic Block Store (Amazon EBS) o una base de datos de Amazon Relational Database Service (Amazon RDS).
Tipo: cadena
Patrón:
^[a-zA-Z0-9\-\_\.]{1,50}$ - StartBy
-
Especifica la hora en formato Unix y horario universal coordinado (UTC) en la que se debe iniciar un trabajo de copia de seguridad antes de que se cancele. El valor se calcula agregando el periodo de inicio a la hora programada. Por lo tanto, si la hora programada fueran las 18:00 h y el periodo de inicio fuera de 2 horas, la hora
StartBysería las 20:00 h en la fecha especificada. El valor deStartBytiene 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
- State
-
El estado actual de un trabajo de copia de seguridad.
Tipo: cadena
Valores válidos:
CREATED | PENDING | RUNNING | ABORTING | ABORTED | COMPLETED | FAILED | EXPIRED | PARTIAL - StatusMessage
-
Un mensaje detallado que explica el estado del trabajo de copia de seguridad de un recurso.
Tipo: cadena
Errores
Para obtener información acerca de los errores comunes a todas las acciones, consulte Errores comunes.
- DependencyFailureException
-
Un servicio o recurso dependiente de AWS devolvió un error al servicio de AWS Backup y la acción no se pudo completar.
Código de estado HTTP: 500
- InvalidParameterValueException
-
Indica que hay algún problema con el valor de un parámetro. Por ejemplo, el valor está fuera del rango.
Código de estado HTTP: 400
- MissingParameterValueException
-
Indica que falta un parámetro obligatorio.
Código de estado HTTP: 400
- ResourceNotFoundException
-
No existe un recurso necesario para la acción.
Código de estado HTTP: 400
- ServiceUnavailableException
-
La solicitud no se ha ejecutado correctamente debido a un error temporal del servidor.
Código de estado HTTP: 500
Véase también
Para obtener más información sobre el uso de esta API en un SDK de AWS de un idioma específico, consulte:
