跳转到主要内容
基础设施相关接口/安装器

部署状态列表

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

GET/api/v1/installer/deploy/status

操作 ID

GetDeployStatus

起始版本

1.0.0

执行模式

同步

认证信息

需要认证

认证信息

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

Authorizationstring必填

Bearer 令牌

X-Tenant-IDstring

X-Tenant-ID

请求参数

此接口无需请求参数。

响应状态

200 OK
200 OK

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

  • status
    String

    状态信息。

    示例: running

  • session
    Object

    资源。

    • id
      String

      资源ID。

      示例: deploy-a1b2c3d4

    • status
      String

      状态信息。

      示例: running

    • progress
      Integer

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

      示例: 55

    • currentPhase
      String

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

      示例: installing-postgresql

    • currentComponent
      String

      名称组件当前已部署。

      示例: postgresql

    • startedAt
      String

      开始时间。

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

    • completedAt
      String

      完成时间。

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

    • logs
      List

      日志。

      示例: (nested array)

      • time
        String

        时间。

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

      • level
        String

        级别。

        示例: INFO

      • message
        String

        错误返回消息。

        示例: PostgreSQL installation complete

    • registrations
      List

      资源。

      示例: (nested array)

      • name
        String

        资源名称。

        示例: postgresql

      • endpoint
        String

        接收端地址。

        示例: 192.168.1.10:5432

      • status
        String

        状态信息。

        示例: registered

      • registeredAt
        String

        注册时间。

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

      • error
        String

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

        示例: connection timeout