List All Node Chains
get
/v1/nodeChains/{nodeManagerId}
Returns a list of all the node chains in a Node Manager.
Request
Path Parameters
-
nodeManagerId(required): string
The unique identifier of the Node Manager.
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/json
200 Response
The node chains were listed successfully.
Root Schema : schema
Type:
Show Source
array-
Array of:
object NodeChainResponse
The response schema that provides the list of node chains associated with a queried node manager.
Nested Schema : NodeChainResponse
Type:
objectThe response schema that provides the list of node chains associated with a queried node manager.
Show Source
-
nodeChains(required): array
nodeChains
The list of node chains associated with the node manager.
-
nodeManagers(required): array
nodeManagers
The list of node managers associated with nodes in the chain.
-
queryNmId(required): string
The identifier of the queried node manager.
Nested Schema : nodeChains
Type:
arrayThe list of node chains associated with the node manager.
Show Source
-
Array of:
object NodeChainResponseChainItem
The schema that defines information about a node chain included in the node chain response.
Nested Schema : nodeManagers
Type:
arrayThe list of node managers associated with nodes in the chain.
Show Source
-
Array of:
object NodeChainResponseNMItem
Schema defining node manager details associated with a node chain in the list node chains response.
Nested Schema : NodeChainResponseChainItem
Type:
objectThe schema that defines information about a node chain included in the node chain response.
Show Source
-
nmId(required): string
The identifier of the node manager for this chain.
-
nodes(required): array
nodes
The details of the nodes that are part of this node chain.
Nested Schema : nodes
Type:
arrayThe details of the nodes that are part of this node chain.
Show Source
-
Array of:
object NodeChainResponseNodeItem
The schema defining a node's information associated with a node chain which is part of list node chains response.
Nested Schema : NodeChainResponseNodeItem
Type:
objectThe schema defining a node's information associated with a node chain which is part of list node chains response.
Show Source
-
displayName(required): string
The display name of the node.
-
id(required): string
The identifier of the node.
-
nodeType(required): object
nodeType
The node type details of the node.
-
routes(required): array
routes
The details for outgoing routes from the node.
-
startState: boolean
Indicates whether the node is running.
-
testId: string
Identifier of the test this node is part of.
Nested Schema : nodeType
Type:
objectThe node type details of the node.
Match All
The node type details of the node.
Show Source
-
object
NodeChainResponseNodeTypeItem
The schema defining node type information for a node associated with a node chain which is part of list node chains response.
Nested Schema : routes
Type:
arrayThe details for outgoing routes from the node.
Show Source
-
Array of:
object NodeChainResponseRouteAttrs
Schema defining a route's information associated with a node chain which is part of list node chains response
Nested Schema : NodeChainResponseNodeTypeItem
Type:
objectThe schema defining node type information for a node associated with a node chain which is part of list node chains response.
Show Source
-
context(required): string
The context of the node.
-
inputType(required): string
The input type of the node, for example, NAR, TEXT, NA, etc.
-
marketSegment(required): string
The market segment of the node.
-
name(required): string
The name of the node.
-
outputType(required): string
The output type of the node, for example, NAR, TEXT, NA, etc.
-
type(required): string
The type of the node, for example, EI, DC, etc.
Nested Schema : NodeChainResponseRouteAttrs
Type:
objectSchema defining a route's information associated with a node chain which is part of list node chains response
Show Source
-
destNmId(required): string
The identifier destination node's Node Manager.
-
destNodeId(required): string
The identifier of destination node.
-
isRemote(required): boolean
The flag indicating if the route is remote.
-
routingFn(required): string
The routing function used for the channel.
Nested Schema : NodeChainResponseNMItem
Type:
objectSchema defining node manager details associated with a node chain in the list node chains response.
Show Source
-
nmHost(required): string
Hostname at which the node manager is deployed.
-
nmId(required): string
The unique identifier of the node manager for this chain.
-
nmName(required): string
Name of the node manager.
-
nmPort(required): integer
(int32)
Port on which the node manager is listening.
-
nodesCount(required): integer
(int32)
Number of nodes associated with this node manager.
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
The requested resource cannot be found.
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 could not 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 get a list of all node chains in a Node Manager by submitting a GET request on the REST resource using cURL. For more information about cURL, see Use cURL.
curl -X GET 'http://hostname:port/nodeChains/NMGR-31eoh3-16it-m8fkvbje' -d @sampleListAllNodeChains.json
Example of the Response Body
If successful, the response code 200 is returned with the following response body.
{
"nodeChains": [
{
"nmId": "NMGR-31eoh3-16it-m8fkvbje",
"nodes": [
{
"displayName": "cc1",
"id": "31eoh3-16it-m8fn0qbj",
"nodeType": {
"context": "CartridgeKit#EI#FlatFileEINode",
"inputType": "TEXT",
"marketSegment": "CartridgeKit",
"name": "ASCII Collection Cartridge",
"outputType": "NAR",
"type": "CC"
},
"routes": [
{
"destNmId": "NMGR-31eoh6-16it-m8fkvbjc",
"destNodeId": "31eoh6-16it-m8fn2ear",
"isRemote": true,
"routingFn": "Multicast"
}
],
"startState": true,
"testId": "T-c5b4f7b0-901d-4132-8882-e8735badc012"
}
]
},
{
"nmId": "NMGR-31eoh3-16it-m8fkvbje",
"nodes": [
{
"displayName": "cc2",
"id": "31eoh3-16it-m8fn193f",
"nodeType": {
"context": "CartridgeKit#EI#FlatFileEINode",
"inputType": "TEXT",
"marketSegment": "CartridgeKit",
"name": "ASCII Collection Cartridge",
"outputType": "NAR",
"type": "CC"
},
"routes": [],
"startState": false
}
]
},
{
"nmId": "NMGR-31eoh6-16it-m8fkvbjc",
"nodes": [
{
"displayName": "dc",
"id": "31eoh6-16it-m8fn2ear",
"nodeType": {
"context": "CartridgeKit#OI#FFOINode",
"inputType": "NAR",
"marketSegment": "CartridgeKit",
"name": "ASCII Distribution Cartridge",
"outputType": "TEXT",
"type": "DC"
},
"routes": [],
"startState": true,
"testId": "T-c5b4f7b0-901d-4132-8882-e8735badc012"
}
]
}
],
"nodeManagers": [
{
"nmHost": "nm-1-0",
"nmId": "NMGR-31eoh3-16it-m8fkvbje",
"nmName": "nm-1-0",
"nmPort": 55109,
"nodesCount": 2
},
{
"nmHost": "nm-2-0",
"nmId": "NMGR-31eoh6-16it-m8fkvbjc",
"nmName": "nm-2-0",
"nmPort": 55109,
"nodesCount": 1
}
],
"queryNmId": "NMGR-31eoh3-16it-m8fkvbje"
}