跳转到主要内容
API Explorer|API Explorer
基础设施相关接口/安装器
GETInstaller起始版本 1.0同步需要认证

部署状态列表

轮询整体部署状态进度当前部署会话。

调试可用性

在线调试

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

请求参数

此接口无需请求参数。

响应状态

200 OK

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

  • statusString

    状态信息。

    示例： running

  • sessionObject

    资源。

    • idString

      资源ID。

      示例： deploy-a1b2c3d4

    • statusString

      状态信息。

      示例： running

    • progressInteger

      整体部署进度百分比0 100。

      示例： 55

    • currentPhaseString

      名称当前执行中部署阶段。

      示例： installing-postgresql

    • currentComponentString

      名称组件当前已部署。

      示例： postgresql

    • startedAtString

      开始时间。

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

    • completedAtString

      完成时间。

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

    • logsList

      日志。

      示例： (nested array)

      • timeString

        时间。

        示例： 2026-04-16T10:00:00Z

      • levelString

        级别。

        示例： INFO

      • messageString

        错误返回消息。

        示例： PostgreSQL installation complete

    • registrationsList

      资源。

      示例： (nested array)

      • nameString

        资源名称。

        示例： postgresql

      • endpointString

        接收端地址。

        示例： 192.168.1.10:5432

      • statusString

        状态信息。

        示例： registered

      • registeredAtString

        注册时间。

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

      • errorString

        错误码。操作成功时为 null，失败时返回具体错误信息。

        示例： connection timeout

请求地址

GET/api/v1/installer/deploy/status

/api/v1/installer/deploy/status

操作 ID

GetDeployStatus

永久链接

请求示例

curl -X GET '{host}/api/v1/installer/deploy/status' -H 'Authorization: Bearer {token}'

响应示例

200
{
  "status": "running",
  "session": {}
}

变更历史

此 API 暂无变更历史记录。

查看全部变更历史