Executa a ação correspondente com base no tipo de módulo especificado.
Experimente agora
Testar
Autorização RAM
|
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.
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:
|
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": "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 |
| 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": [ { "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.