Listado de objetos monitoreados en dimensiones principales
Función
Esta API se utiliza para consultar los objetos supervisados en las dimensiones primarias dcs_instance_id y dcs_memcached_instance_id.
URI
GET /v2/{project_id}/dims/monitored-objects
Parámetro |
Obligatorio |
Tipo |
Descripción |
---|---|---|---|
project_id |
Sí |
String |
ID de inquilino. |
Parámetro |
Obligatorio |
Tipo |
Descripción |
---|---|---|---|
dim_name |
Sí |
String |
ID de dimensión principal, que puede ser dcs_instance_id o dcs_memcached_instance_id. |
offset |
No |
Integer |
offset, que es la posición en la que comienza la consulta. El valor debe ser mayor o igual a 0. Predeterminado: 0 |
limit |
No |
Integer |
Número de elementos mostrados en cada página. Predeterminado: 10 |
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. |
total |
Integer - key |
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. |
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?dim_name={dim_name}
Ejemplo de respuestas
Código de estado: 200
Enumeró correctamente los objetos supervisados en la dimensión principal.
{ "router" : [ "dcs_instance_id" ], "total" : 3, "children" : [ { "dim_name" : "dcs_cluster_redis_node", "dim_route" : "dcs_instance_id,dcs_cluster_redis_node" }, { "dim_name" : "dcs_cluster_proxy_node", "dim_route" : "dcs_instance_id,dcs_cluster_proxy_node" } ], "instances" : [ { "name" : "dcs-redis-single-node", "status" : "RUNNING", "dcs_instance_id" : "fe909c47-8990-44a0-9154-d0a1e95e78fe" }, { "name" : "dcs-redis-master-standby", "status" : "RUNNING", "dcs_instance_id" : "877e5ae3-482e-4c38-88a0-030a0fa6f399" }, { "name" : "dcs-proxy-cluster", "status" : "RUNNING", "dcs_instance_id" : "448ee851-1366-47f2-913a-e21032e690c4" } ] }
Códigos de estado
Código de estado |
Descripción |
---|---|
200 |
Enumeró correctamente los objetos supervisados en la dimensión principal. |
500 |
Error interno del servicio. |
Códigos de error
Consulte Códigos de error.