部署

开始自动部署已配置ZCF组件。

POST/api/v1/installer/deploy

操作 ID

Deploy

起始版本

1.0.0

执行模式

同步

认证信息

需要认证

认证信息

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

Authorizationstring必填

Bearer 令牌

X-Tenant-IDstring

X-Tenant-ID

请求参数

application/json

请求体字段

config
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

响应状态

200 OK

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

deployId
String
唯一ID部署会话。
示例： deploy-a1b2c3d4
status
String
状态信息。
示例： deploying

请求示例

curl -X POST '{host}/api/v1/installer/deploy' \
  -H 'Authorization: Bearer {token}' \
  -H 'Content-Type: application/json' \
  -d '{
  "config": {
    "selectedComponents": [
      "{selectedComponents}"
    ],
    "instanceName": "my-zcf",
    "deployMode": "single",
    "dns": [
      "{dns}"
    ],
    "ntp": [
      "{ntp}"
    ],
    "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": [
        {
          "role": "primary",
          "fqdn": "node01.example.com",
          "username": "root",
          "password": "****",
          "sshKeyPath": "/root/.ssh/id_rsa",
          "sshPort": "22"
        }
      ],
      "vip": "192.168.1.100",
      "adminPassword": "****",
      "vipInterface": "ens192"
    },
    "idp": {
      "applianceSize": "small",
      "nodes": [
        {
          "role": "primary",
          "fqdn": "node01.example.com",
          "username": "root",
          "password": "****",
          "sshKeyPath": "/root/.ssh/id_rsa",
          "sshPort": "22"
        }
      ],
      "vip": "192.168.1.101",
      "adminPassword": "****",
      "rootPassword": "****"
    },
    "extensions": [
      {
        "componentType": "monitoring",
        "version": "1.2.0",
        "applianceSize": "small",
        "nodes": [
          {
            "role": "primary",
            "fqdn": "node01.example.com",
            "username": "root",
            "password": "****",
            "sshKeyPath": "/root/.ssh/id_rsa",
            "sshPort": "22"
          }
        ],
        "vip": "192.168.1.102",
        "adminPassword": "****"
      }
    ],
    "cloud": [
      {
        "address": "192.168.1.50",
        "port": "22",
        "user": "root",
        "password": "****"
      }
    ],
    "env": {},
    "versionPins": [
      {
        "product": "value",
        "version": "value",
        "release": "value"
      }
    ],
    "depotChannel": "value",
    "placementPins": [
      "{placementPins}"
    ],
    "configOverwrite": {},
    "noDumpState": "true",
    "licenseServer": {
      "host": "172.24.243.148",
      "http": "8201"
    }
  }
}'

响应示例

{
  "deployId": "deploy-a1b2c3d4",
  "status": "deploying"
}

变更历史

查看全部变更历史

变更时间变更内容概要操作

变更时间
2026-06-10
新增请求体字段 host, http, licenseServer
查看 API
变更时间
2026-05-27
新增请求体字段 address, user已删除请求体字段 nodeIp
查看 API
变更时间
2026-05-25
新增请求体字段 configOverwrite, depotChannel, noDumpState...
查看 API

Agent 插件

Agent 管理

资产

指标目录与保留策略

采集任务

基础设施综合

安装器

生命周期

OTA 升级计划

OTA 版本与策略

联邦与 SSO

变更管理

资源删除

生命周期升级

指标采集

监控缓存

监控查询与概览

自动修复

监控综合

Grafana 集成

Grafana 仪表盘

日志

性能剖析

Zaku

告警规则

告警模板

告警通道与集成

告警事件

告警路由与策略

值班

SLO

健康检查

凭证

ZIAM

安全

ZMetis 审计

平台管理

平台联邦

平台自监控

平台健康

平台综合

ZMetis 任务

认证信息

请求参数

请求体字段

响应状态

变更历史