Todos los productos
Search
Centro de documentos

Application Real-Time Monitoring Service:DoInsightsAction

Última actualización: Sep 01, 2026

Ejecuta la acción correspondiente según el tipo de módulo especificado por el parámetro.

Pruébelo ahora

Pruebe esta API en OpenAPI Explorer sin necesidad de firma manual. Las llamadas exitosas generan automáticamente código SDK acorde a sus parámetros. Descárguelo con seguridad de credenciales integrada para uso local.

Test

Autorización de RAM

La siguiente tabla describe la autorización necesaria para invocar esta API. Puede definirla en una directiva de Resource Access Management (RAM). A continuación, se detallan las columnas de la tabla:

  • Action: Estas acciones se utilizan en el elemento Action de las declaraciones de directivas de permisos de RAM para otorgar permisos que permitan realizar la operación.

  • API: La API que debe invocarse para llevar a cabo la acción.

  • Nivel de acceso: Nivel de acceso predefinido que se concede para cada API. Valores válidos: create, list, get, update y delete.

  • Tipo de recurso: Tipo de recurso que admite autorización para ejecutar la acción. Indica si la acción es compatible con permisos a nivel de recurso. El recurso especificado debe ser compatible con la acción; de lo contrario, la directiva no surtirá efecto.

    • En las API con permisos a nivel de recurso, los tipos de recursos obligatorios se marcan con un asterisco (*). Especifique el Alibaba Cloud Resource Name (ARN) correspondiente en el elemento Resource de la directiva.

    • Para las API sin permisos a nivel de recurso, se muestra All Resources. Utilice un asterisco (*) en el elemento Resource de la directiva.

  • Clave de condición: Claves de condición definidas por el servicio. Permiten un control granular y se aplican ya sea solo a acciones o a acciones asociadas con recursos específicos. Además de las claves de condición específicas del servicio, Alibaba Cloud proporciona un conjunto de common condition keys aplicables a todos los servicios compatibles con RAM.

  • Acción dependiente: Acciones dependientes necesarias para ejecutar la acción principal. Para completar la operación, el usuario de RAM o el rol de RAM debe contar con permisos para realizar todas las acciones dependientes.

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

  • QueryTopo

    Función de consulta de topología. 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 de filtro, puede filtrar los datos de topología necesarios.

  • QueryTopoRed

    Consulta de métricas RED de topología (recuento de solicitudes, latencia, recuento de errores). Al consultar una topología con la opción de consulta de métricas habilitada, es posible que la topología sea demasiado grande para recuperar todos los datos de métricas. Esta función permite a los usuarios consultar activamente datos de métricas para nodos y aristas específicos.

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:

  • QueryTopoRed :

    Consulta de métricas RED de topología.

  • QueryTopo :

    Consulta de topología.

QueryTopo

Data

string

Sí

Parámetros de consulta. Los parámetros de consulta varían según el tipo de módulo.

  • QueryTopo

{
    "regionId": string,  #ID de región
    "startTime": string, #Hora de inicio en formato yyyy-MM-dd HH:mm:ss
    "endTime": string, #Hora de fin en formato yyyy-MM-dd HH:mm:ss
    "edgeFilter": { #Condiciones de filtro de aristas
        "includeTypes": [enum], #Tipos de aristas a incluir
        "excludeTypes": [enum], #Tipos de aristas a excluir
        "fromNodeFilter": { #Condiciones de filtro de nodo de origen
            "includeEntityTypes": [enum] #Tipos de entidad a incluir
            "excludeEntityTypes": [enum] #Tipos de entidad a excluir
        },
        "toNodeFilter": {  #Condiciones de filtro de nodo de destino
            "includeEntityTypes": [enum] #Tipos de entidad a incluir
            "excludeEntityTypes": [enum] #Tipos de entidad a excluir
        }
    },
    "includeIsolatedNodes": boolean, #Indica si se deben incluir nodos aislados
    "isolatedNodeFilter": { # Condiciones de filtro de nodos aislados
        "includeEntityTypes": [enum] #Tipos de entidad a incluir
        "excludeEntityTypes": [enum] #Tipos de entidad a excluir
     },
    "queryMetrics": boolean, # Indica si se deben consultar sincrónicamente las métricas RED relacionadas al consultar la topología
    "timeoutSecs": int, # Tiempo de espera de consulta de métricas en segundos
	"redOption": { #Opciones de control de consulta de métricas
		"skipRt": boolean,  # Indica si se debe omitir la consulta de métricas RT
		"skipCount": boolean, # Indica si se debe omitir la consulta de métricas de recuento de solicitudes
		"skipError": boolean # Indica si se debe omitir la consulta de métricas de recuento de errores
	}
}

  • QueryTopoRed

{
    "regionId": string,  #ID de región
    "startTime": string, #Hora de inicio en formato yyyy-MM-dd HH:mm:ss
    "endTime": string,   #Hora de fin en formato yyyy-MM-dd HH:mm:ss
    "edgeIds": [string]  #ID de aristas a consultar
    "nodeIds": [string]  #ID de nodos a consultar
    "redOption": { #Opciones de control de consulta de métricas
        "skipRt": boolean,  # Indica si se debe omitir la consulta de métricas RT
        "skipCount": boolean, # Indica si se debe omitir la consulta de métricas de recuento de solicitudes
        "skipError": boolean # Indica si se debe omitir la consulta de métricas de recuento de errores
    }
}

- 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: Exitosa.

  • false: Fallida.

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": [Object] #Colección de nodos. Consulte la definición de Nodo en la descripción complementaria de parámetros de retorno.
     "edges": [Object] #Colección de aristas. Consulte la definición de Arista en la descripción complementaria de parámetros de retorno.
    }
    
  • QueryTopoRed

    {
      "nodeRed": {
      	"nodeId": {
      		"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
      	}
      },
      "edgeRed": {
      	"edgeId": {
      	    "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
      	}
      }
    

}

- 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.