部署
开始自动部署已配置ZCF组件。
调试可用性
在线调试
使用当前认证信息和示例参数提交 Mock 请求。
请求参数
请求体字段
configObject必填配置信息。
selectedComponentsList已选择组件。
示例： item1,item2
instanceNameString显示名称ZCF安装实例。
示例： my-zcf
deployModeString部署拓扑模式安装。
示例： single
dnsListDNS。
示例： item1,item2
ntpListNTP。
示例： item1,item2
depotModeString软件包源模式安装。
示例： online
depotBaseUrlString软件仓库基础地址。
示例： https://depot.example.com
depotTokenString认证令牌上游软件仓库。
示例： ****
postgresqlObject资源。
nodeObject节点。
roleString角色。
示例： primary
fqdnString完全限定域名称节点。
示例： node01.example.com
usernameString用户名。
示例： root
passwordString密码。
示例： ****
sshKeyPathStringSSH密钥路径。
示例： /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密码。
示例： ****
sshKeyPathStringSSH密钥路径。
示例： /root/.ssh/id_rsa
sshPortInteger连接。
示例： 22
vipStringVIP。
示例： 192.168.1.100
adminPasswordString管理员账户密码敏感。
示例： ****
idpObjectIdP。
applianceSizeString设备资源剖析IdP实例。
示例： small
nodesList资源。
示例： (nested array)
roleString角色。
示例： primary
fqdnString完全限定域名称节点。
示例： node01.example.com
usernameString用户名。
示例： root
passwordString密码。
示例： ****
sshKeyPathStringSSH密钥路径。
示例： /root/.ssh/id_rsa
sshPortInteger连接。
示例： 22
vipString虚拟IP地址HA IdP访问。
示例： 192.168.1.101
adminPasswordStringIdP管理员账户密码敏感。
示例： ****
rootPasswordStringIdP根账户密码敏感。
示例： ****
extensionsList扩展配置条目。
示例： (nested array)
componentTypeString标识符扩展。
示例： monitoring
versionString版本号。
示例： 1.2.0
applianceSizeString设备资源剖析扩展。
示例： small
nodesList资源。
示例： (nested array)
roleString角色。
示例： primary
fqdnString完全限定域名称节点。
示例： node01.example.com
usernameString用户名。
示例： root
passwordString密码。
示例： ****
sshKeyPathStringSSH密钥路径。
示例： /root/.ssh/id_rsa
sshPortInteger连接。
示例： 22
vipString虚拟IP HA扩展访问。
示例： 192.168.1.102
adminPasswordString扩展敏感。
示例： ****
cloudObject资源。
nodeIpStringIP地址云管理节点。
示例： 192.168.1.50
usernameString用户名。
示例： admin
passwordString密码。
示例： ****
envLinkedHashMap环境配置。
示例： (nested object)
versionPinsList资源。
示例： (nested array)
productString资源。
示例： value
versionString版本号。
示例： value
releaseString资源。
示例： value
响应状态
请求地址
POST/api/v1/installer/deploy
/api/v1/installer/deploy
请求示例
curl -X POST '{host}/api/v1/installer/deploy' -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{
"deployId": "deploy-a1b2c3d4",
"status": "deploying"
}变更历史
此 API 暂无变更历史记录。