容器网络管理

容量网络列表

  • 接口说明:容量网络列表
  • 接口地址:a=list&c=network&m=admin
  • 请求方式:GET

请求参数

参数名称类型描述必填示例值
s_namestring容器网络名称oooooo
pagenumber页码2

请求示例:

发起请求
  1. curl -k "https://{你网站的ip或者域名}:9966/?a=list&c=network&m=admin&s_name={容器网络名称}&page={页码}&v=99999&globalApiNonceStr={随机字符串}&getJson=1&globalApiTimestamp={时间戳}&globalApiSign={签名字符串}"
返回结果
  1. {
  2. "columns": [], //表头数据
  3. "pageInfo": {}, // 分页信息
  4. "dataSource": [], //列表数据
  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=add&c=network&m=admin
  • 请求方式:POST

请求参数

参数名称类型描述必填示例值
namestring容器网络名称 以字母开头,由字母、数字和下划线组成myNetworkIp01
swarmIdnumber所在集群ID1
shareStorageDirboolean共享存储目录 为true时,则允许使用该容器网络的所有服务
可以共享存储目录(需要部署相关服务后方可生效)
false
ipRangestringip范围,如:192.168.100.0/24“auto”
descriptionstring描述 不超过256个字符

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

  1. "name={容器网络名称}&swarmId={所在集群ID}"

请求示例:

发起请求
  1. curl -d "name={容器网络名称}&swarmId={所在集群ID}" "https://{你网站的ip或者域名}:9966/?a=add&c=network&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=edit&c=network&m=admin
  • 请求方式:POST

请求参数

参数名称类型描述必填示例值
shareStorageDirboolean共享存储目录 为true时,则允许使用该容器网络的所有服务
可以共享存储目录(需要部署相关服务后方可生效)
false
descriptionstring描述 不超过256个字符

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

  1. "shareStorageDir={共享存储目录}&description={描述}"

请求示例:

发起请求
  1. curl -d "shareStorageDir={共享存储目录}&description={描述}" "https://{你网站的ip或者域名}:9966/?a=edit&c=network&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=delete&c=network&m=admin
  • 请求方式:GET

请求参数

参数名称类型描述必填示例值
idnumber容器网络ID1

请求示例:

发起请求
  1. curl -k "https://{你网站的ip或者域名}:9966/?a=delete&c=network&m=admin&id={容器网络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. }