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

获取安装器状态

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

调试可用性

在线调试

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

请求参数

此接口无需请求参数。

响应状态

200 OK

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

  • versionInteger

    版本号。

    示例: 1

  • stateString

    当前状态。

    示例: configuring

  • currentStepInteger

    当前步骤。

    示例: 2

  • depotConnectedBoolean

    软件仓库连接成功建立。

    示例: true

  • depotConnectedAtString

    软件仓库已连接时间。

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

  • wizardConfigObject

    向导配置信息。

    • selectedComponentsList

      已选择组件。

      示例: item1,item2

    • instanceNameString

      显示名称ZCF安装实例。

      示例: my-zcf

    • deployModeString

      部署拓扑模式安装。

      示例: single

    • dnsList

      DNS。

      示例: item1,item2

    • ntpList

      NTP。

      示例: item1,item2

    • depotModeString

      软件包源模式安装。

      示例: online

    • depotBaseUrlString

      软件仓库基础地址。

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

    • depotTokenString

      认证令牌上游软件仓库。

      示例: ****

    • postgresqlObject

      资源。

      • nodeObject

        节点。

        • roleString

          角色信息。

          示例: primary

        • fqdnString

          完全限定域名称节点。

          示例: node01.example.com

        • usernameString

          用户名。

          示例: root

        • passwordString

          密码。

          示例: ****

        • sshKeyPathString

          SSH键路径。

          示例: /root/.ssh/id_rsa

        • sshPortInteger

          连接。

          示例: 22

      • portInteger

        端口号。

        示例: 5432

      • passwordString

        密码。

        示例: ****

      • imageString

        容器镜像引用postgre SQL部署。

        示例: postgres:14-alpine

      • dataDirString

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

        示例: /var/lib/postgresql/data

    • lifecycleObject

      资源。

      • applianceSizeString

        设备规格。

        示例: medium

      • nodesList

        资源。

        示例: (nested array)

        • roleString

          角色信息。

          示例: primary

        • fqdnString

          完全限定域名称节点。

          示例: node01.example.com

        • usernameString

          用户名。

          示例: root

        • passwordString

          密码。

          示例: ****

        • sshKeyPathString

          SSH键路径。

          示例: /root/.ssh/id_rsa

        • sshPortInteger

          连接。

          示例: 22

      • vipString

        VIP。

        示例: 192.168.1.100

      • adminPasswordString

        管理员账户密码敏感。

        示例: ****

    • idpObject

      IdP。

      • applianceSizeString

        设备资源剖析IdP实例。

        示例: small

      • nodesList

        资源。

        示例: (nested array)

        • roleString

          角色信息。

          示例: primary

        • fqdnString

          完全限定域名称节点。

          示例: node01.example.com

        • usernameString

          用户名。

          示例: root

        • passwordString

          密码。

          示例: ****

        • sshKeyPathString

          SSH键路径。

          示例: /root/.ssh/id_rsa

        • sshPortInteger

          连接。

          示例: 22

      • vipString

        虚拟IP地址HA IdP访问。

        示例: 192.168.1.101

      • adminPasswordString

        IdP管理员账户密码敏感。

        示例: ****

      • rootPasswordString

        IdP根账户密码敏感。

        示例: ****

    • extensionsList

      扩展配置条目。

      示例: (nested array)

      • componentTypeString

        标识符扩展。

        示例: monitoring

      • versionString

        版本号。

        示例: 1.2.0

      • applianceSizeString

        设备资源剖析扩展。

        示例: small

      • nodesList

        资源。

        示例: (nested array)

        • roleString

          角色信息。

          示例: primary

        • fqdnString

          完全限定域名称节点。

          示例: node01.example.com

        • usernameString

          用户名。

          示例: root

        • passwordString

          密码。

          示例: ****

        • sshKeyPathString

          SSH键路径。

          示例: /root/.ssh/id_rsa

        • sshPortInteger

          连接。

          示例: 22

      • vipString

        虚拟IP HA扩展访问。

        示例: 192.168.1.102

      • adminPasswordString

        扩展敏感。

        示例: ****

    • cloudObject

      资源。

      • nodeIpString

        IP地址云管理节点。

        示例: 192.168.1.50

      • usernameString

        用户名。

        示例: admin

      • passwordString

        密码。

        示例: ****

    • envLinkedHashMap

      环境配置。

      示例: (nested object)

    • versionPinsList

      资源。

      示例: (nested array)

      • productString

        资源。

        示例: value

      • versionString

        版本号。

        示例: value

      • releaseString

        资源。

        示例: value

  • downloadsLinkedHashMap

    下载次数。

    示例: (nested object)

    • *Object

      键值映射对象。

  • precheckObject

    资源。

    • idString

      资源ID。

      示例: precheck-a1b2c3d4

    • statusString

      状态信息。

      示例: passed

    • resultsList

      结果列表。

      示例: (nested array)

      • nameString

        资源名称。

        示例: agent-connectivity

      • passedBoolean

        检查条目已通过。

        示例: true

      • messageString

        错误返回消息。

        示例: All agents are reachable

      • fixString

        修复。

        示例: Ensure all agents have active heartbeats before proceeding

  • deployObject

    资源。

    • 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

  • errorString

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

    示例: SSH connection refused

  • updatedAtString

    更新时间。

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

请求地址

GET/api/v1/installer/state

/api/v1/installer/state

操作 ID

GetInstallerState

永久链接

请求示例

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

响应示例

200
{
  "version": 1,
  "state": "configuring",
  "currentStep": 2,
  "depotConnected": true,
  "depotConnectedAt": "example",
  "wizardConfig": {},
  "downloads": null,
  "precheck": {}
}

变更历史

此 API 暂无变更历史记录。

查看全部变更历史