Skip to main content
ZStack
Resource Center/Network Resource/Hardware SDN Controller Operations

ChangeSdnController

ChangeSdnController

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

Operation ID

ChangeSdnController

Since

5.4.0

Execution Mode

Synchronous

Auth Context

Auth Required

Auth Context

Send these values as request headers when calling this API.

AuthorizationstringRequired

Bearer Token

X-Tenant-IDstring

X-Tenant-ID

Request Inputs

application/json

Path Parameters

  • uuid
    StringRequired

    The UUID of the SDN controller resource.

Body Fields

  • changeSdnControllerstructure
    ObjectRequired

    changeSdnControllerstructure request body object.

    • userName
      String

      Optional. New user name for the SDN controller.

    • password
      String

      Optional. The new password for the SDN controller.

    • vlanRanges
      ListRequired

      The VLAN ranges.

  • systemTags
    List

    Optional. The system tags.

  • userTags
    List

    Optional. The user tags.

Responses

200 OK
200 OK

On success, this API returns the following response structure.

  • success
    booleanRequired

    Whether the operation succeeded.

  • inventory
    SdnControllerInventoryRequired

    See inventory.

    • uuid
      StringRequired

      The resource UUID.

    • vendorType
      StringRequired

      The vendor type.

    • vendorVersion
      StringRequired

      The vendor version.

    • name
      StringRequired

      The resource name.

    • description
      StringRequired

      The detailed description of the resource.

    • ip
      StringRequired

      The IP address.

    • username
      StringRequired

      The username.

    • password
      StringRequired

      The password.

    • createDate
      TimestampRequired

      The creation date.

    • lastOpDate
      TimestampRequired

      The last operation date.

    • status
      SdnControllerStatusRequired

      See status.

      • Connecting
        SdnControllerStatusRequired

        Connecting.

      • Connected
        SdnControllerStatusRequired

        Connected.

      • Disconnected
        SdnControllerStatusRequired

        Disconnected.

  • error
    ErrorCodeRequired

    Error code, null if operation succeeds, non-null if operation fails, see error.

    • code
      StringRequired

      The error code, which is a numbered or alphanumeric code that specifies an error. For example, SYS.1000, HOST.1001.

    • description
      StringRequired

      The brief description of the error.

    • details
      StringRequired

      The details about the error.

    • elaboration
      StringRequired

      The reserved field. Default value: null.

    • opaque
      LinkedHashMapRequired

      The reserved field. Default value: null.

    • cause
      ErrorCodeRequired

      The root error, which is the associated root cause of the current error. If no root error exists, this parameter is null.

Change History

View all change history

  • Change Time

    AddedRequest body fields changeSdnControllerstructure
    View API