Creación de una plantilla de parámetros
Función
Esta API se utiliza para crear una plantilla de parámetro. Debe configurarse la siguiente información: nombre de la plantilla, descripción, versión del motor de base de datos y valores de parámetros. Antes de invocar a esta API:
- Aprender cómo autorizar y autenticarla.
- Obtener los región y punto de conexión requeridos.
Restricciones
- Esta API solo está disponible para instancias primarias/en espera de GaussDB(for MySQL) (edición dedicada).
- El nombre de la plantilla de parámetros personalizada distingue entre mayúsculas y minúsculas y debe ser diferente del nombre de una plantilla de parámetros existente o predeterminada.
- El valor de parameter_values en la plantilla de parámetros personalizada debe estar dentro del rango de valores predeterminado de la versión de base de datos especificada.
URI
POST /v3/{project_id}/configurations
Parámetro |
Obligatorio |
Tipo |
Descripción |
---|---|---|---|
project_id |
Sí |
String |
ID de proyecto de un tenant en una región. |
Parámetros de solicitud
Parámetro |
Obligatorio |
Tipo |
Descripción |
---|---|---|---|
X-Auth-Token |
Sí |
String |
Token de usuario. |
X-Language |
No |
String |
Idioma. |
Parámetro |
Obligatorio |
Tipo |
Descripción |
---|---|---|---|
name |
Sí |
String |
Nombre de la plantilla del parámetro. El nombre de la plantilla puede contener de 1 a 64 caracteres. Solo se permiten letras (distinguiendo mayúsculas y minúsculas), dígitos, guiones (-), guiones bajos (_), y puntos (.). |
description |
No |
String |
Descripción de la plantilla de parámetros. El valor se deja en blanco de forma predeterminada. La descripción puede contener hasta 256 caracteres y no puede contener los caracteres de retorno de carro o caracteres especiales (!<"='>&). |
parameter_values |
No |
Map<String,String> |
Asignación entre nombres de parámetros y valores de parámetros. Puede especificar valores de parámetros basados en una plantilla de parámetros predeterminada. |
datastore |
No |
DatastoreResult object |
Objeto de base de datos. |
Parámetro |
Obligatorio |
Tipo |
Descripción |
---|---|---|---|
type |
Sí |
String |
Motor de base de datos. Actualmente, solo se admite gaussdb-mysql. |
version |
Sí |
String |
Versión de base de datos. Para obtener detalles sobre las versiones del motor de base de datos compatibles, invoque a la API para consultar las versiones del motor de base de datos. |
Parámetros de respuesta
Código de estado: 200
Parámetro |
Tipo |
Descripción |
---|---|---|
configurations |
ConfigurationSummary2 object |
Información de la plantilla de parámetros. |
Parámetro |
Tipo |
Descripción |
---|---|---|
id |
String |
ID de plantilla de parámetro. |
name |
String |
Nombre de la plantilla del parámetro. |
description |
String |
Descripción de la plantilla de parámetros. |
datastore |
DatastoreResult object |
Objeto de base de datos. |
created |
String |
Tiempo de creación en el formato "yyyy-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. |
updated |
String |
Tiempo de actualización en el formato "yyyy-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. |
Parámetro |
Tipo |
Descripción |
---|---|---|
type |
String |
Motor de base de datos. Actualmente, solo se admite gaussdb-mysql. |
version |
String |
Versión de base de datos. Para obtener detalles sobre las versiones del motor de base de datos compatibles, invoque a la API para consultar las versiones del motor de base de datos. |
Código de estado: 400
Parámetro |
Tipo |
Descripción |
---|---|---|
error_code |
String |
Código de error. |
error_msg |
String |
Mensaje de error. |
Código de estado: 500
Parámetro |
Tipo |
Descripción |
---|---|---|
error_code |
String |
Código de error. |
error_msg |
String |
Mensaje de error. |
Solicitud de ejemplo
POST https://{endpoint}/v3/056538411200d4cd2f79c003c7606412/configurations { "name" : "myparameter", "description" : "parameter1", "datastore" : { "type" : "gaussdb-mysql", "version" : "8.0" }, "parameter_values" : { "max_user_connections" : "10" } }
Ejemplo de respuesta
Código de estado: 200
Success.
{ "configurations" : { "id" : "887ea0d1bb0843c49e8d8e5a09a95652pr07", "name" : "myparameter", "description" : "parameter1", "datastore" : { "type" : "gaussdb-mysql", "version" : "8.0" }, "created" : "2022-05-15T11:53:34+0000", "updated" : "2022-05-15T11:53:34+0000" } }
Código de estado
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.