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.
StartBackupJob
Inicia un trabajo de copia de seguridad bajo demanda para el recurso especificado.
Sintaxis de la solicitud
PUT /backup-jobs HTTP/1.1
Content-type: application/json
{
"BackupOptions": {
"string
" : "string
"
},
"BackupVaultName": "string
",
"CompleteWindowMinutes": number
,
"IamRoleArn": "string
",
"IdempotencyToken": "string
",
"Lifecycle": {
"DeleteAfterDays": number
,
"MoveToColdStorageAfterDays": number
,
"OptInToArchiveForSupportedResources": boolean
},
"RecoveryPointTags": {
"string
" : "string
"
},
"ResourceArn": "string
",
"StartWindowMinutes": number
}
URIParámetros de solicitud
La solicitud no utiliza ningún URI parámetro.
Cuerpo de la solicitud
La solicitud acepta los siguientes datos en JSON formato.
- BackupOptions
-
La opción de copia de seguridad de un recurso seleccionado. Esta opción solo está disponible para los trabajos de copia de seguridad del Servicio Windows Volume Shadow Copy (VSS).
Valores válidos: configúrelos
"WindowsVSS":"enabled"
para habilitar la opciónWindowsVSS
de copia de seguridad y crear una VSS copia de seguridad de Windows. Configure"WindowsVSS""disabled"
para crear una copia de seguridad normal. La opciónWindowsVSS
no está habilitada de forma predeterminada.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}$
Obligatorio: no
- 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}$
Obligatorio: sí
- CompleteWindowMinutes
-
Un valor en minutos durante el cual debe completarse una copia de seguridad que se haya iniciado correctamente o, de lo contrario, AWS Backup cancelará el trabajo. Este valor es opcional. Este valor comienza la cuenta regresiva a partir del momento en que se programó la copia de seguridad. No agrega tiempo adicional para
StartWindowMinutes
o si la copia de seguridad se inició más tarde de lo programado.Como
StartWindowMinutes
, este parámetro tiene un valor máximo de 100 años (52 560 000 minutos).Tipo: largo
Obligatorio: no
- IamRoleArn
-
Especifica la IAM función ARN utilizada para crear el punto de recuperación de destino; por ejemplo,
arn:aws:iam::123456789012:role/S3Access
.Tipo: cadena
Obligatorio: sí
- IdempotencyToken
-
Una cadena elegida por el cliente que puede utilizar para distinguir entre llamadas a
StartBackupJob
que, de otro modo, serían idénticas. Si se vuelve a intentar una solicitud correcta con el mismo token de idempotencia, aparece un mensaje de confirmación y no se realiza ninguna acción.Tipo: cadena
Requerido: no
- Lifecycle
-
El ciclo de vida define cuándo un recurso protegido pasa a almacenamiento en frío y cuándo caduca. AWS Backup realizará la transición y caducará las copias de seguridad automáticamente según el ciclo de vida que usted defina.
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, 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.
Este parámetro tiene un valor máximo de 100 años (36 500 días).
Tipo: objeto Lifecycle
Obligatorio: no
- RecoveryPointTags
-
Las etiquetas que se van a asignar a los recursos.
Tipo: mapa de cadena a cadena
Obligatorio: no
- ResourceArn
-
Un nombre de recurso de Amazon (ARN) que identifica de forma exclusiva un recurso. El formato ARN depende del tipo de recurso.
Tipo: cadena
Obligatorio: sí
- StartWindowMinutes
-
Un valor en minutos después del que una copia de seguridad está programada antes de que se cancele el trabajo si no se ha iniciado correctamente. El valor es opcional y el valor predeterminado es 8 horas. Si se incluye este valor, debe ser de al menos 60 minutos para evitar errores.
Este parámetro tiene un valor máximo de 100 años (52 560 000 minutos).
Durante el intervalo de inicio, el estado del trabajo de copia de seguridad permanece en ese estado
CREATED
hasta que comience correctamente o hasta que se agote el tiempo del intervalo de inicio. Si dentro de la ventana de inicio, Time AWS Backup recibe un error que permite volver a intentar el trabajo, AWS Backup volverá a intentarlo automáticamente al menos cada 10 minutos hasta que la copia de seguridad comience correctamente (el estado del trabajo cambia aRUNNING
) o hasta que el estado del trabajo cambie aEXPIRED
(lo que se espera que ocurra cuando termine el tiempo de la ventana de inicio).Tipo: largo
Obligatorio: no
Sintaxis de la respuesta
HTTP/1.1 200
Content-type: application/json
{
"BackupJobId": "string",
"CreationDate": number,
"IsParent": boolean,
"RecoveryPointArn": "string"
}
Elementos de respuesta
Si la acción se realiza correctamente, el servicio envía una respuesta de HTTP 200.
El servicio devuelve los siguientes datos en JSON formato.
- BackupJobId
-
Identifica de forma exclusiva una solicitud para AWS Backup hacer una copia de seguridad de un recurso.
Tipo: cadena
- CreationDate
-
La fecha y la hora en que se crea un trabajo de copia de seguridad, en formato Unix y en hora universal coordinada (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
- IsParent
-
Se trata de un valor booleano devuelto que indica que es un trabajo de copia de seguridad principal (compuesto).
Tipo: Booleano
- RecoveryPointArn
-
Nota: Este campo solo se devuelve para los recursos de Amazon EFS y Advanced DynamoDB.
Y ARN que identifique 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
Errores
Para obtener información acerca de los errores comunes a todas las acciones, consulte Errores comunes.
- InvalidParameterValueException
-
Indica que hay algún problema con el valor de un parámetro. Por ejemplo, el valor está fuera del rango.
HTTPCódigo de estado: 400
- InvalidRequestException
-
Indica que hay algún problema con la entrada de la solicitud. Por ejemplo, un parámetro es del tipo incorrecto.
HTTPCódigo de estado: 400
- LimitExceededException
-
Se ha superado un límite en la solicitud; por ejemplo, el número máximo de elementos permitidos en una solicitud.
HTTPCódigo de estado: 400
- MissingParameterValueException
-
Indica que falta un parámetro obligatorio.
HTTPCódigo de estado: 400
- ResourceNotFoundException
-
No existe un recurso necesario para la acción.
HTTPCódigo de estado: 400
- ServiceUnavailableException
-
La solicitud no se ha ejecutado correctamente debido a un error temporal del servidor.
HTTPCódigo de estado: 500
Véase también
Para obtener más información sobre cómo usarlo API en uno de los idiomas específicos AWS SDKs, consulte lo siguiente: