title | layout |
---|---|
system.status |
ja |
{% comment %} ############################################## THIS FILE IS AUTOMATICALLY GENERATED FROM "_po/ja/reference/1.0.5/commands/system/status/index.po" DO NOT EDIT THIS FILE MANUALLY! ############################################## {% endcomment %}
- TOC {:toc}
system.status
コマンドは、クラスタの現在の状態を返します。
リクエスト先
: (ドキュメントルート)/droonga/system/status
リクエストメソッド
: GET
リクエストのURLパラメータ : なし。
リクエストのbody : なし。
レスポンスのbody : レスポンスメッセージ。
対応していません。
形式 : Request-Response型。コマンドに対しては必ず対応するレスポンスが返されます。
リクエストの type
: system.status
リクエストの body
: なし。
レスポンスの type
: system.status.result
このコマンドはパラメータを取りません。
このコマンドは各ノードの死活情報を出力します。 例:
{
"type" : "system.status",
"body" : {}
}
=> {
"type" : "system.status.result",
"body" : {
"nodes": {
"192.168.0.10:10031/droonga": {
"live": true
},
"192.168.0.11:10031/droonga": {
"live": false
}
}
}
}
このコマンドは以下のようなハッシュを body
、200
を statusCode
としたレスポンスを返します。以下はその一例です。。
{
"nodes" : {
"<Identifier of the node 1>" : {
"live" : <Vital status of the node>
},
"<Identifier of the node 2>" : { ... },
...
}
}
nodes
: クラスタ内のノードの情報を含むハッシュ。
ハッシュのキーは、catalog.json
で定義された各ノードの識別子(形式は ホスト名:ポート番号/タグ
)です。
ハッシュの値は対応するノードのステータス情報を表し、以下の情報を含んでいます:
live
: そのノードの死活状態を示す真偽値。
true
であれば、そのノードはメッセージを処理する事ができ、他のノードもそのノード宛にメッセージを配送します。
それ以外の場合、そのノードはサービスが停止しているなどの理由によりメッセージを処理しません。
このコマンドは一般的なエラーを返します。