Help us improve your experience.

Let us know what you think.

Do you have time for a two-minute survey?

 
EN ESTA PÁGINA
 

POST /backup_and_restore/backups

RESUMEN Envía una solicitud al motor de copia de seguridad y restauración para crear una nueva copia de seguridad.

Para comprobar el estado de una copia de seguridad, utilice la siguiente punto de conexión: /api/backup_and_restore/backups/{id}
Tabla 1: Detalles del recurso POST /backup_and_restore/backups:

Detalles del recurso POST /backup_and_restore/backups
Tipo MIME

Application/JSON

Tabla 2: Detalles del parámetro de solicitud POST /backup_and_restore/backups:

Detalles del parámetro de solicitud POST /backup_and_restore/backups
Tipo de parámetro Opcionalidad Tipo de datos Tipo MIME Descripción

backup_type

encabezado

Obligatorio

Cadena

Texto/sin formato

Obligatorio. El tipo de copia de seguridad deseado (CONFIG o DATA).

Campos

encabezado

Opcional

Cadena

Texto/sin formato

Opcional: utilice este parámetro para especificar los campos que desea recuperar en la respuesta. Se excluyen los campos que no tienen nombre. Especifique subcampos entre paréntesis y varios campos en el mismo objeto están separados por comas.
Tabla 3: Detalles del cuerpo de la solicitud POST /backup_and_restore/backups:

Detalles del cuerpo de la solicitud de POST /backup_and_restore/backups
Parámetro Tipo de datos Tipo MIME Descripción Ejemplo

copia de seguridad

Objeto

Application/JSON
Obligatorio. Un único objeto de copia de seguridad tiene los siguientes campos modificables:
  • name - Requerido - String - El nombre de la copia de seguridad.
  • configuration_id - Obligatorio - Largo: el ID de la configuración. Debe ser el ID de una configuración de copia de seguridad implementada. Para obtener más información, consulte la siguiente API de configuración de copia de seguridad:
    • api/config/backup_and_restore/scheduled_backup_configurations
  • description - Opcional - Cadena - Una descripción opcional para la copia de seguridad.
  • host_id - Opcional - Largo - El host que corresponde con la copia de seguridad (predeterminado en la consola).
Se ignorarán los demás campos establecidos.

{ "name": "nightly", "description": "nightly_backup", "configuration_id": 1 }
Tabla 4: Códigos de respuesta POST /backup_and_restore/backups:

Códigos de respuesta POST /backup_and_restore/backups
Código de respuesta HTTP Descripción de código único

201

Se creó la copia de seguridad.

409

1005

El valor del parámetro 'name' debe ser único.

409

1011

Se ha detectado un cambio de configuración no implementado. Implemente los cambios por etapas e inténtelo de nuevo.

409

1015

Ya hay una copia de seguridad en curso en el host.

409

1016

Actualmente se está  realizando una restauración. No se pueden iniciar nuevos procesos de copia de seguridad o restauración mientras se ejecuta el proceso actual.

422

1002

El valor del parámetro 'name' no puede ser nulo ni vacío.

422

1003

El valor del parámetro 'name' no debe superar los 100 caracteres.

422

1004

El parámetro 'name' debe contener solo valores alfanuméricos y '_', '-' o '.'.

422

1006

El valor del parámetro "configuration_id" no puede ser nulo ni estar vacío.

422

1007

La configuración de copia de seguridad no existe.

422

1008

El valor del parámetro "description" no debe superar los 255 caracteres.

422

1009

El host de copia de seguridad no existe.

422

1010

El host_id proporcionado corresponde a un host que actualmente no está activo. Para obtener más información, consulte la siguiente API de hosts: api/config/deployment/hosts

422

1012

El host_id proporcionado corresponde a un host que no es la consola y el tipo de copia de seguridad es CONFIG. Una copia de seguridad de configuración solo puede realizarse en la consola.

422

1013

Las copias de seguridad de datos solo se pueden realizar en hosts que almacenan datos ariel. Para obtener más información, consulte la siguiente API de hosts: api/config/deployment/hosts

422

1014

El host no está configurado para copias de seguridad de datos. Consulte la API de configuración de copia de seguridad para obtener más información: api/config/backup_and_restore/scheduled_backup_configurations

500

1000

Se ha producido un error durante el intento de crear la copia de seguridad.

Descripción de la respuesta

El objeto de copia de seguridad creado que contiene los siguientes campos:
  • id - Long - El ID de la copia de seguridad.
  • configuration_id - Long - El ID de la configuración. Esto siempre será 1. Consulte las API de configuración de copia de seguridad para obtener más información:
    • api/config/backup_and_restore/scheduled_backup_configurations
    • api/staged_config/backup_and_restore/scheduled_backup_configurations
  • host_id - Largo: el host que corresponde con la copia de seguridad. Para obtener más información, consulte la siguiente API de hosts:
    • api/config/deployment/hosts
  • name - String - El nombre de la copia de seguridad.
  • description - String - Una descripción opcional de la copia de seguridad.
  • type - Enumeración - El tipo de copia de seguridad. Están disponibles los siguientes valores: CONFIG, DATA.
  • version - Cadena: la versión de JSA que corresponde a la copia de seguridad.
  • time_initiated - Largo - El número de milisegundos desde la época en que se inició la copia de seguridad.
  • time_completed - Largo - El número de milisegundos desde la época en que se completó la copia de seguridad.
  • initiated_by - Cadena: el usuario o servicio autorizado que inició la copia de seguridad.
  • status - Enumeración - El estado de la copia de seguridad. Están disponibles los siguientes valores: INICIALIZING, IN_PROGRESS, FAILED, SUCCESS, CANCELLING, DEBORRING, MISSING.
    • INITIALIZING: El estado inicial de la copia de seguridad cuando se crea. En este estado, se crea un objeto de copia de seguridad y se envía una solicitud al motor de copia de seguridad y restauración.
    • IN_PROGRESS: Cuando el motor de copia de seguridad y restauración recibe la solicitud de copia de seguridad, el estado se actualiza IN_PROGRESS.
    • FAILED: Si la copia de seguridad se ha completado con errores, el estado se actualiza a FAILED.
    • SUCCESS: Si la copia de seguridad se ha completado sin errores, el estado se actualiza a SUCCESS.
    • CANCELLING: CANCELLING: Si se envía una solicitud desde la API para eliminar una copia de seguridad que está en curso, después de que el motor de copia de seguridad y restauración reciba la solicitud, el estado de la copia de seguridad se actualiza a CANCELLING.
    • ELIMINAR: Si se envía una solicitud para eliminar una copia de seguridad, después de que el motor de copia de seguridad y restauración reciba la solicitud, el estado de la copia de seguridad se actualiza a ELIMINAR. El registro de copia de seguridad, junto con el archivo de copia de seguridad, se elimina.
    • MISSING: Si el archivo de copia de seguridad de un registro de copia de seguridad se mueve o elimina fuera del control del motor de copia de seguridad y restauración, el estado de ese registro se actualiza a MISSING.
  • size_on_disk - Long - El tamaño de la copia de seguridad en bytes.
  • content_file_path - Cadena - La ruta del archivo que corresponde al contenido de la copia de seguridad.
  • is_valid - Booleano - Si el archivo de copia de seguridad asociado, el manifiesto de copia de seguridad y sus propiedades funcionan correctamente, la condición se establece en 'true'; de lo contrario, la condición se establece en 'false'.  Estos son algunos ejemplos de por qué la copia de seguridad podría no ser válida:
    • Al manifiesto de copia de seguridad le faltan propiedades.
    • No se puede recuperar el manifiesto de copia de seguridad.
    • La copia de seguridad de un sistema en espera que no sea de alta disponibilidad no se puede restaurar en una consola configurada como sistema en espera de alta disponibilidad.
    • Los nombres de los productos de copia de seguridad y de host no coinciden.
    • Los nombres de la copia de seguridad y del dispositivo de host no coinciden.
    • La copia de seguridad utiliza la dirección IP actual de la consola para el host administrado que no es de consola.
  • is_version_compatible - Boolean - Si la versión de copia de seguridad asociada es compatible con el sistema, la condición se establece en 'true'; de lo contrario, la condición se establece en 'false'.

Ejemplo de respuesta