Management API Reference for node

Runtime representation of a mod_cluster node

Stability Level: default

Children (1)

context

Attributes (17)

aliases - The nodes aliases

Type	LIST
Is the attribute nillable?	true
Where is the attribute stored?	runtime
Access Type	read-only
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "LIST" }, "description" : "The nodes aliases", "expressions-allowed" : false, "required" : false, "nillable" : true, "min-length" : 0, "max-length" : 2147483647, "stability" : "default", "value-type" : { "TYPE_MODEL_VALUE" : "STRING" }, "access-type" : "read-only", "storage" : "runtime", "restart-required" : null, "capability-reference" : null }`

cache-connections - The number of connections to keep alive indefinitely

Type	INT
Is the attribute nillable?	true
Where is the attribute stored?	runtime
Access Type	read-only
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "INT" }, "description" : "The number of connections to keep alive indefinitely", "expressions-allowed" : false, "required" : false, "nillable" : true, "stability" : "default", "access-type" : "read-only", "storage" : "runtime", "restart-required" : null, "capability-reference" : null }`

elected - The elected count

Type	INT
Is the attribute nillable?	true
Where is the attribute stored?	runtime
Access Type	read-only
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "INT" }, "description" : "The elected count", "expressions-allowed" : false, "required" : false, "nillable" : true, "stability" : "default", "access-type" : "read-only", "storage" : "runtime", "restart-required" : null, "capability-reference" : null }`

flush-packets - If received data should be immediately flushed

Type	BOOLEAN
Is the attribute nillable?	true
Where is the attribute stored?	runtime
Access Type	read-only
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "BOOLEAN" }, "description" : "If received data should be immediately flushed", "expressions-allowed" : false, "required" : false, "nillable" : true, "stability" : "default", "access-type" : "read-only", "storage" : "runtime", "restart-required" : null, "capability-reference" : null }`

load - The current load of this node

Type	INT
Is the attribute nillable?	true
Where is the attribute stored?	runtime
Access Type	read-only
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "INT" }, "description" : "The current load of this node", "expressions-allowed" : false, "required" : false, "nillable" : true, "stability" : "default", "access-type" : "read-only", "storage" : "runtime", "restart-required" : null, "capability-reference" : null }`

load-balancing-group - The load balancing group this node belongs to

Type	STRING
Is the attribute nillable?	true
Where is the attribute stored?	runtime
Access Type	read-only
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "The load balancing group this node belongs to", "expressions-allowed" : false, "required" : false, "nillable" : true, "min-length" : 1, "max-length" : 2147483647, "stability" : "default", "access-type" : "read-only", "storage" : "runtime", "restart-required" : null, "capability-reference" : null }`

max-connections - The maximum number of connections per IO thread

Type	INT
Is the attribute nillable?	true
Where is the attribute stored?	runtime
Access Type	read-only
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "INT" }, "description" : "The maximum number of connections per IO thread", "expressions-allowed" : false, "required" : false, "nillable" : true, "stability" : "default", "access-type" : "read-only", "storage" : "runtime", "restart-required" : null, "capability-reference" : null }`

open-connections - The current number of open connections

Type	INT
Is the attribute nillable?	true
Where is the attribute stored?	runtime
Access Type	read-only
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "INT" }, "description" : "The current number of open connections", "expressions-allowed" : false, "required" : false, "nillable" : true, "stability" : "default", "access-type" : "read-only", "storage" : "runtime", "restart-required" : null, "capability-reference" : null }`

ping - The nodes ping

Type	INT
Is the attribute nillable?	true
Where is the attribute stored?	runtime
Access Type	read-only
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "INT" }, "description" : "The nodes ping", "expressions-allowed" : false, "required" : false, "nillable" : true, "stability" : "default", "access-type" : "read-only", "storage" : "runtime", "restart-required" : null, "capability-reference" : null }`

queue-new-requests - If a request is received and there is no worker immediately available should it be queued

Type	BOOLEAN
Is the attribute nillable?	true
Where is the attribute stored?	runtime
Access Type	read-only
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "BOOLEAN" }, "description" : "If a request is received and there is no worker immediately available should it be queued", "expressions-allowed" : false, "required" : false, "nillable" : true, "stability" : "default", "access-type" : "read-only", "storage" : "runtime", "restart-required" : null, "capability-reference" : null }`

read - The number of bytes read from the node

Type	LONG
Unit	BYTES
Is the attribute nillable?	true
Where is the attribute stored?	runtime
Access Type	read-only
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "LONG" }, "description" : "The number of bytes read from the node", "expressions-allowed" : false, "required" : false, "nillable" : true, "unit" : "BYTES", "stability" : "default", "access-type" : "read-only", "storage" : "runtime", "restart-required" : null, "capability-reference" : null }`

request-queue-size - The size of the request queue

Type	INT
Is the attribute nillable?	true
Where is the attribute stored?	runtime
Access Type	read-only
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "INT" }, "description" : "The size of the request queue", "expressions-allowed" : false, "required" : false, "nillable" : true, "stability" : "default", "access-type" : "read-only", "storage" : "runtime", "restart-required" : null, "capability-reference" : null }`

status - The current status of this node

Type	STRING
Is the attribute nillable?	true
Where is the attribute stored?	runtime
Access Type	read-only
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "The current status of this node", "expressions-allowed" : false, "required" : false, "nillable" : true, "min-length" : 1, "max-length" : 2147483647, "stability" : "default", "access-type" : "read-only", "storage" : "runtime", "restart-required" : null, "capability-reference" : null }`

timeout - The request timeout

Type	INT
Unit	SECONDS
Is the attribute nillable?	true
Where is the attribute stored?	runtime
Access Type	read-only
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "INT" }, "description" : "The request timeout", "expressions-allowed" : false, "required" : false, "nillable" : true, "unit" : "SECONDS", "stability" : "default", "access-type" : "read-only", "storage" : "runtime", "restart-required" : null, "capability-reference" : null }`

ttl - The time connections will stay alive with no requests before being closed, if the number of connections is larger than cache-connections

Type	LONG
Is the attribute nillable?	true
Where is the attribute stored?	runtime
Access Type	read-only
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "LONG" }, "description" : "The time connections will stay alive with no requests before being closed, if the number of connections is larger than cache-connections", "expressions-allowed" : false, "required" : false, "nillable" : true, "stability" : "default", "access-type" : "read-only", "storage" : "runtime", "restart-required" : null, "capability-reference" : null }`

uri - The URI that the load balancer uses to connect to the node

Type	STRING
Is the attribute nillable?	true
Where is the attribute stored?	runtime
Access Type	read-only
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "The URI that the load balancer uses to connect to the node", "expressions-allowed" : false, "required" : false, "nillable" : true, "min-length" : 1, "max-length" : 2147483647, "stability" : "default", "access-type" : "read-only", "storage" : "runtime", "restart-required" : null, "capability-reference" : null }`

written - The number of bytes transferred to the node

Type	LONG
Unit	BYTES
Is the attribute nillable?	true
Where is the attribute stored?	runtime
Access Type	read-only
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "LONG" }, "description" : "The number of bytes transferred to the node", "expressions-allowed" : false, "required" : false, "nillable" : true, "unit" : "BYTES", "stability" : "default", "access-type" : "read-only", "storage" : "runtime", "restart-required" : null, "capability-reference" : null }`

Operations (3)

disable - Disables all contexts on this node

Raw DMR model


{
    "operation-name" : "disable",
    "description" : "Disables all contexts on this node",
    "request-properties" : {},
    "reply-properties" : {},
    "stability" : "default",
    "read-only" : false,
    "runtime-only" : true
}

enable - Enables all contexts on this node

Raw DMR model


{
    "operation-name" : "enable",
    "description" : "Enables all contexts on this node",
    "request-properties" : {},
    "reply-properties" : {},
    "stability" : "default",
    "read-only" : false,
    "runtime-only" : true
}

stop - Stops all contests on this node

Raw DMR model


{
    "operation-name" : "stop",
    "description" : "Stops all contests on this node",
    "request-properties" : {},
    "reply-properties" : {},
    "stability" : "default",
    "read-only" : false,
    "runtime-only" : true
}