Documentation
Table of Contents
hanode.get
説明
integer/array hanode.get(object parameters)
このメソッドは、指定されたパラメーターに従って High availability cluster node のリストを取得することができます。
このメソッドは、Super admin ユーザータイプにのみ使用できます。このメソッドを呼び出す許可は、ユーザーロール設定で取り消すことができます。
詳細については、User rolesを参照してください。
パラメータ
(object) 希望する出力を定義するパラメータ
このメソッドは、以下のパラメータをサポートしています。
| パラメータ | Type | 説明 |
|---|---|---|
| ha_nodeids | string/array | Return only nodes with the given node IDs. |
| filter | object | Return only those results that exactly match the given filter. Accepts an array, where the keys are property names, and the values are either a single value or an array of values to match against. Allows filtering by the node properties: name, address, status. |
| sortfield | string/array | Sort the result by the given properties. Possible values are: name, lastaccess, status. |
| countOutput | flag | These parameters being common for all get methods are described in detail in the reference commentary. |
| limit | integer | |
| output | query | |
| preservekeys | boolean | |
| sortorder | string/array |
戻り値
(integer/array) 次のいずれかを返します:
- オブジェクトの配列
countOutputパラメーターが使用されている場合、取得したオブジェクトの数
例
ノードのリストを状態順に取得
リクエスト：
{ "jsonrpc": "2.0", "method": "hanode.get", "params": { "preservekeys": true, "sortfield": "status", "sortorder": "DESC" }, "auth": "3a57200802b24cda67c4e4010b50c065", "id": 1 }レスポンス：
{ "jsonrpc": "2.0", "result": { "ckuo7i1nw000h0sajj3l3hh8u": { "ha_nodeid": "ckuo7i1nw000h0sajj3l3hh8u", "name": "node-active", "address": "192.168.1.13", "port": "10051", "lastaccess": "1635335704", "status": "3" }, "ckuo7i1nw000e0sajwfttc1mp": { "ha_nodeid": "ckuo7i1nw000e0sajwfttc1mp", "name": "node6", "address": "192.168.1.10", "port": "10053", "lastaccess": "1635332902", "status": "2" }, "ckuo7i1nv000c0sajz85xcrtt": { "ha_nodeid": "ckuo7i1nv000c0sajz85xcrtt", "name": "node4", "address": "192.168.1.8", "port": "10052", "lastaccess": "1635334214", "status": "1" }, "ckuo7i1nv000a0saj1fcdkeu4": { "ha_nodeid": "ckuo7i1nv000a0saj1fcdkeu4", "name": "node2", "address": "192.168.1.6", "port": "10051", "lastaccess": "1635335705", "status": "0" } }, "id": 1 }特定のノードのIDによるリストの取得
リクエスト：
{ "jsonrpc": "2.0", "method": "hanode.get", "params": { "ha_nodeids": ["ckuo7i1nw000e0sajwfttc1mp", "ckuo7i1nv000c0sajz85xcrtt"] }, "auth": "3a57200802b24cda67c4e4010b50c065", "id": 1 }レスポンス：
{ "jsonrpc": "2.0", "result": [ { "ha_nodeid": "ckuo7i1nv000c0sajz85xcrtt", "name": "node4", "address": "192.168.1.8", "port": "10052", "lastaccess": "1635334214", "status": "1" }, { "ha_nodeid": "ckuo7i1nw000e0sajwfttc1mp", "name": "node6", "address": "192.168.1.10", "port": "10053", "lastaccess": "1635332902", "status": "2" } ], "id": 1 }停止しているノードのリストを取得
リクエスト：
{ "jsonrpc": "2.0", "method": "hanode.get", "params": { "output": ["ha_nodeid", "address", "port"], "filter": { "status": 1 } }, "auth": "3a57200802b24cda67c4e4010b50c065", "id": 1 }レスポンス：
{ "jsonrpc": "2.0", "result": [ { "ha_nodeid": "ckuo7i1nw000g0sajjsjre7e3", "address": "192.168.1.12", "port": "10051" }, { "ha_nodeid": "ckuo7i1nv000c0sajz85xcrtt", "address": "192.168.1.8", "port": "10052" }, { "ha_nodeid": "ckuo7i1nv000d0sajd95y1b6x", "address": "192.168.1.9", "port": "10053" } ], "id": 1 }待機ノード数の取得
リクエスト：
{ "jsonrpc": "2.0", "method": "hanode.get", "params": { "countOutput": true, "filter": { "status": 0 } }, "auth": "3a57200802b24cda67c4e4010b50c065", "id": 1 }レスポンス：
特定のIPアドレスのノードの状態を確認
リクエスト：
{ "jsonrpc": "2.0", "method": "hanode.get", "params": { "output": ["name", "status"], "filter": { "address": ["192.168.1.7", "192.168.1.13"] } }, "auth": "3a57200802b24cda67c4e4010b50c065", "id": 1 }レスポンス：
{ "jsonrpc": "2.0", "result": [ { "name": "node3", "status": "0" }, { "name": "node-active", "status": "3" } ], "id": 1 }ソース
CHaNode::get() in ui/include/classes/api/services/CHaNode.php.