GetBackupPlan
Devuelve los detalles del BackupPlan para el BackupPlanId especificado. Los detalles son el cuerpo de un plan de copia de seguridad en formato JSON, además de los metadatos del plan.
Sintaxis de la solicitud
GET /backup/plans/backupPlanId/?MaxScheduledRunsPreview=MaxScheduledRunsPreview&versionId=VersionId HTTP/1.1
Parámetros de solicitud del URI
La solicitud utiliza los siguientes parámetros URI.
- backupPlanId
-
Identifica de forma única un plan de copia de seguridad.
Obligatorio: sí
- MaxScheduledRunsPreview
-
Número de ejecuciones de copias de seguridad programadas futuras para previsualizar. Si se establece en 0 (valor predeterminado), no se incluye ninguna vista previa de ejecuciones programadas en la respuesta. El rango válido es de 0 a 10.
Rango válido: valor mínimo de 0. Valor máximo de 10.
- VersionId
-
Cadenas cifradas en UTF-8, Unicode, únicas, generadas aleatoriamente que tienen como máximo una longitud de 1024 bytes. Los ID de versión no se pueden editar.
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
{
"AdvancedBackupSettings": [
{
"BackupOptions": {
"string" : "string"
},
"ResourceType": "string"
}
],
"BackupPlan": {
"AdvancedBackupSettings": [
{
"BackupOptions": {
"string" : "string"
},
"ResourceType": "string"
}
],
"BackupPlanName": "string",
"Rules": [
{
"CompletionWindowMinutes": number,
"CopyActions": [
{
"DestinationBackupVaultArn": "string",
"Lifecycle": {
"DeleteAfterDays": number,
"MoveToColdStorageAfterDays": number,
"OptInToArchiveForSupportedResources": boolean
}
}
],
"EnableContinuousBackup": boolean,
"IndexActions": [
{
"ResourceTypes": [ "string" ]
}
],
"Lifecycle": {
"DeleteAfterDays": number,
"MoveToColdStorageAfterDays": number,
"OptInToArchiveForSupportedResources": boolean
},
"RecoveryPointTags": {
"string" : "string"
},
"RuleId": "string",
"RuleName": "string",
"ScheduleExpression": "string",
"ScheduleExpressionTimezone": "string",
"StartWindowMinutes": number,
"TargetBackupVaultName": "string"
}
]
},
"BackupPlanArn": "string",
"BackupPlanId": "string",
"CreationDate": number,
"CreatorRequestId": "string",
"DeletionDate": number,
"LastExecutionDate": number,
"ScheduledRunsPreview": [
{
"ExecutionTime": number,
"RuleExecutionType": "string",
"RuleId": "string"
}
],
"VersionId": "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.
- AdvancedBackupSettings
-
Contiene una lista de
BackupOptionspara cada tipo de recurso. La lista se rellena solo si se ha configurado la opción avanzada para el plan de copia de seguridad.Tipo: matriz de objetos AdvancedBackupSetting
- BackupPlan
-
Especifica el cuerpo de un plan de copia de seguridad. Incluye un
BackupPlanNamey uno o más conjuntos deRules.Tipo: objeto BackupPlan
- BackupPlanArn
-
Un nombre de recurso de Amazon (ARN) que identifica de forma única un plan de copia de seguridad; por ejemplo,
arn:aws:backup:us-east-1:123456789012:plan:8F81F553-3A74-4A3F-B93D-B3360DC80C50.Tipo: cadena
- BackupPlanId
-
Identifica de forma única un plan de copia de seguridad.
Tipo: cadena
- CreationDate
-
La fecha y la hora en que se creó el plan 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
- CreatorRequestId
-
Una cadena única que identifica la solicitud y permite que se reintenten las solicitudes que han producido un error sin el riesgo de ejecutar la operación dos veces.
Tipo: cadena
- DeletionDate
-
La fecha y la hora en que se eliminó el plan de copia de seguridad, en formato Unix y horario universal coordinado (UTC). El valor de
DeletionDatetiene 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
- LastExecutionDate
-
La última vez que se ejecutó este plan de copia de seguridad. Una fecha y hora, en formato Unix y horario universal coordinado (UTC). El valor de
LastExecutionDatetiene 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
- ScheduledRunsPreview
-
Lista de las próximas ejecuciones de copias de seguridad programadas. Solo se incluye cuando el parámetro
MaxScheduledRunsPreviewsea mayor que 0. Contiene hasta diez ejecuciones futuras de copias de seguridad con sus horarios programados, tipos de ejecución e ID de regla asociados.Tipo: matriz de objetos ScheduledPlanExecutionMember
- VersionId
-
Cadenas cifradas en UTF-8, Unicode, únicas, generadas aleatoriamente que tienen como máximo una longitud de 1024 bytes. Los ID de versión no se pueden editar.
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.
- 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 un SDK de AWS de un idioma específico, consulte:
