QueryAppTopology - Application Real-Time Monitoring Service

Query App Topology.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
arms:QueryTopology	get	All Resources *	none	none

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The ID of the region.	cn-hangzhou
Pid	string	No	The ID of the application. Log on to the ARMS console. In the left-side navigation pane, choose Browser Monitoring > Browser Monitoring. On the Browser Monitoring page, click the name of an application. The URL in the address bar contains the process ID (PID) of the application. The PID is indicated in the pid=xxx format. The PID is usually percent encoded as xxx%40xxx. You must modify this value to remove the percent encoding. For example, if the PID in the URL is eb4zdose6v%409781be0f44d**, you must replace %40 with an at sign (@) to obtain eb4zdose6v@9781be0f44d**.	atc889zkcf@d8deedfa9bf****
AppType	string	No	The application type	TRACE
Type	string	Yes	The type kind of topology.	apm_apps_v2
Rpc	string	No	RPC interface name.	/eventCenter
Db	string	No	The database domain name.	rm-xxx.mysql.rds.aliyuncs.com:3306
DbName	string	No	The name of the database.	orders
StartTime	long	Yes	The start of the time range to query. Unit: milliseconds.	1595568910000
EndTime	long	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 parameters

Parameter	Type	Description	Example
	object	Schema of Response
RequestId	string	The ID of the request.	78901766-3806-4E96-8E47-CFEF59E4****
Success	boolean	Indicates whether the call was successful. Valid values: true: The call was successful. false: The call failed.	true
Code	long	The status code. The status code 200 indicates that the request was successful. If another status code is returned, the request failed.	200
Message	string	The error message.	Internal error. Please try again. Contact the DingTalk service account if the issue persists after multiple retries.
Data	any	The returned struct.	"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

Sample success responses

JSONformat

{
  "RequestId": "78901766-3806-4E96-8E47-CFEF59E4****",
  "Success": true,
  "Code": 200,
  "Message": "Internal error. Please try again. Contact the DingTalk service account if the issue                              persists after multiple retries.",
  "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.
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.
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.

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation

No change history