Ejecuta la acción correspondiente según el tipo de módulo especificado por el parámetro.
Pruébelo ahora
Test
Autorización de RAM
|
Action |
Nivel de acceso |
Tipo de recurso |
Clave de condición |
Acción dependiente |
|
arms:DoInsightsAction |
get |
*All Resource
|
Ninguna | Ninguna |
Parámetros de la solicitud
|
Parámetro |
Tipo |
Obligatorio |
Descripción |
Ejemplo |
| Module |
string |
Sí |
Tipo de módulo
Nota: Las funciones anteriores se encuentran en versión canary y no están habilitadas de forma predeterminada. Para habilitarlas, póngase en contacto con el soporte de guardia de ARMS. Valores válidos:
|
QueryTopo |
| Data |
string |
Sí |
Parámetros de consulta. Los parámetros de consulta varían según el tipo de módulo.
|
- QueryTopo { "regionId": "cn-hangzhou", "startTime": "2024-07-23 19:16:00", "endTime": "2024-07-23 20:16:00", # Limitar el rango de consulta de topología del 2024-07-23 19:16:00 al 2024-07-23 20:16:00 "edgeFilter": { "includeTypes": [ "CALLS" # Limitar la topología resultante para incluir solo aristas con relaciones de llamada ], "fromNodeFilter": { "includeEntityTypes": [ # Limitar el tipo de nodo de origen de las aristas de llamada al tipo de aplicación "APPLICATION" ] }, "toNodeFilter": { "includeEntityTypes": [ # Limitar el nodo de destino de las aristas de llamada al tipo de aplicación o tipo de servicio externo "APPLICATION", "EXTERNAL_SERVICE" ] } }, "includeIsolatedNodes": false, # No incluir nodos aislados en la topología resultante "queryMetrics": true, # Consultar sincrónicamente las métricas RED "timeoutSecs": 20, # Permitir hasta 20 segundos para consultar los datos de métricas "redOption": { # Las métricas a consultar incluyen latencia y recuento de solicitudes; omitir la consulta de recuento de errores "skipRt": false, "skipCount": false, "skipError": true } } - QueryTopoRed { "regionId": "cn-hangzhou", "startTime": "2024-07-23 10:00:00", "endTime": "2024-07-23 14:00:00", "edgeIds": [ "097843bd50b06fbe2c6c1d8b761a7e8b" ], "nodeIds": [ "23d973261c6923da1b5b7a571ec1aa8b" ], "redOption": { # Las métricas a consultar incluyen latencia y recuento de solicitudes; omitir la consulta de recuento de errores "skipCount": false, "skipError": true, "skipRt": false } } |
| RegionId |
string |
No |
El ID de la región. |
cn-hangzhou |
Una topología consiste en aristas y nodos. Cada arista tiene un tipo correspondiente, cada nodo tiene una entidad correspondiente y cada entidad tiene su propio tipo. Al configurar el tipo de arista, el tipo de nodo, el rango de tiempo de consulta y otros parámetros, puede filtrar los datos de topología necesarios.
-
Nodos aislados.
Un nodo aislado se refiere a un nodo que no tiene relaciones con otros nodos.
Cuando un tipo de campo es enum, indica que el valor del campo proviene de una enumeración. Consulte la descripción complementaria para las definiciones de enumeración.
Elementos de la respuesta
|
Elemento |
Tipo |
Descripción |
Ejemplo |
|
object |
Esquema de respuesta. |
||
| RequestId |
string |
El ID de la solicitud. |
626037F5-FDEB-45B0-804C-B3C92797A64E |
| Code |
integer |
Código de estado. 200 indica éxito; otros códigos de estado indican excepciones. |
200 |
| Success |
boolean |
Indica si la consulta fue exitosa:
|
true |
| Message |
string |
El mensaje devuelto cuando la llamada falla. |
success |
| Data |
string |
El tipo de parámetro de retorno está relacionado con el valor del módulo pasado.
} |
- QueryTopo { "nodes": [ { "nodeId": "3bfe1a747389273388182760406c079d", "entity": { "regionId": "cn-hangzhou", "appType": "TRACE", "appId": "xxxxxxxxxxxxxxxx", "name": "prometheus-pop-cn-hangzhou", "entityId": "3bfe1a747389273388182760406c079d", "firstSeenTms": 1721733226981, "lastSeenTms": 1721789171614, "type": "APPLICATION" }, "attrs": { "RED": { "count": 643848.0, "error": 0.0, "rt": 172.31701892372112 } } } ], "edges": [ { "from": "98b4184b22e588cf86e9a29aa4179606", "to": "98b4184b22e588cf86e9a29aa4179606", "type": "CALLS", "attrs": { "RED": { "count": 4.0, "error": 0.0, "rt": 37.0 } }, "edgeId": "5d611597e4b0013d0947615c9eca4de6", "firstSeenTms": 1721783795125, "lastSeenTms": 1721787371614 } ] } - QueryTopoRed { "nodeRed": { "361d9f32e58cef316bf2355f3ff05575": { "count": 3258110.0, "error": 74.0, "rt": 167.39844355494878 } }, "edgeRed": {} } |
-
Definición de nodo
{ "nodeId": string, #ID de nodo "entity": Object, #Información de entidad. Los campos varían según el tipo. Consulte Información de entidad en la descripción complementaria. "attrs": { #Información de atributos extendidos "RED": { # Métricas RED "count": double, #Número total de solicitudes durante el período de consulta "error": double, #Número total de errores durante el período de consulta "rt": double, # Latencia promedio durante el período de consulta, en milisegundos } } } -
Definición de arista.
{ "from": string, #ID de nodo "to": string, #ID de nodo "type": enum, #Consulte Tipos de arista en la descripción complementaria "attrs": { #Información de atributos extendidos "RED": { # Métricas RED "count": double, #Número total de solicitudes durante el período de consulta "error": double, #Número total de errores durante el período de consulta "rt": double, #Latencia promedio durante el período de consulta, en milisegundos } }, "edgeId": string, #ID de arista "firstSeenTms": long, #Marca de tiempo en milisegundos cuando se descubrió la arista por primera vez "lastSeenTms": long, #Marca de tiempo en milisegundos cuando se descubrió la arista por última vez }
Ejemplos
Respuesta exitosa
JSON Formato
{
"RequestId": "626037F5-FDEB-45B0-804C-B3C92797A64E",
"Code": 200,
"Success": true,
"Message": "success",
"Data": "- QueryTopo\n\n\n\t{\n\t\t\"nodes\": [\n\t\t\t{\n\t\t\t\t\"nodeId\": \"3bfe1a747389273388182760406c079d\",\n\t\t\t\t\"entity\": {\n\t\t\t\t\t\"regionId\": \"cn-hangzhou\",\n\t\t\t\t\t\"appType\": \"TRACE\",\n\t\t\t\t\t\"appId\": \"xxxxxxxxxxxxxxxx\",\n\t\t\t\t\t\"name\": \"prometheus-pop-cn-hangzhou\",\n\t\t\t\t\t\"entityId\": \"3bfe1a747389273388182760406c079d\",\n\t\t\t\t\t\"firstSeenTms\": 1721733226981,\n\t\t\t\t\t\"lastSeenTms\": 1721789171614,\n\t\t\t\t\t\"type\": \"APPLICATION\"\n\t\t\t\t},\n\t\t\t\t\"attrs\": {\n\t\t\t\t\t\"RED\": {\n\t\t\t\t\t\t\"count\": 643848.0,\n\t\t\t\t\t\t\"error\": 0.0,\n\t\t\t\t\t\t\"rt\": 172.31701892372112\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t],\n\t\t\"edges\": [\n\t\t\t{\n\t\t\t\t\"from\": \"98b4184b22e588cf86e9a29aa4179606\",\n\t\t\t\t\"to\": \"98b4184b22e588cf86e9a29aa4179606\",\n\t\t\t\t\"type\": \"CALLS\",\n\t\t\t\t\"attrs\": {\n\t\t\t\t\t\"RED\": {\n\t\t\t\t\t\t\"count\": 4.0,\n\t\t\t\t\t\t\"error\": 0.0,\n\t\t\t\t\t\t\"rt\": 37.0\n\t\t\t\t\t}\n\t\t\t\t},\n\t\t\t\t\"edgeId\": \"5d611597e4b0013d0947615c9eca4de6\",\n\t\t\t\t\"firstSeenTms\": 1721783795125,\n\t\t\t\t\"lastSeenTms\": 1721787371614\n\t\t\t}\n\t\t]\n\t}\n\n\n- QueryTopoRed\n\n\t{\n\t\t\"nodeRed\": {\n\t\t\t\"361d9f32e58cef316bf2355f3ff05575\": {\n\t\t\t\t\"count\": 3258110.0,\n\t\t\t\t\"error\": 74.0,\n\t\t\t\t\"rt\": 167.39844355494878\n\t\t\t}\n\t\t},\n\t\t\"edgeRed\": {}\n\t}\n\n"
}
Códigos de error
Consulte Códigos de error para ver la lista completa.
Notas de la versión
Consulte Notas de la versión para ver la lista completa.