POST zstack/v1/sdn-controllers
Authorization: OAuth the-session-uuid
{ "params": { "vendorType": "vendor", "name": "sdn-1", "description": "sdn controller from vendor", "ip": "192.168.1.1", "userName": "admin", "password": "password" }, "systemTags": [], "userTags": [] }
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 | ||
zoneUuid (可选) | String | body(包含在params结构中) | 区域UUID | 5.3.20 |
vdsUuid::{%s}
vdsUuid::1234-5678
SdnControllerVO.class
{ "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 | 5.3.20 | |
error | ErrorCode | 错误码,若不为null,则表示操作失败,操作成功时该字段为null。 详情参考error | 3.7.0 |
inventory | SdnControllerInventory | 详情参考inventory | 3.7.0 |
名字 | 类型 | 描述 | 起始版本 |
---|---|---|---|
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 |
名字 | 类型 | 描述 | 起始版本 |
---|---|---|---|
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 |
status | SdnControllerStatus | 详情参考status | 5.3.20 |
vniRanges | List | 详情参考vniRanges | 3.7.0 |
vxlanPools | List | 详情参考vxlanPools | 3.7.0 |
hostRefs | List | 详情参考hostRefs | 5.3.20 |
名字 | 类型 | 描述 | 起始版本 |
---|---|---|---|
Connecting | SdnControllerStatus | 连接中 | 5.3.20 |
Connected | SdnControllerStatus | 已连接 | 5.3.20 |
Disconnected | SdnControllerStatus | 已失联 | 5.3.20 |
名字 | 类型 | 描述 | 起始版本 |
---|---|---|---|
startVni | Integer | 3.7.0 | |
endVni | Integer | 3.7.0 |
名字 | 类型 | 描述 | 起始版本 |
---|---|---|---|
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 | |
vSwitchType | String | 5.3.20 | |
virtualNetworkId | Integer | 5.3.20 | |
isolated | Boolean | 5.3.20 | |
pvlan | String | 5.3.20 | |
createDate | Timestamp | 创建时间 | 3.7.0 |
lastOpDate | Timestamp | 最后一次修改时间 | 3.7.0 |
attachedClusterUuids | List | 3.7.0 | |
attachedVtepRefs | List | 详情参考attachedVtepRefs | 3.7.0 |
remoteVteps | List | 详情参考remoteVteps | 5.3.20 |
attachedVxlanNetworkRefs | List | 详情参考attachedVxlanNetworkRefs | 3.7.0 |
attachedVniRanges | List | 详情参考attachedVniRanges | 3.7.0 |
名字 | 类型 | 描述 | 起始版本 |
---|---|---|---|
uuid | String | 资源的UUID,唯一标示该资源 | 3.7.0 |
hostUuid | String | 物理机UUID | 3.7.0 |
vtepIp | String | 隧道端点IP地址 | 5.3.20 |
port | Integer | 端口 | 5.3.20 |
type | String | 类型 | 5.3.20 |
createDate | Timestamp | 创建时间 | 3.7.0 |
lastOpDate | Timestamp | 最后一次修改时间 | 3.7.0 |
poolUuid | String | VXLAN资源池UUID | 5.3.20 |
名字 | 类型 | 描述 | 起始版本 |
---|---|---|---|
uuid | String | 资源的UUID,唯一标示该资源 | 5.3.20 |
clusterUuid | String | 集群UUID | 5.3.20 |
vtepIp | String | 隧道端点IP地址 | 5.3.20 |
port | Integer | 端口 | 5.3.20 |
type | String | 类型 | 5.3.20 |
createDate | Timestamp | 创建时间 | 5.3.20 |
lastOpDate | Timestamp | 最后一次修改时间 | 5.3.20 |
poolUuid | String | VXLAN资源池UUID | 5.3.20 |
名字 | 类型 | 描述 | 起始版本 |
---|---|---|---|
vni | Integer | Vni号 | 3.7.0 |
poolUuid | String | VXLAN资源池UUID | 5.3.20 |
uuid | String | 资源的UUID,唯一标示该资源 | 3.7.0 |
name | String | 资源名称 | 3.7.0 |
description | String | 资源的详细描述 | 3.7.0 |
zoneUuid | String | 区域UUID | 3.7.0 |
physicalInterface | String | 物理网卡 | 5.3.20 |
type | String | 二层网络类型 | 5.3.20 |
vSwitchType | String | 5.3.20 | |
virtualNetworkId | Integer | 5.3.20 | |
isolated | Boolean | 5.3.20 | |
pvlan | String | 5.3.20 | |
createDate | Timestamp | 创建时间 | 3.7.0 |
lastOpDate | Timestamp | 最后一次修改时间 | 3.7.0 |
attachedClusterUuids | List | 挂载集群的UUID列表 | 5.3.20 |
名字 | 类型 | 描述 | 起始版本 |
---|---|---|---|
uuid | String | 资源的UUID,唯一标示该资源 | 3.7.0 |
name | String | 资源名称 | 3.7.0 |
description | String | 资源的详细描述 | 3.7.0 |
startVni | Integer | 起始VNI | 5.3.20 |
endVni | Integer | 结束VNI | 5.3.20 |
createDate | Timestamp | 创建时间 | 3.7.0 |
lastOpDate | Timestamp | 最后一次修改时间 | 3.7.0 |
l2NetworkUuid | String | 二层网络UUID | 3.7.0 |
名字 | 类型 | 描述 | 起始版本 |
---|---|---|---|
sdnControllerUuid | String | SDN控制器UUID | 5.3.20 |
hostUuid | String | 物理机UUID | 5.3.20 |
vSwitchType | String | 虚拟交换机类型 | 5.3.20 |
vtepIp | String | 物理机VTEP IP | 5.3.20 |
nicPciAddresses | String | 物理机网卡和PCI地址映射 | 5.3.20 |
nicDrivers | String | 物理机网卡和驱动类型映射 | 5.3.20 |
netmask | String | 物理机VTEP IP掩码 | 5.3.20 |
bondMode | String | 物理机网卡bond模式 | 5.3.20 |
lacpMode | String | 物理机网卡LACP模式 | 5.3.20 |
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();
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()
DELETE zstack/v1/sdn-controllers/{uuid}
Authorization: OAuth the-session-uuid
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 |
{}
,出错时返回的JSON结构包含一个error字段,例如:{ "error": { "code": "SYS.1001", "description": "A message or a operation timeout", "details": "Create VM on KVM timeout after 300s" } }
RemoveSdnControllerAction action = new RemoveSdnControllerAction(); action.uuid = "237901c5097b38c480315569a1ac7567"; action.deleteMode = "Permissive"; action.sessionId = "b86c9016b4f24953a9edefb53ca0678c"; RemoveSdnControllerAction.Result res = action.call();
RemoveSdnControllerAction action = RemoveSdnControllerAction() action.uuid = "237901c5097b38c480315569a1ac7567" action.deleteMode = "Permissive" action.sessionId = "b86c9016b4f24953a9edefb53ca0678c" RemoveSdnControllerAction.Result res = action.call()
学习路径
ZStack Cloud 产品学习路径
快速梳理文档,点击相应文本链接,快速跳转到相应文档的页面,学习 ZStack Cloud 产品。
业务咨询:
400-962-2212 转 1售后咨询:
400-962-2212 转 2其他(漏洞提交、投诉举报等)
400-962-2212 转 3业务咨询:
400-962-2212 转 1ZStack学院:
training@zstack.io业务咨询:
400-962-2212 转 1售后咨询:
400-962-2212 转 2其他(漏洞提交、投诉举报等)
400-962-2212 转 3业务咨询:
400-962-2212 转 1售后咨询:
400-962-2212 转 2其他(漏洞提交、投诉举报等)
400-962-2212 转 3业务咨询:
400-962-2212 转 1商务联系:
channel@zstack.io业务咨询:
400-962-2212 转 1商务联系:
channel@zstack.io下载链接已发送至您的邮箱。
如未收到,请查看您的垃圾邮件、订阅邮件、广告邮件。 当您收到电子邮件后,请点击 URL 链接,以完成下载。感谢您使用 ZStack 产品和服务。
成功提交申请。
我们将安排工作人员尽快与您取得联系。感谢您使用 ZStack 产品和服务。
信息提交成功。
我们将安排工作人员尽快与您取得联系,请保持电话畅通。感谢您使用 ZStack 产品和服务。
商务咨询:
400-962-2212 转 1售后咨询:
400-962-2212 转 2商务联系:
sales@zstack.io成功提交申请。
我们将安排工作人员尽快与您取得联系。感谢您使用 ZStack 产品和服务。