跳转到主要内容
API Explorer|API Explorer
基础设施相关接口/OTA 升级计划
POSTOTA起始版本 1.0同步需要认证

预检

运行预升级兼容性检查针对目标版本。

调试可用性

在线调试

使用当前认证信息和示例参数提交 Mock 请求。

路径参数

请求参数

路径参数

  • planIdString必填

    计划ID。

请求体字段

  • itemString必填

    可选特定预检条目运行。

    示例： agent-connectivity

响应状态

200 OK

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

  • allowedBoolean

    允许。

    示例： true

  • itemsList

    条目列表。

    示例： (nested array)

    • nameString

      资源名称。

      示例： agent-connectivity

    • passedBoolean

      检查条目已通过。

      示例： true

    • messageString

      错误返回消息。

      示例： All agents are reachable

    • fixString

      修复。

      示例： Ensure all agents have active heartbeats before proceeding

请求地址

POST/api/v1/lifecycle/upgrade-plans/{planId}/precheck

/api/v1/lifecycle/upgrade-plans/{planId}/precheck

操作 ID

Precheck

永久链接

请求示例

curl -X POST '{host}/api/v1/lifecycle/upgrade-plans/{planId}/precheck' -H 'Authorization: Bearer {token}' -H 'Content-Type: application/json' -d '{"item":"agent-connectivity"}'

响应示例

200
{"allowed": true, "items": [{"name": "agent-connectivity", "passed": true, "message": "All agents are reachable", "fix": "Ensure all agents have active heartbeats before proceeding"}]}

变更历史

此 API 暂无变更历史记录。

查看全部变更历史