Consulta de nodos de instancia en lotes
Función
Esta API se utiliza para consultar la información de nodo, el número de instancias válidas y el número de nodos de todas las instancias de un proyecto específico. No se devolverá ninguna información de nodo cuando se estén creando instancias. Solo se pueden consultar las instancias de DCS Redis 4.0 y 5.0.
Restricciones
Solo se pueden consultar las instancias de DCS Redis 4.0 y 5.0.
URI
GET /v2/{project_id}/instances-logical-nodes
Parámetro |
Obligatorio |
Tipo |
Descripción |
---|---|---|---|
project_id |
Sí |
String |
ID del proyecto. |
Parámetro |
Obligatorio |
Tipo |
Descripción |
---|---|---|---|
offset |
No |
Integer |
offset, que es la posición en la que comienza la consulta. El valor debe ser mayor o igual a 0. |
limit |
No |
Integer |
Número de elementos mostrados en cada página. El valor máximo es 1000*. Si no se especifica este parámetro, se muestran 10 elementos en cada página de forma predeterminada. |
Parámetros de solicitud
Ninguno
Parámetros de respuesta
Código de estado: 200
Parámetro |
Tipo |
Descripción |
---|---|---|
count |
Integer |
Número total de instancias en el resultado de la consulta. |
instances |
Array of InstanceNodesInfoResp objects |
Lista de instancias. |
Parámetro |
Tipo |
Descripción |
---|---|---|
instance_id |
String |
ID de instancia. |
node_count |
Integer |
Número total de nodos de la instancia actual. |
nodes |
Array of NodesInfoResp objects |
Detalles del nodo. |
Parámetro |
Tipo |
Descripción |
---|---|---|
logical_node_id |
String |
ID de nodo lógico. |
name |
String |
Nombre del nodo. |
status |
String |
Estado del nodo. El valor puede ser:
Valores de enumeración:
|
az_code |
String |
Código de zona de disponibilidad. |
node_role |
String |
Tipo de nodo. El valor puede ser:
Valores de enumeración:
|
node_type |
String |
Rol de nodo. El valor puede ser:
Valores de enumeración:
|
node_ip |
String |
Dirección IP del nodo. |
node_port |
String |
Puerto de nodo. |
node_id |
String |
ID del nodo. |
priority_weight |
Integer |
Peso del nodo. |
is_access |
Boolean |
Si se puede acceder directamente a la dirección IP del nodo. |
group_id |
String |
ID de shard. |
group_name |
String |
Nombre del shard. |
is_remove_ip |
Boolean |
Si la dirección IP se elimina del nombre de dominio de solo lectura. |
replication_id |
String |
ID de la réplica. |
dimensions |
Array of InstanceReplicationDimensionsInfo objects |
Dimensión de la métrica de monitoreo de la réplica utilizada para llamar a la API de Cloud Eye para consultar métricas de monitoreo.
|
Parámetro |
Tipo |
Descripción |
---|---|---|
name |
String |
Monitoreo de nombre de dimensión |
value |
String |
Valor de la dimensión. |
Código de estado: 500
Parámetro |
Tipo |
Descripción |
---|---|---|
error_msg |
String |
Mensaje de error. Máximo: 1024 |
error_code |
String |
Código de error. Máximo: 9 |
error_ext_msg |
String |
Información de error extendida. Este parámetro no se utiliza actualmente y se establece en null. Máximo: 1024 |
Código de estado: 400
Parámetro |
Tipo |
Descripción |
---|---|---|
error_msg |
String |
Mensaje de error. Máximo: 1024 |
error_code |
String |
Código de error. Máximo: 9 |
error_ext_msg |
String |
Información de error extendida. Este parámetro no se utiliza actualmente y se establece en null. Máximo: 1024 |
Solicitudes de ejemplo
GET https://{dcs_endpoint}/v2/{project_id}/instances-logical-nodes?offset={offset}&limit={limit}
Ejemplo de respuestas
Código de estado: 200
Se consultó con éxito la Información de nodo.
{ "count" : 1, "instances" : [ { "instance_id" : "b4468cb1-4f75-4866-a49d-86959acc0c9c", "node_count" : 2, "nodes" : [ { "logical_node_id" : "8f997eb512a92834bf5914be52ca8919", "name" : "(replica)192.168.0.178", "status" : "Active", "az_code" : "xxxxxx", "node_role" : "redis-server", "node_type" : "slave", "node_ip" : "192.168.0.178", "node_port" : "6379", "node_id" : "8a2c26c17f4d6516017f4d7b77940030", "is_access" : true, "group_id" : "ace962d1-7841-4e50-9313-c239fd75dee3", "group_name" : "group-0", "priority_weight" : 100, "is_remove_ip" : false, "replication_id" : "e40aa09e-03c2-4319-86eb-5ef4ca637544", "dimensions" : [ { "name" : "dcs_instance_id", "value" : "caf2d19f-7783-44b0-be46-8c9da3ef1e94" }, { "name" : "dcs_cluster_redis_node", "value" : "8263dc69629c5b2d840e9816fa9c6200" } ] } ] } ] }
Código de estado: 500
Error interno del servicio.
{ "error_code" : "DCS.5000", "error_msg" : "Internal service error." }
Código de estado: 400
Solicitud no válida.
{ "error_code" : "DCS.4800", "error_msg" : "Invalid offset in the request." }
Códigos de estado
Código de estado |
Descripción |
---|---|
200 |
Se consultó con éxito la Información de nodo. |
500 |
Error interno del servicio. |
400 |
Solicitud no válida. |
Códigos de error
Consulte Códigos de error.