Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add description for the "status" command
- Loading branch information
Showing
5 changed files
with
227 additions
and
2 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,115 @@ | ||
| --- | ||
| title: status | ||
| layout: ja | ||
| --- | ||
|
|
||
| {% comment %} | ||
| ############################################## | ||
| THIS FILE IS AUTOMATICALLY GENERATED FROM | ||
| "_po/ja/reference/1.0.4/commands/status/index.po" | ||
| DO NOT EDIT THIS FILE MANUALLY! | ||
| ############################################## | ||
| {% endcomment %} | ||
|
|
||
|
|
||
| * TOC | ||
| {:toc} | ||
|
|
||
| ## 概要 {#abstract} | ||
|
|
||
| `statu` コマンドは、クラスタの現在の状態を返します。 | ||
|
|
||
| ## APIの形式 {#api-types} | ||
|
|
||
| ### HTTP {#api-types-http} | ||
|
|
||
| リクエスト先 | ||
| : `(ドキュメントルート)/droonga/status` | ||
|
|
||
| リクエストメソッド | ||
| : `GET` | ||
|
|
||
| リクエストのURLパラメータ | ||
| : なし。 | ||
|
|
||
| リクエストのbody | ||
| : なし。 | ||
|
|
||
| レスポンスのbody | ||
| : [レスポンスメッセージ](#response)。 | ||
|
|
||
| ### REST {#api-types-rest} | ||
|
|
||
| 対応していません。 | ||
|
|
||
| ### Fluentd {#api-types-fluentd} | ||
|
|
||
| 形式 | ||
| : Request-Response型。コマンドに対しては必ず対応するレスポンスが返されます。 | ||
|
|
||
| リクエストの `type` | ||
| : `status` | ||
|
|
||
| リクエストの `body` | ||
| : なし。 | ||
|
|
||
| レスポンスの `type` | ||
| : `status.result` | ||
|
|
||
| ## パラメータの構文 {#syntax} | ||
|
|
||
| このコマンドはパラメータを取りません。 | ||
|
|
||
| ## 使い方 {#usage} | ||
|
|
||
| On the version {{ site.droonga_version }}, this command just reports the list of nodes and their vital information. | ||
| For example: | ||
|
|
||
| { | ||
| "type" : "status", | ||
| "body" : {} | ||
| } | ||
|
|
||
| => { | ||
| "type" : "status.result", | ||
| "body" : { | ||
| "nodes": { | ||
| "192.168.0.10:10031/droonga": { | ||
| "live": true | ||
| }, | ||
| "192.168.0.11:10031/droonga": { | ||
| "live": false | ||
| } | ||
| } | ||
| } | ||
| } | ||
|
|
||
|
|
||
| ## レスポンス {#response} | ||
|
|
||
| This returns a hash like following as the response's `body`, with `200` as its `statusCode`. | ||
|
|
||
| { | ||
| "nodes" : { | ||
| "<Identifier of the node 1>" : { | ||
| "live" : <Vital status of the node> | ||
| }, | ||
| "<Identifier of the node 2>" : { ... }, | ||
| ... | ||
| } | ||
| } | ||
|
|
||
| `nodes` | ||
| : A hash including information of nodes in the cluster. | ||
| Keys of the hash are identifiers of nodes defined in the `catalog.json`, with the format: `hostname:port/tag`. | ||
| Each value indicates status information of corresponding node, and have following information: | ||
|
|
||
| `live` | ||
| : A boolean value indicating vital state of the node. | ||
| If `true`, the node can process messages, and messages are delivered to it. | ||
| Otherwise, the node doesn't process any message for now, because it is down or some reasons. | ||
|
|
||
|
|
||
| ## エラーの種類 {#errors} | ||
|
|
||
| This command reports [general errors](/reference/message/#error). |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,106 @@ | ||
| --- | ||
| title: status | ||
| layout: en | ||
| --- | ||
|
|
||
| * TOC | ||
| {:toc} | ||
|
|
||
| ## Abstract {#abstract} | ||
|
|
||
| The `status` command reports current status of the clsuter itself. | ||
|
|
||
| ## API types {#api-types} | ||
|
|
||
| ### HTTP {#api-types-http} | ||
|
|
||
| Request endpoint | ||
| : `(Document Root)/droonga/status` | ||
|
|
||
| Request methd | ||
| : `GET` | ||
|
|
||
| Request URL parameters | ||
| : Nothing. | ||
|
|
||
| Request body | ||
| : Nothing. | ||
|
|
||
| Response body | ||
| : A [response message](#response). | ||
|
|
||
| ### REST {#api-types-rest} | ||
|
|
||
| Not supported. | ||
|
|
||
| ### Fluentd {#api-types-fluentd} | ||
|
|
||
| Style | ||
| : Request-Response. One response message is always returned per one request. | ||
|
|
||
| `type` of the request | ||
| : `status` | ||
|
|
||
| `body` of the request | ||
| : Nothing. | ||
|
|
||
| `type` of the response | ||
| : `status.result` | ||
|
|
||
| ## Parameter syntax {#syntax} | ||
|
|
||
| This command has no parameter. | ||
|
|
||
| ## Usage {#usage} | ||
|
|
||
| On the version {{ site.droonga_version }}, this command just reports the list of nodes and their vital information. | ||
| For example: | ||
|
|
||
| { | ||
| "type" : "status", | ||
| "body" : {} | ||
| } | ||
|
|
||
| => { | ||
| "type" : "status.result", | ||
| "body" : { | ||
| "nodes": { | ||
| "192.168.0.10:10031/droonga": { | ||
| "live": true | ||
| }, | ||
| "192.168.0.11:10031/droonga": { | ||
| "live": false | ||
| } | ||
| } | ||
| } | ||
| } | ||
|
|
||
|
|
||
| ## Responses {#response} | ||
|
|
||
| This returns a hash like following as the response's `body`, with `200` as its `statusCode`. | ||
|
|
||
| { | ||
| "nodes" : { | ||
| "<Identifier of the node 1>" : { | ||
| "live" : <Vital status of the node> | ||
| }, | ||
| "<Identifier of the node 2>" : { ... }, | ||
| ... | ||
| } | ||
| } | ||
|
|
||
| `nodes` | ||
| : A hash including information of nodes in the cluster. | ||
| Keys of the hash are identifiers of nodes defined in the `catalog.json`, with the format: `hostname:port/tag`. | ||
| Each value indicates status information of corresponding node, and have following information: | ||
|
|
||
| `live` | ||
| : A boolean value indicating vital state of the node. | ||
| If `true`, the node can process messages, and messages are delivered to it. | ||
| Otherwise, the node doesn't process any message for now, because it is down or some reasons. | ||
|
|
||
|
|
||
| ## Error types {#errors} | ||
|
|
||
| This command reports [general errors](/reference/message/#error). |