Todos os produtos
Search
Central de documentação

Application Real-Time Monitoring Service:DoInsightsAction

Última atualização: Oct 27, 2026

Executa a ação correspondente com base no tipo de módulo especificado.

Experimente agora

Experimente esta API no OpenAPI Explorer, sem necessidade de assinatura manual. Chamadas bem-sucedidas geram automaticamente código SDK correspondente aos seus parâmetros. Faça o download com segurança de credenciais integrada para uso local.

Testar

Autorização RAM

A tabela abaixo descreve a autorização necessária para chamar esta API. Você pode defini-la em uma política do Resource Access Management (RAM). As colunas da tabela estão detalhadas abaixo:

  • Ação: As ações que podem ser usadas no elemento Action das instruções de política de permissão do RAM para conceder permissões para executar a operação.

  • API: A API que você pode chamar para executar a ação.

  • Nível de acesso: O nível de acesso predefinido concedido para cada API. Valores válidos: create, list, get, update e delete.

  • Tipo de recurso: O tipo de recurso que suporta autorização para executar a ação. Indica se a ação suporta permissão em nível de recurso. O recurso especificado deve ser compatível com a ação. Caso contrário, a política será ineficaz.

    • Para APIs com permissões em nível de recurso, os tipos de recursos obrigatórios são marcados com um asterisco (*). Especifique o Nome de Recurso Alibaba Cloud (ARN) correspondente no elemento Resource da política.

    • Para APIs sem permissões em nível de recurso, é exibido como Todos os Recursos. Use um asterisco (*) no elemento Resource da política.

  • Chave de condição: As chaves de condição definidas pelo serviço. A chave permite controle granular, aplicando-se somente a ações ou a ações associadas a recursos específicos. Além das chaves de condição específicas do serviço, o Alibaba Cloud fornece um conjunto de chaves de condição comuns aplicáveis a todos os serviços compatíveis com RAM.

  • Ação dependente: As ações dependentes necessárias para executar a ação. Para concluir a ação, o usuário RAM ou a função RAM deve ter permissões para executar todas as ações dependentes.

Ação

Nível de acesso

Tipo de recurso

Chave de condição

Ação dependente

arms:DoInsightsAction

get

*Todos os recursos.

*

Nenhuma Nenhuma

Parâmetros da solicitação

Parâmetro

Tipo

Obrigatório

Descrição

Exemplo

Module

string

Sim

O tipo de módulo.

  • QueryTopo

    O recurso de consulta de topologia. Uma topologia consiste em arestas e nós. Cada aresta tem um tipo correspondente, e cada nó tem uma entidade correspondente com um tipo específico. Você pode filtrar os dados de topologia necessários definindo parâmetros de filtro como o tipo de aresta, tipo de nó e intervalo de tempo de consulta.

  • QueryTopoRed

    O recurso de consulta de métricas RED de topologia (contagem de solicitações, tempo de resposta e contagem de erros). Ao consultar uma topologia com a opção de consulta de métricas ativada, nem todos os dados de métricas podem ser recuperados devido ao grande tamanho da topologia. Este recurso permite que os usuários consultem proativamente os dados de métricas para nós e arestas especificados.

Nota: Os recursos anteriores estão em versão canary e são desativados por padrão. Para ativá-los, entre em contato com a equipe de plantão do ARMS.

Valores válidos:

  • QueryTopoRed :

    Consulta de métricas RED de topologia.

  • QueryTopo :

    Consulta de topologia.

QueryTopo

Data

string

Sim

Os parâmetros de consulta. Os parâmetros de consulta variam de acordo com o tipo de módulo.

  • QueryTopo

{
    "regionId": string,  # O ID da região.
    "startTime": string, # A hora de início no formato yyyy-MM-dd HH:mm:ss.
    "endTime": string, # A hora de término no formato yyyy-MM-dd HH:mm:ss.
    "edgeFilter": { # As condições de filtro de aresta.
        "includeTypes": [enum], # Os tipos de aresta a serem incluídos.
        "excludeTypes": [enum], # Os tipos de aresta a serem excluídos.
        "fromNodeFilter": { # As condições de filtro do nó de origem.
            "includeEntityTypes": [enum] # Os tipos de entidade a serem incluídos.
            "excludeEntityTypes": [enum] # Os tipos de entidade a serem excluídos.
        },
        "toNodeFilter": {  # As condições de filtro do nó de destino.
            "includeEntityTypes": [enum] # Os tipos de entidade a serem incluídos.
            "excludeEntityTypes": [enum] # Os tipos de entidade a serem excluídos.
        }
    },
    "includeIsolatedNodes": boolean, # Especifica se deve incluir nós isolados.
    "isolatedNodeFilter": { # As condições de filtro de nó isolado.
        "includeEntityTypes": [enum] # Os tipos de entidade a serem incluídos.
        "excludeEntityTypes": [enum] # Os tipos de entidade a serem excluídos.
     },
    "queryMetrics": boolean, # Especifica se deve consultar sincronamente as métricas RED relacionadas ao consultar métricas.
    "timeoutSecs": int, # O tempo limite para consultas de métricas.
	"redOption": { # As opções de controle de consulta de métricas.
		"skipRt": boolean,  # Especifica se deve pular a consulta da métrica de tempo de resposta.
		"skipCount": boolean, # Especifica se deve pular a consulta da métrica de contagem de solicitações.
		"skipError": boolean # Especifica se deve pular a consulta da métrica de contagem de erros.
	}
}

  • QueryTopoRed

{
    "regionId": string,  # O ID da região.
    "startTime": string, # A hora de início no formato yyyy-MM-dd HH:mm:ss.
    "endTime": string,   # A hora de término no formato yyyy-MM-dd HH:mm:ss.
    "edgeIds": [string]  # Os IDs das arestas a serem consultadas.
    "nodeIds": [string]  # Os IDs dos nós a serem consultados.
    "redOption": { # As opções de controle de consulta de métricas.
        "skipRt": boolean,  # Especifica se deve pular a consulta da métrica de tempo de resposta.
        "skipCount": boolean, # Especifica se deve pular a consulta da métrica de contagem de solicitações.
        "skipError": boolean # Especifica se deve pular a consulta da métrica de contagem de erros.
    }
}

- QueryTopo { "regionId": "cn-hangzhou", "startTime": "2024-07-23 19:16:00", "endTime": "2024-07-23 20:16:00", # Limits the topology query range to 2024-07-23 19:16:00 to 2024-07-23 20:16:00. "edgeFilter": { "includeTypes": [ "CALLS" # Limits the edges in the result topology to only call relationships. ], "fromNodeFilter": { "includeEntityTypes": [ # Limits the source node type of the call edge to the application type. "APPLICATION" ] }, "toNodeFilter": { "includeEntityTypes": [ # Limits the destination node type of the call edge to the application type or external service type. "APPLICATION", "EXTERNAL_SERVICE" ] } }, "includeIsolatedNodes": false, # Excludes isolated nodes from the result topology. "queryMetrics": true, # Synchronously queries RED metrics. "timeoutSecs": 20, # Sets the timeout period for querying metric data to 20 seconds. "redOption": { # The queried metrics include response time and request count. Skips querying the error count. "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": { # The queried metrics include response time and request count. Skips querying the error count. "skipCount": false, "skipError": true, "skipRt": false } }

RegionId

string

Não

O ID da região.

cn-hangzhou

Uma topologia consiste em arestas e nós. Cada aresta tem um tipo correspondente, e cada nó tem uma entidade correspondente com um tipo específico. Você pode filtrar os dados de topologia necessários definindo parâmetros como o tipo de aresta, tipo de nó e intervalo de tempo de consulta.

  • Nós isolados.

    Um nó isolado refere-se a um nó que não tem nenhuma relação com outros nós.

Quando o tipo de campo é enum, indica que o valor do campo vem de uma enumeração. Para a definição da enumeração, consulte a descrição suplementar.

Elementos de resposta

Elemento

Tipo

Descrição

Exemplo

object

Esquema da resposta.

RequestId

string

O ID da solicitação.

626037F5-FDEB-45B0-804C-B3C92797A64E

Code

integer

O código de status. Um código de status 200 indica sucesso, e outros códigos de status indicam erros.

200

Success

boolean

Especifica se a consulta foi bem-sucedida. Valores válidos:

  • true: A consulta foi bem-sucedida.

  • false: A consulta falhou.

true

Message

string

A mensagem de erro retornada quando a chamada falha.

success

Data

string

Os dados retornados. O tipo de parâmetro varia de acordo com o valor do parâmetro Module.

  • QueryTopo

    {
     "nodes": [Object] # A coleção de nós. Para mais informações, consulte a definição de Nó na descrição suplementar dos parâmetros de resposta.
     "edges": [Object] # A coleção de arestas. Para mais informações, consulte a definição de Aresta na descrição suplementar dos parâmetros de resposta.
    }
    
  • QueryTopoRed

    {
      "nodeRed": {
      	"nodeId": {
      		"count": double, # O número total de solicitações no período de consulta.
      		"error": double, # O número total de erros no período de consulta.
      		"rt": double, # O tempo médio de resposta no período de consulta. Unidade: milissegundos.
      	}
      },
      "edgeRed": {
      	"edgeId": {
      	    "count": double, # O número total de solicitações no período de consulta.
      		"error": double, # O número total de erros no período de consulta.
      		"rt": double, # O tempo médio de resposta no período de consulta. Unidade: milissegundos.
      	}
      }
    

}

- 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": {} }

  • Definição de nó

     {
     	"nodeId": string, # O ID do nó.
     	"entity": Object, # As informações da entidade. Os campos variam de acordo com o tipo. Para mais informações, consulte as Informações da entidade na descrição suplementar.             
     	"attrs": { # As informações de atributo estendido. 
     		"RED": { # As métricas RED.
     			"count": double, # O número total de solicitações no período de consulta.
     			"error": double, # O número total de erros no período de consulta.
     			"rt": double, # O tempo médio de resposta no período de consulta. Unidade: milissegundos.
     		}
     	}
     }
    
  • Definição de aresta.

     	{
     	"from": string, # O ID do nó de origem.
     	"to": string,   # O ID do nó de destino.
     	"type": enum, # Para mais informações, consulte o tipo de Aresta na descrição suplementar.
     	"attrs": { # As informações de atributo estendido.
     		"RED": { # As métricas RED.
     			"count": double, # O número total de solicitações no período de consulta.
     			"error": double, # O número total de erros no período de consulta.
     			"rt": double,    # O tempo médio de resposta no período de consulta. Unidade: milissegundos.
     		}
     	},
     	"edgeId": string, # O ID da aresta.
     	"firstSeenTms": long, # A hora em que a aresta foi descoberta pela primeira vez. O valor é um carimbo de data e hora UNIX em milissegundos.
     	"lastSeenTms": long,  # A hora em que a aresta foi descoberta pela última vez. O valor é um carimbo de data e hora UNIX em milissegundos.
     }
    
    

Exemplos

Resposta de sucesso

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}"
}

Códigos de erro

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.