跳转到主要内容
API Explorer|API Explorer
资源中心/网络资源/SDN设备相关接口
POSTHardware SDN Controller Operations起始版本 3.7.0同步需要认证

添加SDN控制器

添加SDN控制器

调试可用性

在线调试

使用当前认证信息和示例参数提交 Mock 请求。

请求参数

请求体字段

  • paramsObject必填

    请求体参数结构

    • vendorTypeString必填

      暂无描述。

    • nameString必填

      资源名称

    • descriptionString

      资源的详细描述

    • ipString必填

      来源IP地址。

    • userNameString

      用户名称。

    • passwordString

      密码。

    • resourceUuidString

      资源UUID。若指定，资源会使用该字段值作为UUID。

    • tagUuidsList

      标签UUID列表

    • zoneUuidString

      区域UUID

  • systemTagsList

    系统标签。

  • userTagsList

    用户标签。

  • hostRefsList必填

    暂无描述。

响应状态

200 OK

该 API 成功时返回以下响应结构。

  • successBoolean必填

    操作是否成功。

  • errorErrorCode必填

    错误码，若不为null，则表示操作失败，操作成功时该字段为null。 详情参考error

    • codeString必填

      错误码号，错误的全局唯一标识，例如SYS.1000, HOST.1001

    • descriptionString必填

      错误的概要描述

    • detailsString必填

      错误的详细信息

    • elaborationString必填

      保留字段，默认为null

    • opaqueLinkedHashMap必填

      保留字段，默认为null

    • causeErrorCode必填

      根错误，引发当前错误的源错误，若无原错误，该字段为null

  • inventorySdnControllerInventory必填

    详情参考inventory

    • uuidString必填

      资源的UUID，唯一标示该资源

    • vendorTypeString必填

      暂无描述。

    • vendorVersionString必填

      厂商版本

    • nameString必填

      资源名称

    • descriptionString必填

      资源的详细描述

    • ipString必填

      来源IP地址。

    • usernameString必填

      用户名。

    • passwordString必填

      密码。

    • createDateTimestamp必填

      创建时间

    • lastOpDateTimestamp必填

      最后一次修改时间

    • statusSdnControllerStatus必填

      详情参考status

      • ConnectingSdnControllerStatus必填

        连接中

      • ConnectedSdnControllerStatus必填

        已连接

      • DisconnectedSdnControllerStatus必填

        已失联

    • hostRefsList必填

      详情参考hostRefs

      • sdnControllerUuidString必填

        SDN控制器Uuid

      • hostUuidString必填

        物理机UUID

      • vSwitchTypeString必填

        虚拟交换机类型

      • vtepIpString必填

        物理机VTEP IP

      • nicPciAddressesString必填

        物理机网卡和PCI地址映射

      • nicDriversString必填

        物理机网卡和驱动类型映射

      • netmaskString必填

        物理机VTEP IP掩码

      • bondModeString必填

        物理机网卡bond模式

      • lacpModeString必填

        物理机网卡LACP模式

请求地址

POST/zstack/v1/sdn-controllers

/zstack/v1/sdn-controllers

操作 ID

AddSdnController

永久链接

请求示例

curl -X POST 'http://{host}/zstack/v1/sdn-controllers' -H 'Authorization: OAuth {sessionUuid}' -H 'Content-Type: application/json;charset=UTF-8' -d '{"params":{"vendorType":"<vendorType>","name":"<name>","description":"<description>","ip":"<ip>","userName":"<userName>","password":"<password>","resourceUuid":"<resourceUuid>","tagUuids":["<tagUuids>"],"zoneUuid":"<zoneUuid>"},"systemTags":["<systemTags>"],"userTags":["<userTags>"],"hostRefs":["<hostRefs>"]}'

响应示例

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

变更历史

此 API 暂无变更历史记录。

查看全部变更历史