Skip to main content
POST
获取服务拓扑图

限制说明

使用说明

  • 服务拓扑是可选子系统:未配置 redis.servicemap 的部署会返回 ServiceUnavailable
  • at 当前仅支持 now(留空效果相同)。
  • direction 当前仅支持 outbound(留空效果相同)。
  • anchor.host_id 必须已被服务拓扑感知(存在当前或近期的拓扑数据),否则返回 ResourceNotFound
  • depth(最大 3)、max_nodes(最大 500)、max_edges(最大 1000)共同限定遍历范围;触发任一上限时 truncated=true,并在 truncation_reasons 中说明原因。
  • unresolved_mode=summary(相对默认值 full)会从 edges 中省略未解析边,仅在 unresolved_endpoints 中返回有界样本。

授权

app_key
string
query
必填

在 Flashduty 控制台 账户 → APP Key 中签发的 app_key。调用任何公开 API 时都必须携带。它等同于所属账户的身份凭证,请妥善保管。

请求体

application/json

出向拓扑遍历的查询参数。

anchor
object
必填

遍历的起始主机(及可选的实体)。

network_scope_id
string

可选的一致性校验:如果设置,必须与 anchor.host_id 已关联的网络域一致,否则返回 InvalidParameter

at
enum<string>

查询的时间选择器。当前仅支持 now;省略该字段效果相同。

可用选项:
now
direction
enum<string>

遍历方向。当前仅支持 outbound;省略该字段效果相同。

可用选项:
outbound
depth
integer
默认值:1

从锚点开始的最大遍历深度。默认 1,最大 3。

必填范围: x <= 3
max_nodes
integer
默认值:100

返回节点数量的上限,超出则截断。默认 100,最大 500。

必填范围: x <= 500
max_edges
integer
默认值:200

遍历边数量的上限,超出则截断。默认 200,最大 1000。

必填范围: x <= 1000
include_metrics
boolean
默认值:false

是否在响应中包含每条边的原始 metrics 数据。默认 false

unresolved_mode
enum<string>
默认值:full

未解析边的投影方式。full(默认)会将其同时纳入 edgesunresolved_endpointssummary 会从 edges 中省略,仅在 unresolved_endpoints 中返回有界样本。

可用选项:
summary,
full

响应

成功

成功响应结构。2xx 响应中 request_id 标识本次调用(同时出现在 Flashcat-Request-Id 响应头中),data 为接口业务 payload。失败响应使用不同结构,参见 ErrorResponse

request_id
string
必填

本次请求的唯一 ID,也会在 Flashcat-Request-Id 响应头中返回。反馈问题时请一并附上。

示例:

"01HK8XQE3Z7JM2NTFQ5YJ8P9R4"

data
object
必填

以锚点主机为中心发现的出向依赖拓扑图。