全部产品
Search
文档中心

应用实时监控服务ARMS:QueryAppTopology - 查询拓扑图

更新时间:Aug 28, 2026

查询应用拓扑。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

当前API暂无授权信息透出。

请求参数

名称

类型

必填

描述

示例值

RegionId

string

是

地域 ID。

cn-hangzhou

Pid

string

否

应用 ID。

atc889zkcf@d8deedfa9bf****

AppType

string

否

应用类型,XTRACE、EBPF 需要填写,默认不填。

TRACE

Type

string

是

拓扑查询类型。

枚举值:

  • apm_txn :

    应用详情-接口调用拓扑图接口

  • apm_app_v2 :

    应用详情-应用拓扑图接口 V2

  • apm_database_v2 :

    应用详情-数据库调用拓扑图接口 V2

  • apm_apps :

    应用列表-总览拓扑图接口

  • apm_app :

    应用详情-应用拓扑图接口

  • apm_txn_v2 :

    应用详情-接口调用拓扑图接口 V2

  • apm_database :

    应用详情-数据库调用拓扑图接口

  • apm_apps_v2 :

    应用列表-总览拓扑图接口 V2

apm_apps_v2

Rpc

string

否

RPC 接口名。

/eventCenter

Db

string

否

数据库域名。

rm-xxx.mysql.rds.aliyuncs.com:3306

DbName

string

否

数据库名称。

orders

StartTime

integer

是

起始时间的时间戳,精确到毫秒。

1595568910000

EndTime

integer

是

结束时间的时间戳,精确到毫秒。

1671952708499

Filters

object

否

筛选条件组合。

string

否

筛选条件组合。

"rootIp":"127.0.0.1"

返回参数

名称

类型

描述

示例值

object

Schema of Response

RequestId

string

请求 ID。

78901766-3806-4E96-8E47-CFEF59E4****

Success

boolean

查询是否成功:true:成功。 false:失败。

true

Code

integer

接口状态,取值说明如下:2XX:成功。3XX:重定向。4XX:请求错误。5XX:服务器错误。

200

Message

string

调用失败时返回的信息。

null

Data

any

返回信息。

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

示例

正常返回示例

JSON格式

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

错误码

HTTP status code

错误码

错误信息

描述

400 ParameterMissing You must specify the parameter. 必选参数缺失
400 ParameterRegionIdMissing You must specify regionId. 参数regionId缺失
400 ParameterTopologyTypeIllegal The specified topologyType is invalid. 参数topoloyType非法
400 ParameterTimeStampIllegal The specified timeStamp is invalid. 时间参数非法
500 InternalError 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. 当前用户无权限访问该接口
404 AppNotExist The application does not exist. 应用不存在

访问错误中心查看更多错误码。

变更历史

更多信息,参考变更详情。