Obtención del valor de un parámetro especificado para una instancia
Función
Esta API se utiliza para obtener el valor de un parámetro especificado para una instancia.
- Antes de invocar a una API, debe entender la API de Autenticación.
Restricciones
- Esta API está en OBT. Para utilizar esta API, póngase en contacto con el servicio de atención al cliente.
- Esta operación no se puede realizar cuando la instancia está en el estado anormal o congelado.
- Solo se puede consultar el valor de shared_preload_libraries.
URI
- Formato de URI
GET /v3/{project_id}/instances/{instance_id}/parameter/{name}
- Descripción de parámetro
Tabla 1 Descripción de parámetro Nombre
Obligatorio
Descripción
project_id
Sí
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í
ID de instancia.
name
Sí
Nombre del parámetro. Solo se puede consultar el valor de shared_preload_libraries.
Solicitud
Respuesta
- Respuesta normal
Tabla 2 Descripción de parámetro Nombre
Tipo
Descripción
name
String
Nombre del parámetro.
value
String
Valor del parámetro.
restart_required
Boolean
Si se requiere un reinicio.
- true: Se requiere un reinicio.
- false: No es necesario reiniciar.
value_range
String
Rango de valores de parámetros. Si el tipo de parámetro es integer, el valor es 0 o 1. Si el tipo de parámetro es boolean, el valor es true o false.
type
String
Tipo de parámetro. El valor puede ser string, integer, boolean, list, o float.
description
String
Descripción del parámetro.
- Ejemplo de respuesta normal
{ "name" : "shared_preload_libraries", "value" : "passwordcheck.so,pg_sql_history", "restart_required" : true, "value_range" : "passwordcheck.so,pg_stat_statements,pg_sql_history", "type" : "list", "description" : "Lists shared libraries to preload into server." }
- 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.