Call the QueryAppTopology API to get application topology - Application Real-Time Monitoring Service - Alibaba Cloud - Application Real-Time Monitoring Service

Queries the topology of an application, including nodes and edges that represent service dependencies.

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

No authorization for this operation. If you encounter issues with this operation, contact technical support.

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The ID of the region.	cn-hangzhou
Pid	string	No	The application ID (PID). To obtain the PID, log on to the ARMS console, choose Browser Monitoring > Browser Monitoring, and then click an application name. The PID is in the pid=xxx format in the browser address bar. The PID is usually percent-encoded as xxx%40xxx. Replace %40 with an at sign (@). For example, change eb4zdose6v%409781be0f44d** to eb4zdose6v@9781be0f44d**.	atc889zkcf@d8deedfa9bf****
AppType	string	No	The application type	TRACE
Type	string	Yes	The type of topology. Valid values: apm_txn : apm_app_v2 : apm_database_v2 : apm_apps : apm_app : apm_txn_v2 : apm_database : apm_apps_v2 :	apm_apps_v2
Rpc	string	No	The RPC interface name.	/eventCenter
Db	string	No	The database endpoint.	rm-xxx.mysql.rds.aliyuncs.com:3306
DbName	string	No	The name of the database.	orders
StartTime	integer	Yes	The start of the time range to query. Unit: milliseconds.	1595568910000
EndTime	integer	Yes	The end of the time range to query. Unit: milliseconds.	1671952708499
Filters	object	No	The filter conditions.
	string	No	The filter conditions.	"rootIp":"127.0.0.1"

Response elements

Element	Type	Description	Example
	object	The response parameters.
RequestId	string	The ID of the request.	78901766-3806-4E96-8E47-CFEF59E4****
Success	boolean	Indicates whether the request was successful. Valid values: true: The request was successful. false: The request failed.	true
Code	integer	The HTTP status code. A value of 200 indicates success. Other values indicate failure.	200
Message	string	The error message.	null
Data	any	The topology data, including nodes and edges.	"Data": { "nodes": [ { "data": { "duration": 0.2254335260115607, "requests": 1211, "type": "MYSQL", "errors": 0 }, "id": "ggxw4lnjuz@c0507xxxx##MYSQL", "label": "mysql-pod:3306(cart_db)" } ], "edges": [ { "data": { "duration": 0.03333333333333333, "requests": 600, "type": "UNKNOWN", "errors": 0 }, "id": "1974097372", "source": "ggxw4lnjuz@456xxxxx", "target": "ggxw4lnjuz@c0507xxxx" } ] }

Examples

Success response

JSON format

{
  "RequestId": "78901766-3806-4E96-8E47-CFEF59E4****",
  "Success": true,
  "Code": 200,
  "Message": "null",
  "Data": "\"Data\": {\n    \"nodes\": [\n      {\n        \"data\": {\n          \"duration\": 0.2254335260115607,\n          \"requests\": 1211,\n          \"type\": \"MYSQL\",\n          \"errors\": 0\n        },\n        \"id\": \"ggxw4lnjuz@c0507xxxx##MYSQL\",\n        \"label\": \"mysql-pod:3306(cart_db)\"\n      }\n    ],\n    \"edges\": [\n      {\n        \"data\": {\n          \"duration\": 0.03333333333333333,\n          \"requests\": 600,\n          \"type\": \"UNKNOWN\",\n          \"errors\": 0\n        },\n        \"id\": \"1974097372\",\n        \"source\": \"ggxw4lnjuz@456xxxxx\",\n        \"target\": \"ggxw4lnjuz@c0507xxxx\"\n      }\n    ]\n  }"
}

Error codes

HTTP status code	Error code	Error message	Description
400	ParameterMissing	You must specify the parameter.	You must specify the parameter.
400	ParameterRegionIdMissing	You must specify regionId.	You must specify regionId.
400	ParameterTopologyTypeIllegal	The specified topologyType is invalid.	The specified topologyType is invalid.
400	ParameterTimeStampIllegal	The specified timeStamp is invalid.	The specified timeStamp is invalid.
500	InternalError	Internal error. Please try again. Contact the DingTalk service account if the issue persists after multiple retries.	Internal error. Please try again. Contact the DingTalk service account if the issue persists after multiple retries.
403	APINotAuthorize	The current user is not authorized to access the interface.	The current user is not authorized to access the interface.
404	AppNotExist	The application does not exist.	The application does not exist.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.