Resource /webmapi/cluster/management-interfaceExpand | Collapse

APIs for cluster-level operations

Show the cluster management IP address, netmask, and gateway
Description

Show the cluster management IP address, netmask, and gateway

HTTP Example

GET /webmapi/cluster/management-interface

Output

Reports successful result in ResponseContentType<ClusterMgmtInterfaceOutputType>

Errors

Reports errors in ResponseContentType<ErrorType>

Error KeyError CodeError Description
CLUSTER_MANAGEMENT_INTERFACE_SHOW_INTERNAL_ERROR7017Internal error occurred.
CLUSTER_MANAGEMENT_INTERFACE_SHOW_REQUEST_IN_PROGRESS7018Another request is in progress.
CLUSTER_MANAGEMENT_INTERFACE_SHOW_MANAGEMENT_IP_NOT_INITIALIZED7019Cluster management IP address not initialized.
CLUSTER_MANAGEMENT_INTERFACE_SHOW_IPV4_UNINITIALIZED7020IPv4 cluster management address not initialized.
CLUSTER_MANAGEMENT_INTERFACE_SHOW_IPV6_UNINITIALIZED7021IPv6 cluster management address not initialized.
CLUSTER_MANAGEMENT_INTERFACE_SHOW_CLUSTER_SHUTDOWN7022Cluster shutdown in progress.
Produces

application/json

Since

1.0

Change cluster management interface
Description

Change cluster management interface

HTTP Example

PUT /webmapi/cluster/management-interface

Input

Pass input arguments in ClusterMgmtInterfaceModifyInputType

Output

Reports successful result in ResponseContentType

Errors

Reports errors in ResponseContentType<ErrorType>

Error KeyError CodeError Description
CLUSTER_MANAGEMENT_INTERFACE_MODIFY_INTERNAL_ERROR7037Internal error occurred.
CLUSTER_MANAGEMENT_INTERFACE_MODIFY_REQUEST_IN_PROGRESS7038Another request is in progress.
CLUSTER_MANAGEMENT_INTERFACE_MODIFY_SHELL_FAILURE7039Cluster operation failed.
CLUSTER_MANAGEMENT_INTERFACE_MODIFY_CLUSTER_SHUTDOWN7040Cluster shutdown in progress.
CLUSTER_MANAGEMENT_INTERFACE_MODIFY_CLUSTER_IPV6_NOT_SUPPORTED7041IPv6 not supported.
CLUSTER_MANAGEMENT_INTERFACE_MODIFY_INVALID_CLUSTER_MGMT_IP7043Invalid cluster management IP.
CLUSTER_MANAGEMENT_INTERFACE_MODIFY_INVALID_CLUSTER_NETMASK7044Invalid cluster netmask.
CLUSTER_MANAGEMENT_INTERFACE_MODIFY_INVALID_CLUSTER_GATEWAY7045Invalid cluster gateway.
CLUSTER_MANAGEMENT_INTERFACE_MODIFY_INVALID_MGMT_IP_GATEWAY7046Cluster management IP and gateway in different subnets.
CLUSTER_MANAGEMENT_INTERFACE_MODIFY_DUPLICATE_CLUSTER_IP_GATEWAY7047Duplicate cluster IP and Gateway.
HTTP Responses
Status CodeReason
202The request has been accepted successfully
Produces

application/json

Consumes

application/json

Since

1.0