Consulta de información sobre el proxy de base de datos
Función
Esta API se utiliza para consultar información sobre el proxy de base de datos de una instancia de base de datos especificada.
Esta API no estará disponible el 31 de marzo de 2024.
- Antes de invocar a una API, debe entender la API de Autenticación.
Restricciones
- Solo se soportan PostgreSQL 11 y PostgreSQL 12.
- Se debe haber habilitado un proxy de base de datos para la instancia de base de datos.
URI
- Formato de URI
- Ejemplo
https://{endpoint}/v3/0483b6b16e954cb88930a360d2c4e663/instances/f569f1358436479dbcba8603c32cc4aein03/proxy
- 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.
Solicitud
Ninguna
Respuesta
- Respuesta normal
Tabla 2 Descripción de parámetro Nombre
Tipo
Descripción
proxy
Object
Indica la información de instancia de proxy.
Para obtener más información, consulte Tabla 3.
master_instance
Object
Indica la información de instancia principal.
Para más detalles, véase Tabla 4
readonly_instances
Array of objects
Indica información de réplica de lectura.
Para obtener más información, consulte Tabla 5.
Tabla 3 descripción de la estructura de datos del elemento proxy Nombre
Tipo
Descripción
pool_id
String
Indica el ID de instancia del proxy.
status
String
Indica si la instancia proxy está habilitada. El valor puede ser cualquiera de los siguientes:
- open
- closed
- frozen
- opening
- closing
- freezing
- unfreezing
address
String
Indica la dirección de separación de lectura/escritura del proxy.
elb_vip
String
Indica la dirección IP virtual en modo ELB.
eip
String
Indica la EIP.
port
Integer
Indica el puerto proxy.
pool_status
String
Indica el estado de la instancia proxy. El valor puede ser cualquiera de los siguientes:
- abnormal
- normal
- creating
- deleted
delay_threshold_in_kilobytes
Integer
Indica el umbral de retardo (KB).
cpu
String
Indica el número de CPU de una instancia proxy.
mem
String
Indica la memoria de una instancia proxy.
node_num
Integer
Indica el número de un nodo proxy.
nodes
Array of objects
Indica la información del nodo proxy.
Para obtener más información, consulte Tabla 6.
mode
String
Indica el proxy en el modo primario/en espera. El valor puede ser Ha.
Tabla 4 descripción de la estructura de datos del elemento master_instance Nombre
Tipo
Descripción
id
String
Indica el ID de instancia de base de datos principal.
status
String
Indica el estado de la instancia de base de datos principal.
name
String
Indica el nombre de la instancia de base de datos principal.
weight
Integer
Indica el peso de lectura de una instancia de base de datos principal.
available_zones
Array of objects
Indica la información de zona de disponibilidad.
Para obtener más información, consulte Tabla 7.
cpu_num
Integer
Indica el número de CPU de una instancia de base de datos principal.
Tabla 5 descripción de estructura de datos de elemento de readonly_instances Nombre
Tipo
Descripción
id
String
Indica el ID de réplica de lectura.
status
String
Indica el estado de la réplica de lectura.
name
String
Indica el nombre de la réplica de lectura.
weight
Integer
Indica la ponderación de lectura de una réplica de lectura.
available_zones
Array of objects
Indica la información de zona de disponibilidad.
Para obtener más información, consulte Tabla 7.
cpu_num
Integer
Indica el número de CPU de una réplica de lectura.
Tabla 6 descripción de estructura de datos de elemento de nodos Nombre
Tipo
Descripción
id
String
Indica el ID del nodo proxy.
name
String
Indica el nombre del nodo proxy.
role
String
Indica el rol del nodo proxy. El valor puede ser uno de los siguientes:
- master
- slave
az_code
String
Indica la zona de disponibilidad.
status
String
Indica el estado del nodo proxy. El valor puede ser cualquiera de los siguientes:
- normal
- abnormal
- creating
- deleted
frozen_flag
Integer
Indica si el nodo proxy está congelado.
- 0: descongelado.
- 1: congelado
- 2: suprimida después de haber sido congelada.
- Ejemplo de respuesta normal
{ "proxy":{ "pool_id":"c6ee492784b640e694f1da0201cd82c8po03", "status":"open", "address":"192.168.0.60", "elb_vip":null, "eip":null, "port":3306, "pool_status":"normal", "delay_threshold_in_kilobytes":30, "cpu":"4", "mem":"8", "node_num":2, "nodes":[ { "id":"4fb00607cffd42dc9583ca09863df93cpn03", "name":"PROXY-c6ee492784b640e694f1da0201cd82c8po03_1", "role":"slave", "az_code":"az1xahz", "status":"normal", "frozen_flag":0 }, { "id":"191f3164f918463bb6aedeb6ba742920pn03", "name":"PROXY-c6ee492784b640e694f1da0201cd82c8po03_0", "role":"master", "az_code":"az1xahz", "status":"normal", "frozen_flag":0 } ], "mode":"Ha" }, "master_instance":{ "id":"49fcbb94435c4d89930e91dcf5884909in03", "status":"normal", "name":"proxy-hwt-0922-3", "weight":0, "available_zones":[ { "code":"az1xahz", "description":"AZ 1" } ], "cpu_num":8 }, "readonly_instances":[ { "id":"83251d1398594b9fbfc8f1ab8b8228b2in03", "status":"normal", "name":"replica-a392", "weight":100, "available_zones":[ { "code":"az1xahz", "description":"AZ 1" } ], "cpu_num":4 } ] }
- 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.