Create a Node Manager
post
/v1/nodeManagers
Creates and adds a Node Manager in the Administration Server.
Request
There are no request parameters for this operation.
Supported Media Types
- application/json;charset=utf-8
Root Schema : schema
Type:
Show Source
object-
host(required): string
Minimum Length:
1The host name where the Node Manager is hosted. -
name(required): string
Minimum Length:
1The name of the Node Manager. -
port(required): integer
(int32)
The port where the Node Manager is hosted.
Response
Supported Media Types
- application/json
201 Response
The Node Manager was added successfully to the admin server.
Root Schema : NodeManagerResponse
Type:
objectThe response schema for getting details of a Node Manager.
Show Source
-
@type: string
Defines the sub-class entity when sub-classing.
-
host(required): string
The host name where the Node Manager is hosted.
-
href(required): string
(uri)
The 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 managerExample:
NM-z8kfsx-16it-l0qpcmee -
name(required): string
The name of the Node Manager.
-
nodes: array
nodes
Nodes managed by the node manager
-
port(required): integer
(int32)
The 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:
arrayNodes managed by the node manager
Show Source
-
Array of:
object NodeReference
The schema defining reference to get a node's information.
Nested Schema : NodeReference
Type:
objectThe schema defining reference to get a node's information.
Show Source
-
href(required): string
(uri)
The reference to get information about the node.
-
id(required): string
The identifier of the node.
400 Response
The server cannot process the request due to a client error.
Root Schema : Error
Type:
objectUsed 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
The application relevant details defined in the API or a common list.
-
message: string
The details and corrective actions for the error shown to the client user.
-
reason(required): string
The reason for the error, which is shown to a client user.
-
referenceError: string
(uri)
URI of documentation describing the error
-
status: string
HTTP Error code extension
401 Response
The client does not have the correct privileges.
Root Schema : Error
Type:
objectUsed 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
The application relevant details defined in the API or a common list.
-
message: string
The details and corrective actions for the error shown to the client user.
-
reason(required): string
The reason for the error, which is shown to a client user.
-
referenceError: string
(uri)
URI of documentation describing the error
-
status: string
HTTP Error code extension
403 Response
The request was not authorized.
Root Schema : Error
Type:
objectUsed 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
The application relevant details defined in the API or a common list.
-
message: string
The details and corrective actions for the error shown to the client user.
-
reason(required): string
The reason for the error, which is shown to a client user.
-
referenceError: string
(uri)
URI of documentation describing the error
-
status: string
HTTP Error code extension
404 Response
This method is not allowed.
Root Schema : Error
Type:
objectUsed 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
The application relevant details defined in the API or a common list.
-
message: string
The details and corrective actions for the error shown to the client user.
-
reason(required): string
The reason for the error, which is shown to a client user.
-
referenceError: string
(uri)
URI of documentation describing the error
-
status: string
HTTP Error code extension
405 Response
This method is not allowed.
Root Schema : Error
Type:
objectUsed 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
The application relevant details defined in the API or a common list.
-
message: string
The details and corrective actions for the error shown to the client user.
-
reason(required): string
The reason for the error, which is shown to a client user.
-
referenceError: string
(uri)
URI of documentation describing the error
-
status: string
HTTP Error code extension
409 Response
The request cannot be processed due to a conflict with the existing state of the resource.
Root Schema : Error
Type:
objectUsed 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
The application relevant details defined in the API or a common list.
-
message: string
The details and corrective actions for the error shown to the client user.
-
reason(required): string
The reason for the error, which is shown to a client user.
-
referenceError: string
(uri)
URI of documentation describing the error
-
status: string
HTTP Error code extension
500 Response
The system has encountered an internal server error.
Root Schema : Error
Type:
objectUsed 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
The application relevant details defined in the API or a common list.
-
message: string
The details and corrective actions for the error shown to the client user.
-
reason(required): string
The reason for the error, which is shown to a client user.
-
referenceError: string
(uri)
URI of documentation describing the error
-
status: string
HTTP Error code extension
Examples
The following example shows how to create a new Node Manager by submitting a POST request on the REST resource using cURL. For more information about cURL, see Use cURL.
The -d option specifies the file to attach as the request body.
curl -X POST 'http://host:port/nodeManagers' -d @sampleAddaNodeManagertoAdminServer.json
Example of Request Body
The following is an example of the contents of the sampleAddaNodeManagertoAdminServer.json file sent as the request body.
{
"host": "cagbu-phx-671.snphxprshared1.gbucdsint02phx.oraclevcn.com",
"name": "Nodemgr",
"port": 32170
}Example of Response Body
If successful, the response code 200 is displayed.