服务操作

智能部署

  • 接口说明：智能部署
  • 接口地址：a=normalDeploy&c=service&m=admin
  • 请求方式：GET

请求参数

参数名称类型描述必填示例值
idnumber服务ID是1

请求示例：

发起请求
  1. curl -k "https://{你网站的ip或者域名}:9966/?a=normalDeploy&c=service&id={服务ID}&m=admin&v=99999&globalApiNonceStr={随机字符串}&getJson=1&globalApiTimestamp={时间戳}&globalApiSign={签名字符串}"
返回结果
  1. {
  2.       "msg": {
  3.         "message": "", // 提交请求执行结果的信息
  4.         "msgType": "success", // 提交请求执行结果的状态，有success、error、info、warning、fail
  5.         "msgMark": null,
  6.         "msgCode": null,
  7.         "jumpUrl": null,
  8.         "waitTime": 8
  9.     },
  10.     "currentInfo": {},
  11.     "softwareInfo": {}
  12. }

强制部署

  • 接口说明：强制部署
  • 接口地址：a=forceDeploy&c=service&m=admin
  • 请求方式：GET

请求参数

参数名称类型描述必填示例值
idnumber服务ID是1

请求示例：

发起请求
  1. curl -k "https://{你网站的ip或者域名}:9966/?a=forceDeploy&c=service&id={服务ID}&m=admin&v=99999&globalApiNonceStr={随机字符串}&getJson=1&globalApiTimestamp={时间戳}&globalApiSign={签名字符串}"
返回结果
  1. {
  2.       "msg": {
  3.         "message": "", // 提交请求执行结果的信息
  4.         "msgType": "success", // 提交请求执行结果的状态，有success、error、info、warning、fail
  5.         "msgMark": null,
  6.         "msgCode": null,
  7.         "jumpUrl": null,
  8.         "waitTime": 8
  9.     },
  10.     "currentInfo": {},
  11.     "softwareInfo": {}
  12. }

执行快照备份

  • 接口说明：执行快照备份
  • 接口地址：a=manual&c=snapshot&m=admin
  • 请求方式：GET

请求参数

参数名称类型描述必填示例值
serviceIdnumber服务ID是1

请求示例：

发起请求
  1. curl -k "https://{你网站的ip或者域名}:9966/?a=manual&c=snapshot&m=admin&serviceId={服务ID}&v=99999&globalApiNonceStr={随机字符串}&getJson=1&globalApiTimestamp={时间戳}&globalApiSign={签名字符串}"
返回结果
  1. {
  2.       "msg": {
  3.         "message": "", // 提交请求执行结果的信息
  4.         "msgType": "success", // 提交请求执行结果的状态，有success、error、info、warning、fail
  5.         "msgMark": null,
  6.         "msgCode": null,
  7.         "jumpUrl": null,
  8.         "waitTime": 8
  9.     },
  10.     "currentInfo": {},
  11.     "softwareInfo": {}
  12. }

执行远程备份

注意 远程备份可能需要消耗较长时间和较大带宽，请认真考虑操作！

  • 接口说明：执行远程备份
  • 接口地址：a=sendRemoteBackupCron&c=snapshot&m=admin
  • 请求方式：GET

请求参数

参数名称类型描述必填示例值
serviceIdnumber服务ID是1

请求示例：

发起请求
  1. curl -k "https://{你网站的ip或者域名}:9966/?a=sendRemoteBackupCron&c=snapshot&m=admin&serviceId={服务ID}&v=99999&globalApiNonceStr={随机字符串}&getJson=1&globalApiTimestamp={时间戳}&globalApiSign={签名字符串}"
返回结果
  1. {
  2.       "msg": {
  3.         "message": "", // 提交请求执行结果的信息
  4.         "msgType": "success", // 提交请求执行结果的状态，有success、error、info、warning、fail
  5.         "msgMark": null,
  6.         "msgCode": null,
  7.         "jumpUrl": null,
  8.         "waitTime": 8
  9.     },
  10.     "currentInfo": {},
  11.     "softwareInfo": {}
  12. }

查看Docker容器信息

  • 接口说明：查看Docker容器信息
  • 接口地址：a=inspect&c=service&m=admin
  • 请求方式：GET

请求参数

参数名称类型描述必填示例值
serviceIdnumber服务ID是1

请求示例：

发起请求
  1. curl -k "https://{你网站的ip或者域名}:9966/?a=inspect&c=service&id={服务ID}&m=admin&v=99999&globalApiNonceStr={随机字符串}&getJson=1&globalApiTimestamp={时间戳}&globalApiSign={签名字符串}"
返回结果
  1. {
  2.         "globalModalInfo": {
  3.             "content": []
  4.       },
  5.       "msg": {
  6.         "message": "", // 提交请求执行结果的信息
  7.         "msgType": "success", // 提交请求执行结果的状态，有success、error、info、warning、fail
  8.         "msgMark": null,
  9.         "msgCode": null,
  10.         "jumpUrl": null,
  11.         "waitTime": 8
  12.     },
  13.     "currentInfo": {},
  14.     "softwareInfo": {}
  15. }

查看活动容器数

  • 接口说明：查看活动容器数
  • 接口地址：a=serviceTask&c=service&m=admin
  • 请求方式：GET

请求参数

参数名称类型描述必填示例值
serviceIdnumber服务ID是1

请求示例：

发起请求
  1. curl -k "https://{你网站的ip或者域名}:9966/?a=serviceTask&c=service&id={服务ID}&m=admin&v=99999&globalApiNonceStr={随机字符串}&getJson=1&globalApiTimestamp={时间戳}&globalApiSign={签名字符串}"
返回结果
  1. {
  2.       "msg": {
  3.         "message": "", // 提交请求执行结果的信息
  4.         "msgType": "success", // 提交请求执行结果的状态，有success、error、info、warning、fail
  5.         "msgMark": null,
  6.         "msgCode": null,
  7.         "jumpUrl": null,
  8.         "waitTime": 8
  9.     },
  10.     "currentInfo": {},
  11.     "softwareInfo": {}
  12. }

停止并关闭服务

注意 停止服务后，将删除正在运行的容器，请谨慎操作！

  • 接口说明：停止并关闭服务
  • 接口地址：a=stopAndCloseService&c=service&m=admin
  • 请求方式：GET

请求参数

参数名称类型描述必填示例值
serviceIdnumber服务ID是1

请求示例：

发起请求
  1. curl -k "https://{你网站的ip或者域名}:9966/?a=stopAndCloseService&c=service&id={服务ID}&m=admin&v=99999&globalApiNonceStr={随机字符串}&getJson=1&globalApiTimestamp={时间戳}&globalApiSign={签名字符串}"
返回结果
  1. {
  2.       "msg": {
  3.         "message": "", // 提交请求执行结果的信息
  4.         "msgType": "success", // 提交请求执行结果的状态，有success、error、info、warning、fail
  5.         "msgMark": null,
  6.         "msgCode": null,
  7.         "jumpUrl": null,
  8.         "waitTime": 8
  9.     },
  10.     "currentInfo": {},
  11.     "softwareInfo": {}
  12. }

停止并删除服务

注意 服务产生的数据不会随服务一起删除，如有需要，请使用SFTP客户端工具登录主机进行删除！

  • 接口说明：停止并删除服务
  • 接口地址：a=stopAndDeleteService&c=service&m=admin
  • 请求方式：GET

请求参数

参数名称类型描述必填示例值
serviceIdnumber服务ID是1

请求示例：

发起请求
  1. curl -k "https://{你网站的ip或者域名}:9966/?a=stopAndDeleteService&c=service&id={服务ID}&m=admin&v=99999&globalApiNonceStr={随机字符串}&getJson=1&globalApiTimestamp={时间戳}&globalApiSign={签名字符串}"
返回结果
  1. {
  2.     "msg": {
  3.         "message": "", // 提交请求执行结果的信息
  4.         "msgType": "success", // 提交请求执行结果的状态，有success、error、info、warning、fail
  5.         "msgMark": null,
  6.         "msgCode": null,
  7.         "jumpUrl": null,
  8.         "waitTime": 8
  9.     },
  10.     "currentInfo": {},
  11.     "softwareInfo": {}
  12. }

配置WAF

  • 接口说明：配置WAF
  • 接口地址：a=waf&c=website&id={服务ID}&m=admin&swarmId={集群ID}
  • 请求方式：POST

请求参数

参数名称类型描述必填示例值
wafSwitch01number是否开启“攻击防护”，开启：1，关闭：0是1
argsFilterSwitch01number网址检查，开启：1，关闭：0。开启网址检查可有效防止SQL注入，
XSS和SSRF等WEB攻击		是1
wafBrowserCheckSwitch01number浏览器检查，开启：1，关闭：0。开启后仅浏览器才允许访问，
可增加攻击难度，但有可能会导致CDN不可使用，搜索引擎的爬虫抓
取不到网站内容，请认真权衡利弊		是1
wafCheckUrl01string防护网址 支持正则匹配，默认值”/“表示防护所有网页，配置成，
配置成”.(php|jsp|cgi)$”表示防护以”php|jsp|cgi”为扩展名的网址		否“/“
wafCheckSeconds01number请选择防护时长，一般为10秒即可否5
wafCheckCounts01number最大请求数，一定时间内的请求数达到此数量时，即显示错误页面否100
wafKeepSeconds01number客户端保持时长，如果某客户端合法则放入白名单，保持一段时间后再重新检查否1800
wafIpWhiteList01stringIP白名单，白名单中的IP不需检查即可访问网站，多个IP请换行否“192.168.1.2\n192.168.1.3”
wafIpBlackList01stringIP黑名单，黑名单中的IP不可访问网站，多个IP请换行否“192.168.1.2\n192.168.1.3”

序列化请求参数为键值对格式的字符串(注意：如果键值对的值是JSON格式数据，可能需要urlencode)：

  1. "wafSwitch01=1&argsFilterSwitch01=1&wafBrowserCheckSwitch01=1"

请求示例：

发起请求
  1. curl -d "wafSwitch01=1&argsFilterSwitch01=1&wafBrowserCheckSwitch01=1" "https://{你网站的ip或者域名}:9966/?a=waf&c=website&id={服务ID}&m=admin&swarmId={集群ID}"
返回结果
  1. {
  2.     "msg": {
  3.         "message": "", // 提交请求执行结果的信息
  4.         "msgType": "success", // 提交请求执行结果的状态，有success、error、info、warning、fail
  5.         "msgMark": null,
  6.         "msgCode": null,
  7.         "jumpUrl": null,
  8.         "waitTime": 8
  9.     },
  10.     "currentInfo": {},
  11.     "softwareInfo": {}
  12. }

查看PHP扩展

  • 接口说明：查看PHP扩展
  • 接口地址：a=custom&actionMark=showPhpExtension&c=service&m=admin&serviceId={服务ID}
  • 请求方式：GET

请求参数

参数名称类型描述必填示例值
actionMarknumber固定值为：showPhpExtension是
serviceIdnumber服务ID是1

请求示例：

发起请求
  1. curl -k "https://{你网站的ip或者域名}:9966/?a=custom&actionMark=showPhpExtension&c=service&m=admin&serviceId={服务ID}&v=99999&globalApiNonceStr={随机字符串}&getJson=1&globalApiTimestamp={时间戳}&globalApiSign={签名字符串}"
返回结果
  1. {
  2.         "globalModalInfo": {
  3.             "content": []
  4.       },
  5.       "msg": {
  6.         "message": "", // 提交请求执行结果的信息
  7.         "msgType": "success", // 提交请求执行结果的状态，有success、error、info、warning、fail
  8.         "msgMark": null,
  9.         "msgCode": null,
  10.         "jumpUrl": null,
  11.         "waitTime": 8
  12.     },
  13.     "currentInfo": {},
  14.     "softwareInfo": {}
  15. }

检查服务部署状态 v1.2.5.6版本新增

  • 接口说明：检查服务部署状态
  • 接口地址：a=isDeployed&c=serviceDeploy&m=admin
  • 请求方式：GET

请求参数

参数名称类型描述必填示例值
serviceIdnumber服务ID是1

请求示例：

发起请求
  1. curl -k "https://{你网站的ip或者域名}:9966/?a=isDeployed&c=serviceDeploy&m=admin&serviceId={服务ID}&v=99999&globalApiNonceStr={随机字符串}&getJson=1&globalApiTimestamp={时间戳}&globalApiSign={签名字符串}"
返回结果
  1. {
  2.       "msg": {
  3.         "message": "", //部署过程中或者部署结束后的信息
  4.         "msgType": "success", // 提交请求执行结果的状态，有success、error、info、warning、fail
  5.         "msgMark": "IS_OK", // 如果msgMark == "IS_OK", 表示部署成功
  6.         "msgCode": null,
  7.         "jumpUrl": null,
  8.         "waitTime": 8
  9.     },
  10.     "currentInfo": {},
  11.     "softwareInfo": {}
  12. }