Creación de una plantilla de parámetros
Función
Esta API se utiliza para crear una plantilla de parámetros y configurar el nombre, la descripción, el motor de base de datos y los valores de parámetros en la plantilla de parámetros.
- 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.
- La nueva plantilla de parámetros no puede tener el mismo nombre que cualquier plantilla de parámetros existente.
URI
- Formato de URI
- 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.
Solicitud
- Descripción de parámetro
Tabla 2 Descripción de parámetro Nombre
Obligatorio
Tipo
Descripción
name
Sí
String
Especifica el nombre de la plantilla de parámetro. Contiene un máximo de 64 caracteres y puede contener solo letras mayúsculas, minúsculas, dígitos, guiones (-), guiones bajos (_), y puntos (.).
description
No
String
Especifica la descripción de la plantilla de parámetro. Contiene un máximo de 256 caracteres y no puede contener los siguientes caracteres especiales: >!<&'= Su valor se deja en blanco de forma predeterminada.
values
No
Map<String,String>
Especifica los valores de parámetros definidos por los usuarios en función de las plantillas de parámetros predeterminadas. De forma predeterminada, los valores de los parámetros no se cambian.
- key: nombre de parámetro, por ejemplo, div_precision_increment o connect_timeout. Si no se especifica este parámetro, no se cambiará ningún valor de parámetro.
- value: valor de parámetro, por ejemplo, 6 o 20. Si key no está vacío, el parámetro value tampoco puede estar vacío.
datastore
Sí
Object
Especifica el objeto de base de datos.
Para obtener más información, consulte Tabla 3.
Tabla 3 descripción de la estructura de datos del campo de datastore Nombre
Obligatorio
Tipo
Descripción
type
Sí
String
Especifica el motor de base de datos. Su valor puede ser cualquiera de los siguientes y no distingue entre mayúsculas y minúsculas:
- MySQL
- PostgreSQL
- SQLServer
version
Sí
String
Especifica la versión de la base de datos. Para obtener más información, consulte Restricciones. Valores de ejemplo:- MySQL: 5.7
- PostgreSQL: 9.5
- Microsoft SQL Server: 2014_SE
Solicitud de ejemplo
Creación de una plantilla de parámetros denominada configuration_test
POST https://{endpoint}/v3/0483b6b16e954cb88930a360d2c4e663/configurations { "name": "configuration_test", "description": "configuration_test", "values": { "div_precision_increment": "6", "connect_timeout": "20" }, "datastore": { "type": "mysql", "version": "5.7" } }
Respuesta
- Respuesta normal
Tabla 4 Descripción de parámetro Nombre
Tipo
Descripción
configuration
Object
Indica la información de la plantilla de parámetros.
Para obtener más información, consulte Tabla 5.
Tabla 5 descripción de la estructura de datos del campo de configuración Nombre
Tipo
Descripción
id
String
Indica el ID de plantilla de parámetro.
name
String
Indica el nombre de la plantilla de parámetro.
datastore_version_name
String
Indica el nombre de la versión de la base de datos.
datastore_name
String
Indica el nombre de la base de datos.
description
String
Indica la descripción de la plantilla de parámetro.
created
String
Indica la hora de creación en el siguiente formato: aaaa-MM-ddTHH:mm:ssZ.
T es el separador entre el calendario y la notación horaria del tiempo. Z indica el desplazamiento de la zona horaria. Por ejemplo, en la zona horaria de Beijing, el desplazamiento de zona horaria se muestra como +0800.
updated
String
Indica la hora de actualización en el siguiente formato: aaaa-MM-ddTHH:mm:ssZ.
T es el separador entre el calendario y la notación horaria del tiempo. Z indica el desplazamiento de la zona horaria. Por ejemplo, en la zona horaria de Beijing, el desplazamiento de zona horaria se muestra como +0800.
- Ejemplo de respuesta normal
{ "configuration": { "id": "463b4b58-d0e8-4e2b-9560-5dea4552fde9", "name": "configuration_test", "datastore_version_name": "5.7", "datastore_name": "mysql", "description": "configuration_test", "created": "2017-04-09T08:27:56+0800", "updated": "2017-04-09T08:27:56+0800" } }
- Respuesta anormal
Para obtener más información, consulte Resultados de solicitud anormales.
Código de estado
- Normal
- 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.