跳转到主要内容
ZStack
基础设施相关接口/OTA 版本与策略

运行预检

执行预检健康就绪检查启动中升级。

POST/api/v1/ota/plans/{planId}/preflight

操作 ID

RunPreflight

起始版本

1.0.0

执行模式

同步

认证信息

需要认证

认证信息

调用该 API 时需要在请求头中携带以下认证信息。

Authorizationstring必填

Bearer 令牌

X-Tenant-IDstring

X-Tenant-ID

请求参数

application/json

路径参数

  • planId
    String必填

    计划ID。

请求体字段

  • agentIds
    List必填

    代理ID列表。

    示例： item1,item2

  • config
    Object必填

    配置信息。

    • planId
      String

      计划ID。

      示例： plan-a1b2c3d4-e5f6-7890-abcd-ef1234567890

    • mode
      String

      预检模式严格建议。

      示例： strict

    • checks
      List

      资源。

      示例： item1,item2

    • timeoutSec
      Integer

      超时时间秒。

      示例： 120

    • minHealthyPct
      Long

      最小健康比例。

      示例： 90

响应状态

200 OK
200 OK

该 API 成功时返回以下响应结构。

  • planId
    String

    计划ID。

    示例： plan-a1b2c3d4-e5f6-7890-abcd-ef1234567890

  • mode
    String

    已使用预检运行。

    示例： strict

  • totalAgents
    Integer

    代理总数。

    示例： 20

  • healthyAgents
    Integer

    健康代理。

    示例： 19

  • unhealthyAgents
    Integer

    不健康代理。

    示例： 1

  • healthyPct
    Long

    健康百分比。

    示例： 95

  • decision
    String

    处理决定。

    示例： proceed

  • excludedAgentIds
    List

    排除代理ID。

    示例： item1,item2

  • agentResults
    List

    代理结果。

    示例： (nested array)

    • agentId
      String

      代理ID。

      示例： lca-node01.example.com

    • agentName
      String

      显示名称代理节点。

      示例： node01

    • healthy
      Boolean

      代理已通过预检检查。

      示例： true

    • checkResults
      LinkedHashMap

      预检检查结果条目。

      示例： (nested object)

    • failReasons
      List

      失败原因。

      示例： item1,item2

  • checkedAt
    String

    检查时间。

    示例： 2026-01-15T08:00:00Z

  • durationMs
    String

    时长预检运行时间，单位为毫秒。

    示例： 4800