容器网络管理

容量网络列表

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

请求参数

参数名称 类型 描述 必填 示例值
s_name string 容器网络名称 oooooo
page number 页码 2

请求示例:

发起请求
curl -k "https://{你网站的ip或者域名}:9966/?a=list&c=network&m=admin&s_name={容器网络名称}&page={页码}&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": 8
    },
    "currentInfo": {},
    "softwareInfo": {}
}


添加容器网络

  • 接口说明:添加容器网络
  • 接口地址:a=add&c=network&m=admin
  • 请求方式:POST

请求参数

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

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

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

请求示例:

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

请求参数

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

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

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

请求示例:

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

请求参数

参数名称 类型 描述 必填 示例值
id number 容器网络ID 1

请求示例:

发起请求
curl -k "https://{你网站的ip或者域名}:9966/?a=delete&c=network&m=admin&id={容器网络ID}&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": {}
}
Copyright © 广州市万岁云计算有限公司 2020 all right reserved,powered by Gitbook文档最近一次修订时间: 2020-08-11 15:31:24

results matching ""

    No results matching ""