Configuración de una política de copia de respaldo automatizada

Función

Esta API se utiliza para establecer una política de copia de respaldo automatizada.

• Antes de invocar a una API, debe entender la API de Autenticación.

URI

• Formato de URI

  PUT /v3/{project_id}/instances/{instance_id}/backups/policy

• Descripción de parámetro

  Tabla 1 Descripción de parámetro

  Nombre	Obligatorio	Descripción
  project_id	Sí	Especifica el ID de proyecto de un tenant en una región. Para obtener más información sobre cómo obtener el ID del proyecto, consulte Obtención de un ID de proyecto.
  instance_id	Sí	Especifica el ID de instancia de base de datos.

Solicitud

• Descripción de parámetro

  Tabla 2 Descripción de parámetro

  Nombre	Obligatorio	Tipo	Descripción
  backup_policy	Sí	Object	Especifica los objetos de política de copia de respaldo, incluidos el período de retención de la copia de respaldo (días) y la hora de inicio de la copia de respaldo. Para obtener más información, consulte Tabla 3.
  reserve_backups	No	Boolean	Especifica si se conservarán las copias de respaldo automatizadas y no sincronizadas. Este parámetro sólo es válido cuando la política de copia de respaldo automatizada está deshabilitada. true: indica que se conservan las copias de respaldo automatizadas y no sincronizadas. false: indica que las copias de respaldo automatizadas y no sincronizadas se eliminan cuando la política de copia de respaldo está deshabilitada.

  Tabla 3 descripción de la estructura de datos del campo de backup_policy

  Nombre	Obligatorio	Tipo	Descripción
  keep_days	Sí	Integer	Especifica el número de días para conservar los archivos de copia de respaldo generados. El intervalo de valores es de 0 a 732. El valor 0 indica que la política de copia de respaldo automatizada está deshabilitada. Para ampliar el período de retención, póngase en contacto con el servicio de atención al cliente. Las copias de respaldo automatizadas se pueden conservar hasta 2,562 días. AVISO: Una vez deshabilitada la política de copia de respaldo automatizada, las copias de seguridad automatizadas ya no se crean y todas las copias de seguridad incrementales se eliminan inmediatamente. Las operaciones relacionadas con las copias de respaldo incrementales, incluidas las descargas, las replicaciones, las restauraciones y las reconstrucciones, pueden fallar.
  start_time	No	String	Especifica la ventana de tiempo de copia de respaldo. Las copias de respaldo automatizadas se activarán durante la ventana de tiempo de copia de respaldo. Este parámetro es obligatorio, excepto que la política de copia de respaldo automatizada está deshabilitada. El valor debe ser un valor válido en el formato "hh:mm-HH:MM". La hora actual está en el formato UTC. El valor HH debe ser 1 mayor que el valor hh. Los valores de mm y MM deben ser los mismos y deben establecerse en cualquiera de los siguientes: 00, 15, 30 o 45. Valor de ejemplo: 08:15-09:15 23:00-00:00
  period	No	String	Especifica la configuración del ciclo de copia de respaldo. Los datos se respaldarán automáticamente en los días seleccionados cada semana. Este parámetro es obligatorio, excepto que la política de copia de respaldo automatizada está deshabilitada. Intervalo de valores: El valor es un número separado por comas (,), que indica los días de la semana. Por ejemplo, el valor 1,2,3,4 indica que el período de copia de respaldo es lunes, martes, miércoles y jueves.

Solicitud de ejemplo

• Configuración de una política de copia de respaldo automatizada para una instancia de base de datos, con el ciclo de copia de respaldo establecido en lunes y martes, la ventana de copia de respaldo en 19:00 a 20:00 y el período de retención en 7 días

  PUT https://{endpoint}/v3/0483b6b16e954cb88930a360d2c4e663/instances/dsfae23fsfdsae3435in01/backups/policy
  
  {
  	"backup_policy": {
  		"keep_days": 7,
  		"start_time": "19:00-20:00",
  		"period": "1,2"
  	}
  }

• Desactivación de una política de copia de respaldo automatizada

  {
  	"backup_policy": {
  		"keep_days": 0
  	},
  	"reserve_backups": false
  }

Respuesta

• Respuesta normal

  Ninguna

• Respuesta anormal

  Para obtener más información, consulte Resultados de solicitud anormales.

Código de estado

• Normal

  200

• Anormal

  Para obtener más información, consulte Códigos de estado.

Código de error

Para obtener más información, consulte Códigos de error.