主机管理
主机管理列表
- 接口说明:获取主机管理列表
- 接口地址:a=list&c=node&m=admin
- 请求方式:GET
请求参数
参数名称 | 类型 | 描述 | 必填 | 示例值 |
---|---|---|---|---|
s_hostname | string | 主机名 | 否 | master-node |
s_ip | string | IP | 否 | 192.168.1.10 |
page | string | 页码 | 否 | 2 |
请求示例:
发起请求
curl -k "https://{你网站的ip或者域名}:9966/?a=list&c=node&m=admin&v=99999&globalApiNonceStr={随机字符串}&getJson=1&globalApiTimestamp={时间戳}&globalApiSign={签名字符串}"
返回结果
{
"columns": [], //表头数据
"pageInfo": {}, // 分页信息
"dataSource": [], //列表数据
"msg": {
"message": "", // 提交请求执行结果的信息
"msgType": "success", // 提交请求执行结果的状态,有success、error、info、warning、fail
"msgMark": null,
"msgCode": null,
"jumpUrl": null,
"waitTime": 2
},
"currentInfo": {},
"softwareInfo": {}
}
添加主机
- 接口说明:添加主机
- 接口地址:a=add&c=node&m=admin
- 请求方式:POST
请求参数
参数名称 | 类型 | 描述 | 必填 | 示例值 |
---|---|---|---|---|
hostname | string | 主机名称 | 是 | 广州节点1 |
ip | string | 主机IP | 是 | 172.17.2.1 |
swarmId | number | 所在集群的ID | 是 | 1 |
nodeType | number | 主机类型:{管理主机+工作主机: 1, 工作主机: 0} (管理主机用于管理集群主机,当管理主机数量大 于等于3个时,集群便有了自动修复功能,当集群 内某台主机宕机时,基于非单机应用构建的服务可 实)现自动迁移,业务几乎不中断 |
是 | 1 |
status | number | 状态 {开启:1, 关闭并退出集群:0} | 是 | 1 |
sshUser | string | SSH用户名 | 是 | root |
sshPort | string | SSH端口 | 是 | 22 |
sshLoginType | string | SSH登录方式 {SSH密码: "password", SSH密钥: "key"} | 是 | password |
sshPassword | string | SSH密码 (当SSH的登录方式为“SSH密码”时,此项为必须) | 是 | |
sshPriKey | string | SSH密钥 (当SSH的登录方式为“SSH密钥”时,此项为必须) | 是 | |
doNotSaveSshInfo | boolean | 不保存密钥和密码,当主机部署完成后立即清除加密保存 在数据库中的SSH密码和密钥信息,下次部署主机前需再次输入 |
是 | true |
swapSize | number | 虚拟内存 { 不增加虚拟内存: 0, 512M: 512, 1G: 1024, 2G: 2048, 4G: 4096, 8G: 8192, 16G: 16384, 32G: 32768 } |
是 | 0 |
description | string | 描述 | 否 | |
sysctlConfigAppend | object | 内核参数 用于调整系统Sysctl的值,内容为json格式, 注意:此配置会覆盖集群中的内核参数配置 |
否 | { "file-max": 655350 } |
labels | array | 主机标签用于部署服务时的定向部署,即按不同服务类型部署到 不同的主机服务器 [网站专用:1, 数据库专用: 2, 缓存专用: 3, 工具专用: 4] 可多选 |
否 | [1, 2] |
storageDisk | string | 添加需要挂载的硬盘设备 | 否 | /dev/sdb |
storageDiskConfirm | string | 再次输入确认硬盘设备的路径 | 否 | |
storageDiskCheckboxComfirm | boolean | 为true时,这将擦除硬盘的现有数据,并且将硬盘挂载到存储 目录下的mounts目录上(一般为/data/mounts或/home/mounts) |
否 | false |
updateOs | boolean | 更新系统有利于提高安全性,建议当主机不能连接外网或者无法更新系统才设置为false | 否 | true |
序列化请求参数为键值对格式的字符串(注意:如果键值对的值是JSON格式数据,可能需要urlencode
):
"hostname={主机名称}&ip={主机IP}&swarmId={集群ID}&nodeType={主机类型}&status=1&sshUser={SSH用户名}&sshPort=22&sshLoginType=password&sshPassword={SSH密码}&doNotSaveSshInfo=true&swapSize={虚拟内存大小}"
请求示例:
发起请求
curl -d "hostname={主机名称}&ip={主机IP}&swarmId={集群ID}&nodeType={主机类型}&status=1&sshUser={SSH用户名}root&sshPort=22&sshLoginType=password&sshPassword={SSH密码}&doNotSaveSshInfo=true&swapSize={虚拟内存大小}" "https://{你网站的ip或者域名}:9966/?a=add&c=node&m=admin&v=99999&globalApiNonceStr={随机字符串}&getJson=1&globalApiTimestamp={时间戳}&globalApiSign={签名字符串}"
返回结果
{
"msg": {
"message": "", // 提交请求执行结果的信息
"msgType": "success", // 提交请求执行结果的状态,有success、error、info、warning、fail
"msgMark": null,
"msgCode": null,
"jumpUrl": null,
"waitTime": 8
},
"currentInfo": {},
"softwareInfo": {}
}
删除主机
- 接口说明:删除主机
- 接口地址:a=delete&c=node&m=admin
- 请求方式:GET
请求参数
参数名称 | 类型 | 描述 | 必填 | 示例值 |
---|---|---|---|---|
id | number | 主机ID | 是 | 1 |
请求示例:
curl -k "https://{你网站的ip或者域名}:9966/?a=delete&c=node&id={主机ID}&m=admin&v=99999&globalApiNonceStr={随机字符串}&getJson=1&globalApiTimestamp={时间戳}&globalApiSign={签名字符串}"
返回结果
{
"msg": {
"message": "", // 提交请求执行结果的信息
"msgType": "success", // 提交请求执行结果的状态,有success、error、info、warning、fail
"msgMark": null,
"msgCode": null,
"jumpUrl": null,
"waitTime": 8
},
"currentInfo": {},
"softwareInfo": {}
}
升级主机受控
- 接口说明:升级主机受控
- 接口地址:a=updateAgent&c=nodeHandle&m=admin
- 请求方式:GET
请求参数
参数名称 | 类型 | 描述 | 必填 | 示例值 |
---|---|---|---|---|
id | number | 主机ID | 是 | 1 |
请求示例:
curl -k "https://{你网站的ip或者域名}:9966/?a=updateAgent&c=nodeHandle&id={主机ID}&m=admin&v=99999&globalApiNonceStr={随机字符串}&getJson=1&globalApiTimestamp={时间戳}&globalApiSign={签名字符串}"
返回结果
{
"msg": {
"message": "", // 提交请求执行结果的信息
"msgType": "success", // 提交请求执行结果的状态,有success、error、info、warning、fail
"msgMark": null,
"msgCode": null,
"jumpUrl": null,
"waitTime": 8
},
"currentInfo": {},
"softwareInfo": {}
}
清理主机垃圾
- 接口说明:清理主机垃圾
- 接口地址:a=dockerClear&c=swarm&m=admin
- 请求方式:GET
请求参数
参数名称 | 类型 | 描述 | 必填 | 示例值 |
---|---|---|---|---|
id | number | 主机ID | 是 | 1 |
请求示例:
curl -k "https://{你网站的ip或者域名}:9966/?a=dockerClear&c=swarm&id={主机ID}&m=admin&v=99999&globalApiNonceStr={随机字符串}&getJson=1&globalApiTimestamp={时间戳}&globalApiSign={签名字符串}"
返回结果
{
"msg": {
"message": "", // 提交请求执行结果的信息
"msgType": "success", // 提交请求执行结果的状态,有success、error、info、warning、fail
"msgMark": null,
"msgCode": null,
"jumpUrl": null,
"waitTime": 8
},
"currentInfo": {},
"softwareInfo": {}
}
诊断主机
- 接口说明:诊断主机
- 接口地址:a=connCheck&c=node&m=admin
- 请求方式:GET
请求参数
参数名称 | 类型 | 描述 | 必填 | 示例值 |
---|---|---|---|---|
id | number | 主机ID | 是 | 1 |
请求示例:
curl -k "https://{你网站的ip或者域名}:9966/?a=connCheck&c=node&id={主机ID}&m=admin&v=99999&globalApiNonceStr={随机字符串}&getJson=1&globalApiTimestamp={时间戳}&globalApiSign={签名字符串}"
返回结果
{
"msg": {
"message": "", // 提交请求执行结果的信息
"msgType": "success", // 提交请求执行结果的状态,有success、error、info、warning、fail
"msgMark": null,
"msgCode": null,
"jumpUrl": null,
"waitTime": 8
},
"currentInfo": {},
"softwareInfo": {}
}
查看简要
- 接口说明:查看简要
- 接口地址:a=info&c=node&m=admin
- 请求方式:GET
请求参数
参数名称 | 类型 | 描述 | 必填 | 示例值 |
---|---|---|---|---|
id | number | 主机ID | 是 | 1 |
请求示例:
curl -k "https://{你网站的ip或者域名}:9966/?a=info&c=node&id={主机ID}&m=admin&v=99999&globalApiNonceStr={随机字符串}&getJson=1&globalApiTimestamp={时间戳}&globalApiSign={签名字符串}"
返回结果
{
"columns": [],
"dataSource": [],
"msg": {
"message": "", // 提交请求执行结果的信息
"msgType": "success", // 提交请求执行结果的状态,有success、error、info、warning、fail
"msgMark": null,
"msgCode": null,
"jumpUrl": null,
"waitTime": 8
},
"currentInfo": {},
"softwareInfo": {}
}
查看内存
- 接口说明:查看内存
- 接口地址:a=memInfo&c=node&m=admin
- 请求方式:GET
请求参数
参数名称 | 类型 | 描述 | 必填 | 示例值 |
---|---|---|---|---|
id | number | 主机ID | 是 | 1 |
请求示例:
curl -k "https://{你网站的ip或者域名}:9966/?a=memInfo&c=node&id={主机ID}&m=admin&v=99999&globalApiNonceStr={随机字符串}&getJson=1&globalApiTimestamp={时间戳}&globalApiSign={签名字符串}"
返回结果
{
"columns": [],
"dataSource": [],
"msg": {
"message": "", // 提交请求执行结果的信息
"msgType": "success", // 提交请求执行结果的状态,有success、error、info、warning、fail
"msgMark": null,
"msgCode": null,
"jumpUrl": null,
"waitTime": 8
},
"currentInfo": {},
"softwareInfo": {}
}
查看存储
- 接口说明:查看存储
- 接口地址:a=diskInfo&c=node&m=admin
- 请求方式:GET
请求参数
参数名称 | 类型 | 描述 | 必填 | 示例值 |
---|---|---|---|---|
id | number | 主机ID | 是 | 1 |
请求示例:
curl -k "https://{你网站的ip或者域名}:9966/?a=diskInfo&c=node&id={主机ID}&m=admin&v=99999&globalApiNonceStr={随机字符串}&getJson=1&globalApiTimestamp={时间戳}&globalApiSign={签名字符串}"
返回结果
{
"columns": [],
"dataSource": [],
"msg": {
"message": "", // 提交请求执行结果的信息
"msgType": "success", // 提交请求执行结果的状态,有success、error、info、warning、fail
"msgMark": null,
"msgCode": null,
"jumpUrl": null,
"waitTime": 8
},
"currentInfo": {},
"softwareInfo": {}
}