Consulta de información del proxy de base de datos
Función
Esta API no estará disponible el 31 de marzo de 2024. Se recomienda cambiar las cargas de trabajo a la nueva API (Consulta de instancias de proxy de base de datos) antes de esa fecha.
- Aprender cómo autorizar y autenticarla.
- Obtener los región y punto de conexión requeridos.
- El proxy de base de datos no está disponible para instancias de base de datos en un DeC.
URI
- Formato de URI
GET https://{endpoint}/mysql/v3/{project_id}/instances/{instance_id}/proxy
- Ejemplo
GET https://{endpoint}/mysql/v3/97b026aa9cc4417888c14c84a1ad9860/instances/436aaafb689c4250a9a5bb33cb271e8cin07/proxy
- Descripción de parámetro
Tabla 1 Descripción de parámetro Nombre
Tipo
Obligatorio
Descripción
project_id
String
Sí
ID de proyecto de un tenant en una región.
Para obtener este valor, consulte Obtención de un ID de proyecto.
instance_id
String
Sí
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
Instancia de proxy de base de datos.
Para obtener más información, consulte Tabla 3.
master_node
Object
Nodo principal.
Para obtener más información, consulte Tabla 4.
readonly_nodes
Array of Object
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 campo de proxy Nombre
Tipo
Descripción
pool_id
String
ID de instancia de proxy.
status
String
Si la instancia proxy está habilitada. Puede ser closed, open, frozen, opening, closing, enlarging, freezing o unfreezing.
address
String
Dirección de división de lectura/escritura de proxy.
port
Integer
Información de puerto de proxy.
pool_status
String
Estado de instancia de proxy. Puede ser abnormal, normal, creating o deleted.
delay_threshold_in_seconds
Integer
Umbral de retardo en segundos.
elb_vip
String
Dirección IP virtual en modo ELB.
eip
String
Información de la EIP.
vcpus
String
Número de vCPUs de la instancia de proxy.
ram
String
Tamaño de la memoria de la instancia de proxy.
node_num
Integer
Número de nodos de proxy.
mode
String
Proxy primario/en espera. Puede ser Cluster.
nodes
Object
Información del nodo de proxy.
Para obtener más información, consulte Tabla 6.
flavor_ref
String
Código de especificación de proxy.
Tabla 4 descripción de la estructura de datos de master_node Nombre
Tipo
Descripción
id
String
ID de nodo primario.
instance_id
String
ID de instancia de base de datos.
status
String
Estado del nodo primario.
name
String
Nombre del nodo principal.
weight
Integer
Ponderación de división de lectura/escritura del nodo principal.
available_zones
Array of object
Información de zona de disponibilidad.
Para obtener más información, consulte Tabla 7.
Tabla 5 descripción de estructura de datos de campo de readonly_nodes Nombre
Tipo
Descripción
id
String
ID de réplica de lectura.
instance_id
String
ID de instancia de base de datos.
status
String
Estado de réplica de lectura.
name
String
Nombre de réplica de lectura.
weight
Integer
Ponderación de lectura de réplicas de lectura.
available_zones
Array of object
Información de zona de disponibilidad.
Tabla 6 descripción de estructura de datos de campo de nodos Nombre
Tipo
Descripción
id
String
ID de nodo de proxy.
status
String
Estado del nodo de proxy. Puede ser normal, abnormal, creating o deleted.
name
String
Nombre del nodo de proxy.
role
String
Rol del nodo de proxy. Puede ser master o slave.
az_code
String
Zona de disponibilidad.
frozen_flag
Integer
Si el nodo proxy está congelado. Puede ser 0 (sin congelar), 1 (congelado) o 2 (eliminado después de ser congelado).
- Ejemplo de respuesta normal
{
"proxy":{
"pool_id":null,
"status":"closed",
"address":null,
"port":null,
"pool_status":null,
"delay_threshold_in_seconds":null,
"elb_vip":null,
"eip":null,
"vcpus":null,
"ram":null,
"node_num":null,
"mode":null,
"nodes":[
],
"flavor_ref": "gaussdb.proxy.xlarge.arm.2"
},
"master_node":{
"id":"294daeb0ec9e4c4eacaf2c6dbd8246a9no07",
"instance_id":"71215aadf19c428db088e51b157583f2in07",
"status":"ACTIVE",
"name":"BUG-gauss-dw_node01",
"weight":null,
"available_zones":[
{
"code":"az1xahz",
"description":"az1xahz"
}
]
},
"readonly_nodes":[
{
"id":"b36d70cc3c3b4ef680e34c5b25b168dano07",
"instance_id":"71215aadf19c428db088e51b157583f2in07",
"status":"ACTIVE",
"name":"BUG-gauss-dw_node02",
"weight":null,
"available_zones":[
{
"code":"az1xahz",
"description":"az1xahz"
}
]
}
]
}
Código de estado
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.