Show cluster information
GET /webmapi/cluster
Reports successful result in ResponseContentType<ClusterShowOutputType>
Reports errors in ResponseContentType<ErrorType>
| Error Key | Error Code | Error Description |
|---|---|---|
| CLUSTER_SHOW_CLUSTER_UNINITIALIZED | 7001 | Cluster is uninitialized. |
| CLUSTER_SHOW_INTERNAL_ERROR | 7023 | Internal error occurred. |
| CLUSTER_SHOW_EXISTS | 7024 | Cluster already exists. |
| CLUSTER_SHOW_SHELL_FAILURE | 7025 | Cluster operation failed. |
| CLUSTER_SHOW_CLUSTER_SHUTDOWN | 7026 | Cluster shutdown in progress. |
application/json
1.0
Create a cluster
POST /webmapi/cluster
Pass input arguments in ClusterCreateInputType
Reports successful result in ResponseContentType<UuidType>
Reports errors in ResponseContentType<ErrorType>
| Error Key | Error Code | Error Description |
|---|---|---|
| CLUSTER_CREATE_EXISTS | 7000 | Cluster already exists. |
| CLUSTER_CREATE_INTERNAL_ERROR | 7009 | Internal error occurred. |
| CLUSTER_CREATE_REQUEST_IN_PROGRESS | 7010 | Another request is in progress. |
| CLUSTER_CREATE_SHELL_FAILURE | 7011 | Cluster operation failed. |
application/json
application/json
1.0
Discover nodes that are eligible for forming or joining a cluster. Nodes are identified by system serial number
POST /webmapi/cluster/action/discover-nodes
Reports successful result in ResponseContentType<ContainerType<ClusterNodeType>>
Reports errors in ResponseContentType<ErrorType>
| Error Key | Error Code | Error Description |
|---|---|---|
| CLUSTER_DISCOVER_NODES_INTERNAL_ERROR | 7027 | Internal error occurred. |
application/json
application/json
1.0
Show the network DNS server
GET /webmapi/cluster/dns-server
Reports successful result in ResponseContentType<ClusterDnsServerOutputType>
Reports errors in ResponseContentType<ErrorType>
| Error Key | Error Code | Error Description |
|---|---|---|
| NETWORK_DNS_SERVER_SHOW_INTERNAL_ERROR | 35008 | Internal error occurred. |
| NETWORK_DNS_SERVER_SHOW_REQUEST_IN_PROGRESS | 35009 | Another request is in progress. |
| NETWORK_DNS_SERVER_SHOW_DNS_UNINITIALIZED | 35010 | Network DNS server not initialized. |
| NETWORK_DNS_SERVER_SHOW_SHELL_FAILURE | 35011 | Network operation failed. |
| NETWORK_DNS_SERVER_SHOW_NETWORK_SHUTDOWN | 35012 | Network shutdown in progress. |
application/json
1.0
Set the network DNS server
To clear DNS settings, pass all empty fields to input except for protocol.
PUT /webmapi/cluster/dns-server
Pass input arguments in ClusterDnsServerModifyInputType
Reports successful result in ResponseContentType
Reports errors in ResponseContentType<ErrorType>
| Error Key | Error Code | Error Description |
|---|---|---|
| NETWORK_DNS_SERVER_MODIFY_INTERNAL_ERROR | 35013 | Internal error occurred. |
| NETWORK_DNS_SERVER_MODIFY_REQUEST_IN_PROGRESS | 35014 | Another request is in progress. |
| NETWORK_DNS_SERVER_MODIFY_SHELL_FAILURE | 35015 | Network operation failed. |
| NETWORK_DNS_SERVER_MODIFY_NETWORK_SHUTDOWN | 35016 | Network shutdown in progress. |
| NETWORK_DNS_SERVER_MODIFY_NETWORK_IPV6_NOT_SUPPORTED | 35017 | IPV6 not supported. |
| NETWORK_DNS_SERVER_MODIFY_NUM_NETWORK_DNS_SERVERS | 35018 | Incorrect number of DNS servers. |
| NETWORK_DNS_SERVER_MODIFY_DUPLICATE_DNS_SERVERS | 35019 | Duplicate DNS servers. |
| NETWORK_DNS_SERVER_MODIFY_INVALID_DNS_SERVER_IP | 35020 | INVALID DNS server IP. |
application/json
application/json
1.0
Show the cluster management IP address, netmask, and gateway
GET /webmapi/cluster/management-interface
Reports successful result in ResponseContentType<ClusterMgmtInterfaceOutputType>
Reports errors in ResponseContentType<ErrorType>
| Error Key | Error Code | Error Description |
|---|---|---|
| CLUSTER_MANAGEMENT_INTERFACE_SHOW_INTERNAL_ERROR | 7017 | Internal error occurred. |
| CLUSTER_MANAGEMENT_INTERFACE_SHOW_REQUEST_IN_PROGRESS | 7018 | Another request is in progress. |
| CLUSTER_MANAGEMENT_INTERFACE_SHOW_MANAGEMENT_IP_NOT_INITIALIZED | 7019 | Cluster management IP address not initialized. |
| CLUSTER_MANAGEMENT_INTERFACE_SHOW_IPV4_UNINITIALIZED | 7020 | IPv4 cluster management address not initialized. |
| CLUSTER_MANAGEMENT_INTERFACE_SHOW_IPV6_UNINITIALIZED | 7021 | IPv6 cluster management address not initialized. |
| CLUSTER_MANAGEMENT_INTERFACE_SHOW_CLUSTER_SHUTDOWN | 7022 | Cluster shutdown in progress. |
application/json
1.0
Change cluster management interface
PUT /webmapi/cluster/management-interface
Pass input arguments in ClusterMgmtInterfaceModifyInputType
Reports successful result in ResponseContentType
Reports errors in ResponseContentType<ErrorType>
| Error Key | Error Code | Error Description |
|---|---|---|
| CLUSTER_MANAGEMENT_INTERFACE_MODIFY_INTERNAL_ERROR | 7037 | Internal error occurred. |
| CLUSTER_MANAGEMENT_INTERFACE_MODIFY_REQUEST_IN_PROGRESS | 7038 | Another request is in progress. |
| CLUSTER_MANAGEMENT_INTERFACE_MODIFY_SHELL_FAILURE | 7039 | Cluster operation failed. |
| CLUSTER_MANAGEMENT_INTERFACE_MODIFY_CLUSTER_SHUTDOWN | 7040 | Cluster shutdown in progress. |
| CLUSTER_MANAGEMENT_INTERFACE_MODIFY_CLUSTER_IPV6_NOT_SUPPORTED | 7041 | IPv6 not supported. |
| CLUSTER_MANAGEMENT_INTERFACE_MODIFY_INVALID_CLUSTER_MGMT_IP | 7043 | Invalid cluster management IP. |
| CLUSTER_MANAGEMENT_INTERFACE_MODIFY_INVALID_CLUSTER_NETMASK | 7044 | Invalid cluster netmask. |
| CLUSTER_MANAGEMENT_INTERFACE_MODIFY_INVALID_CLUSTER_GATEWAY | 7045 | Invalid cluster gateway. |
| CLUSTER_MANAGEMENT_INTERFACE_MODIFY_INVALID_MGMT_IP_GATEWAY | 7046 | Cluster management IP and gateway in different subnets. |
| CLUSTER_MANAGEMENT_INTERFACE_MODIFY_DUPLICATE_CLUSTER_IP_GATEWAY | 7047 | Duplicate cluster IP and Gateway. |
| Status Code | Reason |
|---|---|
| 202 | The request has been accepted successfully |
application/json
application/json
1.0
APIs for cluster-level operations