List All Node Managers
get
/nodeManagers
Returns a list of all the node managers in the administration server.
Request
There are no request parameters for this operation.
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/json
200 Response
All node manager entities listed successfully.
Root Schema : schema
Type:
Show Source
array
-
Array of:
object NodeManagerResponse
Response schema for getting details of a node manager.
Nested Schema : NodeManagerResponse
Type:
object
Response schema for getting details of a node manager.
Show Source
-
@type: string
Defines the sub-class entity when sub-classing. name
-
host(required): string
Hostname where the node manager is hosted.
-
href(required): string
(uri)
Reference to get the node manager's information.Example:
http://server:port/api/v1/nodeManagers/NM-z8kfsx-16it-l0qpcmee
-
id(required): string
Identifier of the node manager.Example:
NM-z8kfsx-16it-l0qpcmee
-
name(required): string
Name of the node manager.
-
nodes: array
nodes
Nodes managed by the node manager.
-
port(required): integer
(int32)
Port where the node manager is hosted.
-
state: string
State of the node manager.
-
statusMessage: string
Status of the node manager.
Nested Schema : nodes
Type:
array
Nodes managed by the node manager.
Show Source
-
Array of:
object NodeReference
Schema defining reference to get a node's information.
Nested Schema : NodeReference
Type:
object
Schema defining reference to get a node's information.
Show Source
-
href(required): string
(uri)
Reference to get information about a node.
-
id(required): string
Identifier of a node.
400 Response
The server cannot process the request due to a client error.
Root Schema : Error
Type:
object
Used when an API encounters an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx).
Show Source
-
@type: string
Defines the sub-class entity when sub-classing.
-
cause: string
Cause of the exception
-
code(required): string
Application relevant details defined in the API or a common list.
-
message: string
Details and corrective actions related to the error which is shown to a client user.
-
reason(required): string
The reason for the error, shown to a client user.
-
referenceError: string
(uri)
URI of documentation describing the error.
-
status: string
HTTP Error Code describiing the error.
401 Response
The client does not have the correct privileges.
Root Schema : Error
Type:
object
Used when an API encounters an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx).
Show Source
-
@type: string
Defines the sub-class entity when sub-classing.
-
cause: string
Cause of the exception
-
code(required): string
Application relevant details defined in the API or a common list.
-
message: string
Details and corrective actions related to the error which is shown to a client user.
-
reason(required): string
The reason for the error, shown to a client user.
-
referenceError: string
(uri)
URI of documentation describing the error.
-
status: string
HTTP Error Code describiing the error.
403 Response
The request was not authorized.
Root Schema : Error
Type:
object
Used when an API encounters an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx).
Show Source
-
@type: string
Defines the sub-class entity when sub-classing.
-
cause: string
Cause of the exception
-
code(required): string
Application relevant details defined in the API or a common list.
-
message: string
Details and corrective actions related to the error which is shown to a client user.
-
reason(required): string
The reason for the error, shown to a client user.
-
referenceError: string
(uri)
URI of documentation describing the error.
-
status: string
HTTP Error Code describiing the error.
404 Response
The requested resource cannot be found.
Root Schema : Error
Type:
object
Used when an API encounters an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx).
Show Source
-
@type: string
Defines the sub-class entity when sub-classing.
-
cause: string
Cause of the exception
-
code(required): string
Application relevant details defined in the API or a common list.
-
message: string
Details and corrective actions related to the error which is shown to a client user.
-
reason(required): string
The reason for the error, shown to a client user.
-
referenceError: string
(uri)
URI of documentation describing the error.
-
status: string
HTTP Error Code describiing the error.
405 Response
This method is not allowed.
Root Schema : Error
Type:
object
Used when an API encounters an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx).
Show Source
-
@type: string
Defines the sub-class entity when sub-classing.
-
cause: string
Cause of the exception
-
code(required): string
Application relevant details defined in the API or a common list.
-
message: string
Details and corrective actions related to the error which is shown to a client user.
-
reason(required): string
The reason for the error, shown to a client user.
-
referenceError: string
(uri)
URI of documentation describing the error.
-
status: string
HTTP Error Code describiing the error.
409 Response
The request cannot be processed due to a conflict with the existing state of the resource.
Root Schema : Error
Type:
object
Used when an API encounters an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx).
Show Source
-
@type: string
Defines the sub-class entity when sub-classing.
-
cause: string
Cause of the exception
-
code(required): string
Application relevant details defined in the API or a common list.
-
message: string
Details and corrective actions related to the error which is shown to a client user.
-
reason(required): string
The reason for the error, shown to a client user.
-
referenceError: string
(uri)
URI of documentation describing the error.
-
status: string
HTTP Error Code describiing the error.
500 Response
The system has encountered an internal server error.
Root Schema : Error
Type:
object
Used when an API encounters an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx).
Show Source
-
@type: string
Defines the sub-class entity when sub-classing.
-
cause: string
Cause of the exception
-
code(required): string
Application relevant details defined in the API or a common list.
-
message: string
Details and corrective actions related to the error which is shown to a client user.
-
reason(required): string
The reason for the error, shown to a client user.
-
referenceError: string
(uri)
URI of documentation describing the error.
-
status: string
HTTP Error Code describiing the error.
Examples
The following example shows how to get a list of all the Node Managers by submitting a GET request on the REST resource using cURL. For more information about cURL, see Use cURL.
curl -X GET 'http://host:port/nodeManagers'
Example of the Response Body
If successful, the response code 200 is returned with the following response body.
[ { "host": "node-mgr-app", "href": "/nodemanagers/NMGR-31eoeh-otm-ln3hrqc9", "id": "NMGR-31eoeh-otm-ln3hrqc9", "name": "nm1", "nodes": [ { "href": "/nodes/31eoef-otm-lna53s09", "id": "31eoef-otm-lna53s09" }, { "href": "/nodes/31eoef-otm-lna51qht", "id": "31eoef-otm-lna51qht" }, { "href": "/nodes/31eoef-otm-lna4vku4", "id": "31eoef-otm-lna4vku4" }, { "href": "/nodes/31eoep-otm-lnbhn159", "id": "31eoep-otm-lnbhn159" } ], "port": 32170, "statusMessage": "Informational - " } ]