DescribeBackupJob - AWS Backup
Sintaxis de la solicitudParámetros de solicitud del URICuerpo de la solicitudSintaxis de la respuestaElementos de respuestaErroresVéase también

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.

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 para AWS Backup 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",
      "BackupPlanName": "string",
      "BackupPlanVersion": "string",
      "BackupRuleCron": "string",
      "BackupRuleId": "string",
      "BackupRuleName": "string",
      "BackupRuleTimezone": "string"
   },
   "CreationDate": number,
   "EncryptionKeyArn": "string",
   "ExpectedCompletionDate": number,
   "IamRoleArn": "string",
   "InitiationDate": number,
   "IsEncrypted": boolean,
   "IsParent": boolean,
   "MessageCategory": "string",
   "NumberOfChildJobs": number,
   "ParentJobId": "string",
   "PercentDone": "string",
   "RecoveryPointArn": "string",
   "RecoveryPointLifecycle": { 
      "DeleteAfterDays": number,
      "MoveToColdStorageAfterDays": number,
      "OptInToArchiveForSupportedResources": boolean
   },
   "ResourceArn": "string",
   "ResourceName": "string",
   "ResourceType": "string",
   "StartBy": number,
   "State": "string",
   "StatusMessage": "string",
   "VaultLockState": "string",
   "VaultType": "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 para AWS Backup 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, en bytes, de una copia de seguridad (punto de recuperación).

Este valor puede representarse de forma diferente según el tipo de recurso, ya que AWS Backup extrae información de datos de otros AWS servicios. Por ejemplo, el valor devuelto puede mostrar un valor de0, que puede diferir del valor previsto.

El comportamiento esperado de los valores por tipo de recurso se describe a continuación:

  • Este valor no se rellena a partir de la operación en Amazon Aurora, Amazon DocumentDB y Amazon Neptune. GetBackupJobStatus

  • En el caso de Amazon DynamoDB con funciones avanzadas, este valor se refiere al tamaño del punto de recuperación (copia de seguridad).

  • Amazon EC2 y Amazon EBS muestran el tamaño del volumen (almacenamiento aprovisionado) devuelto como parte de este valor. Amazon EBS no devuelve información sobre el tamaño de la copia de seguridad; el tamaño de la instantánea tendrá el mismo valor que el recurso original del que se hizo la copia de seguridad.

  • En Amazon EFS, este valor se refiere a los bytes delta transferidos durante una copia de seguridad.

  • Amazon FSx no rellena este valor a partir de la operación GetBackupJobStatus para sistemas de FSx archivos.

  • Una instancia de Amazon RDS se mostrará como0.

  • En el caso de las máquinas virtuales en ejecución VMware, este valor se transfiere a AWS Backup través de un flujo de trabajo asíncrono, lo que puede significar que este valor mostrado puede representar de forma insuficiente el tamaño real de la copia de seguridad.

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, BackupType devuelve "WindowsVSS". Si BackupType está 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 CompletionDate 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

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, BackupPlanVersion y BackupRuleId del 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 CreationDate 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

EncryptionKeyArn

El nombre de recurso de Amazon (ARN) de la clave de KMS utilizada para cifrar la copia de seguridad. Puede ser una clave administrada por el cliente o una clave AWS administrada, según la configuración del almacén.

Tipo: cadena

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 ExpectedCompletionDate 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

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

IsEncrypted

Un valor booleano que indica si la copia de seguridad está cifrada. Todas las copias de seguridad AWS Backup incluidas están cifradas, pero este campo indica el estado de cifrado para garantizar la transparencia.

Tipo: Booleano

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_ALL y INVALIDPARAMETERS. Consulta la sección Supervisión para ver una lista de MessageCategory las cadenas 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

RecoveryPointLifecycle

Especifica el período, en días, antes de que un punto de recuperación se transfiera al almacenamiento en frío o se elimine.

Las copias de seguridad que se han migrado al almacenamiento en frío deben permanecer en él durante un mínimo de 90 días. Por lo tanto, en la consola, el valor de retención debe tener 90 días más que el valor del número de días tras los cuales se transferirá al almacenamiento en frío. El valor de "transition to cold after days" (número de días tras los cuales migrará a almacenamiento en frío) no puede cambiarse una vez que se ha migrado una copia de seguridad al almacenamiento en frío.

Los tipos de recursos que pueden pasar al almacenamiento en frío se muestran en la tabla Disponibilidad de funciones por recurso. AWS Backup omite esta expresión para otros tipos de recursos.

Para eliminar el ciclo de vida y los períodos de retención existentes y conservar los puntos de recuperación indefinidamente, especifique -1 para MoveToColdStorageAfterDays y DeleteAfterDays.

Tipo: objeto Lifecycle

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 AWS recurso del que se va a hacer una 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 StartBy sería las 20:00 h en la fecha especificada. El valor de StartBy 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

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

VaultLockState

El estado de bloqueo del almacén de copias de seguridad. En el caso de las bóvedas con huecos lógicos, esto indica si la bóveda está bloqueada en el modo de conformidad. Los valores válidos son LOCKED y UNLOCKED.

Tipo: cadena

VaultType

El tipo de almacén de respaldo en el que se almacena el punto de recuperación. Los valores válidos son BACKUP_VAULT para las bóvedas de respaldo estándar y LOGICALLY_AIR_GAPPED_BACKUP_VAULT para las bóvedas con huecos lógicos.

Tipo: cadena

Errores

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

DependencyFailureException

Un AWS servicio o recurso dependiente devolvió un error al servicio y la acción no se AWS Backup pudo completar.

Context

Type

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.

Context

Type

Código de estado HTTP: 400

MissingParameterValueException

Indica que falta un parámetro obligatorio.

Context

Type

Código de estado HTTP: 400

ResourceNotFoundException

No existe un recurso necesario para la acción.

Context

Type

Código de estado HTTP: 400

ServiceUnavailableException

La solicitud no se ha ejecutado correctamente debido a un error temporal del servidor.

Context

Type

Código de estado HTTP: 500

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: