QueryAppTopology_应用实时监控服务ARMS_API文档

插件下载了解更多
VS Code 插件
安装插件之前,确保已安装 VS Code安装插件之前,确保已安装 VS Code
Alibaba Cloud Developer Toolkit is a collection of extensions that can help access Alibaba Cloud services in Visual Studio Code.
JetBrains 插件
安装插件之前,确保已安装 JetBrains IDE安装插件之前,确保已安装 JetBrains IDE
The Alibaba Cloud Developer Toolkit for JetBrains makes it easier to access Alibaba Cloud services.

流控信息

当前云产品API请求速率暂未透出。

授权信息

如下是此API对应的授权信息,用于RAM权限策略语句的Action元素中,为RAM用户或RAM角色授予调用此API的权限。请通过 RAM 访问控制设置,使用方法可参考访问控制帮助文档

具体说明如下:展开详情

操作访问级别资源类型条件关键字关联操作
arms:QueryTopology
Get
全部资源
*

请求参数

字段名称字段详情
RegionIdstring

地域 ID。

示例值:cn-hangzhou
Pidstring

应用 ID。

示例值:atc889zkcf@d8deedfa9bf****
AppTypestring

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

示例值:TRACE参考取值来源:
    GetRumApps
Typestring

拓扑查询类型。

示例值:apm_apps_v2枚举值:apm_txnapm_app_v2apm_database_v2apm_appsapm_appapm_txn_v2apm_databaseapm_apps_v2
Rpcstring

RPC 接口名。

示例值:/eventCenter
Dbstring

数据库域名。

示例值:rm-xxx.mysql.rds.aliyuncs.com:3306
DbNamestring

数据库名称。

示例值:orders
StartTimeinteger<int64>

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

注意 该字段类型为 Long,在序列化/反序列化的过程中可能导致精度丢失,请注意数值不得大于 9007199254740991。
示例值:1595568910000
EndTimeinteger<int64>

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

注意 该字段类型为 Long,在序列化/反序列化的过程中可能导致精度丢失,请注意数值不得大于 9007199254740991。
示例值:1671952708499
Filtersmap<string>

筛选条件组合。

返回参数

字段名称字段详情
RequestIdstring

请求 ID。

示例值:78901766-3806-4E96-8E47-CFEF59E4****
Successboolean

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

示例值:true
Codeinteger<int64>

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

注意 请注意,该值为 Long 类型,在某些语言中可能存在精度丢失的风险,请小心使用。
示例值:200
Messagestring

调用失败时返回的信息。

示例值:null
Dataany

返回信息。

示例值:"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" } ] }

返回示例

错误码

全局错误码
HTTP 状态码错误码错误信息操作
400
ParameterMissing
You must specify the parameter.诊断
400
ParameterRegionIdMissing
You must specify regionId.诊断
400
ParameterTopologyTypeIllegal
The specified topologyType is invalid.诊断
400
ParameterTimeStampIllegal
The specified timeStamp is invalid.诊断
403
APINotAuthorize
The current user is not authorized to access the interface.诊断
404
AppNotExist
The application does not exist.诊断
500
InternalError
Internal error. Please try again. Contact the DingTalk service account if the issue persists after multiple retries.诊断

变更历史

暂无变更历史

相关示例

2024年08月20日