查询拓扑详情
更新时间：2026-06-26
DescribeTopology
拓扑详情查询，支持查询全局拓扑或指定服务的上下游拓扑，返回节点与边的详细信息。
API Explorer
去调试
您可以在 API Explorer 中直接运行该接口，免去您计算签名的困扰。运行成功后，API Explorer 可以自动生成 SDK 代码示例。
请求结构
Plain Text
1POST /v1/apm/query?action=DescribeTopology HTTP/1.1
2Host: apm.bj.baidubce.com
3Authorization: authorization string
4
5{
6 "serviceName": "mall-gateway",
7 "env": "",
8 "beginDatetime": "20241011T10:10:10Z",
9 "endDatetime": "20241011T10:25:10Z"
10}请求头域
除公共头域外，无其他特殊头域
请求参数
| 参数名称 | 类型 | 是否必需 | 参数位置 | 描述 |
|---|---|---|---|---|
| version | String | 是 | URL参数 | API版本号，当前取值为v1 |
| action | String | 是 | URL参数 | API接口名称，当前取值为DescribeTopology |
| serviceName | String | 否 | RequestBody参数 | 应用名。若未设置，表示查询全局拓扑；若设置，表示查询服务上下游拓扑。支持模糊搜索，例如".mall." |
| env | String | 否 | RequestBody参数 | 按env过滤，若未设置，返回所有环境的拓扑图 |
| beginDatetime | String | 是 | RequestBody参数 | 开始时间，UTC时间 |
| endDatetime | String | 是 | RequestBody参数 | 结束时间，UTC时间 |
返回状态码
成功返回200，失败返回见错误码
返回头域
除公共头域外，无其他特殊头域
返回参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| success | Boolean | 请求是否成功 |
| code | String | 状态码 |
| message | String | 错误信息 |
| nodes | List<TopoNode> | 节点列表 |
| edges | List<TopoEdge> | 边列表 |
请求示例
Plain Text
1POST /v1/apm/query?action=DescribeTopology HTTP/1.1
2HOST apm.bj.baidubce.com
3Authorization bce-auth-v1/...
4
5{
6 "serviceName": "mall-gateway",
7 "env": "",
8 "beginDatetime": "20241011T10:10:10Z",
9 "endDatetime": "20241011T10:25:10Z"
10}响应示例
Plain Text
1HTTP/1.1 200 OK
2x-bce-request-id: request-id-example
3Date: Wed, 08 Jan 2025 03:25:48 GMT
4Transfer-Encoding: chunked
5Content-Type: application/json;charset=UTF-8
6Server: BWS
7
8{
9 "success": true,
10 "code": "OK",
11 "message": "",
12 "nodes": [
13 {
14 "serviceName": "mall-gateway",
15 "language": "java",
16 "type": "server",
17 "inferred": false,
18 "component": "grpc",
19 "requests": 1000,
20 "requestsPerSecond": 10,
21 "errors": 100,
22 "errorRate": 0.21,
23 "durationSeconds": 10.56,
24 "state": "OK"
25 }
26 ],
27 "edges": [
28 {
29 "source": "mall-gateway",
30 "target": "cart-service",
31 "type": "grpc",
32 "requests": 1000,
33 "requestsPerSecond": 10,
34 "errors": 100,
35 "errorRate": 0.21,
36 "durationSeconds": 10.56,
37 "state": "OK"
38 }
39 ]
40}评价此篇文章