Obtención de la plantilla de parámetros de una instancia de base de datos especificada
Función
Esta API se utiliza para obtener información sobre la plantilla de parámetros de una instancia de base de datos especificada.
- 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
- 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 que cumple con el formato UUID.
Solicitud
Respuesta
- Respuesta normal
Tabla 2 Descripción de parámetro Nombre
Tipo
Descripción
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.
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.
configuration_parameters
Array of objects
Indica los parámetros definidos por los usuarios basados en las plantillas de parámetros por defecto.
Para obtener más información, véase Tabla 3.
Tabla 3 descripción de la estructura de datos del campo configuration_parameters Nombre
Tipo
Descripción
name
String
Indica el nombre del parámetro.
value
String
Indica el valor del parámetro.
restart_required
Boolean
Indica si se requiere un reinicio.
- false: No es necesario reiniciar.
- true: Se requiere un reinicio.
readonly
Boolean
Indica si el parámetro es de sólo lectura.
- false: El parámetro no es sólo lectura.
- true: El parámetro es sólo lectura.
value_range
String
Indica el rango de valores del parámetro. Si el tipo es entero, el valor es 0 o 1. Si el tipo es Boolean, el valor es true o false.
type
String
Indica el tipo de parámetro, que puede ser integer, string, boolean, list o float.
description
String
Indica la descripción del parámetro.
- Ejemplo de respuesta normal
{ "datastore_version_name": "5.7", "datastore_name": "mysql", "created": "2018-10-11 11:40:44", "updated": "2018-10-11 11:40:44", "configuration_parameters": [{ "name": "auto_increment_increment", "value": "1", "restart_required": false, "readonly": false, "value_range": "1-65535", "type": "integer", "description": auto_increment_increment and auto_increment_offset are used for master-to-master replication and to control the operations of the AUTO_INCREMENT column. }] }
- 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.