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

验证安装器配置

运行预部署校验检查针对提供安装器配置。

调试可用性

在线调试

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

请求参数

请求体字段

  • configObject必填

    配置信息。

    • 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

响应状态

200 OK

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

  • validateIdString

    唯一ID校验会话已创建。

    示例： validate-a1b2c3d4

  • statusString

    状态信息。

    示例： validating

请求地址

POST/api/v1/installer/validate

/api/v1/installer/validate

操作 ID

ValidateInstallerConfig

永久链接

请求示例

curl -X POST '{host}/api/v1/installer/validate' -H 'Authorization: Bearer {token}' -H 'Content-Type: application/json' -d '{"config":{"selectedComponents":"item1,item2","instanceName":"my-zcf","deployMode":"single","dns":"item1,item2","ntp":"item1,item2","depotMode":"online","depotBaseUrl":"https://depot.example.com","depotToken":"****","postgresql":{"node":{"role":"primary","fqdn":"node01.example.com","username":"root","password":"****","sshKeyPath":"/root/.ssh/id_rsa","sshPort":22},"port":5432,"password":"****","image":"postgres:14-alpine","dataDir":"/var/lib/postgresql/data"},"lifecycle":{"applianceSize":"medium","nodes":"(nested array)","vip":"192.168.1.100","adminPassword":"****"},"idp":{"applianceSize":"small","nodes":"(nested array)","vip":"192.168.1.101","adminPassword":"****","rootPassword":"****"},"extensions":"(nested array)","cloud":{"nodeIp":"192.168.1.50","username":"admin","password":"****"},"env":"(nested object)","versionPins":"(nested array)"}}'

响应示例

200
{
  "validateId": "validate-a1b2c3d4",
  "status": "validating"
}

变更历史

此 API 暂无变更历史记录。

查看全部变更历史