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

获取安装器状态

获取当前安装器状态机器状态向导进度。

GET/api/v1/installer/state

操作 ID

GetInstallerState

起始版本

1.0.0

执行模式

同步

认证信息

需要认证

认证信息

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

Authorizationstring必填

Bearer 令牌

X-Tenant-IDstring

X-Tenant-ID

请求参数

此接口无需请求参数。

响应状态

200 OK
200 OK

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

  • version
    Integer

    版本号。

    示例: 1

  • state
    String

    当前状态。

    示例: configuring

  • currentStep
    Integer

    当前步骤。

    示例: 2

  • depotConnected
    Boolean

    软件仓库连接成功建立。

    示例: true

  • depotConnectedAt
    String

    软件仓库已连接时间。

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

  • wizardConfig
    Object

    向导配置信息。

    • selectedComponents
      List

      已选择组件。

      示例: item1,item2

    • instanceName
      String

      显示名称ZCF安装实例。

      示例: my-zcf

    • deployMode
      String

      部署拓扑模式安装。

      示例: single

    • dns
      List

      DNS。

      示例: item1,item2

    • ntp
      List

      NTP。

      示例: item1,item2

    • depotMode
      String

      软件包源模式安装。

      示例: online

    • depotBaseUrl
      String

      软件仓库基础地址。

      示例: https://depot.example.com

    • depotToken
      String

      认证令牌上游软件仓库。

      示例: ****

    • postgresql
      Object

      资源。

      • node
        Object

        节点。

        • role
          String

          角色信息。

          示例: primary

        • fqdn
          String

          完全限定域名称节点。

          示例: node01.example.com

        • username
          String

          用户名。

          示例: root

        • password
          String

          密码。

          示例: ****

        • sshKeyPath
          String

          SSH键路径。

          示例: /root/.ssh/id_rsa

        • sshPort
          Integer

          连接。

          示例: 22

      • port
        Integer

        端口号。

        示例: 5432

      • password
        String

        密码。

        示例: ****

      • image
        String

        容器镜像引用postgre SQL部署。

        示例: postgres:14-alpine

      • dataDir
        String

        主机目录postgre SQL数据持久化。

        示例: /var/lib/postgresql/data

    • lifecycle
      Object

      资源。

      • applianceSize
        String

        设备规格。

        示例: medium

      • nodes
        List

        资源。

        示例: (nested array)

        • role
          String

          角色信息。

          示例: primary

        • fqdn
          String

          完全限定域名称节点。

          示例: node01.example.com

        • username
          String

          用户名。

          示例: root

        • password
          String

          密码。

          示例: ****

        • sshKeyPath
          String

          SSH键路径。

          示例: /root/.ssh/id_rsa

        • sshPort
          Integer

          连接。

          示例: 22

      • vip
        String

        VIP。

        示例: 192.168.1.100

      • adminPassword
        String

        管理员账户密码敏感。

        示例: ****

      • vipInterface
        String

        网络接口拥有生命周期VIP。

        示例: ens192

    • idp
      Object

      IdP。

      • applianceSize
        String

        设备资源剖析IdP实例。

        示例: small

      • nodes
        List

        资源。

        示例: (nested array)

        • role
          String

          角色信息。

          示例: primary

        • fqdn
          String

          完全限定域名称节点。

          示例: node01.example.com

        • username
          String

          用户名。

          示例: root

        • password
          String

          密码。

          示例: ****

        • sshKeyPath
          String

          SSH键路径。

          示例: /root/.ssh/id_rsa

        • sshPort
          Integer

          连接。

          示例: 22

      • vip
        String

        虚拟IP地址HA IdP访问。

        示例: 192.168.1.101

      • adminPassword
        String

        IdP管理员账户密码敏感。

        示例: ****

      • rootPassword
        String

        IdP根账户密码敏感。

        示例: ****

    • extensions
      List

      扩展配置条目。

      示例: (nested array)

      • componentType
        String

        标识符扩展。

        示例: monitoring

      • version
        String

        版本号。

        示例: 1.2.0

      • applianceSize
        String

        设备资源剖析扩展。

        示例: small

      • nodes
        List

        资源。

        示例: (nested array)

        • role
          String

          角色信息。

          示例: primary

        • fqdn
          String

          完全限定域名称节点。

          示例: node01.example.com

        • username
          String

          用户名。

          示例: root

        • password
          String

          密码。

          示例: ****

        • sshKeyPath
          String

          SSH键路径。

          示例: /root/.ssh/id_rsa

        • sshPort
          Integer

          连接。

          示例: 22

      • vip
        String

        虚拟IP HA扩展访问。

        示例: 192.168.1.102

      • adminPassword
        String

        扩展敏感。

        示例: ****

    • cloud
      List

      管理节点。

      示例: (nested array)

      • address
        String必填

        地址。

        示例: 192.168.1.50

      • port
        Integer

        端口号。

        示例: 22

      • user
        String必填

        用户信息。

        示例: root

      • password
        String

        密码。

        示例: ****

    • env
      LinkedHashMap

      环境配置。

      示例: (nested object)

    • versionPins
      List

      资源。

      示例: (nested array)

      • product
        String

        资源。

        示例: value

      • version
        String

        版本号。

        示例: value

      • release
        String

        资源。

        示例: value

    • depotChannel
      String

      资源。

      示例: value

    • placementPins
      List

      资源。

      示例: item1,item2

    • configOverwrite
      Object

      资源。

      示例: (nested object)

    • noDumpState
      Boolean

      资源。

      示例: true

    • licenseServer
      Object必填

      外部许可证服务器已使用ZCF服务。

      • host
        String必填

        主机地址。

        示例: 172.24.243.148

      • http
        Integer必填

        HTTP。

        示例: 8201

  • downloads
    LinkedHashMap

    下载次数。

    示例: (nested object)

    • *
      Object

      键值映射对象。

  • precheck
    Object

    资源。

    • id
      String

      资源ID。

      示例: precheck-a1b2c3d4

    • status
      String

      状态信息。

      示例: passed

    • results
      List

      结果列表。

      示例: (nested array)

      • name
        String

        资源名称。

        示例: agent-connectivity

      • passed
        Boolean

        检查条目已通过。

        示例: true

      • message
        String

        错误返回消息。

        示例: All agents are reachable

      • fix
        String

        修复。

        示例: Ensure all agents have active heartbeats before proceeding

  • deploy
    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

  • error
    String

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

    示例: SSH connection refused

  • updatedAt
    String

    更新时间。

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

  • 变更时间

    新增响应字段 host, http, licenseServer
    查看 API
  • 变更时间

    新增响应字段 address, user已删除响应字段 nodeIp
    查看 API
  • 变更时间

    新增响应字段 configOverwrite, depotChannel, noDumpState...
    查看 API