Aplicación de plantilla de parámetros.

Función

Esta API se utiliza para aplicar una plantilla de parámetro a una o más instancias de base de datos.

Esta API no estará disponible el 31 de marzo de 2024. Se recomienda cambiar las cargas de trabajo a la nueva API (Aplicación de plantilla de parámetros.) antes de esa fecha.

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

Restricciones

• Los siguientes motores de base de datos son compatibles: MySQL, PostgreSQL, y Microsoft SQL Server.

URI

• Formato de URI

  PUT /v3/{project_id}/configurations/{config_id}/apply

• Ejemplo

  https://{endpoint}/v3/0483b6b16e954cb88930a360d2c4e663/configurations/463b4b58-d0e8-4e2b-9560-5dea4552fde9/apply

• Descripción de parámetro

  Tabla 1 Descripción de parámetro

  Nombre	Obligatorio	Descripción
  project_id	Sí	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.
  config_id	Sí	ID de plantilla de parámetro.

Solicitud

• Descripción de parámetro

  Tabla 2 Descripción de parámetro

  Nombre	Obligatorio	Tipo	Descripción
  instance_ids	Sí	Array of strings	ID de instancia.

• Ejemplo de solicitud

{
	"instance_ids": ["73ea2bf70c73497f89ee0ad4ee008aa2in01", "fe5f5a07539c431181fc78220713aebein01"]
}

Respuesta

• Respuesta normal

  Tabla 3 Descripción de parámetro

  Nombre	Tipo	Descripción
  configuration_id	String	ID de plantilla de parámetro.
  configuration_name	String	Nombre de la plantilla del parámetro.
  apply_results	Array of objects	Resultado de la aplicación de la plantilla de parámetros. Para obtener más información, consulte Tabla 4.
  success	Boolean	Si la plantilla de parámetro se aplica correctamente a todas las instancias de base de datos solicitadas. true: La plantilla de parámetros se aplicó correctamente a todas las instancias de base de datos solicitadas. false: No se pudo aplicar la plantilla de parámetros a una o más instancias de base de datos solicitadas.
  job_id	String	ID de tarea.

  Tabla 4 descripción de la estructura de datos del campo apply_results

  Nombre	Tipo	Descripción
  instance_id	String	ID de instancia.
  instance_name	String	Nombre de instancia.
  restart_required	Boolean	Si se requiere un reinicio. true: Se requiere un reinicio. false: No es necesario reiniciar.
  success	Boolean	Si la plantilla de parámetro se ha aplicado correctamente a la instancia de base de datos. true: La aplicación se ha realizado correctamente. false: Error en la aplicación.

• Ejemplo de respuesta normal

  {
  	"configuration_id": "cf49bbd7d2384878bc3808733c9e9d8bpr01",
  	"configuration_name": "paramsGroup-bcf9",
          "job_id":"e4942c94-9d66-458e-beb7-90601664641e",
  	"apply_results": [{
  		"instance_id": "fe5f5a07539c431181fc78220713aebein01",
  		"instance_name": "zyy1",
  		"restart_required": false,
  		"success": false
  	}, {
  		"instance_id": "73ea2bf70c73497f89ee0ad4ee008aa2in01",
  		"instance_name": "zyy2",
  		"restart_required": false,
  		"success": false
  	}],
  	"success": false
  }

• 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.