网络资源

ZStack Cloud 5.4.0>ZStack Cloud开发手册>资源中心>网络资源

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": [] }

说明: 上述示例中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
name	String	body(包含在`params`结构中)	资源名称	3.7
description (可选)	String	body(包含在`params`结构中)	资源的详细描述	3.7
ip	String	body(包含在`params`结构中)		3.7
userName (可选)	String	body(包含在`params`结构中)		3.7
password (可选)	String	body(包含在`params`结构中)		3.7
resourceUuid (可选)	String	body(包含在`params`结构中)		3.7
tagUuids (可选)	List	body(包含在`params`结构中)	标签UUID列表	3.7
systemTags (可选)	List	body		3.7
userTags (可选)	List	body		3.7
zoneUuid (可选)	String	body(包含在`params`结构中)	区域UUID	5.3.0

说明:

ZStack Cloud添加SDN控制器时支持创建H3C SDN控制，SystemTags增加H3C_VDS_UUID选项，使用 vdsUuid参数来传递 SystemTag。
- 选项格式为：vdsUuid::{%s}
- 例如：vdsUuid::1234-5678
- 关联资源：SdnControllerVO.class
ZStack Cloud添加华为SDN控制器时支持记录SDN控制使用VLAN范围，SystemTags增加startVlan::endVlan::选项。
- 选项格式为：startVlan::{%s}::endVlan::{%s}
- 例如：startVlan::110::endVlan::120
- 关联资源：SdnControllerVO.class
- ZStack Cloud添加H3C v1 SDN控制器时支持记录SDN控制使用vni 范围，SystemTags增加startVni::endVni::选项。
  - 选项格式为：startVni::{%s}::endVni::{%s}
  - 例如： startVni::100::endVni::200
  - 关联资源：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"   } }

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

#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，唯一标示该资源	3.7.0
vendorType	String		3.7.0
vendorVersion	String	厂商版本	5.4.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
status	SdnControllerStatus	详情参考status	5.3.0
hostRefs	List	详情参考hostRefs	5.3.0

#status

名字	类型	描述	起始版本
Connecting	SdnControllerStatus	连接中	5.3.0
Connected	SdnControllerStatus	已连接	5.3.0
Disconnected	SdnControllerStatus	已失联	5.3.0

#hostRefs

名字	类型	描述	起始版本
sdnControllerUuid	String	SDN控制器Uuid	5.3.0
hostUuid	String	物理机UUID	5.3.0
vSwitchType	String	虚拟交换机类型	5.3.0
vtepIp	String	物理机VTEP IP	5.3.0
nicPciAddresses	String	物理机网卡和PCI地址映射	5.3.0
nicDrivers	String	物理机网卡和驱动类型映射	5.3.0
netmask	String	物理机VTEP IP掩码	5.3.0
bondMode	String	物理机网卡bond模式	5.3.0
lacpMode	String	物理机网卡LACP模式	5.3.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控制器(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()