Modificación de parámetros en una plantilla de parámetros
Función
Esta API se utiliza para modificar parámetros en una plantilla de parámetros especificada, incluidos nombres de parámetros, descripciones y valores. Antes de invocar a esta API:
- Aprender cómo autorizar y autenticarla.
- Obtenga la región y el punto de conexión requeridos.
Restricciones
- Esta API solo está disponible para instancias de TaurusDB de clúster (edición dedicada).
- Las plantillas de parámetros predeterminadas no se pueden modificar.
- El nombre de la plantilla de parámetros modificada debe ser diferente del de una plantilla de parámetros predeterminada.
- Los valores de los parámetros que se van a modificar deben estar dentro del rango de valores predeterminado de la versión de base de datos especificada.
URI
PUT /v3/{project_id}/configurations/{configuration_id}
|
Parámetro |
Obligatorio |
Tipo |
Descripción |
|---|---|---|---|
|
project_id |
Sí |
String |
ID de proyecto de un tenant en una región. Para obtener este valor, consulte Obtención de un ID de proyecto. |
|
configuration_id |
Sí |
String |
ID de plantilla de parámetro. Para obtener este valor, consulte Consulta de plantillas de parámetros. |
Parámetros de solicitud
|
Parámetro |
Obligatorio |
Tipo |
Descripción |
|---|---|---|---|
|
X-Auth-Token |
Sí |
String |
Token de usuario. Para obtener este valor, invoque a la API de IAM para obtener un token de usuario. El valor de X-Subject-Token en el encabezado de respuesta es el valor del token. |
|
X-Language |
No |
String |
Tipo de idioma de solicitud. El valor predeterminado es en-us. Valores:
|
|
Parámetro |
Obligatorio |
Tipo |
Descripción |
|---|---|---|---|
|
name |
No |
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 (.). La descripción de la plantilla de parámetro, el nombre de parámetro y la asignación de valores de parámetro no pueden estar vacías al mismo tiempo. |
|
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 un máximo de 256 caracteres y no puede contener el carácter de retorno de carro ni los siguientes 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. Si no se especifica este parámetro, se conserva la información original del parámetro. |
Parámetros de respuesta
Código de estado: 200
|
Parámetro |
Tipo |
Descripción |
|---|---|---|
|
job_id |
String |
ID de tarea para modificar la plantilla de parámetros. |
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. |
Ejemplo de la solicitud
Modificación de parámetros en una plantilla de parámetros
PUT https://{endpoint}/v3/0549b4a43100d4f32f51c01c2fe4acdb/configurations/7a8d539ba30f43adaf1b16d08b1df4bdpr07
{
"parameter_values" : {
"max_user_connections" : "4"
}
}
Ejemplo de respuesta
Código de estado: 200
Operación exitosa.
{
"job_id" : "f6cb21fe-186a-4931-b20d-764ced1f1f6b"
}
Código de estado
Para más detalles, véase Códigos de estado.
Código de error
Para más detalles, véase Códigos de error.
