Obtención de parámetros en una plantilla de parámetros especificada
Función
Esta API se utiliza para obtener parámetros de una plantilla de parámetros 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.
config_id
Sí
Especifica el ID de plantilla de parámetro.
Cuando este parámetro está vacío (no es espacio), se obtiene la URL de la lista de plantillas de parámetros. Para obtener más información, consulte Obtención de una lista de plantillas de parámetros.
Solicitud
Respuesta
- Respuesta normal
Tabla 2 Descripción de parámetro 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.
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, consulte 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: indica que no se requiere un reinicio.
- true: indica que se requiere un reinicio.
readonly
Boolean
Indica si el parámetro es de sólo lectura.
- false: indica que el parámetro no es sólo lectura.
- true: indica que el parámetro es sólo lectura.
value_range
String
Indica el rango de valores del parámetro. Por ejemplo, el valor de integer es 0-1, y el valor de boolean 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
{ "id": "07fc12a8e0e94df7a3fcf53d0b5e1605pr01", "name": "default-mysql-5.7", "datastore_version_name": "5.7", "datastore_name": "mysql", "description": "Default parameter group for mysql 5.7", "created": "2017-05-05T04:40:51+0800", "updated": "2017-05-05T04:40:51+0800", "configuration_parameters": [ { "name": "auto_increment_increment", "value": "1", "restart_required": false, "readonly": true, "value_range": "1-65535", "type": "integer", "description": "auto_increment_increment and auto_increment_offset are intended for use with master-to-master replication, and can be used to control the operation of AUTO_INCREMENT columns." }, { "name": "autocommit", "value": "ON", "restart_required": false, "readonly": true, "value_range": "ON|OFF", "type": "boolean", "description": "The autocommit mode. If set to ON, all changes to a table take effect immediately. If set to OFF, you must use COMMIT to accept a transaction or ROLLBACK to cancel it. " } ] }
- 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.