跳转到主要内容
ZStack
资源中心/网络资源/SDN设备相关接口

添加SDN控制器

添加SDN控制器

POST/zstack/v1/sdn-controllers

操作 ID

AddSdnController

起始版本

3.7.0

执行模式

同步

认证信息

需要认证

认证信息

调用该 API 时需要在请求头中携带以下认证信息。

Authorizationstring必填

Bearer 令牌

X-Tenant-IDstring

X-Tenant-ID

请求参数

application/json

请求体字段

  • params
    Object必填

    请求体参数结构

    • vendorType
      String必填

      vendor类型。

    • name
      String必填

      资源名称

    • description
      String

      资源的详细描述

    • ip
      String必填

      来源IP地址。

    • userName
      String

      用户名称。

    • password
      String

      密码。

    • resourceUuid
      String

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

    • tagUuids
      List

      标签UUID列表

    • zoneUuid
      String

      区域UUID

  • systemTags
    List

    系统标签。

  • userTags
    List

    用户标签。

  • hostRefs
    List必填

    暂无描述。

响应状态

200 OK
200 OK

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

  • success
    Boolean必填

    操作是否成功。

  • error
    ErrorCode必填

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

    • code
      String必填

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

    • description
      String必填

      错误的概要描述

    • details
      String必填

      错误的详细信息

    • elaboration
      String必填

      保留字段，默认为null

    • opaque
      LinkedHashMap必填

      保留字段，默认为null

    • cause
      ErrorCode必填

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

  • inventory
    SdnControllerInventory必填

    详情参考inventory

    • uuid
      String必填

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

    • vendorType
      String必填

      vendor类型。

    • vendorVersion
      String必填

      厂商版本

    • name
      String必填

      资源名称

    • description
      String必填

      资源的详细描述

    • ip
      String必填

      来源IP地址。

    • username
      String必填

      用户名。

    • password
      String必填

      密码。

    • createDate
      Timestamp必填

      创建时间

    • lastOpDate
      Timestamp必填

      最后一次修改时间

    • status
      SdnControllerStatus必填

      详情参考status

      • Connecting
        SdnControllerStatus必填

        连接中

      • Connected
        SdnControllerStatus必填

        已连接

      • Disconnected
        SdnControllerStatus必填

        已失联

    • hostRefs
      List必填

      详情参考hostRefs

      • sdnControllerUuid
        String必填

        SDN控制器Uuid

      • hostUuid
        String必填

        物理机UUID

      • vSwitchType
        String必填

        虚拟交换机类型

      • vtepIp
        String必填

        物理机VTEP IP

      • nicPciAddresses
        String必填

        物理机网卡和PCI地址映射

      • nicDrivers
        String必填

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

      • netmask
        String必填

        物理机VTEP IP掩码

      • bondMode
        String必填

        物理机网卡bond模式

      • lacpMode
        String必填

        物理机网卡LACP模式