Listado de objetos monitoreados en dimensiones secundarias bajo una dimensión principal
Función
Esta API se utiliza para consultar los objetos monitoreados en dimensiones secundarias bajo la dimensión primaria dcs_instance_id.
URI
GET /v2/{project_id}/dims/monitored-objects/{instance_id}
Parámetro |
Obligatorio |
Tipo |
Descripción |
---|---|---|---|
project_id |
Sí |
String |
ID de inquilino. |
instance_id |
Sí |
String |
ID del objeto monitoreado en la dimensión principal, que es el ID de instancia. |
Parámetro |
Obligatorio |
Tipo |
Descripción |
---|---|---|---|
dim_name |
Sí |
String |
ID de la dimensión principal, que puede ser dcs_instance_id. |
Parámetros de solicitud
Ninguno
Parámetros de respuesta
Código de estado: 200
Parámetro |
Tipo |
Descripción |
---|---|---|
router |
Array of strings |
Ruta de la dimensión especificada. Si la dimensión es la dimensión principal, la matriz contiene el ID de la dimensión principal. |
children |
Array of DimChild objects |
Dimensiones secundarias bajo la dimensión especificada. Este parámetro sólo es válido cuando la dimensión es dcs_instance_id.
|
instances |
Array of InstancesMonitoredObject objects |
Objetos monitoreados de la dimensión especificada. |
dcs_cluster_redis_node |
Array of ClusterRedisNodeMonitoredObject objects |
Objetos monitoreados del servidor Redis. Este parámetro es válido para instancias de clúster de proxy y clúster de Redis. El nombre del campo es el mismo que el nombre del objeto de dimensión secundaria de children. |
dcs_cluster_proxy_node |
Array of ProxyNodeMonitoredObject objects |
Objetos monitoreados del Proxy. Este parámetro sólo es válido para instancias de clúster proxy de Redis 3.0. El nombre del campo es el mismo que el nombre del objeto de dimensión secundaria de children. |
dcs_cluster_proxy2_node |
Array of Proxy2NodeMonitoredObject objects |
Objetos monitoreados del Proxy. Este parámetro sólo es válido para las instancias de clúster proxy de Redis 4.0 y 5.0. El nombre del campo es el mismo que el nombre del objeto de dimensión secundaria de children. |
total |
Integer |
Número total de objetos monitoreados en la dimensión principal. |
Parámetro |
Tipo |
Descripción |
---|---|---|
dim_name |
String |
Nombre de la dimensión. Actualmente, se soportan las siguientes dimensiones: dcs_instance_id, dcs_cluster_redis_node, dcs_cluster_proxy_node, dcs_memcached_instance_id. |
dim_route |
String |
Ruta de la dimensión. Formato: Dimension name,Sub-dimension name. Por ejemplo, si dim_name es dcs_cluster_redis_node, el valor de dim_route es dcs_instance_id,dcs_cluster_redis_node. |
Parámetro |
Tipo |
Descripción |
---|---|---|
dcs_instance_id |
String |
ID del objeto monitoreado, que es el ID de instancia. |
name |
String |
Nombre del objeto monitoreado, que es el nombre de la instancia. |
status |
String |
Estado del objeto monitoreado, que es el estado de la instancia. |
Parámetro |
Tipo |
Descripción |
---|---|---|
dcs_instance_id |
String |
ID del objeto monitoreado, que es el ID del nodo. |
name |
String |
Nombre del objeto monitoreado, que es la dirección IP del nodo. |
dcs_cluster_redis_node |
String |
ID del objeto supervisado en la dimensión dcs_cluster_redis_node. |
status |
String |
Estado del objeto monitoreado, que es el estado del nodo. |
Parámetro |
Tipo |
Descripción |
---|---|---|
dcs_instance_id |
String |
ID del objeto monitoreado, que es el ID del nodo. |
name |
String |
Nombre del objeto monitoreado, que es la dirección IP del nodo. |
dcs_cluster_proxy_node |
String |
ID del objeto monitoreado en la dimensión dcs_cluster_proxy_node. |
status |
String |
Estado del objeto monitoreado, que es el estado del nodo. |
Parámetro |
Tipo |
Descripción |
---|---|---|
dcs_instance_id |
String |
ID del objeto monitoreado, que es el ID del nodo. |
name |
String |
Nombre del objeto monitoreado, que es la dirección IP del nodo. |
dcs_cluster_proxy2_node |
String |
ID del objeto monitoreado en la dimensión dcs_cluster_proxy2_node. |
status |
String |
Estado del objeto monitoreado, que es el estado del nodo. |
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 |
Solicitudes de ejemplo
GET https://{dcs_endpoint}/v2/{project_id}/dims/monitored-objects/{instance_id}?dim_name={dim_name}
Ejemplo de respuestas
Código de estado: 200
Se consultó correctamente los objetos supervisados de la dimensión principal.
{ "router" : [ "dcs_instance_id" ], "total" : 1, "children" : [ { "dim_name" : "dcs_cluster_redis_node", "dim_route" : "dcs_instance_id,dcs_cluster_redis_node" } ], "instances" : [ { "name" : "dcs-test001", "status" : "RUNNING", "dcs_instance_id" : "03ca9da0-1104-40a5-b49d-5ef8e41bfd19" } ], "dcs_cluster_redis_node" : [ { "name" : "(master)192.168.2.145", "status" : "RUNNING", "dcs_instance_id" : "03ca9da0-1104-40a5-b49d-5ef8e41bfd19", "dcs_cluster_redis_node" : "b1f4aa9e4dae50888e58c9caecdfc108" }, { "name" : "(replica)192.168.2.199", "status" : "RUNNING", "dcs_instance_id" : "03ca9da0-1104-40a5-b49d-5ef8e41bfd19", "dcs_cluster_redis_node" : "e0e10e489a73487147928167396474bc" }, { "name" : "(master)192.168.2.243", "status" : "RUNNING", "dcs_instance_id" : "03ca9da0-1104-40a5-b49d-5ef8e41bfd19", "dcs_cluster_redis_node" : "e797c3ba8bee782e25cdd4a90eb00517" }, { "name" : "(replica)192.168.2.164", "status" : "RUNNING", "dcs_instance_id" : "03ca9da0-1104-40a5-b49d-5ef8e41bfd19", "dcs_cluster_redis_node" : "d810fb44f9f7a359e000cf277a824c43" }, { "name" : "(master)192.168.2.95", "status" : "RUNNING", "dcs_instance_id" : "03ca9da0-1104-40a5-b49d-5ef8e41bfd19", "dcs_cluster_redis_node" : "f25c37a4654d50b07e629fc2adfba60f" }, { "name" : "(replica)192.168.2.51", "status" : "RUNNING", "dcs_instance_id" : "03ca9da0-1104-40a5-b49d-5ef8e41bfd19", "dcs_cluster_redis_node" : "da5149a20dc7caf35587e4d2433fe452" } ] }
Códigos de estado
Código de estado |
Descripción |
---|---|
200 |
Se consultó correctamente los objetos supervisados de la dimensión principal. |
500 |
Error interno del servicio. |
Códigos de error
Consulte Códigos de error.