61 lines
2.5 KiB
JSON
61 lines
2.5 KiB
JSON
{
|
|
"LINKS": {
|
|
"summary": "Returns a list of all TCP links to and from peer nodes.",
|
|
"complexity": "O(N) where N is the total number of Cluster nodes",
|
|
"group": "cluster",
|
|
"since": "7.0.0",
|
|
"arity": 2,
|
|
"container": "CLUSTER",
|
|
"function": "clusterCommand",
|
|
"command_flags": [
|
|
"STALE"
|
|
],
|
|
"command_tips": [
|
|
"NONDETERMINISTIC_OUTPUT"
|
|
],
|
|
"reply_schema": {
|
|
"description": "An array of cluster links and their attributes.",
|
|
"type": "array",
|
|
"items": {
|
|
"type": "object",
|
|
"properties": {
|
|
"direction": {
|
|
"description": "This link is established by the local node _to_ the peer, or accepted by the local node _from_ the peer.",
|
|
"oneOf": [
|
|
{
|
|
"description": "Connection initiated from peer.",
|
|
"const": "from"
|
|
},
|
|
{
|
|
"description": "Connection initiated to peer.",
|
|
"const": "to"
|
|
}
|
|
]
|
|
},
|
|
"node": {
|
|
"description": "The node id of the peer.",
|
|
"type": "string"
|
|
},
|
|
"create-time": {
|
|
"description": "Unix time creation time of the link. (In the case of a _to_ link, this is the time when the TCP link is created by the local node, not the time when it is actually established.)",
|
|
"type": "integer"
|
|
},
|
|
"events": {
|
|
"description": "Events currently registered for the link. r means readable event, w means writable event.",
|
|
"type": "string"
|
|
},
|
|
"send-buffer-allocated": {
|
|
"description": "Allocated size of the link's send buffer, which is used to buffer outgoing messages toward the peer.",
|
|
"type": "integer"
|
|
},
|
|
"send-buffer-used": {
|
|
"description": "Size of the portion of the link's send buffer that is currently holding data(messages).",
|
|
"type": "integer"
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
}
|
|
}
|
|
}
|
|
}
|