硬件SDN对接相关接口

添加SDN控制器(AddSdnController)

API请求

URLs

POST zstack/v1/sdn-controllers

Headers

Authorization: OAuth the-session-uuid

Body

{
  "params": {
    "vendorType": "vendor",
    "name": "sdn-1",
    "description": "sdn controller from vendor",
    "ip": "192.168.1.1",
    "userName": "admin",
    "password": "password"
  },
  "systemTags": [],
  "userTags": []
}

Note: 上述示例中systemTags、userTags字段可以省略。列出是为了表示body中可以包含这两个字段。

Curl示例

curl -H "Content-Type: application/json;charset=UTF-8" \
-H "Authorization: OAuth b86c9016b4f24953a9edefb53ca0678c" \
-X POST -d '{"params":{"vendorType":"vendor","name":"sdn-1","description":"sdn controller from vendor","ip":"192.168.1.1","userName":"admin","password":"password"}}' http://localhost:8080/zstack/v1/sdn-controllers

参数列表

名字	类型	位置	描述	起始版本
vendorType	String	body(包含在params结构中)		3.7.0
name	String	body(包含在params结构中)	资源名称	3.7.0
description (可选)	String	body(包含在params结构中)	资源的详细描述	3.7.0
ip	String	body(包含在params结构中)		3.7.0
userName	String	body(包含在params结构中)		3.7.0
password	String	body(包含在params结构中)		3.7.0
resourceUuid (可选)	String	body(包含在params结构中)		3.7.0
tagUuids (可选)	List	body(包含在params结构中)	标签UUID列表	3.7.0
systemTags (可选)	List	body		3.7.0
userTags (可选)	List	body		3.7.0

Note:

ZStack Cloud添加SDN控制器时支持创建H3C SDN控制，SystemTags增加H3C_VDS_UUID选项，使用 vdsUuid参数来传递 SystemTag。
- 选项格式为：vdsUuid::{%s}
- 例如：vdsUuid::1234-5678
- 关联资源：SdnControllerVO.class

API返回

返回示例

{
  "inventory": {
    "uuid": "2f7e443a152833efb0f4b7d196a35ce0",
    "vendorType": "H3C VCFC",
    "name": "sdn-1",
    "description": "sdn controller from vendor",
    "ip": "192.168.1.1",
    "username": "admin",
    "password": "password"
  }
}

名字	类型	描述	起始版本
error	ErrorCode	错误码，若不为null，则表示操作失败, 操作成功时该字段为null。详情参考error	3.7.0
inventory	SdnControllerInventory	详情参考inventory	3.7.0

#error

名字	类型	描述	起始版本
code	String	错误码号，错误的全局唯一标识，例如SYS.1000, HOST.1001	3.7.0
description	String	错误的概要描述	3.7.0
details	String	错误的详细信息	3.7.0
elaboration	String	保留字段，默认为null	3.7.0
opaque	LinkedHashMap	保留字段，默认为null	3.7.0
cause	ErrorCode	根错误，引发当前错误的源错误，若无原错误，该字段为null	3.7.0

#inventory

名字	类型	描述	起始版本
uuid	String	资源的UUID，唯一标示该资源	3.7.0
vendorType	String		3.7.0
name	String	资源名称	3.7.0
description	String	资源的详细描述	3.7.0
ip	String		3.7.0
username	String		3.7.0
password	String		3.7.0
createDate	Timestamp	创建时间	3.7.0
lastOpDate	Timestamp	最后一次修改时间	3.7.0
vniRanges	List	详情参考vniRanges	3.7.0
vxlanPools	List	详情参考vxlanPools	3.7.0

#vniRanges

名字	类型	描述	起始版本
startVni	Integer		3.7.0
endVni	Integer		3.7.0

#vxlanPools

名字	类型	描述	起始版本
sdnControllerUuid	String		3.7.0
attachedCidrs	Map		3.7.0
uuid	String	资源的UUID，唯一标示该资源	3.7.0
name	String	资源名称	3.7.0
description	String	资源的详细描述	3.7.0
zoneUuid	String	区域UUID	3.7.0
physicalInterface	String		3.7.0
type	String		3.7.0
createDate	Timestamp	创建时间	3.7.0
lastOpDate	Timestamp	最后一次修改时间	3.7.0
attachedClusterUuids	List		3.7.0
attachedVtepRefs	List	详情参考attachedVtepRefs	3.7.0
attachedVxlanNetworkRefs	List	详情参考attachedVxlanNetworkRefs	3.7.0
attachedVniRanges	List	详情参考attachedVniRanges	3.7.0

#attachedVtepRefs

名字	类型	描述	起始版本
uuid	String	资源的UUID，唯一标示该资源	3.7.0
hostUuid	String	物理机UUID	3.7.0
vtepIp	String		3.7.0
port	Integer		3.7.0
type	String		3.7.0
createDate	Timestamp	创建时间	3.7.0
lastOpDate	Timestamp	最后一次修改时间	3.7.0
poolUuid	String		3.7.0

#attachedVxlanNetworkRefs

名字	类型	描述	起始版本
vni	Integer		3.7.0
poolUuid	String		3.7.0
uuid	String	资源的UUID，唯一标示该资源	3.7.0
name	String	资源名称	3.7.0
description	String	资源的详细描述	3.7.0
zoneUuid	String	区域UUID	3.7.0
physicalInterface	String		3.7.0
type	String		3.7.0
createDate	Timestamp	创建时间	3.7.0
lastOpDate	Timestamp	最后一次修改时间	3.7.0
attachedClusterUuids	List		3.7.0

#attachedVniRanges

名字	类型	描述	起始版本
uuid	String	资源的UUID，唯一标示该资源	3.7.0
name	String	资源名称	3.7.0
description	String	资源的详细描述	3.7.0
startVni	Integer		3.7.0
endVni	Integer		3.7.0
createDate	Timestamp	创建时间	3.7.0
lastOpDate	Timestamp	最后一次修改时间	3.7.0
l2NetworkUuid	String	二层网络UUID	3.7.0

SDK示例

Java SDK

AddSdnControllerAction action = new AddSdnControllerAction();
action.vendorType = "vendor";
action.name = "sdn-1";
action.description = "sdn controller from vendor";
action.ip = "192.168.1.1";
action.userName = "admin";
action.password = "password";
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c";
AddSdnControllerAction.Result res = action.call();

Python SDK

AddSdnControllerAction action = AddSdnControllerAction()
action.vendorType = "vendor"
action.name = "sdn-1"
action.description = "sdn controller from vendor"
action.ip = "192.168.1.1"
action.userName = "admin"
action.password = "password"
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c"
AddSdnControllerAction.Result res = action.call()

查询SDN控制器(QuerySdnController)

API请求

URLs

GET zstack/v1/sdn-controllers
GET zstack/v1/sdn-controllers/{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/sdn-controllers?q=uuid=5e897e7e3a663786b873a3e020dbfc0a

curl -H "Content-Type: application/json;charset=UTF-8" \
-H "Authorization: OAuth b86c9016b4f24953a9edefb53ca0678c" \
-X GET http://localhost:8080/zstack/v1/sdn-controllers/37c3e4f7602930c5888107528521ac90

可查询字段

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

API返回

返回示例

{
  "inventories": [
    {
      "uuid": "b4134eb269a632eda5df826686733c5e",
      "name": "test-sdn",
      "description": "sdn for test",
      "ip": "192.168.1.1",
      "username": "admin",
      "password": "password"
    }
  ]
}

名字	类型	描述	起始版本
error	ErrorCode	错误码，若不为null，则表示操作失败, 操作成功时该字段为null。详情参考error	3.7.0
inventories	List	详情参考inventories	3.7.0

#error

名字	类型	描述	起始版本
code	String	错误码号，错误的全局唯一标识，例如SYS.1000, HOST.1001	3.7.0
description	String	错误的概要描述	3.7.0
details	String	错误的详细信息	3.7.0
elaboration	String	保留字段，默认为null	3.7.0
opaque	LinkedHashMap	保留字段，默认为null	3.7.0
cause	ErrorCode	根错误，引发当前错误的源错误，若无原错误，该字段为null	3.7.0

#inventories

名字	类型	描述	起始版本
uuid	String	资源的UUID，唯一标示该资源	3.7.0
vendorType	String		3.7.0
name	String	资源名称	3.7.0
description	String	资源的详细描述	3.7.0
ip	String		3.7.0
username	String		3.7.0
password	String		3.7.0
createDate	Timestamp	创建时间	3.7.0
lastOpDate	Timestamp	最后一次修改时间	3.7.0
vniRanges	List	详情参考vniRanges	3.7.0
vxlanPools	List	详情参考vxlanPools	3.7.0

#vniRanges

名字	类型	描述	起始版本
startVni	Integer		3.7.0
endVni	Integer		3.7.0

#vxlanPools

名字	类型	描述	起始版本
sdnControllerUuid	String		3.7.0
attachedCidrs	Map		3.7.0
uuid	String	资源的UUID，唯一标示该资源	3.7.0
name	String	资源名称	3.7.0
description	String	资源的详细描述	3.7.0
zoneUuid	String	区域UUID	3.7.0
physicalInterface	String		3.7.0
type	String		3.7.0
createDate	Timestamp	创建时间	3.7.0
lastOpDate	Timestamp	最后一次修改时间	3.7.0
attachedClusterUuids	List		3.7.0
attachedVtepRefs	List	详情参考attachedVtepRefs	3.7.0
attachedVxlanNetworkRefs	List	详情参考attachedVxlanNetworkRefs	3.7.0
attachedVniRanges	List	详情参考attachedVniRanges	3.7.0

#attachedVtepRefs

名字	类型	描述	起始版本
uuid	String	资源的UUID，唯一标示该资源	3.7.0
hostUuid	String	物理机UUID	3.7.0
vtepIp	String		3.7.0
port	Integer		3.7.0
type	String		3.7.0
createDate	Timestamp	创建时间	3.7.0
lastOpDate	Timestamp	最后一次修改时间	3.7.0
poolUuid	String		3.7.0

#attachedVxlanNetworkRefs

名字	类型	描述	起始版本
vni	Integer		3.7.0
poolUuid	String		3.7.0
uuid	String	资源的UUID，唯一标示该资源	3.7.0
name	String	资源名称	3.7.0
description	String	资源的详细描述	3.7.0
zoneUuid	String	区域UUID	3.7.0
physicalInterface	String		3.7.0
type	String		3.7.0
createDate	Timestamp	创建时间	3.7.0
lastOpDate	Timestamp	最后一次修改时间	3.7.0
attachedClusterUuids	List		3.7.0

#attachedVniRanges

名字	类型	描述	起始版本
uuid	String	资源的UUID，唯一标示该资源	3.7.0
name	String	资源名称	3.7.0
description	String	资源的详细描述	3.7.0
startVni	Integer		3.7.0
endVni	Integer		3.7.0
createDate	Timestamp	创建时间	3.7.0
lastOpDate	Timestamp	最后一次修改时间	3.7.0
l2NetworkUuid	String	二层网络UUID	3.7.0

SDK示例

Java SDK

QuerySdnControllerAction action = new QuerySdnControllerAction();
action.conditions = asList("uuid=e9f330402ed03b32a865ac4f19890589");
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c";
QuerySdnControllerAction.Result res = action.call();

Python SDK

QuerySdnControllerAction action = QuerySdnControllerAction()
action.conditions = ["uuid=d6a1f2d694273d31bfd23736ab530e44"]
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c"
QuerySdnControllerAction.Result res = action.call()

删除SDN控制器(RemoveSdnController)

API请求

URLs

DELETE zstack/v1/sdn-controllers/{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/sdn-controllers/237901c5097b38c480315569a1ac7567?deleteMode=Permissive

参数列表

名字	类型	位置	描述	起始版本
uuid	String	url	资源的UUID，唯一标示该资源	3.7.0
deleteMode (可选)	String	body		3.7.0
systemTags (可选)	List	body		3.7.0
userTags (可选)	List	body		3.7.0

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

RemoveSdnControllerAction action = new RemoveSdnControllerAction();
action.uuid = "237901c5097b38c480315569a1ac7567";
action.deleteMode = "Permissive";
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c";
RemoveSdnControllerAction.Result res = action.call();

Python SDK

RemoveSdnControllerAction action = RemoveSdnControllerAction()
action.uuid = "237901c5097b38c480315569a1ac7567"
action.deleteMode = "Permissive"
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c"
RemoveSdnControllerAction.Result res = action.call()

更新SDN控制器(UpdateSdnController)

API请求

URLs

PUT zstack/v1/sdn-controllers/{uuid}/actions

Headers

Authorization: OAuth the-session-uuid

Body

{
  "updateSdnController": {
    "name": "Test-Net",
    "description": "Test"
  },
  "systemTags": [],
  "userTags": []
}

Note: 上述示例中systemTags、userTags字段可以省略。列出是为了表示body中可以包含这两个字段。

Curl示例

curl -H "Content-Type: application/json;charset=UTF-8" \
-H "Authorization: OAuth b86c9016b4f24953a9edefb53ca0678c" \
-X PUT -d '{"updateSdnController":{"name":"Test-Net","description":"Test"}}' http://localhost:8080/zstack/v1/sdn-controllers/4a39301758b13cda968bdcd866452d14/actions

参数列表

名字	类型	位置	描述	起始版本
uuid	String	url	资源的UUID，唯一标示该资源	3.7.0
name (可选)	String	body(包含在updateSdnController结构中)	资源名称	3.7.0
description (可选)	String	body(包含在updateSdnController结构中)	资源的详细描述	3.7.0
systemTags (可选)	List	body		3.7.0
userTags (可选)	List	body		3.7.0

API返回

返回示例

{
  "inventory": {
    "uuid": "722428da8bac30d2b75daa2f6cd34e9d",
    "vendorType": "H3C VCFC",
    "name": "sdn-1",
    "description": "sdn controller from vendor",
    "ip": "192.168.1.1",
    "username": "admin",
    "password": "password"
  }
}

名字	类型	描述	起始版本
error	ErrorCode	错误码，若不为null，则表示操作失败, 操作成功时该字段为null。详情参考error	3.7.0
inventory	SdnControllerInventory	详情参考inventory	3.7.0

#error

名字	类型	描述	起始版本
code	String	错误码号，错误的全局唯一标识，例如SYS.1000, HOST.1001	3.7.0
description	String	错误的概要描述	3.7.0
details	String	错误的详细信息	3.7.0
elaboration	String	保留字段，默认为null	3.7.0
opaque	LinkedHashMap	保留字段，默认为null	3.7.0
cause	ErrorCode	根错误，引发当前错误的源错误，若无原错误，该字段为null	3.7.0

#inventory

名字	类型	描述	起始版本
uuid	String	资源的UUID，唯一标示该资源	3.7.0
vendorType	String		3.7.0
name	String	资源名称	3.7.0
description	String	资源的详细描述	3.7.0
ip	String		3.7.0
username	String		3.7.0
password	String		3.7.0
createDate	Timestamp	创建时间	3.7.0
lastOpDate	Timestamp	最后一次修改时间	3.7.0
vniRanges	List	详情参考vniRanges	3.7.0
vxlanPools	List	详情参考vxlanPools	3.7.0

#vniRanges

名字	类型	描述	起始版本
startVni	Integer		3.7.0
endVni	Integer		3.7.0

#vxlanPools

名字	类型	描述	起始版本
sdnControllerUuid	String		3.7.0
attachedCidrs	Map		3.7.0
uuid	String	资源的UUID，唯一标示该资源	3.7.0
name	String	资源名称	3.7.0
description	String	资源的详细描述	3.7.0
zoneUuid	String	区域UUID	3.7.0
physicalInterface	String		3.7.0
type	String		3.7.0
createDate	Timestamp	创建时间	3.7.0
lastOpDate	Timestamp	最后一次修改时间	3.7.0
attachedClusterUuids	List		3.7.0
attachedVtepRefs	List	详情参考attachedVtepRefs	3.7.0
attachedVxlanNetworkRefs	List	详情参考attachedVxlanNetworkRefs	3.7.0
attachedVniRanges	List	详情参考attachedVniRanges	3.7.0

#attachedVtepRefs

名字	类型	描述	起始版本
uuid	String	资源的UUID，唯一标示该资源	3.7.0
hostUuid	String	物理机UUID	3.7.0
vtepIp	String		3.7.0
port	Integer		3.7.0
type	String		3.7.0
createDate	Timestamp	创建时间	3.7.0
lastOpDate	Timestamp	最后一次修改时间	3.7.0
poolUuid	String		3.7.0

#attachedVxlanNetworkRefs

名字	类型	描述	起始版本
vni	Integer		3.7.0
poolUuid	String		3.7.0
uuid	String	资源的UUID，唯一标示该资源	3.7.0
name	String	资源名称	3.7.0
description	String	资源的详细描述	3.7.0
zoneUuid	String	区域UUID	3.7.0
physicalInterface	String		3.7.0
type	String		3.7.0
createDate	Timestamp	创建时间	3.7.0
lastOpDate	Timestamp	最后一次修改时间	3.7.0
attachedClusterUuids	List		3.7.0

#attachedVniRanges

名字	类型	描述	起始版本
uuid	String	资源的UUID，唯一标示该资源	3.7.0
name	String	资源名称	3.7.0
description	String	资源的详细描述	3.7.0
startVni	Integer		3.7.0
endVni	Integer		3.7.0
createDate	Timestamp	创建时间	3.7.0
lastOpDate	Timestamp	最后一次修改时间	3.7.0
l2NetworkUuid	String	二层网络UUID	3.7.0

SDK示例

Java SDK

UpdateSdnControllerAction action = new UpdateSdnControllerAction();
action.uuid = "4a39301758b13cda968bdcd866452d14";
action.name = "Test-Net";
action.description = "Test";
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c";
UpdateSdnControllerAction.Result res = action.call();

Python SDK

UpdateSdnControllerAction action = UpdateSdnControllerAction()
action.uuid = "4a39301758b13cda968bdcd866452d14"
action.name = "Test-Net"
action.description = "Test"
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c"
UpdateSdnControllerAction.Result res = action.call()

上一篇物理网络相关接口下一篇二层网络资源相关接口