All Products
Search
Document Center

Application Real-Time Monitoring Service:DoInsightsAction

Last Updated:Jun 24, 2026

Executes the corresponding action based on the module type specified by the parameter.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

  • Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.

  • API: The API that you can call to perform the action.

  • Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.

  • Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.

    • For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.

    • For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.

  • Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.

  • Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

arms:DoInsightsAction

get

*All Resource

*

None None

Request parameters

Parameter

Type

Required

Description

Example

Module

string

Yes

Module type

  • QueryTopo

    Topology query feature. A topology consists of edges and nodes. Each edge has a corresponding type, each node has a corresponding entity, and each entity has its type. By setting the edge type, node type, query time range, and other filter parameters, you can filter out the required topology data.

  • QueryTopoRed

    Topology RED metrics (request count, latency, error count) query. When querying a topology with the metrics query option enabled, the topology may be too large to retrieve all metrics data. This feature allows users to actively query metrics data for specified nodes and edges.

Note: The above features are in canary release and are not enabled by default. To enable them, please contact ARMS on-call support.

Valid values:

  • QueryTopoRed :

    Topology RED metrics query

  • QueryTopo :

    Topology query

QueryTopo

Data

string

Yes

Query parameters. The query parameters vary depending on the module type.

  • QueryTopo

{
    "regionId": string,  #Region ID
    "startTime": string, #Start time in the format of yyyy-MM-dd HH:mm:ss
    "endTime": string, #End time in the format of yyyy-MM-dd HH:mm:ss
    "edgeFilter": { #Edge filter conditions
        "includeTypes": [enum], #Edge types to include
        "excludeTypes": [enum], #Edge types to exclude
        "fromNodeFilter": { #Source node filter conditions
            "includeEntityTypes": [enum] #Entity types to include
            "excludeEntityTypes": [enum] #Entity types to exclude
        },
        "toNodeFilter": {  #Target node filter conditions
            "includeEntityTypes": [enum] #Entity types to include
            "excludeEntityTypes": [enum] #Entity types to exclude
        }
    },
    "includeIsolatedNodes": boolean, #Whether to include isolated nodes
    "isolatedNodeFilter": { # Isolated node filter conditions
        "includeEntityTypes": [enum] #Entity types to include
        "excludeEntityTypes": [enum] #Entity types to exclude
     },
    "queryMetrics": boolean, # Whether to synchronously query related RED metrics when querying topology
    "timeoutSecs": int, # Metrics query timeout in seconds
	"redOption": { #Metrics query control options
		"skipRt": boolean,  # Whether to skip querying RT metrics
		"skipCount": boolean, # Whether to skip querying request count metrics
		"skipError": boolean # Whether to skip querying error count metrics
	}
}

  • QueryTopoRed

{
    "regionId": string,  #Region ID
    "startTime": string, #Start time in the format of yyyy-MM-dd HH:mm:ss
    "endTime": string,   #End time in the format of yyyy-MM-dd HH:mm:ss
    "edgeIds": [string]  #Edge IDs to query
    "nodeIds": [string]  #Node IDs to query
    "redOption": { #Metrics query control options
        "skipRt": boolean,  # Whether to skip querying RT metrics
        "skipCount": boolean, # Whether to skip querying request count metrics
        "skipError": boolean # Whether to skip querying error count metrics
    }
}

- QueryTopo { "regionId": "cn-hangzhou", "startTime": "2024-07-23 19:16:00", "endTime": "2024-07-23 20:16:00", # 限定拓扑查询范围为 2024-07-23 19:16:00至2024-07-23 20:16:00 "edgeFilter": { "includeTypes": [ "CALLS" # 限定结果拓扑中仅包含调用关系的边 ], "fromNodeFilter": { "includeEntityTypes": [ # 限定调用边的源节点类型必须为应用类型 "APPLICATION" ] }, "toNodeFilter": { "includeEntityTypes": [ # 限定调用边的目标节点必须为应用类型或者外部服务类型 "APPLICATION", "EXTERNAL_SERVICE" ] } }, "includeIsolatedNodes": false, # 结果拓扑中不包含孤立节点 "queryMetrics": true, # 同步查询RED指标 "timeoutSecs": 20, #最多用20秒来查询指标数据 "redOption": { # 查询的指标包括耗时、请求量,跳过错误数的查询 "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": { # 查询的指标包括耗时、请求量,跳过错误数的查询 "skipCount": false, "skipError": true, "skipRt": false } }

RegionId

string

No

Region ID.

cn-hangzhou

A topology consists of edges and nodes. Each edge has a corresponding type, each node has a corresponding entity, and each entity has its type. By setting the edge type, node type, query time range, and other parameters, you can filter out the required topology data.

  • Isolated nodes

    An isolated node refers to a node that has no relationships with other nodes.

When a field type is enum, it indicates that the value of the field comes from an enumeration. See the supplementary description for enumeration definitions.

Response elements

Element

Type

Description

Example

object

Schema of Response

RequestId

string

Id of the request

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

Code

integer

Status code. 200 indicates success; other status codes indicate exceptions.

200

Success

boolean

Whether the query is successful:

  • true: Successful.

  • false: Failed.

true

Message

string

The message returned when the call fails.

success

Data

string

The return parameter type is related to the module value passed in.

  • QueryTopo

    {
     "nodes": [Object] #Node collection. See the Node definition in the supplementary description of return parameters.
     "edges": [Object] #Edge collection. See the Edge definition in the supplementary description of return parameters.
    }
    
  • QueryTopoRed

    {
      "nodeRed": {
      	"nodeId": {
      		"count": double, #Total number of requests during the query period
      		"error": double, #Total number of errors during the query period
      		"rt": double, #Average latency during the query period, in milliseconds
      	}
      },
      "edgeRed": {
      	"edgeId": {
      	    "count": double, #Total number of requests during the query period
      		"error": double, #Total number of errors during the query period
      		"rt": double, #Average latency during the query period, in milliseconds
      	}
      }
    

}

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

  • Node definition

     {
     	"nodeId": string, #Node ID
     	"entity": Object, #Entity information. Fields vary depending on the type. See Entity information in the supplementary description.
     	"attrs": { #Extended attribute information 
     		"RED": { # RED metrics
     			"count": double, #Total number of requests during the query period
     			"error": double, #Total number of errors during the query period
     			"rt": double, # Average latency during the query period, in milliseconds
     		}
     	}
     }
    
  • Edge definition

     	{
     	"from": string, #Node ID
     	"to": string,   #Node ID
     	"type": enum, #See Edge types in the supplementary description
     	"attrs": { #Extended attribute information
     		"RED": { # RED metrics
     			"count": double, #Total number of requests during the query period
     			"error": double, #Total number of errors during the query period
     			"rt": double,    #Average latency during the query period, in milliseconds
     		}
     	},
     	"edgeId": string, #Edge ID
     	"firstSeenTms": long, #Timestamp in milliseconds when the edge was first discovered
     	"lastSeenTms": long,  #Timestamp in milliseconds when the edge was last discovered
     }
    
    

Examples

Success response

JSON format

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

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.