文档中心知识库API Explorer
文档中心›ZCF›ZStack Cloud›探索更多›开发手册ZCF
文档目录

IPsec相关接口

创建IPsec连接(CreateIPsecConnection)

API请求

URLs
POST zstack/v1/ipsec
Headers
Authorization: OAuth the-session-uuid
Body
{
  "params": {
    "name": "Test-IPSec",
    "vipUuid": "cefa2f4e56ef33e496ccbb5879850f76",
    "peerAddress": "100.64.10.10",
    "authMode": "psk",
    "authKey": "auth",
    "idType": "ip",
    "localId": "1.1.1.1",
    "remoteId": "2.2.2.2",
    "l3NetworkUuid": "a4097ba23a7e38339029e1839bb415e1",
    "peerCidrs": [
      "192.168.100.0/24"
    ],
    "ikeVersion": "ikev2",
    "ikeAuthAlgorithm": "sha256",
    "ikeEncryptionAlgorithm": "aes-256",
    "ikeDhGroup": 2.0,
    "ikeLifeTime": 86400.0,
    "policyAuthAlgorithm": "sha256",
    "policyEncryptionAlgorithm": "aes-256",
    "pfs": "dh-group14",
    "policyMode": "tunnel",
    "transformProtocol": "esp",
    "lifeTime": 3600.0
  },
  "systemTags": [],
  "userTags": []
}
Note: 上述示例中systemTags、userTags字段可以省略。列出是为了表示body中可以包含这两个字段。
Curl示例
curl -H "Content-Type: application/json;charset=UTF-8" \
-H "Authorization: OAuth b86c9016b4f24953a9edefb53ca0678c" \
-X POST -d '{"params":{"name":"Test-IPSec","vipUuid":"cefa2f4e56ef33e496ccbb5879850f76","peerAddress":"100.64.10.10","authMode":"psk","authKey":"auth","idType":"ip","localId":"1.1.1.1","remoteId":"2.2.2.2","l3NetworkUuid":"a4097ba23a7e38339029e1839bb415e1","peerCidrs":["192.168.100.0/24"],"ikeVersion":"ikev2","ikeAuthAlgorithm":"sha256","ikeEncryptionAlgorithm":"aes-256","ikeDhGroup":2.0,"ikeLifeTime":86400.0,"policyAuthAlgorithm":"sha256","policyEncryptionAlgorithm":"aes-256","pfs":"dh-group14","policyMode":"tunnel","transformProtocol":"esp","lifeTime":3600.0}}' \
http://localhost:8080/zstack/v1/ipsec
参数列表
名字 类型 位置 描述 可选值 起始版本
name String body(包含在params结构中) 资源名称 0.6
description (可选) String body(包含在params结构中) 资源的详细描述 0.6
l3NetworkUuid (可选) String body(包含在params结构中) 三层网络UUID 2.3
peerAddress String body(包含在params结构中) 远端网络地址 4.5.0
authMode (可选) String body(包含在params结构中) 认证模式
  • psk
  • certs
 0.6
authKey String body(包含在params结构中) 认证密钥 0.6
idType (可选) String body(包含在params结构中) ID配置方法
  • ip
  • name
  • fqdn
 4.5.0
vipUuid String body(包含在params结构中) VIP UUID 0.6
localId (可选) String body(包含在params结构中) 本端ID 4.5.0
remoteId (可选) String body(包含在params结构中) 对端ID 4.5.0
peerCidrs (可选) List body(包含在params结构中) 目的网络CIDR 4.5.0
ikeVersion (可选) String body(包含在params结构中) IKE版本
  • ike
  • ikev1
  • ikev2
 4.5.0
ikeAuthAlgorithm (可选) String body(包含在params结构中) IKE验证算法
  • md5
  • sha1
  • sha256
  • sha384
  • sha512
 0.6
ikeEncryptionAlgorithm (可选) String body(包含在params结构中) IKE加密算法
  • 3des
  • aes-128
  • aes-192
  • aes-256
 0.6
ikeDhGroup (可选) int body(包含在params结构中) IKE DH组 4.5.0
ikeLifeTime (可选) int body(包含在params结构中) IKE存活时间 4.5.0
policyAuthAlgorithm (可选) String body(包含在params结构中) ESP认证算法
  • md5
  • sha1
  • sha256
  • sha384
  • sha512
 0.6
policyEncryptionAlgorithm (可选) String body(包含在params结构中) ESP加密算法
  • 3des
  • aes-128
  • aes-192
  • aes-256
 0.6
pfs (可选) String body(包含在params结构中) PFS DH组
  • none
  • dh-group0
  • dh-group2
  • dh-group5
  • dh-group14
  • dh-group15
  • dh-group16
  • dh-group17
  • dh-group18
  • dh-group19
  • dh-group20
  • dh-group21
  • dh-group22
  • dh-group23
  • dh-group24
  • dh-group25
  • dh-group26
 4.5.0
policyMode (可选) String body(包含在params结构中) 封装模式
  • tunnel
  • transport
 4.5.0
transformProtocol (可选) String body(包含在params结构中) 安全协议
  • esp
  • ah
  • ah-esp
 4.5.0
lifeTime (可选) int body(包含在params结构中) IPSec存活时间 4.5.0
resourceUuid (可选) String body(包含在params结构中) 资源UUID 0.6
tagUuids (可选) List body(包含在params结构中) 标签UUID列表 4.5.0
systemTags (可选) List body 系统标签 0.6
userTags (可选) List body 用户标签 0.6

API返回

返回示例
{
  "inventory": {
    "name": "Test-IPSec",
    "peerAddress": "100.64.10.10",
    "authKey": "auth",
    "vipUuid": "6a33d0d912263fd7a47d036eead9a27f",
    "status": "Connecting",
    "ikeLifeTime": 0.0,
    "lifeTime": 0.0,
    "peerCidrs": [
      {
        "uuid": "199b04405d1e3fef83fd67a7a1f77bb3",
        "cidr": "192.168.100.0/24",
        "connectionUuid": "6deaa1c0ffd43f8eb3ebe2e8e7e66811",
        "createDate": "Nov 14, 2017 10:20:57 PM",
        "lastOpDate": "Nov 14, 2017 10:20:57 PM"
      }
    ],
    "l3NetworkRefs": [
      {}
    ]
  }
}
名字 类型 描述 起始版本
success boolean 4.5.0
error ErrorCode 错误码，若不为null，则表示操作失败, 操作成功时该字段为null。 详情参考error 0.6
inventory IPsecConnectionInventory 详情参考inventory 0.6
#error
名字 类型 描述 起始版本
code String 错误码号，错误的全局唯一标识，例如SYS.1000, HOST.1001 0.6
description String 错误的概要描述 0.6
details String 错误的详细信息 0.6
elaboration String 保留字段，默认为null 0.6
opaque LinkedHashMap 保留字段，默认为null 0.6
cause ErrorCode 根错误，引发当前错误的源错误，若无原错误，该字段为null 0.6
#inventory
名字 类型 描述 起始版本
uuid String 资源的UUID，唯一标示该资源 0.6
name String 资源名称 0.6
description String 资源的详细描述 0.6
peerAddress String 远端网络地址 4.5.0
authMode String 认证模式 4.5.0
authKey String 认证密钥 4.5.0
vipUuid String VIP UUID 0.6
ikeAuthAlgorithm String IKE验证算法 4.5.0
ikeEncryptionAlgorithm String IKE加密算法 4.5.0
ikeDhGroup Integer IKE DH组 4.5.0
policyAuthAlgorithm String ESP认证算法 4.5.0
policyEncryptionAlgorithm String ESP加密算法 4.5.0
pfs String PFS DH组 4.5.0
policyMode String 封装模式 4.5.0
transformProtocol String 安全协议 4.5.0
ikeVersion String IKE版本 4.5.0
idType String ID配置方法 4.5.0
localId String 本端ID 4.5.0
remoteId String 对端ID 4.5.0
state String 启用状态 4.5.0
status String 就绪状态 4.5.0
ikeLifeTime int IKE存活时间 4.5.0
lifeTime int IPSec存活时间 4.5.0
createDate Timestamp 创建时间 0.6
lastOpDate Timestamp 最后一次修改时间 0.6
peerCidrs List 详情参考peerCidrs 0.6
l3NetworkRefs List 详情参考l3NetworkRefs 2.3
#peerCidrs
名字 类型 描述 起始版本
uuid String 资源的UUID，唯一标示该资源 0.6
cidr String 0.6
connectionUuid String 0.6
createDate Timestamp 创建时间 0.6
lastOpDate Timestamp 最后一次修改时间 0.6
#l3NetworkRefs
名字 类型 描述 起始版本
uuid String 资源的UUID，唯一标示该资源 2.3
connectionUuid String 2.3
l3NetworkUuid String 三层网络UUID 2.3
createDate Timestamp 创建时间 2.3
lastOpDate Timestamp 最后一次修改时间 2.3

SDK示例

Java SDK
CreateIPsecConnectionAction action = new CreateIPsecConnectionAction();
action.name = "Test-IPSec";
action.vipUuid = "cefa2f4e56ef33e496ccbb5879850f76";
action.peerAddress = "100.64.10.10";
action.authMode = "psk";
action.authKey = "auth";
action.idType = "ip";
action.localId = "1.1.1.1";
action.remoteId = "2.2.2.2";
action.l3NetworkUuid = "a4097ba23a7e38339029e1839bb415e1";
action.peerCidrs = asList("192.168.100.0/24");
action.ikeVersion = "ikev2";
action.ikeAuthAlgorithm = "sha256";
action.ikeEncryptionAlgorithm = "aes-256";
action.ikeDhGroup = 2.0;
action.ikeLifeTime = 86400.0;
action.policyAuthAlgorithm = "sha256";
action.policyEncryptionAlgorithm = "aes-256";
action.pfs = "dh-group14";
action.policyMode = "tunnel";
action.transformProtocol = "esp";
action.lifeTime = 3600.0;
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c";
CreateIPsecConnectionAction.Result res = action.call();
Python SDK
CreateIPsecConnectionAction action = CreateIPsecConnectionAction()
action.name = "Test-IPSec"
action.vipUuid = "cefa2f4e56ef33e496ccbb5879850f76"
action.peerAddress = "100.64.10.10"
action.authMode = "psk"
action.authKey = "auth"
action.idType = "ip"
action.localId = "1.1.1.1"
action.remoteId = "2.2.2.2"
action.l3NetworkUuid = "a4097ba23a7e38339029e1839bb415e1"
action.peerCidrs = [192.168.100.0/24]
action.ikeVersion = "ikev2"
action.ikeAuthAlgorithm = "sha256"
action.ikeEncryptionAlgorithm = "aes-256"
action.ikeDhGroup = 2.0
action.ikeLifeTime = 86400.0
action.policyAuthAlgorithm = "sha256"
action.policyEncryptionAlgorithm = "aes-256"
action.pfs = "dh-group14"
action.policyMode = "tunnel"
action.transformProtocol = "esp"
action.lifeTime = 3600.0
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c"
CreateIPsecConnectionAction.Result res = action.call()

删除IPsec连接(DeleteIPsecConnection)

API请求

URLs
DELETE zstack/v1/ipsec/{uuid}
Headers
Authorization: OAuth the-session-uuid
Curl示例
curl -H "Content-Type: application/json;charset=UTF-8" \
-H "Authorization: OAuth b86c9016b4f24953a9edefb53ca0678c" \
-X DELETE http://localhost:8080/zstack/v1/ipsec/7176e70d92953235998cce8b486e2467
参数列表
名字 类型 位置 描述 可选值 起始版本
uuid String url 资源的UUID，唯一标示该资源 0.6
deleteMode (可选) String body 删除模式 4.5.0
systemTags (可选) List body 系统标签 0.6
userTags (可选) List body 用户标签 0.6

API返回

该API成功时返回一个空的JSON结构{}，出错时返回的JSON结构包含一个error字段，例如：
{
"error": {
"code": "SYS.1001",
"description": "A message or a operation timeout",
"details": "Create VM on KVM timeout after 300s"
    }
}

SDK示例

Java SDK
DeleteIPsecConnectionAction action = new DeleteIPsecConnectionAction();
action.uuid = "2935596566fa421f833a801d501dbb53";
action.deleteMode = "Permissive";
action.sessionId = "7392673bd2244ad2a63280e81f9a7014";
DeleteIPsecConnectionAction.Result res = action.call();
Python SDK
DeleteIPsecConnectionAction action = DeleteIPsecConnectionAction()
action.uuid = "808078c31bdd499591bc009b8ae3446f"
action.deleteMode = "Permissive"
action.sessionId = "fcafdabd9a5e47c5ae7ff92c121173f9"
DeleteIPsecConnectionAction.Result res = action.call()

查询IPsec连接(QueryIPSecConnection)

API请求

URLs
GET zstack/v1/ipsec
GET zstack/v1/ipsec/{uuid}
Headers
Authorization: OAuth the-session-uuid
Curl示例
curl -H "Content-Type: application/json;charset=UTF-8" \
-H "Authorization: OAuth b86c9016b4f24953a9edefb53ca0678c" \
-X GET http://localhost:8080/zstack/v1/ipsec
curl -H "Content-Type: application/json;charset=UTF-8" \
-H "Authorization: OAuth b86c9016b4f24953a9edefb53ca0678c" \
-X GET http://localhost:8080/zstack/v1/ipsec/ea540aa23c0b36a887cd93a912fd0c32

可查询字段

运行CLI命令行工具，输入QueryIPSecConnection并按Tab键查看所有可查询字段以及可跨表查询的资源名。

API返回

返回示例
{
  "inventories": [
    {
      "name": "Test-IPSec",
      "peerAddress": "100.64.10.10",
      "authKey": "auth",
      "vipUuid": "ca0f405c79ea3b53aa588f58ed10e410",
      "ikeLifeTime": 0.0,
      "lifeTime": 0.0,
      "peerCidrs": [
        {
          "uuid": "72744840ae243518859730e99ea42157",
          "cidr": "192.168.100.0/24",
          "connectionUuid": "9d832d652fc732d6a5cebe1d8173c6c9",
          "createDate": "Nov 14, 2017 10:20:57 PM",
          "lastOpDate": "Nov 14, 2017 10:20:57 PM"
        }
      ],
      "l3NetworkRefs": [
        {}
      ]
    }
  ]
}
名字 类型 描述 起始版本
success boolean 4.5.0
error ErrorCode 错误码，若不为null，则表示操作失败, 操作成功时该字段为null。 详情参考error 0.6
inventories List 详情参考inventories 0.6
#error
名字 类型 描述 起始版本
code String 错误码号，错误的全局唯一标识，例如SYS.1000, HOST.1001 0.6
description String 错误的概要描述 0.6
details String 错误的详细信息 0.6
elaboration String 保留字段，默认为null 0.6
opaque LinkedHashMap 保留字段，默认为null 0.6
cause ErrorCode 根错误，引发当前错误的源错误，若无原错误，该字段为null 0.6
#inventories
名字 类型 描述 起始版本
uuid String 资源的UUID，唯一标示该资源 0.6
name String 资源名称 0.6
description String 资源的详细描述 0.6
peerAddress String 远端网络地址 4.5.0
authMode String 认证模式 4.5.0
authKey String 认证密钥 4.5.0
vipUuid String VIP UUID 0.6
ikeAuthAlgorithm String IKE验证算法 4.5.0
ikeEncryptionAlgorithm String IKE加密算法 4.5.0
ikeDhGroup Integer IKE DH组 4.5.0
policyAuthAlgorithm String ESP认证算法 4.5.0
policyEncryptionAlgorithm String ESP加密算法 4.5.0
pfs String PFS DH组 4.5.0
policyMode String 封装模式 4.5.0
transformProtocol String 安全协议 4.5.0
ikeVersion String IKE版本 4.5.0
idType String ID配置方法 4.5.0
localId String 本端ID 4.5.0
remoteId String 对端ID 4.5.0
state String 启用状态 4.5.0
status String 就绪状态 4.5.0
ikeLifeTime int IKE存活时间 4.5.0
lifeTime int IPSec存活时间 4.5.0
createDate Timestamp 创建时间 0.6
lastOpDate Timestamp 最后一次修改时间 0.6
peerCidrs List 详情参考peerCidrs 0.6
l3NetworkRefs List 详情参考l3NetworkRefs 2.3
#peerCidrs
名字 类型 描述 起始版本
uuid String 资源的UUID，唯一标示该资源 0.6
cidr String 0.6
connectionUuid String 0.6
createDate Timestamp 创建时间 0.6
lastOpDate Timestamp 最后一次修改时间 0.6
#l3NetworkRefs
名字 类型 描述 起始版本
uuid String 资源的UUID，唯一标示该资源 2.3
connectionUuid String 2.3
l3NetworkUuid String 三层网络UUID 2.3
createDate Timestamp 创建时间 2.3
lastOpDate Timestamp 最后一次修改时间 2.3

SDK示例

Java SDK
QueryIPSecConnectionAction action = new QueryIPSecConnectionAction();
action.conditions = asList();
action.sessionId = "2da0145074b749de95a5f7e6197dedf5";
QueryIPSecConnectionAction.Result res = action.call();
Python SDK
QueryIPSecConnectionAction action = QueryIPSecConnectionAction()
action.conditions = []
action.sessionId = "39df08f032b9490a853c60158dee9140"
QueryIPSecConnectionAction.Result res = action.call()

更新IPsec连接(UpdateIPsecConnection)

API请求

URLs
PUT zstack/v1/ipsec/{uuid}
Headers
Authorization: OAuth the-session-uuid
Body
{
  "updateIPsecConnection": {
    "name": "test Ipsec",
    "description": "info",
    "deleteMode": "Permissive"
  },
  "systemTags": [],
  "userTags": []
}
Note: 上述示例中systemTags、userTags字段可以省略。列出是为了表示body中可以包含这两个字段。
Curl示例
curl -H "Content-Type: application/json;charset=UTF-8" \
-H "Authorization: OAuth b86c9016b4f24953a9edefb53ca0678c" \
-X PUT -d '{"updateIPsecConnection":{"name":"test Ipsec","description":"info"}}' \
http://localhost:8080/zstack/v1/ipsec/1bcf0b898cf33f05b29edeb54a87ed82
参数列表
名字 类型 位置 描述 可选值 起始版本
uuid String url 资源的UUID，唯一标示该资源 0.6
name (可选) String body(包含在updateIPsecConnection结构中) 资源名称 0.6
description (可选) String body(包含在updateIPsecConnection结构中) 资源的详细描述 0.6
systemTags (可选) List body 0.6
userTags (可选) List body 0.6

API返回

返回示例

{
  "inventory": {
    "name": "Test-IPSec",
    "description": "desc info ",
    "peerAddress": "100.64.10.10",
    "authKey": "auth",
    "vipUuid": "7c94b57b6daa38c9b6862f11101e9612",
    "ikeLifeTime": 0.0,
    "lifeTime": 0.0,
    "peerCidrs": [
      {
        "uuid": "4796b27ab42d3baba893ea3d34c723e4",
        "cidr": "192.168.100.0/24",
        "connectionUuid": "2ce0380d4a5e3aed95b1511682926aeb",
        "createDate": "Nov 14, 2017 10:20:57 PM",
        "lastOpDate": "Nov 14, 2017 10:20:57 PM"
      }
    ],
    "l3NetworkRefs": [
      {}
    ]
  }
}
名字 类型 描述 起始版本
success boolean 4.5.0
error ErrorCode 错误码，若不为null，则表示操作失败, 操作成功时该字段为null。 详情参考error 0.6
inventory IPsecConnectionInventory 详情参考inventory 0.6
#error
名字 类型 描述 起始版本
code String 错误码号，错误的全局唯一标识，例如SYS.1000, HOST.1001 0.6
description String 错误的概要描述 0.6
details String 错误的详细信息 0.6
elaboration String 保留字段，默认为null 0.6
opaque LinkedHashMap 保留字段，默认为null 0.6
cause ErrorCode 根错误，引发当前错误的源错误，若无原错误，该字段为null 0.6
#inventory
名字 类型 描述 起始版本
uuid String 资源的UUID，唯一标示该资源 0.6
name String 资源名称 0.6
description String 资源的详细描述 0.6
peerAddress String 远端网络地址 4.5.0
authMode String 认证模式 4.5.0
authKey String 认证密钥 4.5.0
vipUuid String VIP UUID 2.3
ikeAuthAlgorithm String IKE验证算法 4.5.0
ikeEncryptionAlgorithm String IKE加密算法 4.5.0
ikeDhGroup Integer IKE DH组 4.5.0
policyAuthAlgorithm String ESP认证算法 4.5.0
policyEncryptionAlgorithm String ESP加密算法 4.5.0
pfs String PFS DH组 4.5.0
policyMode String 封装模式 4.5.0
transformProtocol String 安全协议 4.5.0
ikeVersion String IKE版本 4.5.0
idType String ID配置方法 4.5.0
localId String 本端ID 4.5.0
remoteId String 对端ID 4.5.0
state String 启用状态 4.5.0
status String 就绪状态 4.5.0
ikeLifeTime int IKE存活时间 4.5.0
lifeTime int IPSec存活时间 4.5.0
createDate Timestamp 创建时间 0.6
lastOpDate Timestamp 最后一次修改时间 0.6
peerCidrs List 详情参考peerCidrs 0.6
l3NetworkRefs |List| 详情参考l3NetworkRefs 2.3
#peerCidrs
名字 类型 描述 起始版本
uuid String 资源的UUID，唯一标示该资源 0.6
cidr String 0.6
connectionUuid String 0.6
createDate Timestamp 创建时间 0.6
lastOpDate Timestamp 最后一次修改时间 0.6
#l3NetworkRefs
名字 类型 描述 起始版本
uuid String 资源的UUID，唯一标示该资源 2.3
connectionUuid String 2.3
l3NetworkUuid String 三层网络UUID 2.3
createDate Timestamp 创建时间 2.3
lastOpDate Timestamp 最后一次修改时间 2.3

SDK示例

Java SDK
UpdateIPsecConnectionAction action = new UpdateIPsecConnectionAction();
action.uuid = "cedcb7a02f1548cbb8a68665cab0b191";
action.name = "test Ipsec";
action.description = "info";
action.deleteMode = "Permissive";
action.sessionId = "4e74102f098948cf97781ee6604b1571";
UpdateIPsecConnectionAction.Result res = action.call();
Python SDK
UpdateIPsecConnectionAction action = UpdateIPsecConnectionAction()
action.uuid = "dba5bbf127124fe2a3def62bcb96743d"
action.name = "test Ipsec"
action.description = "info"
action.deleteMode = "Permissive"
action.sessionId = "cc93dbb3278c4a699f2f1635eb756caf"
UpdateIPsecConnectionAction.Result res = action.call()

更改IPsec连接状态(ChangeIPSecConnectionState)

API请求

URLs
PUT zstack/v1/ipsec/{uuid}/actions
Headers
Authorization: OAuth the-session-uuid
Body
{
  "changeIPSecConnectionState": {
    "stateEvent": "enable"
  },
  "systemTags": [],
  "userTags": []
}
Note: 上述示例中systemTags、userTags字段可以省略。列出是为了表示body中可以包含这两个字段。
Curl示例
curl -H "Content-Type: application/json;charset=UTF-8" \
-H "Authorization: OAuth b86c9016b4f24953a9edefb53ca0678c" \
-X PUT -d '{"changeIPSecConnectionState":{"stateEvent":"enable"}}' \
http://localhost:8080/zstack/v1/ipsec/76424bb25d3a37c9961fff1116bc06da/actions
参数列表
名字 类型 位置 描述 可选值 起始版本
uuid String url 资源的UUID，唯一标示该资源 2.3
stateEvent String body(包含在changeIPSecConnectionState结构中)
  • enable
  • disable
 2.3
systemTags (可选) List body 系统标签 2.3
userTags (可选) List body 用户标签 2.3

API返回

返回示例
{
  "inventory": {
    "uuid": "13b5a2cd8c5c30a9a47ba95802cf4e1a",
    "name": "IPSec-1",
    "state": "Enabled",
    "ikeLifeTime": 0.0,
    "lifeTime": 0.0
  }
}
名字 类型 描述 起始版本
success boolean 4.5.0
error ErrorCode 错误码，若不为null，则表示操作失败, 操作成功时该字段为null。 详情参考error 2.3
inventory IPsecConnectionInventory 详情参考inventory 2.3
#error
名字 类型 描述 起始版本
code String 错误码号，错误的全局唯一标识，例如SYS.1000, HOST.1001 2.3
description String 错误的概要描述 2.3
details String 错误的详细信息 2.3
elaboration String 保留字段，默认为null 2.3
opaque LinkedHashMap 保留字段，默认为null 2.3
cause ErrorCode 根错误，引发当前错误的源错误，若无原错误，该字段为null 2.3
#inventory
名字 类型 描述 起始版本
uuid String 资源的UUID，唯一标示该资源 2.3
name String 资源名称 2.3
description String 资源的详细描述 2.3
peerAddress String 远端网络地址 4.5.0
authMode String 认证模式 4.5.0
authKey String 认证密钥 4.5.0
vipUuid String VIP UUID 4.5.0
ikeAuthAlgorithm String IKE验证算法 4.5.0
ikeEncryptionAlgorithm String IKE加密算法 4.5.0
ikeDhGroup Integer IKE DH组 4.5.0
policyAuthAlgorithm String ESP认证算法 4.5.0
policyEncryptionAlgorithm String ESP加密算法 4.5.0
pfs String PFS DH组 4.5.0
policyMode String 封装模式 4.5.0
transformProtocol String 安全协议 4.5.0
ikeVersion String IKE版本 4.5.0
idType String ID配置方法 4.5.0
localId String 本端ID 4.5.0
remoteId String 对端ID 4.5.0
state String 启用状态 4.5.0
status String 就绪状态 4.5.0
ikeLifeTime int IKE存活时间 4.5.0
lifeTime int IPSec存活时间 4.5.0
createDate Timestamp 创建时间 2.3
lastOpDate Timestamp 最后一次修改时间 2.3
peerCidrs List 详情参考peerCidrs 2.3
l3NetworkRefs List 详情参考l3NetworkRefs 2.3
#peerCidrs
名字 类型 描述 起始版本
uuid String 资源的UUID，唯一标示该资源 2.3
cidr String 2.3
connectionUuid String 2.3
createDate Timestamp 创建时间 2.3
lastOpDate Timestamp 最后一次修改时间 2.3
#l3NetworkRefs
名字 类型 描述 起始版本
uuid String 资源的UUID,唯一标示该资源 2.3
connectionUuid String 2.3
l3NetworkUuid String 三层网络UUID 2.3
createDate Timestamp 创建时间 2.3
lastOpDate Timestamp 最后一次修改时间 2.3

SDK示例

Java SDK
ChangeIPSecConnectionStateAction action = new ChangeIPSecConnectionStateAction();
action.uuid = "76424bb25d3a37c9961fff1116bc06da";
action.stateEvent = "enable";
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c";
ChangeIPSecConnectionStateAction.Result res = action.call();
Python SDK
ChangeIPSecConnectionStateAction action = ChangeIPSecConnectionStateAction()
action.uuid = "76424bb25d3a37c9961fff1116bc06da"
action.stateEvent = "enable"
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c"
ChangeIPSecConnectionStateAction.Result res = action.call()

重连IPsec(ReconnectIPsecConnection)

API请求

URLs
PUT zstack/v1/ipsec/{uuid}/actions
Headers
Authorization: OAuth the-session-uuid
Body
{
  "reconnectIPsecConnection": {},
  "systemTags": [],
  "userTags": []
}
Note: 上述示例中systemTags、userTags字段可以省略。列出是为了表示body中可以包含这两个字段。
Curl示例
curl -H "Content-Type: application/json;charset=UTF-8" \
-H "Authorization: OAuth b86c9016b4f24953a9edefb53ca0678c" \
-X PUT -d '{"reconnectIPsecConnection":{}}' \
http://localhost:8080/zstack/v1/ipsec/5186dbf43843358ea9e7420c4af27338/actions
参数列表
名字 类型 位置 描述 可选值 起始版本
uuid String url 资源的UUID，唯一标示该资源 4.5.0
systemTags (可选) List body 系统标签 4.5.0
userTags (可选) List body 用户标签 4.5.0

API返回

返回示例

{
  "inventory": {
    "name": "Test-IPSec",
    "description": "desc info ",
    "peerAddress": "100.64.10.10",
    "authKey": "auth",
    "vipUuid": "37c2aa27aff4338abb41fb5bdaa90f77",
    "status": "Connecting",
    "ikeLifeTime": 0.0,
    "lifeTime": 0.0,
    "peerCidrs": [
      {
        "uuid": "0cf06fba80743d09bb31845d0b187197",
        "cidr": "192.168.100.0/24",
        "connectionUuid": "654dedd65de8345cae7042a375451146",
        "createDate": "Nov 14, 2017 10:20:57 PM",
        "lastOpDate": "Nov 14, 2017 10:20:57 PM"
      }
    ],
    "l3NetworkRefs": [
      {}
    ]
  }
}
名字 类型 描述 起始版本
success boolean 4.5.0
inventory IPsecConnectionInventory 详情参考inventory 4.5.0
error ErrorCode 错误码，若不为null，则表示操作失败, 操作成功时该字段为null。 详情参考error 4.5.0
#inventory
名字 类型 描述 起始版本
uuid String 资源的UUID，唯一标示该资源 4.5.0
name String 资源名称 4.5.0
description String 资源的详细描述 4.5.0
peerAddress String 远端网络地址 4.5.0
authMode String 认证模式 4.5.0
authKey String 认证密钥 4.5.0
vipUuid String VIP UUID 4.5.0
ikeAuthAlgorithm String IKE验证算法 4.5.0
ikeEncryptionAlgorithm String IKE加密算法 4.5.0
ikeDhGroup Integer IKE DH组 4.5.0
policyAuthAlgorithm String ESP认证算法 4.5.0
policyEncryptionAlgorithm String ESP加密算法 4.5.0
pfs String PFS DH组 4.5.0
policyMode String 封装模式 4.5.0
transformProtocol String 安全协议 4.5.0
ikeVersion String IKE版本 4.5.0
idType String ID配置方法 4.5.0
localId String 本端ID 4.5.0
remoteId String 对端ID 4.5.0
state String 启用状态 4.5.0
status String 就绪状态 4.5.0
ikeLifeTime int IKE存活时间 4.5.0
lifeTime int IPSec存活时间 4.5.0
createDate Timestamp 创建时间 4.5.0
lastOpDate Timestamp 最后一次修改时间 4.5.0
peerCidrs List 详情参考peerCidrs 4.5.0
l3NetworkRefs List 详情参考l3NetworkRefs 4.5.0
#peerCidrs
名字 类型 描述 起始版本
uuid String 资源的UUID，唯一标示该资源 4.5.0
cidr String 4.5.0
connectionUuid String 4.5.0
createDate Timestamp 创建时间 4.5.0
lastOpDate Timestamp 最后一次修改时间 4.5.0
#l3NetworkRefs
名字 类型 描述 起始版本
uuid String 资源的UUID，唯一标示该资源 4.5.0
connectionUuid String 4.5.0
l3NetworkUuid String 三层网络UUID 4.5.0
createDate Timestamp 创建时间 4.5.0
lastOpDate Timestamp 最后一次修改时间 4.5.0
#error
名字 类型 描述 起始版本
code String 错误码号，错误的全局唯一标识，例如SYS.1000, HOST.1001 4.5.0
description String 错误的概要描述 4.5.0
details String 错误的详细信息 4.5.0
elaboration String 保留字段，默认为null 4.5.0
opaque LinkedHashMap 保留字段，默认为null 4.5.0
cause ErrorCode 根错误，引发当前错误的源错误，若无原错误，该字段为null 4.5.0

SDK示例

Java SDK
ReconnectIPsecConnectionAction action = new ReconnectIPsecConnectionAction();
action.uuid = "5186dbf43843358ea9e7420c4af27338";
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c";
ReconnectIPsecConnectionAction.Result res = action.call();
Python SDK
ReconnectIPsecConnectionAction action = ReconnectIPsecConnectionAction()
action.uuid = "5186dbf43843358ea9e7420c4af27338"
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c"
ReconnectIPsecConnectionAction.Result res = action.call()

修改IPsec连接配置(ChangeIPsecConnection)

API请求

URLs
PUT zstack/v1/ipsec/config/{uuid}
Headers
Authorization: OAuth the-session-uuid
Body
{
  "changeIPsecConnection": {
    "peerAddress": "2.2.2.2",
    "authMode": "psk",
    "authKey": "12345678",
    "idType": "ip",
    "localId": "1.1.1.1",
    "remoteId": "2.2.2.2",
    "ikeVersion": "ikev2",
    "ikeAuthAlgorithm": "sha256",
    "ikeEncryptionAlgorithm": "aes-256",
    "ikeDhGroup": 2.0,
    "ikeLifeTime": 86400.0,
    "policyAuthAlgorithm": "sha256",
    "policyEncryptionAlgorithm": "aes-256",
    "pfs": "dh-group14",
    "policyMode": "tunnel",
    "transformProtocol": "esp",
    "lifeTime": 3600.0
  },
  "systemTags": [],
  "userTags": []
}
Note: 上述示例中systemTags、userTags字段可以省略。列出是为了表示body中可以包含这两个字段。
Curl示例
curl -H "Content-Type: application/json;charset=UTF-8" \
-H "Authorization: OAuth b86c9016b4f24953a9edefb53ca0678c" \
-X PUT -d '{"changeIPsecConnection":{"peerAddress":"2.2.2.2","authMode":"psk","authKey":"12345678","idType":"ip","localId":"1.1.1.1","remoteId":"2.2.2.2","ikeVersion":"ikev2","ikeAuthAlgorithm":"sha256","ikeEncryptionAlgorithm":"aes-256","ikeDhGroup":2.0,"ikeLifeTime":86400.0,"policyAuthAlgorithm":"sha256","policyEncryptionAlgorithm":"aes-256","pfs":"dh-group14","policyMode":"tunnel","transformProtocol":"esp","lifeTime":3600.0}}' \
http://localhost:8080/zstack/v1/ipsec/config/fe981c6d20243102b6939d5eada78ef9
参数列表
名字 类型 位置 描述 可选值 起始版本
uuid String url 资源的UUID，唯一标示该资源 4.5.0
peerAddress String body(包含在changeIPsecConnection结构中) 远端网络地址 4.5.0
authMode (可选) String body(包含在changeIPsecConnection结构中) 认证模式
  • psk
  • certs
 4.5.0
authKey String body(包含在changeIPsecConnection结构中) 认证密钥 4.5.0
idType (可选) String body(包含在changeIPsecConnection结构中) ID配置方法
  • ip
  • name
  • fqdn
 4.5.0
localId (可选) String body(包含在changeIPsecConnection结构中) 本端ID 4.5.0
remoteId (可选) String body(包含在changeIPsecConnection结构中) 对端ID 4.5.0
ikeVersion (可选) String body(包含在changeIPsecConnection结构中) IKE版本
  • ike
  • ikev1
  • ikev2
 4.5.0
ikeAuthAlgorithm (可选) String body(包含在changeIPsecConnection结构中) IKE验证算法
  • md5
  • sha1
  • sha256
  • sha384
  • sha512
 4.5.0
ikeEncryptionAlgorithm (可选) String body(包含在changeIPsecConnection结构中) IKE加密算法
  • 3des
  • aes-128
  • aes-192
  • aes-256
 4.5.0
ikeDhGroup (可选) int body(包含在changeIPsecConnection结构中) IKE DH组 4.5.0
ikeLifeTime (可选) int body(包含在changeIPsecConnection结构中) IKE存活时间 4.5.0
policyAuthAlgorithm (可选) String body(包含在changeIPsecConnection结构中) ESP认证算法
  • md5
  • sha1
  • sha256
  • sha384
  • sha512
 4.5.0
policyEncryptionAlgorithm (可选) String body(包含在changeIPsecConnection结构中) ESP加密算法
  • 3des
  • aes-128
  • aes-192
  • aes-256
 4.5.0
pfs (可选) String body(包含在changeIPsecConnection结构中) PFS DH组
  • none
  • dh-group2
  • dh-group5
  • dh-group14
  • dh-group15
  • dh-group16
  • dh-group17
  • dh-group18
  • dh-group19
  • dh-group20
  • dh-group21
  • dh-group22
  • dh-group23
  • dh-group24
  • dh-group25
  • dh-group26
 4.5.0
policyMode (可选) String body(包含在changeIPsecConnection结构中) 封装模式
  • tunnel
  • transport
 4.5.0
transformProtocol (可选) String body(包含在changeIPsecConnection结构中) 安全协议
  • esp
  • ah
  • ah-esp
 4.5.0
lifeTime (可选) int body(包含在changeIPsecConnection结构中) IPSec存活时间 4.5.0
systemTags (可选) List body 系统标签 4.5.0
userTags (可选) List body 用户标签 4.5.0

API返回

返回示例

{
  "inventory": {
    "name": "Test-IPSec",
    "description": "desc info ",
    "peerAddress": "100.64.10.10",
    "authKey": "auth",
    "vipUuid": "9f580de9b80c32feb149be989f5c9158",
    "ikeLifeTime": 0.0,
    "lifeTime": 0.0,
    "peerCidrs": [
      {
        "uuid": "c97d7be1bae43cac8fad2099ab9d4ef3",
        "cidr": "192.168.100.0/24",
        "connectionUuid": "5700953056a03c589a264faa51db6a8f",
        "createDate": "Nov 14, 2017 10:20:57 PM",
        "lastOpDate": "Nov 14, 2017 10:20:57 PM"
      }
    ],
    "l3NetworkRefs": [
      {}
    ]
  }
}
名字 类型 描述 起始版本
success boolean 4.5.0
inventory IPsecConnectionInventory 详情参考inventory 4.5.0
error ErrorCode 错误码，若不为null，则表示操作失败, 操作成功时该字段为null。 详情参考error 4.5.0
#inventory
名字 类型 描述 起始版本
uuid String 资源的UUID，唯一标示该资源 4.5.0
name String 资源名称 4.5.0
description String 资源的详细描述 4.5.0
peerAddress String 远端网络地址 4.5.0
authMode String 认证模式 4.5.0
authKey String 认证密钥 4.5.0
vipUuid String VIP UUID 4.5.0
ikeAuthAlgorithm String IKE验证算法 4.5.0
ikeEncryptionAlgorithm String IKE加密算法 4.5.0
ikeDhGroup Integer IKE DH组 4.5.0
policyAuthAlgorithm String ESP认证算法 4.5.0
policyEncryptionAlgorithm String ESP加密算法 4.5.0
pfs String PFS DH组 4.5.0
policyMode String 封装模式 4.5.0
transformProtocol String 安全协议 4.5.0
ikeVersion String IKE版本 4.5.0
idType String ID配置方法 4.5.0
localId String 本端ID 4.5.0
remoteId String 对端ID 4.5.0
state String 启用状态 4.5.0
status String 就绪状态 4.5.0
ikeLifeTime int IKE存活时间 4.5.0
lifeTime int IPSec存活时间 4.5.0
createDate Timestamp 创建时间 4.5.0
lastOpDate Timestamp 最后一次修改时间 4.5.0
peerCidrs List 详情参考peerCidrs 4.5.0
l3NetworkRefs List 详情参考l3NetworkRefs 4.5.0
#peerCidrs
名字 类型 描述 起始版本
uuid String 资源的UUID，唯一标示该资源 4.5.0
cidr String 4.5.0
connectionUuid String 4.5.0
createDate Timestamp 创建时间 4.5.0
lastOpDate Timestamp 最后一次修改时间 4.5.0
#l3NetworkRefs
名字 类型 描述 起始版本
uuid String 资源的UUID，唯一标示该资源 4.5.0
connectionUuid String 4.5.0
l3NetworkUuid String 三层网络UUID 4.5.0
createDate Timestamp 创建时间 4.5.0
lastOpDate Timestamp 最后一次修改时间 4.5.0
#error
名字 类型 描述 起始版本
code String 错误码号，错误的全局唯一标识，例如SYS.1000, HOST.1001 4.5.0
description String 错误的概要描述 4.5.0
details String 错误的详细信息 4.5.0
elaboration String 保留字段，默认为null 4.5.0
opaque LinkedHashMap 保留字段，默认为null 4.5.0
cause ErrorCode 根错误，引发当前错误的源错误，若无原错误，该字段为null 4.5.0

SDK示例

Java SDK
ChangeIPsecConnectionAction action = new ChangeIPsecConnectionAction();
action.uuid = "fe981c6d20243102b6939d5eada78ef9";
action.peerAddress = "2.2.2.2";
action.authMode = "psk";
action.authKey = "12345678";
action.idType = "ip";
action.localId = "1.1.1.1";
action.remoteId = "2.2.2.2";
action.ikeVersion = "ikev2";
action.ikeAuthAlgorithm = "sha256";
action.ikeEncryptionAlgorithm = "aes-256";
action.ikeDhGroup = 2.0;
action.ikeLifeTime = 86400.0;
action.policyAuthAlgorithm = "sha256";
action.policyEncryptionAlgorithm = "aes-256";
action.pfs = "dh-group14";
action.policyMode = "tunnel";
action.transformProtocol = "esp";
action.lifeTime = 3600.0;
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c";
ChangeIPsecConnectionAction.Result res = action.call();
Python SDK
ChangeIPsecConnectionAction action = ChangeIPsecConnectionAction()
action.uuid = "fe981c6d20243102b6939d5eada78ef9"
action.peerAddress = "2.2.2.2"
action.authMode = "psk"
action.authKey = "12345678"
action.idType = "ip"
action.localId = "1.1.1.1"
action.remoteId = "2.2.2.2"
action.ikeVersion = "ikev2"
action.ikeAuthAlgorithm = "sha256"
action.ikeEncryptionAlgorithm = "aes-256"
action.ikeDhGroup = 2.0
action.ikeLifeTime = 86400.0
action.policyAuthAlgorithm = "sha256"
action.policyEncryptionAlgorithm = "aes-256"
action.pfs = "dh-group14"
action.policyMode = "tunnel"
action.transformProtocol = "esp"
action.lifeTime = 3600.0
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c"
ChangeIPsecConnectionAction.Result res = action.call()

添加三层网络到IPsec连接(AttachL3NetworksToIPsecConnection)

API请求

URLs
POST zstack/v1/ipsec/{uuid}/l3networks
Headers
Authorization: OAuth the-session-uuid
Body
{
  "params": {
    "l3NetworkUuids": [
      "4b0779efacdc39a5b2dd4799e2452720"
    ]
  },
  "systemTags": [],
  "userTags": []
}
Note: 上述示例中systemTags、userTags字段可以省略。列出是为了表示body中可以包含这两个字段。
Curl示例
curl -H "Content-Type: application/json;charset=UTF-8" \
-H "Authorization: OAuth b86c9016b4f24953a9edefb53ca0678c" \
-X POST -d '{"params":{"l3NetworkUuids":["4b0779efacdc39a5b2dd4799e2452720"]}}' \
http://localhost:8080/zstack/v1/ipsec/8f6fa5c86fd13968b8d8666f4b117aca/l3networks
参数列表
名字 类型 位置 描述 可选值 起始版本
uuid String url 资源的UUID，唯一标示该资源 2.3
l3NetworkUuids List body(包含在params结构中) 2.3
resourceUuid (可选) String body(包含在params结构中) 2.3
systemTags (可选) List body 2.3
userTags (可选) List body 2.3

API返回

返回示例
{
  "inventory": {
    "uuid": "3293505dd7de3a2aacca821c4a9d8b5e",
    "name": "Test-IPSec",
    "peerAddress": "100.64.10.10",
    "authKey": "auth",
    "vipUuid": "58d827fb56cb3fc394c89429c28c29a4",
    "ikeLifeTime": 0.0,
    "lifeTime": 0.0,
    "peerCidrs": [
      {
        "uuid": "185878e63f1c39c48de641f55f8a870b",
        "cidr": "192.168.100.0/24",
        "connectionUuid": "3293505dd7de3a2aacca821c4a9d8b5e",
        "createDate": "Nov 14, 2017 10:20:57 PM",
        "lastOpDate": "Nov 14, 2017 10:20:57 PM"
      }
    ],
    "l3NetworkRefs": [
      {
        "uuid": "a1e9c14d5d9736c0885b6cc67238873e",
        "connectionUuid": "3293505dd7de3a2aacca821c4a9d8b5e",
        "l3NetworkUuid": "43253fb59d8c36b49f684278747bf209",
        "createDate": "Nov 14, 2017 10:20:57 PM",
        "lastOpDate": "Nov 14, 2017 10:20:57 PM"
      }
    ]
  }
}
名字 类型 描述 起始版本
success boolean 4.5.0
error ErrorCode 错误码，若不为null，则表示操作失败, 操作成功时该字段为null。 详情参考error 2.3
inventory IPsecConnectionInventory 详情参考inventory 2.3
#error
名字 类型 描述 起始版本
code String 错误码号，错误的全局唯一标识，例如SYS.1000, HOST.1001 2.3
description String 错误的概要描述 2.3
details String 错误的详细信息 2.3
elaboration String 保留字段，默认为null 2.3
opaque LinkedHashMap 保留字段，默认为null 2.3
cause ErrorCode 根错误，引发当前错误的源错误，若无原错误，该字段为null 2.3
#inventory
名字 类型 描述 起始版本
uuid String 资源的UUID，唯一标示该资源 2.3
name String 资源名称 2.3
description String 资源的详细描述 2.3
peerAddress String 远端网络地址 4.5.0
authMode String 认证模式 4.5.0
authKey String 认证密钥 4.5.0
vipUuid String VIP UUID 4.5.0
ikeAuthAlgorithm String IKE验证算法 4.5.0
ikeEncryptionAlgorithm String IKE加密算法 4.5.0
ikeDhGroup Integer IKE DH组 4.5.0
policyAuthAlgorithm String ESP认证算法 4.5.0
policyEncryptionAlgorithm String ESP加密算法 4.5.0
pfs String PFS DH组 4.5.0
policyMode String PFS DH组 4.5.0
transformProtocol String 安全协议 4.5.0
ikeVersion String IKE版本 4.5.0
idType String ID配置方法 4.5.0
localId String 本端ID 4.5.0
remoteId String 对端ID 4.5.0
state String 启用状态 4.5.0
status String 就绪状态 4.5.0
ikeLifeTime int IKE存活时间 4.5.0
lifeTime int IPSec存活时间 4.5.0
createDate Timestamp 创建时间 2.3
lastOpDate Timestamp 最后一次修改时间 2.3
peerCidrs List 详情参考peerCidrs 2.3
l3NetworkRefs List 详情参考l3NetworkRefs 2.3
#peerCidrs
名字 类型 描述 起始版本
uuid String 资源的UUID，唯一标示该资源 2.3
cidr String 2.3
connectionUuid String 2.3
createDate Timestamp 创建时间 2.3
lastOpDate Timestamp 最后一次修改时间 2.3
#l3NetworkRefs
名字 类型 描述 起始版本
uuid String 资源的UUID，唯一标示该资源 2.3
connectionUuid String 2.3
l3NetworkUuid String 三层网络UUID 2.3
createDate Timestamp 创建时间 2.3
lastOpDate Timestamp 最后一次修改时间 2.3

SDK示例

Java SDK
AttachL3NetworksToIPsecConnectionAction action = new AttachL3NetworksToIPsecConnectionAction();
action.uuid = "8f6fa5c86fd13968b8d8666f4b117aca";
action.l3NetworkUuids = asList("4b0779efacdc39a5b2dd4799e2452720");
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c";
AttachL3NetworksToIPsecConnectionAction.Result res = action.call();
Python SDK
AttachL3NetworksToIPsecConnectionAction action = AttachL3NetworksToIPsecConnectionAction()
action.uuid = "8f6fa5c86fd13968b8d8666f4b117aca"
action.l3NetworkUuids = [4b0779efacdc39a5b2dd4799e2452720]
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c"
AttachL3NetworksToIPsecConnectionAction.Result res = action.call()

从IPsec连接删除三层网络(DetachL3NetworksFromIPsecConnection)

API请求

URLs
DELETE zstack/v1/ipsec/{uuid}/l3networks
Headers
Authorization: OAuth the-session-uuid
Curl示例
curl -H "Content-Type: application/json;charset=UTF-8" \
-H "Authorization: OAuth b86c9016b4f24953a9edefb53ca0678c" \
-X DELETE http://localhost:8080/zstack/v1/ipsec/ad4996bae0fb374bbbf696422f64e4aa/l3networks
参数列表
名字 类型 位置 描述 可选值 起始版本
uuid String url 资源的UUID，唯一标示该资源 2.3
l3NetworkUuids List body 4.5.0
systemTags (可选) List body 2.3
userTags (可选) List body 2.3

API返回

返回示例
{
  "inventory": {
    "uuid": "8897085a1f673f71abe4b5972959a341",
    "name": "Test-IPSec",
    "peerAddress": "100.64.10.10",
    "authKey": "auth",
    "vipUuid": "bda6c7ab0bfa37ae8fd0404c62bb7782",
    "ikeLifeTime": 0.0,
    "lifeTime": 0.0,
    "peerCidrs": [
      {
        "uuid": "6756721235283be68ff449db51ad480b",
        "cidr": "192.168.100.0/24",
        "connectionUuid": "8897085a1f673f71abe4b5972959a341",
        "createDate": "Nov 14, 2017 10:20:57 PM",
        "lastOpDate": "Nov 14, 2017 10:20:57 PM"
      }
    ],
    "l3NetworkRefs": [
      {
        "uuid": "7c982a34282a3d5ea7436a80a0d38d0c",
        "connectionUuid": "8897085a1f673f71abe4b5972959a341",
        "l3NetworkUuid": "a110262802763e35a695935852b7b470",
        "createDate": "Nov 14, 2017 10:20:57 PM",
        "lastOpDate": "Nov 14, 2017 10:20:57 PM"
      }
    ]
  }
}
名字 类型 描述 起始版本
success boolean 4.5.0
error ErrorCode 错误码，若不为null，则表示操作失败, 操作成功时该字段为null。 详情参考error 2.3
inventory IPsecConnectionInventory 详情参考inventory 2.3
#error
名字 类型 描述 起始版本
code String 错误码号，错误的全局唯一标识，例如SYS.1000, HOST.1001 2.3
description String 错误的概要描述 2.3
details String 错误的详细信息 2.3
elaboration String 保留字段，默认为null 2.3
opaque LinkedHashMap 保留字段，默认为null 2.3
cause ErrorCode 根错误，引发当前错误的源错误，若无原错误，该字段为null 2.3
#inventory
名字 类型 描述 起始版本
uuid String 资源的UUID，唯一标示该资源 2.3
name String 资源名称 2.3
description String 资源的详细描述 2.3
peerAddress String 远端网络地址 4.5.0
authMode String 认证模式 4.5.0
authKey String 认证密钥 4.5.0
vipUuid String VIP UUID 2.3
ikeAuthAlgorithm String IKE验证算法 4.5.0
ikeEncryptionAlgorithm String IKE加密算法 4.5.0
ikeDhGroup Integer IKE DH组 4.5.0
policyAuthAlgorithm String ESP认证算法 4.5.0
policyEncryptionAlgorithm String ESP加密算法 4.5.0
pfs String PFS DH组 4.5.0
policyMode String 封装模式 4.5.0
transformProtocol String 安全协议 4.5.0
ikeVersion String IKE版本 4.5.0
idType String ID配置方法 4.5.0
localId String 本端ID 4.5.0
remoteId String 对端ID 4.5.0
state String 启用状态 4.5.0
status String 就绪状态 4.5.0
ikeLifeTime int IKE存活时间 4.5.0
lifeTime int IPSec存活时间 4.5.0
createDate Timestamp 创建时间 2.3
lastOpDate Timestamp 最后一次修改时间 2.3
peerCidrs List 详情参考peerCidrs 2.3
l3NetworkRefs List 详情参考l3NetworkRefs 2.3
#peerCidrs
名字 类型 描述 起始版本
uuid String 资源的UUID，唯一标示该资源 2.3
cidr String 2.3
connectionUuid String 2.3
createDate Timestamp 创建时间 2.3
lastOpDate Timestamp 最后一次修改时间 2.3
#l3NetworkRefs
名字 类型 描述 起始版本
uuid String 资源的UUID，唯一标示该资源 2.3
connectionUuid String 2.3
l3NetworkUuid String 三层网络UUID 2.3
createDate Timestamp 创建时间 2.3
lastOpDate Timestamp 最后一次修改时间 2.3

SDK示例

Java SDK
DetachL3NetworksFromIPsecConnectionAction action = new
DetachL3NetworksFromIPsecConnectionAction();
action.uuid = "ad4996bae0fb374bbbf696422f64e4aa";
action.l3NetworkUuids = asList("a835701f0df63d14ad1281eb9cc1a768");
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c";
DetachL3NetworksFromIPsecConnectionAction.Result res = action.call();
Python SDK
DetachL3NetworksFromIPsecConnectionAction action = DetachL3NetworksFromIPsecConnectionAction()
action.uuid = "ad4996bae0fb374bbbf696422f64e4aa"
action.l3NetworkUuids = [a835701f0df63d14ad1281eb9cc1a768]
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c"
DetachL3NetworksFromIPsecConnectionAction.Result res = action.call()

添加远端CIDR到IPsec连接(AddRemoteCidrsToIPsecConnection)

API请求

URLs
POST zstack/v1/ipsec/{uuid}/remote-cidrs
Headers
Authorization: OAuth the-session-uuid
Body
{
  "params": {
    "peerCidrs": [
      "192.168.100.0/24"
    ]
  },
  "systemTags": [],
  "userTags": []
}
Note: 上述示例中systemTags、userTags字段可以省略。列出是为了表示body中可以包含这两个字段。
Curl示例
curl -H "Content-Type: application/json;charset=UTF-8" \
-H "Authorization: OAuth b86c9016b4f24953a9edefb53ca0678c" \
-X POST -d '{"params":{"peerCidrs":["192.168.100.0/24"]}}' \
http://localhost:8080/zstack/v1/ipsec/053658b061363df4be557d13ee0baaef/remote-cidrs
参数列表
名字 类型 位置 描述 可选值 起始版本
uuid String url 资源的UUID，唯一标示该资源 2.3
peerCidrs List body(包含在params结构中) 2.3
resourceUuid (可选) String body(包含在params结构中) 2.3
systemTags (可选) List body 2.3
userTags (可选) List body 2.3

API返回

返回示例
{
  "inventory": {
    "uuid": "55c06a7088a5341c8b4ebed294282bfe",
    "name": "Test-IPSec",
    "peerAddress": "100.64.10.10",
    "authKey": "auth",
    "vipUuid": "a66955e81e893c0f81effba08f1f2f94",
    "ikeLifeTime": 0.0,
    "lifeTime": 0.0,
    "peerCidrs": [
      {
        "uuid": "15b9949bc0553aeeaf53e96a1b437e7c",
        "cidr": "192.168.100.0/24",
        "connectionUuid": "55c06a7088a5341c8b4ebed294282bfe",
        "createDate": "Nov 14, 2017 10:20:57 PM",
        "lastOpDate": "Nov 14, 2017 10:20:57 PM"
      }
    ],
    "l3NetworkRefs": [
      {
        "uuid": "1223ba4c4d0533feb975ff45027ab47f",
        "connectionUuid": "55c06a7088a5341c8b4ebed294282bfe",
        "l3NetworkUuid": "163595b272913065b082d890a68d96a7",
        "createDate": "Nov 14, 2017 10:20:57 PM",
        "lastOpDate": "Nov 14, 2017 10:20:57 PM"
      }
    ]
  }
}
名字 类型 描述 起始版本
success boolean 4.5.0
error ErrorCode 错误码，若不为null，则表示操作失败, 操作成功时该字段为null。 详情参考error 2.3
inventory IPsecConnectionInventory 详情参考inventory 2.3
#error
名字 类型 描述 起始版本
code String 错误码号，错误的全局唯一标识，例如SYS.1000, HOST.1001 2.3
description String 错误的概要描述 2.3
details String 错误的详细信息 2.3
elaboration String 保留字段，默认为null 2.3
opaque LinkedHashMap 保留字段，默认为null 2.3
cause ErrorCode 根错误，引发当前错误的源错误，若无原错误，该字段为null 2.3
#inventory
名字 类型 描述 起始版本
uuid String 资源的UUID，唯一标示该资源 2.3
name String 资源名称 2.3
description String 资源的详细描述 2.3
peerAddress String 远端网络地址 4.5.0
authMode String 认证模式 4.5.0
authKey String 认证密钥 4.5.0
vipUuid String VIP UUID 2.3
ikeAuthAlgorithm String IKE验证算法 4.5.0
ikeEncryptionAlgorithm String IKE加密算法 4.5.0
ikeDhGroup Integer IKE DH组 4.5.0
policyAuthAlgorithm String ESP认证算法 4.5.0
policyEncryptionAlgorithm String ESP加密算法 4.5.0
pfs String PFS DH组 4.5.0
policyMode String 封装模式 4.5.0
transformProtocol String 安全协议 4.5.0
ikeVersion String IKE版本 4.5.0
idType String ID配置方法 4.5.0
localId String 本端ID 4.5.0
remoteId String 对端ID 4.5.0
state String 启用状态 4.5.0
status String 就绪状态 4.5.0
ikeLifeTime int IKE存活时间 4.5.0
lifeTime int IPSec存活时间 4.5.0
createDate Timestamp 创建时间 2.3
lastOpDate Timestamp 最后一次修改时间 2.3
peerCidrs List 详情参考peerCidrs 2.3
l3NetworkRefs List 详情参考l3NetworkRefs 2.3
#peerCidrs
名字 类型 描述 起始版本
uuid String 资源的UUID，唯一标示该资源 2.3
cidr String 2.3
connectionUuid String 2.3
createDate Timestamp 创建时间 2.3
lastOpDate Timestamp 最后一次修改时间 2.3
#l3NetworkRefs
名字 类型 描述 起始版本
uuid String 资源的UUID，唯一标示该资源 2.3
connectionUuid String 2.3
l3NetworkUuid String 三层网络UUID 2.3
createDate Timestamp 创建时间 2.3
lastOpDate Timestamp 最后一次修改时间 2.3

SDK示例

Java SDK
AddRemoteCidrsToIPsecConnectionAction action = new AddRemoteCidrsToIPsecConnectionAction();
action.uuid = "053658b061363df4be557d13ee0baaef";
action.peerCidrs = asList("192.168.100.0/24");
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c";
AddRemoteCidrsToIPsecConnectionAction.Result res = action.call();
Python SDK
AddRemoteCidrsToIPsecConnectionAction action = AddRemoteCidrsToIPsecConnectionAction()
action.uuid = "053658b061363df4be557d13ee0baaef"
action.peerCidrs = [192.168.100.0/24]
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c"
AddRemoteCidrsToIPsecConnectionAction.Result res = action.call()

删除远端CIDR(RemoveRemoteCidrsFromIPsecConnection)

从IPsec连接删除远端CIDR。

API请求

URLs
DELETE zstack/v1/ipsec/{uuid}/remote-cidrs
Headers
Authorization: OAuth the-session-uuid
Curl示例
curl -H "Content-Type: application/json;charset=UTF-8" \
-H "Authorization: OAuth b86c9016b4f24953a9edefb53ca0678c" \
-X DELETE http://localhost:8080/zstack/v1/ipsec/2428fc093ea93b6fb4eda5cc921da355/remote-cidrs
参数列表
名字 类型 位置 描述 可选值 起始版本
uuid String url 资源的UUID，唯一标示该资源 2.3
peerCidrs List body 4.5.0
systemTags (可选) List body 2.3
userTags (可选) List body 2.3

API返回

返回示例
{
  "inventory": {
    "uuid": "a069f4ee49c835869e046204ff5eba8f",
    "name": "Test-IPSec",
    "peerAddress": "100.64.10.10",
    "authKey": "auth",
    "vipUuid": "6af41f780abb3c69b122c29cc3948bab",
    "ikeLifeTime": 0.0,
    "lifeTime": 0.0,
    "peerCidrs": [
      {
        "uuid": "d0cb54ce25053f629623baef345f4bd0",
        "cidr": "192.168.100.0/24",
        "connectionUuid": "a069f4ee49c835869e046204ff5eba8f",
        "createDate": "Nov 14, 2017 10:20:57 PM",
        "lastOpDate": "Nov 14, 2017 10:20:57 PM"
      }
    ],
    "l3NetworkRefs": [
      {
        "uuid": "4e539c9cd56b37d4bb27c6244169fc55",
        "connectionUuid": "a069f4ee49c835869e046204ff5eba8f",
        "l3NetworkUuid": "7c63cc15a47b3c90a0350bd8c6e6906e",
        "createDate": "Nov 14, 2017 10:20:57 PM",
        "lastOpDate": "Nov 14, 2017 10:20:57 PM"
      }
    ]
  }
}
名字 类型 描述 起始版本
success boolean 4.5.0
error ErrorCode 错误码，若不为null，则表示操作失败, 操作成功时该字段为null。 详情参考error 2.3
inventory IPsecConnectionInventory 详情参考inventory 2.3
#error
名字 类型 描述 起始版本
code String 错误码号，错误的全局唯一标识，例如SYS.1000, HOST.1001 2.3
description String 错误的概要描述 2.3
details String 错误的详细信息 2.3
elaboration String 保留字段，默认为null 2.3
opaque LinkedHashMap 保留字段，默认为null 2.3
cause ErrorCode 根错误，引发当前错误的源错误，若无原错误，该字段为null 2.3
#inventory
名字 类型 描述 起始版本
uuid String 资源的UUID，唯一标示该资源 2.3
name String 资源名称 2.3
description String 资源的详细描述 2.3
peerAddress String 远端网络地址 4.5.0
authMode String 认证模式 4.5.0
authKey String 认证密钥 4.5.0
vipUuid String VIP UUID 2.3
ikeAuthAlgorithm String IKE验证算法 4.5.0
ikeEncryptionAlgorithm String IKE加密算法 4.5.0
ikeDhGroup Integer IKE DH组 4.5.0
policyAuthAlgorithm String ESP认证算法 4.5.0
policyEncryptionAlgorithm String ESP加密算法 4.5.0
pfs String PFS DH组 4.5.0
policyMode String 封装模式 4.5.0
transformProtocol String 安全协议 4.5.0
ikeVersion String IKE版本 4.5.0
idType String ID配置方法 4.5.0
localId String 本端ID 4.5.0
remoteId String 对端ID 4.5.0
state String 启用状态 4.5.0
status String 就绪状态 4.5.0
ikeLifeTime int IKE存活时间 4.5.0
lifeTime int IPSec存活时间 4.5.0
createDate Timestamp 创建时间 2.3
lastOpDate Timestamp 最后一次修改时间 2.3
peerCidrs List 详情参考peerCidrs 2.3
l3NetworkRefs List 详情参考l3NetworkRefs 2.3
#peerCidrs
名字 类型 描述 起始版本
uuid String 资源的UUID，唯一标示该资源 2.3
cidr String 2.3
connectionUuid String 2.3
createDate Timestamp 创建时间 2.3
lastOpDate Timestamp 最后一次修改时间 2.3
#l3NetworkRefs
名字 类型 描述 起始版本
uuid String 资源的UUID，唯一标示该资源 2.3
connectionUuid String 2.3
l3NetworkUuid String 三层网络UUID 2.3
createDate Timestamp 创建时间 2.3
lastOpDate Timestamp 最后一次修改时间 2.3

SDK示例

Java SDK
RemoveRemoteCidrsFromIPsecConnectionAction action = new
RemoveRemoteCidrsFromIPsecConnectionAction();
action.uuid = "2428fc093ea93b6fb4eda5cc921da355";
action.peerCidrs = asList("192.168.100.0/24");
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c";
RemoveRemoteCidrsFromIPsecConnectionAction.Result res = action.call();
Python SDK
RemoveRemoteCidrsFromIPsecConnectionAction action = RemoveRemoteCidrsFromIPsecConnectionAction()
action.uuid = "2428fc093ea93b6fb4eda5cc921da355"
action.peerCidrs = [192.168.100.0/24]
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c"
RemoveRemoteCidrsFromIPsecConnectionAction.Result res = action.call()
上一篇负载均衡相关接口下一篇Netflow相关接口
开发手册 | 4.8.38 | ZStack Cloud · ZCF | ZStack 资源中心