插件下载了解更多
Alibaba Cloud Developer ToolkitbetaAlibaba Cloud OpenAPI
Alibaba Cloud Developer Toolkit is a collection of extensions that can help access Alibaba Cloud services in Visual Studio Code.
安装插件之前,确保已安装 JetBrains IDE安装插件之前,确保已安装 JetBrains IDE
Alibaba Cloud Developer ToolkitbetaAlibaba Cloud OpenAPI
The Alibaba Cloud Developer Toolkit for JetBrains makes it easier to access Alibaba Cloud services.
流控信息
当前云产品API请求速率暂未透出。
请求参数
字段名称 | 字段详情 |
---|---|
Modulestring | 模块类型展开详情 示例值:QueryTopo枚举值:QueryTopoRedQueryTopo |
Datastring | 查询参数,不同模块类型对应的查询参数不同。展开详情 示例值:
- 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
}
}
|
RegionIdstring | 地域 ID。 示例值:cn-hangzhou |
请求说明
拓扑由边和节点构成,每条边都有其对应的类型,每个节点都拥有一个对应的实体,每个实体都有其类型。通过设置边的类型,节点的类型,查询时间范围等参数,可以过滤出需要的拓扑数据。
-
孤立节点
孤立节点指该节点与其他节点不存在任何关系
当字段类型为 enum 时,表示该字段的值来源于枚举,枚举的定义参见补充说明
返回参数
字段名称 | 字段详情 |
---|---|
RequestIdstring | Id of the request 示例值:626037F5-FDEB-45B0-804C-B3C92797A64E |
Codeinteger<int32> | 状态码。200 为成功,其他状态码为异常。 示例值:200 |
Successboolean | 查询是否成功:展开详情 示例值:true |
Messagestring | 调用失败时返回的信息。 示例值:success |
Datastring | 返回参数类型与传入的 module 值相关。展开详情 示例值:- 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 定义
{ "nodeId": string, #节点 ID "entity": Object, #实体信息 根据 type 的不同,字段会有不同的差异,详见补充说明中的 实体信息 "attrs": { #扩展属性信息 "RED": { # RED 指标 "count": double, #查询时段的总请求量 "error": double, #查询时段的总错误数 "rt": double, # 查询时段的平均耗时,单位毫秒 } } }
-
Edge 定义
{ "from": string, #节点 ID "to": string, #节点 ID "type": enum, #详见补充说明中的 边类型 "attrs": { #扩展属性信息 "RED": { # RED 指标 "count": double, #查询时段的总请求量 "error": double, #查询时段的总错误数 "rt": double, #查询时段的平均耗时,单位毫秒 } }, "edgeId": string, #边 ID "firstSeenTms": long, #第一次发现该边的时间,毫秒时间戳 "lastSeenTms": long, #最后一次发现该边的时间,毫秒时间戳 }
返回示例
变更历史
变更时间 | 变更内容概要 | 操作 | |
---|---|---|---|
2025-01-03 | |||
2024-07-31 | |||
2024-07-30 |