Skip to main content
POST
获取采集状态

限制说明

使用说明

  • 服务拓扑是可选子系统:未配置 redis.servicemap 的部署会返回 ServiceUnavailable
  • 每次调用只能使用一种选择方式:显式的 host_id/host_ids,或 fleet=true;两者同时传入会被拒绝。
  • POST /monit/servicemap/topologyPOST /monit/servicemap/summary 不同,单个主机解析失败不会导致整个请求失败,而是通过 items[].error_code 逐项披露。
  • limit(默认 100,最大 200)限定了显式主机的接受数量,在 fleet 模式下则限定了抽样的候选主机数量。

授权

app_key
string
query
必填

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

请求体

application/json

选择要查询采集状态的主机:可指定明确的主机 ID,或使用有界的主机群抽样。

host_id
string

要查询的单个主机 ID。可与 host_ids 组合以查询多台;与 fleet=true 互斥。

Maximum string length: 128
Pattern: ^host_[a-z0-9_-]+$
host_ids
string[]

本次调用要查询的多个主机 ID,与 host_id 合计最多 200 个。与 fleet=true 互斥。

fleet
boolean
默认值:false

true 时忽略 host_id/host_ids,改为对账户内主机抽样,最多返回 limit 台候选主机。默认 false

limit
integer
默认值:100

fleet 模式下抽样的候选主机数量,其他模式下忽略该字段。默认 100,范围 1~200。

必填范围: 1 <= x <= 200

响应

成功

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

request_id
string
必填

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

示例:

"01HK8XQE3Z7JM2NTFQ5YJ8P9R4"

data
object
必填

所请求主机的服务拓扑采集状态。