mirror of
https://github.com/XRPLF/xrpl-dev-portal.git
synced 2025-12-01 09:05:49 +00:00
[JA] replaceサーバー to サーバ
This commit is contained in:
@@ -2,15 +2,15 @@
|
||||
html: admin-api-methods.html
|
||||
parent: http-websocket-apis.html
|
||||
seo:
|
||||
description: これらの管理APIメソッドを使用してrippledサーバーを管理します。
|
||||
description: これらの管理APIメソッドを使用してrippledサーバを管理します。
|
||||
labels:
|
||||
- コアサーバー
|
||||
- コアサーバ
|
||||
---
|
||||
# 管理APIメソッド
|
||||
|
||||
`rippled`サーバーと直接通信する際には管理APIメソッドを使用します。管理メソッドは、信頼できるサーバー運用担当者のみを対象としています。管理メソッドには、サーバーの管理、監視、デバッグのためのコマンドが含まれています。
|
||||
`rippled`サーバと直接通信する際には管理APIメソッドを使用します。管理メソッドは、信頼できるサーバ運用担当者のみを対象としています。管理メソッドには、サーバの管理、監視、デバッグのためのコマンドが含まれています。
|
||||
|
||||
管理コマンドを使用できるのは、管理者として、`rippled.cfg`ファイルに指定されているホストとポートで`rippled`サーバーに接続している場合に限られます。デフォルトでは、コマンドラインクライアントが管理接続を使用します。`rippled`への接続についての詳細は、[rippled API入門](../../../tutorials/http-websocket-apis/build-apps/get-started.md)を参照してください。
|
||||
管理コマンドを使用できるのは、管理者として、`rippled.cfg`ファイルに指定されているホストとポートで`rippled`サーバに接続している場合に限られます。デフォルトでは、コマンドラインクライアントが管理接続を使用します。`rippled`への接続についての詳細は、[rippled API入門](../../../tutorials/http-websocket-apis/build-apps/get-started.md)を参照してください。
|
||||
|
||||
|
||||
## [キー生成メソッド](key-generation-methods/index.md)
|
||||
@@ -28,30 +28,30 @@ labels:
|
||||
* **[`can_delete`](logging-and-data-management-methods/can_delete.md)** - 特定レジャーまでのレジャーのオンライン削除を許可します。
|
||||
* **[`download_shard`](logging-and-data-management-methods/download_shard.md)** - レジャー履歴の特定のシャードをダウンロードします。
|
||||
* **[`ledger_cleaner`](logging-and-data-management-methods/ledger_cleaner.md)** - レジャークリーナーサービスが破損データを確認するように設定します。
|
||||
* **[`ledger_request`](logging-and-data-management-methods/ledger_request.md)** - ピアサーバーに対し特定のレジャーバージョンを照会します。
|
||||
* **[`ledger_request`](logging-and-data-management-methods/ledger_request.md)** - ピアサーバに対し特定のレジャーバージョンを照会します。
|
||||
* **[`log_level`](logging-and-data-management-methods/log_level.md)** - ログの詳細レベルを取得または変更します。
|
||||
* **[`logrotate`](logging-and-data-management-methods/logrotate.md)** - ログファイルを再度開きます。
|
||||
|
||||
|
||||
## [サーバー制御メソッド](server-control-methods/index.md)
|
||||
## [サーバ制御メソッド](server-control-methods/index.md)
|
||||
|
||||
rippledサーバーの管理には、以下のメソッドを使用します。
|
||||
rippledサーバの管理には、以下のメソッドを使用します。
|
||||
|
||||
* **[`connect`](peer-management-methods/connect.md)** - rippledサーバーを特定のピアに強制的に接続します。
|
||||
* **[`connect`](peer-management-methods/connect.md)** - rippledサーバを特定のピアに強制的に接続します。
|
||||
* **[`ledger_accept`](server-control-methods/ledger_accept.md)** - スタンドアロンモードでレジャーを閉鎖し、次のレジャーに進みます。
|
||||
* **[`stop`](server-control-methods/stop.md)** - rippledサーバーをシャットダウンします。
|
||||
* **[`stop`](server-control-methods/stop.md)** - rippledサーバをシャットダウンします。
|
||||
* **[`validation_seed`](server-control-methods/validation_seed.md)** - 検証に使用するキーを一時的に設定します。
|
||||
|
||||
|
||||
## [ステータスおよびデバッグメソッド](status-and-debugging-methods/index.md)
|
||||
|
||||
ネットワークとサーバーのステータスを確認するには、以下のメソッドを使用します。
|
||||
ネットワークとサーバのステータスを確認するには、以下のメソッドを使用します。
|
||||
|
||||
* **[`consensus_info`](status-and-debugging-methods/consensus_info.md)** - 発生したコンセンサスの状態に関する情報を取得します。
|
||||
* **[`feature`](status-and-debugging-methods/feature.md)** - プロトコルAmendmentに関する情報を取得します。
|
||||
* **[`fetch_info`](status-and-debugging-methods/fetch_info.md)** - サーバーとネットワークの同期に関する情報を取得します。
|
||||
* **[`get_counts`](status-and-debugging-methods/get_counts.md)** - サーバー内部とメモリー使用状況に関する統計情報を取得します。
|
||||
* **[`peers`](peer-management-methods/peers.md)** - 接続しているピアサーバーに関する情報を取得します。
|
||||
* **[`fetch_info`](status-and-debugging-methods/fetch_info.md)** - サーバとネットワークの同期に関する情報を取得します。
|
||||
* **[`get_counts`](status-and-debugging-methods/get_counts.md)** - サーバ内部とメモリー使用状況に関する統計情報を取得します。
|
||||
* **[`peers`](peer-management-methods/peers.md)** - 接続しているピアサーバに関する情報を取得します。
|
||||
* **[`print`](status-and-debugging-methods/print.md)** - 内部サブシステムに関する情報を取得します。
|
||||
* **[`validators`](status-and-debugging-methods/validators.md)** - 現在のバリデータに関する情報を取得します。
|
||||
* **[`validator_list_sites`](status-and-debugging-methods/validator_list_sites.md)** - バリデータリストを公開するサイトに関する情報を取得します。
|
||||
|
||||
@@ -2,21 +2,21 @@
|
||||
html: validation_create.html
|
||||
parent: key-generation-methods.html
|
||||
seo:
|
||||
description: rippledサーバーがネットワークに対して自身の身元を識別させるのに使用できる暗号鍵を生成します。
|
||||
description: rippledサーバがネットワークに対して自身の身元を識別させるのに使用できる暗号鍵を生成します。
|
||||
labels:
|
||||
- セキュリティ
|
||||
- コアサーバー
|
||||
- コアサーバ
|
||||
---
|
||||
# validation_create
|
||||
[[ソース]](https://github.com/XRPLF/rippled/blob/315a8b6b602798a4cff4d8e1911936011e12abdb/src/ripple/rpc/handlers/ValidationCreate.cpp "Source")
|
||||
|
||||
`validation_create`コマンドキーを使用して、[`rippled`サーバーがネットワークに対して自身の身元を識別させるのに使用できる暗号鍵](../../../../concepts/networks-and-servers/peer-protocol.md#ノードキーペア)を生成します。[wallet_proposeメソッド][]と同様に、このメソッドでは適切なフォーマットで一連のキーが単に生成されるだけです。XRP Ledgerのデータやサーバー構成は変更されません。
|
||||
`validation_create`コマンドキーを使用して、[`rippled`サーバがネットワークに対して自身の身元を識別させるのに使用できる暗号鍵](../../../../concepts/networks-and-servers/peer-protocol.md#ノードキーペア)を生成します。[wallet_proposeメソッド][]と同様に、このメソッドでは適切なフォーマットで一連のキーが単に生成されるだけです。XRP Ledgerのデータやサーバ構成は変更されません。
|
||||
|
||||
_`validation_create`メソッドは、権限のないユーザーは実行できない[管理メソッド](../index.md)です。_
|
||||
|
||||
サーバーを設定することにより、生成されたキーペアを検証の署名(検証キーペア)に使用するか、または通常のピアツーピア通信の署名([ノードキーペア](../../../../concepts/networks-and-servers/peer-protocol.md#ノードキーペア))に使用するかを指定できます。
|
||||
サーバを設定することにより、生成されたキーペアを検証の署名(検証キーペア)に使用するか、または通常のピアツーピア通信の署名([ノードキーペア](../../../../concepts/networks-and-servers/peer-protocol.md#ノードキーペア))に使用するかを指定できます。
|
||||
|
||||
**ヒント:** 堅牢なバリデータを設定するには、`validator-keys`ツール(`rippled` RPMに付属)を使用してバリデータトークン(ローテーション可能)とオフラインマスターキーを生成してください。詳細は、[rippledサーバーで検証を有効化](../../../../infrastructure/configuration/server-modes/run-rippled-as-a-validator.md#3-rippledサーバーで検証を有効化)を参照してください。
|
||||
**ヒント:** 堅牢なバリデータを設定するには、`validator-keys`ツール(`rippled` RPMに付属)を使用してバリデータトークン(ローテーション可能)とオフラインマスターキーを生成してください。詳細は、[rippledサーバで検証を有効化](../../../../infrastructure/configuration/server-modes/run-rippled-as-a-validator.md#3-rippledサーバで検証を有効化)を参照してください。
|
||||
|
||||
|
||||
### リクエストのフォーマット
|
||||
|
||||
@@ -9,7 +9,7 @@ labels:
|
||||
# can_delete
|
||||
[[ソース]](https://github.com/XRPLF/rippled/blob/master/src/ripple/rpc/handlers/CanDelete.cpp "Source")
|
||||
|
||||
`can_delete`メソッドは[指示による削除が有効なオンライン削除](../../../../infrastructure/configuration/data-retention/online-deletion.md#指示による削除)を使用する`rippled`サーバーに削除が可能のレジャーバージョンを通知します。指定したレジャーバージョン以前が削除可能になります。指示による削除が有効ではない場合、このメソッドは何も行いません。
|
||||
`can_delete`メソッドは[指示による削除が有効なオンライン削除](../../../../infrastructure/configuration/data-retention/online-deletion.md#指示による削除)を使用する`rippled`サーバに削除が可能のレジャーバージョンを通知します。指定したレジャーバージョン以前が削除可能になります。指示による削除が有効ではない場合、このメソッドは何も行いません。
|
||||
|
||||
_`can_delete`メソッドは、権限のないユーザーは実行できない[管理メソッド](../index.md)です。_
|
||||
|
||||
@@ -55,7 +55,7 @@ rippled can_delete 11320417
|
||||
|
||||
| `Field` | 型 | 説明 |
|
||||
|:-------------|:------------------|:------------------------------------------|
|
||||
| `can_delete` | 文字列 または整数 | _(省略可)_ 削除可能な最大レジャーバージョンの[レジャーインデックス][]。特殊ケース`never`を指定すると、オンライン削除が無効になります。特殊ケース`always`を指定すると、指示による削除が無効な場合と同様に、自動オンライン削除が有効になります。特殊ケース`now`を指定すると、設定されている`online_delete`値に一致するかまたはこの値を超える次の検証済みレジャーで、オンライン削除が1回実行されます。省略すると、サーバーは変更を行いません(ただし現在の`can_delete`の値でレスポンスします)。 |
|
||||
| `can_delete` | 文字列 または整数 | _(省略可)_ 削除可能な最大レジャーバージョンの[レジャーインデックス][]。特殊ケース`never`を指定すると、オンライン削除が無効になります。特殊ケース`always`を指定すると、指示による削除が無効な場合と同様に、自動オンライン削除が有効になります。特殊ケース`now`を指定すると、設定されている`online_delete`値に一致するかまたはこの値を超える次の検証済みレジャーで、オンライン削除が1回実行されます。省略すると、サーバは変更を行いません(ただし現在の`can_delete`の値でレスポンスします)。 |
|
||||
|
||||
### レスポンスのフォーマット
|
||||
|
||||
@@ -71,9 +71,9 @@ rippled can_delete 11320417
|
||||
|
||||
- [汎用エラータイプ][]のすべて。
|
||||
- `invalidParams` - 1つ以上のフィールドの指定が正しくないか、1つ以上の必須フィールドが指定されていません。
|
||||
- `lgrNotFound` リクエストの`can_delete`フィールドに指定されているレジャーが存在しないか、存在しているがサーバーにはありません。
|
||||
- `notEnabled` - オンライン削除または指示による削除のいずれかがサーバーの設定で有効になっていない場合。
|
||||
- `notReady` - サーバーは現在オンライン削除を実行する準備ができていません。これは通常、サーバーが起動したが、検証済みレジャーをまだ取得していないことを意味します。
|
||||
- `lgrNotFound` リクエストの`can_delete`フィールドに指定されているレジャーが存在しないか、存在しているがサーバにはありません。
|
||||
- `notEnabled` - オンライン削除または指示による削除のいずれかがサーバの設定で有効になっていない場合。
|
||||
- `notReady` - サーバは現在オンライン削除を実行する準備ができていません。これは通常、サーバが起動したが、検証済みレジャーをまだ取得していないことを意味します。
|
||||
|
||||
## 参照項目
|
||||
|
||||
|
||||
@@ -10,7 +10,7 @@ labels:
|
||||
|
||||
[[ソース]](https://github.com/XRPLF/rippled/blob/master/src/ripple/rpc/handlers/CrawlShards.cpp "Source")
|
||||
|
||||
使用可能な[履歴レジャーデータのシャード](../../../../infrastructure/configuration/data-retention/history-sharding.md)に関するピアサーバーからの情報をリクエストします。{% badge href="https://github.com/XRPLF/rippled/releases/tag/1.2.0" %}新規: rippled 1.2.0{% /badge %}
|
||||
使用可能な[履歴レジャーデータのシャード](../../../../infrastructure/configuration/data-retention/history-sharding.md)に関するピアサーバからの情報をリクエストします。{% badge href="https://github.com/XRPLF/rippled/releases/tag/1.2.0" %}新規: rippled 1.2.0{% /badge %}
|
||||
|
||||
_`crawl_shards`メソッドは、権限のないユーザーは実行できない[管理メソッド](../index.md)です。_
|
||||
|
||||
@@ -52,10 +52,10 @@ _`crawl_shards`メソッドは、権限のないユーザーは実行できな
|
||||
|
||||
| `Field` | 型 | 説明 |
|
||||
|:---------|:--------|:--------------------------------------------------------|
|
||||
| `pubkey` | ブール値 | _(省略可)_ `true`の場合、レスポンスには、クロールされたサーバーのノード公開鍵(ピアツーピア通信用)が含まれます。デフォルトは`false`です。 |
|
||||
| `pubkey` | ブール値 | _(省略可)_ `true`の場合、レスポンスには、クロールされたサーバのノード公開鍵(ピアツーピア通信用)が含まれます。デフォルトは`false`です。 |
|
||||
| `limit` | 数値 | _(省略可)_ 検索の深さを示すホップ数。デフォルトは0で、ダイレクトピアのみを検索します。`1`を制限値にすると、ピアのピアも検索します。最大値は`3`です。 |
|
||||
|
||||
**注意:** `limit`が増加すると、検索される可能性のあるピアの数は、指数関数的に増加します。2または3を制限値にすると、サーバーがAPIリクエストにレスポンスするのに数秒かかる場合があります。
|
||||
**注意:** `limit`が増加すると、検索される可能性のあるピアの数は、指数関数的に増加します。2または3を制限値にすると、サーバがAPIリクエストにレスポンスするのに数秒かかる場合があります。
|
||||
|
||||
|
||||
### レスポンスのフォーマット
|
||||
@@ -117,12 +117,12 @@ _`crawl_shards`メソッドは、権限のないユーザーは実行できな
|
||||
|
||||
| `Field` | 型 | 説明 |
|
||||
|:------------------|:-------|:------------------------------------------------|
|
||||
| `complete_shards` | 文字列 | _(省略可)_ ローカルサーバーで利用可能な[履歴シャード](../../../../infrastructure/configuration/data-retention/history-sharding.md)の範囲。これは、空の文字列か、または連続していない範囲である場合があります。たとえば、`1-2,5,7-9`は、シャード1、2、5、7、8、9が利用可能であることを示します。このサーバーで履歴シャーディングが有効になっていない場合は省略されます。 |
|
||||
| `complete_shards` | 文字列 | _(省略可)_ ローカルサーバで利用可能な[履歴シャード](../../../../infrastructure/configuration/data-retention/history-sharding.md)の範囲。これは、空の文字列か、または連続していない範囲である場合があります。たとえば、`1-2,5,7-9`は、シャード1、2、5、7、8、9が利用可能であることを示します。このサーバで履歴シャーディングが有効になっていない場合は省略されます。 |
|
||||
| `peers` | 配列 | 各ピアが使用可能な履歴シャードを表す**ピアシャードオブジェクト**のリスト(以下を参照)。 |
|
||||
|
||||
#### ピアシャードオブジェクト
|
||||
|
||||
レスポンスの`peers`配列のメンバーはそれぞれ、ピアツーピアネットワーク内の1つのサーバーを表すオブジェクトです。リストには、少なくとも1つの完全な[履歴シャード](../../../../infrastructure/configuration/data-retention/history-sharding.md)が使用可能なピアのみが含まれます。配列の各オブジェクトには以下のフィールドが含まれます。
|
||||
レスポンスの`peers`配列のメンバーはそれぞれ、ピアツーピアネットワーク内の1つのサーバを表すオブジェクトです。リストには、少なくとも1つの完全な[履歴シャード](../../../../infrastructure/configuration/data-retention/history-sharding.md)が使用可能なピアのみが含まれます。配列の各オブジェクトには以下のフィールドが含まれます。
|
||||
|
||||
|
||||
| `Field` | 型 | 説明 |
|
||||
|
||||
@@ -9,13 +9,13 @@ labels:
|
||||
# download_shard
|
||||
[[ソース]](https://github.com/XRPLF/rippled/blob/master/src/ripple/rpc/handlers/DownloadShard.cpp "Source")
|
||||
|
||||
サーバーに対し、外部ソースから特定の[履歴レジャーデータのシャード](../../../../infrastructure/configuration/data-retention/history-sharding.md)をダウンロードするように指示します。`rippled`サーバーで[履歴シャードが保管されるように設定する](../../../../infrastructure/configuration/data-retention/configure-history-sharding.md)必要があります。{% badge href="https://github.com/XRPLF/rippled/releases/tag/1.1.0" %}新規: rippled 1.1.0{% /badge %}
|
||||
サーバに対し、外部ソースから特定の[履歴レジャーデータのシャード](../../../../infrastructure/configuration/data-retention/history-sharding.md)をダウンロードするように指示します。`rippled`サーバで[履歴シャードが保管されるように設定する](../../../../infrastructure/configuration/data-retention/configure-history-sharding.md)必要があります。{% badge href="https://github.com/XRPLF/rippled/releases/tag/1.1.0" %}新規: rippled 1.1.0{% /badge %}
|
||||
|
||||
_`download_shard`メソッドは、権限のないユーザーは実行できない[管理メソッド](../index.md)です。_
|
||||
|
||||
外部ソースからHTTPSを使用してシャードが[lz4圧縮](https://lz4.github.io/lz4/) [tarアーカイブ](https://en.wikipedia.org/wiki/Tar_(computing))として提供される必要があります。アーカイブには、NuDB形式のシャードディレクトリとデータファイルが含まれている必要があります。
|
||||
|
||||
通常、このメソッドを使用してシャードをダウンロードしてインポートすれば、ピアツーピアネットワークからシャードを個別に取得するよりも短い時間で取得できます。また、サーバーから提供される特定範囲のシャードまたはシャードのセットを選択する場合にもこのメソッドを使用できます。
|
||||
通常、このメソッドを使用してシャードをダウンロードしてインポートすれば、ピアツーピアネットワークからシャードを個別に取得するよりも短い時間で取得できます。また、サーバから提供される特定範囲のシャードまたはシャードのセットを選択する場合にもこのメソッドを使用できます。
|
||||
|
||||
### リクエストのフォーマット
|
||||
|
||||
@@ -69,7 +69,7 @@ _`download_shard`メソッドは、権限のないユーザーは実行できな
|
||||
| `Field` | 型 | 説明 |
|
||||
|:--------|:-------|:----------------------------------------------------------|
|
||||
| `index` | 数値 | 取得するシャードのインデックス。本番環境のXRP Ledgerでは、最も古いシャードのインデックスは1であり、このシャードにはレジャー32750~32768が含まれています。次のシャードのインデックスは2であり、このシャードにはレジャー32769~49152が含まれています。 |
|
||||
| `url` | 文字列 | このシャードをダウンロードできるURL。このURLは`https://`か`http://`かで始まり`.tar.lz4`(大文字小文字の区別なし)で終わる必要があります。このダウンロードを提供するWebサーバーは、信頼できる認証局(CA)によって署名された有効なTLS証明書を使用する必要があります。(`rippled`はオペレーティングシステムのCAストアーを使用します。) {% badge href="https://github.com/XRPLF/rippled/releases/tag/1.7.0" %}更新: rippled 1.7.0{% /badge %} |
|
||||
| `url` | 文字列 | このシャードをダウンロードできるURL。このURLは`https://`か`http://`かで始まり`.tar.lz4`(大文字小文字の区別なし)で終わる必要があります。このダウンロードを提供するWebサーバは、信頼できる認証局(CA)によって署名された有効なTLS証明書を使用する必要があります。(`rippled`はオペレーティングシステムのCAストアーを使用します。) {% badge href="https://github.com/XRPLF/rippled/releases/tag/1.7.0" %}更新: rippled 1.7.0{% /badge %} |
|
||||
|
||||
### レスポンスのフォーマット
|
||||
|
||||
@@ -110,13 +110,13 @@ _`download_shard`メソッドは、権限のないユーザーは実行できな
|
||||
|:----------|:-------|:--------------------------------------------------------|
|
||||
| `message` | 文字列 | このリクエストに対応して実行されたアクションを説明するメッセージ。 |
|
||||
|
||||
**ヒント:** サーバーで使用可能なシャードを確認するには、[crawl_shardsメソッド[]を使用します。または、シャードストアーとして設定されたロケーションのサブフォルダー(`rippled.cfg`の`[shard_db]`の`path`パラメーター)を調べます。フォルダーには、シャードの番号に対応する名前が付いています。これらのフォルダーの1つに、シャードが未完了であることを示す`control.txt`ファイルが含まれていることがあります。
|
||||
**ヒント:** サーバで使用可能なシャードを確認するには、[crawl_shardsメソッド[]を使用します。または、シャードストアーとして設定されたロケーションのサブフォルダー(`rippled.cfg`の`[shard_db]`の`path`パラメーター)を調べます。フォルダーには、シャードの番号に対応する名前が付いています。これらのフォルダーの1つに、シャードが未完了であることを示す`control.txt`ファイルが含まれていることがあります。
|
||||
|
||||
### 考えられるエラー
|
||||
|
||||
- いずれかの[汎用エラータイプ][]。
|
||||
- `notEnabled` - サーバーでシャードストアーを使用するように設定されていません。
|
||||
- `tooBusy` - サーバーはすでに、ピアツーピアネットワークから、または以前の`download_shard`リクエストの結果として、シャードをダウンロード中です。
|
||||
- `notEnabled` - サーバでシャードストアーを使用するように設定されていません。
|
||||
- `tooBusy` - サーバはすでに、ピアツーピアネットワークから、または以前の`download_shard`リクエストの結果として、シャードをダウンロード中です。
|
||||
- `invalidParams` - リクエストで1つ以上の必須フィールドが省略されていたか、または指定されたフィールドのデータタイプが誤っています。
|
||||
|
||||
{% raw-partial file="/docs/_snippets/common-links.md" /%}
|
||||
|
||||
@@ -2,14 +2,14 @@
|
||||
html: ledger_request.html
|
||||
parent: logging-and-data-management-methods.html
|
||||
seo:
|
||||
description: サーバーに対し接続しているピアから特定のレジャーバージョンを取得するように指示します。
|
||||
description: サーバに対し接続しているピアから特定のレジャーバージョンを取得するように指示します。
|
||||
labels:
|
||||
- データ保持
|
||||
---
|
||||
# ledger_request
|
||||
[[ソース]](https://github.com/XRPLF/rippled/blob/e980e69eca9ea843d200773eb1f43abe3848f1a0/src/ripple/rpc/handlers/LedgerRequest.cpp "Source")
|
||||
|
||||
`ledger_request`コマンドは、サーバーに対し接続しているピアから特定のレジャーバージョンを取得するように指示します。これは、サーバーが直接接続しているピアの1つにそのレジャーが存在している場合にのみ機能します。場合によっては、レジャーを完全に取得するにはこのコマンドを繰り返し実行する必要があります。
|
||||
`ledger_request`コマンドは、サーバに対し接続しているピアから特定のレジャーバージョンを取得するように指示します。これは、サーバが直接接続しているピアの1つにそのレジャーが存在している場合にのみ機能します。場合によっては、レジャーを完全に取得するにはこのコマンドを繰り返し実行する必要があります。
|
||||
|
||||
*`ledger_request`リクエストは、権限のないユーザーは実行できない[管理メソッド](../index.md)です。*
|
||||
|
||||
@@ -47,9 +47,9 @@ rippled ledger_request 13800000
|
||||
|
||||
### レスポンスのフォーマット
|
||||
|
||||
レスポンスは[標準フォーマット][]に従っています。ただし、_`rippled`サーバーに対してレジャーの取得開始を正常に指示できた場合でも_、指定されたレジャーがない場合には失敗を示すレスポンスがリクエストから返されます。
|
||||
レスポンスは[標準フォーマット][]に従っています。ただし、_`rippled`サーバに対してレジャーの取得開始を正常に指示できた場合でも_、指定されたレジャーがない場合には失敗を示すレスポンスがリクエストから返されます。
|
||||
|
||||
**注記:** レジャーを取得するには、rippledサーバーのダイレクトピアの履歴にそのレジャーが含まれている必要があります。どのピアにもリクエストされたレジャーがない場合は、[connectメソッド][]または構成ファイルの`fixed_ips`セクションを使用して、`s2.ripple.com`にあるRippleのすべての履歴が記録されるサーバーを追加すれば、`ledger_request`リクエストを再度実行できます。
|
||||
**注記:** レジャーを取得するには、rippledサーバのダイレクトピアの履歴にそのレジャーが含まれている必要があります。どのピアにもリクエストされたレジャーがない場合は、[connectメソッド][]または構成ファイルの`fixed_ips`セクションを使用して、`s2.ripple.com`にあるRippleのすべての履歴が記録されるサーバを追加すれば、`ledger_request`リクエストを再度実行できます。
|
||||
|
||||
失敗した場合のレスポンスには、レジャーの取得状況が示されます。成功した場合のレスポンスには、[ledgerメソッド][]に類似したフォーマットでレジャーの情報が含まれます。
|
||||
|
||||
@@ -164,28 +164,28 @@ Connecting to 127.0.0.1:5005
|
||||
3つのレスポンスのフォーマットは次のとおりです。
|
||||
|
||||
1. `lgrNotFound`エラーが返された場合、レスポンスの`acquiring`フィールドには、ピアツーピアネットワークからのレジャー取得状況を示す[レジャーリクエストオブジェクト](#レジャーリクエストオブジェクト)が指定されています。
|
||||
2. サーバーが現在データを取得中であるとレスポンスに示される場合、その結果の本文として、ピアツーピアネットワークからのレジャー取得状況を示す[レジャーリクエストオブジェクト](#レジャーリクエストオブジェクト)が表示されます。
|
||||
2. サーバが現在データを取得中であるとレスポンスに示される場合、その結果の本文として、ピアツーピアネットワークからのレジャー取得状況を示す[レジャーリクエストオブジェクト](#レジャーリクエストオブジェクト)が表示されます。
|
||||
3. レジャーが完全に利用可能な場合、レスポンスには[レジャーヘッダー](../../../protocol/ledger-data/ledger-header.md)が表示されます。
|
||||
|
||||
### レジャーリクエストオブジェクト
|
||||
|
||||
サーバーでレジャーの取得操作が進行中であり、まだ完了していない場合は、`rippled`サーバーはレジャー取得状況を示すレジャーリクエストオブジェクトを返します。このオブジェクトのフィールドを次に示します。
|
||||
サーバでレジャーの取得操作が進行中であり、まだ完了していない場合は、`rippled`サーバはレジャー取得状況を示すレジャーリクエストオブジェクトを返します。このオブジェクトのフィールドを次に示します。
|
||||
|
||||
| `Field` | 型 | 説明 |
|
||||
|:----------------------------|:-----------------|:----------------------------|
|
||||
| `hash` | 文字列 | (省略される場合があります)リクエストされるレジャーの[ハッシュ][](サーバーがこのハッシュを認識している場合)。 |
|
||||
| `have_header` | ブール値 | リクエストされたレジャーのヘッダーセクションがサーバーにあるかどうか。 |
|
||||
| `have_state` | ブール値 | (省略される場合があります)リクエストされたレジャーの完全な状態データがサーバーにあるかどうか。 |
|
||||
| `have_transactions` | ブール値 | (省略される場合があります)リクエストされたレジャーの完全なトランザクションセットがサーバーにあるかどうか。 |
|
||||
| `needed_state_hashes` | 文字列の配列 | (省略される場合があります)サーバーが取得する必要がある完全な状態データ内のオブジェクトのハッシュ(最大16個)。 |
|
||||
| `needed_transaction_hashes` | 文字列の配列 | (省略される場合があります)サーバーが取得する必要があるトランザクションセットのオブジェクトのハッシュ(最大16個)。 |
|
||||
| `peers` | 数値 | このレジャーを見つけるためにサーバーが照会するピアの数。 |
|
||||
| `hash` | 文字列 | (省略される場合があります)リクエストされるレジャーの[ハッシュ][](サーバがこのハッシュを認識している場合)。 |
|
||||
| `have_header` | ブール値 | リクエストされたレジャーのヘッダーセクションがサーバにあるかどうか。 |
|
||||
| `have_state` | ブール値 | (省略される場合があります)リクエストされたレジャーの完全な状態データがサーバにあるかどうか。 |
|
||||
| `have_transactions` | ブール値 | (省略される場合があります)リクエストされたレジャーの完全なトランザクションセットがサーバにあるかどうか。 |
|
||||
| `needed_state_hashes` | 文字列の配列 | (省略される場合があります)サーバが取得する必要がある完全な状態データ内のオブジェクトのハッシュ(最大16個)。 |
|
||||
| `needed_transaction_hashes` | 文字列の配列 | (省略される場合があります)サーバが取得する必要があるトランザクションセットのオブジェクトのハッシュ(最大16個)。 |
|
||||
| `peers` | 数値 | このレジャーを見つけるためにサーバが照会するピアの数。 |
|
||||
| `timeouts` | 数値 | これまでにこのレジャーの取得操作がタイムアウトした回数。 |
|
||||
|
||||
### 考えられるエラー
|
||||
|
||||
* [汎用エラータイプ][]のすべて。
|
||||
* `invalidParams` - 1つ以上のフィールドの指定が正しくないか、1つ以上の必須フィールドが指定されていません。このエラーは、指定したレジャーインデックスが現在進行中のレジャーのインデックス以上である場合にも発生します。
|
||||
* `lgrNotFound` - レジャーがまだ利用可能ではない場合。これは、サーバーがレジャーの取得を開始していますが、リクエストされたレジャーが接続されたどのピアにもない場合には失敗する可能性があることを意味します。(以前はこのエラーにはコード`ledgerNotFound`が使用されていました。)[更新: rippled 0.30.1][新規: rippled 0.30.1]
|
||||
* `lgrNotFound` - レジャーがまだ利用可能ではない場合。これは、サーバがレジャーの取得を開始していますが、リクエストされたレジャーが接続されたどのピアにもない場合には失敗する可能性があることを意味します。(以前はこのエラーにはコード`ledgerNotFound`が使用されていました。)[更新: rippled 0.30.1][新規: rippled 0.30.1]
|
||||
|
||||
{% raw-partial file="/docs/_snippets/common-links.md" /%}
|
||||
|
||||
@@ -9,7 +9,7 @@ labels:
|
||||
# log_level
|
||||
[[ソース]](https://github.com/XRPLF/rippled/blob/155fcdbcd0b4927152892c8c8be01d9cf62bed68/src/ripple/rpc/handlers/LogLevel.cpp "Source")
|
||||
|
||||
`log_level`コマンドは`rippled`サーバーのログ詳細レベルを変更するか、各ログメッセージカテゴリー(_パーティション_)の現在のログレベルを返します。
|
||||
`log_level`コマンドは`rippled`サーバのログ詳細レベルを変更するか、各ログメッセージカテゴリー(_パーティション_)の現在のログレベルを返します。
|
||||
|
||||
_`log_level`メソッドは、権限のないユーザーは実行できない[管理メソッド](../index.md)です。_
|
||||
|
||||
|
||||
@@ -33,7 +33,7 @@ labels:
|
||||
}
|
||||
```
|
||||
|
||||
保持するログの量に応じて、`minsize`や`rotate`などのパラメーターを構成できます。`rippled.cfg`ファイルの`log_level`設定を使用して、サーバーのログの詳細度を設定します。このサンプルスクリプトは標準の`log_level`に基づいており、約2週間分のログを圧縮形式で保存します。
|
||||
保持するログの量に応じて、`minsize`や`rotate`などのパラメーターを構成できます。`rippled.cfg`ファイルの`log_level`設定を使用して、サーバのログの詳細度を設定します。このサンプルスクリプトは標準の`log_level`に基づいており、約2週間分のログを圧縮形式で保存します。
|
||||
|
||||
`rippled` 1.3以降、スクリプト`/etc/logrotate.d/rippled`は、DEBおよびRPMパッケージによって自動的にインストールされます。この設定は、必要に応じて変更できます。パッケージのアップグレード時に変更内容が上書きされることはありません。
|
||||
|
||||
|
||||
@@ -2,14 +2,14 @@
|
||||
html: connect.html
|
||||
parent: peer-management-methods.html
|
||||
seo:
|
||||
description: 特定のピアrippledサーバーに強制的に接続します。
|
||||
description: 特定のピアrippledサーバに強制的に接続します。
|
||||
labels:
|
||||
- コアサーバー
|
||||
- コアサーバ
|
||||
---
|
||||
# connect
|
||||
[[ソース]](https://github.com/XRPLF/rippled/blob/a61ffab3f9010d8accfaa98aa3cacc7d38e74121/src/ripple/rpc/handlers/Connect.cpp "Source")
|
||||
|
||||
`connect`コマンドは、`rippled`サーバーを特定のピア`rippled`サーバーに強制的に接続します。
|
||||
`connect`コマンドは、`rippled`サーバを特定のピア`rippled`サーバに強制的に接続します。
|
||||
|
||||
*`connect`リクエストは、権限のないユーザーは実行できない[管理メソッド](../index.md)です。*
|
||||
|
||||
@@ -55,7 +55,7 @@ rippled connect 192.170.145.88 51235
|
||||
|
||||
| `Field` | 型 | 説明 |
|
||||
|:--------|:-------|:----------------------------------------------------------|
|
||||
| `ip` | 文字列 | 接続するサーバーのIPアドレス。 |
|
||||
| `ip` | 文字列 | 接続するサーバのIPアドレス。 |
|
||||
| `port` | 数値 | _(省略可)_ 接続時に使用するポート番号。デフォルトでは**2459**です。 {% badge href="https://github.com/XRPLF/rippled/releases/tag/1.6.0" %}新規: rippled 1.6.0{% /badge %} |
|
||||
|
||||
### レスポンスのフォーマット
|
||||
|
||||
@@ -6,7 +6,7 @@ metadata:
|
||||
---
|
||||
# ピア管理メソッド
|
||||
|
||||
以下のメソッドを使用して、サーバーのピアツーピア接続を管理することができます。
|
||||
以下のメソッドを使用して、サーバのピアツーピア接続を管理することができます。
|
||||
|
||||
|
||||
{% child-pages /%}
|
||||
|
||||
@@ -2,14 +2,14 @@
|
||||
html: peer_reservations_add.html
|
||||
parent: peer-management-methods.html
|
||||
seo:
|
||||
description: 特定のピアサーバー用の予約済みスロットを追加します。
|
||||
description: 特定のピアサーバ用の予約済みスロットを追加します。
|
||||
labels:
|
||||
- コアサーバー
|
||||
- コアサーバ
|
||||
---
|
||||
# peer_reservations_add
|
||||
[[ソース]](https://github.com/XRPLF/rippled/blob/4a1148eb2849513dd1e7ae080288fd47ab57a376/src/ripple/rpc/handlers/Reservations.cpp#L36 "Source")
|
||||
|
||||
この{% code-page-name /%}メソッドは、XRP Ledger[ピアツーピアネットワーク](../../../../concepts/networks-and-servers/peer-protocol.md)内の特定のピアサーバーの予約済みスロットを追加または更新します。{% badge href="https://github.com/XRPLF/rippled/releases/tag/1.4.0" %}新規: rippled 1.4.0{% /badge %}
|
||||
この{% code-page-name /%}メソッドは、XRP Ledger[ピアツーピアネットワーク](../../../../concepts/networks-and-servers/peer-protocol.md)内の特定のピアサーバの予約済みスロットを追加または更新します。{% badge href="https://github.com/XRPLF/rippled/releases/tag/1.4.0" %}新規: rippled 1.4.0{% /badge %}
|
||||
|
||||
_{% code-page-name /%}メソッドは、権限のないユーザーは実行できない[管理メソッド](../index.md)です。_
|
||||
|
||||
@@ -57,7 +57,7 @@ rippled {% $frontmatter.seo.title %} n9Jt8awsPzWLjBCNKVEEDQnw4bQEPjezfcQ4gttD1Uz
|
||||
| `Field` | 型 | 説明 |
|
||||
|:--------------|:-------|:----------------------------------------------------|
|
||||
| `public_key` | 文字列 | [base58][]での予約を追加するピアリザベーションの[ノード公開鍵][] 。 |
|
||||
| `description` | 文字列 | _(省略可)_ ピアリザベーションに関するカスタムの説明。64文字を超える部分は、再起動時にサーバーによって切り捨てられます。 |
|
||||
| `description` | 文字列 | _(省略可)_ ピアリザベーションに関するカスタムの説明。64文字を超える部分は、再起動時にサーバによって切り捨てられます。 |
|
||||
|
||||
|
||||
|
||||
|
||||
@@ -2,9 +2,9 @@
|
||||
html: peer_reservations_del.html
|
||||
parent: peer-management-methods.html
|
||||
seo:
|
||||
description: 特定のピアサーバー用の予約済みスロットを削除します。
|
||||
description: 特定のピアサーバ用の予約済みスロットを削除します。
|
||||
labels:
|
||||
- コアサーバー
|
||||
- コアサーバ
|
||||
---
|
||||
# peer_reservations_del
|
||||
|
||||
|
||||
@@ -2,9 +2,9 @@
|
||||
html: peer_reservations_list.html
|
||||
parent: peer-management-methods.html
|
||||
seo:
|
||||
description: 特定のピアサーバー用の予約済みスロットをリスト表示します。
|
||||
description: 特定のピアサーバ用の予約済みスロットをリスト表示します。
|
||||
labels:
|
||||
- コアサーバー
|
||||
- コアサーバ
|
||||
---
|
||||
# peer_reservations_list
|
||||
[[ソース]](https://github.com/XRPLF/rippled/blob/4a1148eb2849513dd1e7ae080288fd47ab57a376/src/ripple/rpc/handlers/Reservations.cpp#L116 "Source")
|
||||
|
||||
@@ -2,14 +2,14 @@
|
||||
html: peers.html
|
||||
parent: peer-management-methods.html
|
||||
seo:
|
||||
description: ピアプロトコルでこのサーバーに現在接続されているその他のすべてのrippledサーバーのリストを返します。
|
||||
description: ピアプロトコルでこのサーバに現在接続されているその他のすべてのrippledサーバのリストを返します。
|
||||
labels:
|
||||
- コアサーバー
|
||||
- コアサーバ
|
||||
---
|
||||
# peers
|
||||
[[ソース]](https://github.com/XRPLF/rippled/blob/52f298f150fc1530d201d3140c80d3eaf781cb5f/src/ripple/rpc/handlers/Peers.cpp "Source")
|
||||
|
||||
`peers`コマンドは、[ピアプロトコル](../../../../concepts/networks-and-servers/peer-protocol.md)でこのサーバーに現在接続されているその他のすべての`rippled`サーバーのリスト(各サーバーの接続状況と同期状況を含む)を返します。
|
||||
`peers`コマンドは、[ピアプロトコル](../../../../concepts/networks-and-servers/peer-protocol.md)でこのサーバに現在接続されているその他のすべての`rippled`サーバのリスト(各サーバの接続状況と同期状況を含む)を返します。
|
||||
|
||||
*`peers`リクエストは、権限のないユーザーは実行できない[管理メソッド](../index.md)です。*
|
||||
|
||||
@@ -383,10 +383,10 @@ Connecting to 127.0.0.1:5005
|
||||
|
||||
| `Field` | 型 | 説明 |
|
||||
|:----------|:-------|:--------------------------------------------------------|
|
||||
| `cluster` | オブジェクト | [クラスターとして構成されている](../../../../concepts/networks-and-servers/clustering.md)場合は、同じクラスター内の他の`rippled`サーバーの概要。{% badge href="https://github.com/XRPLF/rippled/releases/tag/0.30.1" %}新規: rippled 0.30.1{% /badge %} |
|
||||
| `cluster` | オブジェクト | [クラスターとして構成されている](../../../../concepts/networks-and-servers/clustering.md)場合は、同じクラスター内の他の`rippled`サーバの概要。{% badge href="https://github.com/XRPLF/rippled/releases/tag/0.30.1" %}新規: rippled 0.30.1{% /badge %} |
|
||||
| `peers` | 配列 | peerオブジェクトからなる配列。 |
|
||||
|
||||
`cluster`オブジェクトの各フィールドは、該当する`rippled`サーバーの識別用キーペアの公開鍵です。(これは、[server_infoメソッド][]で当該サーバーから`pubkey_node`として返される値と同じです。)そのフィールドの内容は、以下のフィールドを持つオブジェクトです。
|
||||
`cluster`オブジェクトの各フィールドは、該当する`rippled`サーバの識別用キーペアの公開鍵です。(これは、[server_infoメソッド][]で当該サーバから`pubkey_node`として返される値と同じです。)そのフィールドの内容は、以下のフィールドを持つオブジェクトです。
|
||||
|
||||
| `Field` | 型 | 説明 |
|
||||
|:--------|:-------|:----------------------------------------------------------|
|
||||
@@ -399,19 +399,19 @@ Connecting to 127.0.0.1:5005
|
||||
| `Field` | 型 | 説明 |
|
||||
|:-------------------|:--------|:----------------------------------------------|
|
||||
| `address` | 文字列 | このピアが接続しているIPアドレスとポート。 |
|
||||
| `cluster` | ブール値 | (省略される場合があります)`true`の場合、現在のサーバーとピアサーバーは同じ`rippled`クラスターに含まれています。 |
|
||||
| `name` | 文字列 | (省略される場合があります)ピアが同じクラスターに含まれている場合、この名前は構成ファイルで定義されているそのピアサーバーの表示名です。 |
|
||||
| `cluster` | ブール値 | (省略される場合があります)`true`の場合、現在のサーバとピアサーバは同じ`rippled`クラスターに含まれています。 |
|
||||
| `name` | 文字列 | (省略される場合があります)ピアが同じクラスターに含まれている場合、この名前は構成ファイルで定義されているそのピアサーバの表示名です。 |
|
||||
| `complete_ledgers` | 文字列 | ピア`rippled`で利用可能なレジャーバージョンのシーケンス番号を示す範囲式 |
|
||||
| `inbound` | ブール値 | (省略される場合があります)`true`の場合は、ピアはローカルサーバーに接続しています。 |
|
||||
| `inbound` | ブール値 | (省略される場合があります)`true`の場合は、ピアはローカルサーバに接続しています。 |
|
||||
| `latency` | 数値 | ピアへのネットワーク遅延(ミリ秒単位) |
|
||||
| `ledger` | 文字列 | 最後に閉鎖されたピアのレジャーのハッシュ。 |
|
||||
| `load` | 数値 | ピアサーバーによるローカルサーバーへの負荷の測定値。この数値が大きいほど負荷が高くなります。(負荷の測定単位は正式には定義されていません。) |
|
||||
| `protocol` | 文字列 | (省略される場合があります)ピアが使用しているプロトコルバージョン(ローカルサーバーのプロトコルバージョンと異なる場合)。 |
|
||||
| `load` | 数値 | ピアサーバによるローカルサーバへの負荷の測定値。この数値が大きいほど負荷が高くなります。(負荷の測定単位は正式には定義されていません。) |
|
||||
| `protocol` | 文字列 | (省略される場合があります)ピアが使用しているプロトコルバージョン(ローカルサーバのプロトコルバージョンと異なる場合)。 |
|
||||
| `public_key` | 文字列 | (省略される場合があります)ピアのメッセージの整合性の検証に使用できる公開鍵。これは、検証に使用する公開鍵とは異なりますが、フォーマットは同じです。 |
|
||||
| `sanity` | 文字列 | (省略される場合があります)このピアが現行サーバーと同じルールとレジャーシーケンスに従っているかどうか。値が`insane`の場合、ピアは並列ネットワークの一部である可能性があります。値が`unknown`の場合、現行サーバーはピアに互換性があるかどうかを把握していません。 <!-- STYLE_OVERRIDE: insane --> |
|
||||
| `sanity` | 文字列 | (省略される場合があります)このピアが現行サーバと同じルールとレジャーシーケンスに従っているかどうか。値が`insane`の場合、ピアは並列ネットワークの一部である可能性があります。値が`unknown`の場合、現行サーバはピアに互換性があるかどうかを把握していません。 <!-- STYLE_OVERRIDE: insane --> |
|
||||
| `status` | 文字列 | (省略される場合があります)ピアからの最新のステータスメッセージ。`connecting`、`connected`、`monitoring`、`validating`、`shutting`のいずれかです。 |
|
||||
| `uptime` | 数値 | `rippled`サーバーがこのピアに継続して接続していた秒数。{% badge href="https://github.com/XRPLF/rippled/releases/tag/0.30.1" %}新規: rippled 0.30.1{% /badge %} |
|
||||
| `version` | 文字列 | (省略される場合があります)ピアサーバーの`rippled`バージョン番号 |
|
||||
| `uptime` | 数値 | `rippled`サーバがこのピアに継続して接続していた秒数。{% badge href="https://github.com/XRPLF/rippled/releases/tag/0.30.1" %}新規: rippled 0.30.1{% /badge %} |
|
||||
| `version` | 文字列 | (省略される場合があります)ピアサーバの`rippled`バージョン番号 |
|
||||
|
||||
### 考えられるエラー
|
||||
|
||||
|
||||
@@ -6,7 +6,7 @@ metadata:
|
||||
---
|
||||
# サーバ操作メソッド
|
||||
|
||||
以下のメソッドを使用して、rippledサーバーを管理することができます。
|
||||
以下のメソッドを使用して、rippledサーバを管理することができます。
|
||||
|
||||
|
||||
{% child-pages /%}
|
||||
|
||||
@@ -2,14 +2,14 @@
|
||||
html: ledger_accept.html
|
||||
parent: server-control-methods.html
|
||||
seo:
|
||||
description: スタンドアロンモードでサーバーが現在処理中のレジャーを強制的に終了し、次のレジャー番号に進むようにします。
|
||||
description: スタンドアロンモードでサーバが現在処理中のレジャーを強制的に終了し、次のレジャー番号に進むようにします。
|
||||
labels:
|
||||
- コアサーバー
|
||||
- コアサーバ
|
||||
---
|
||||
# ledger_accept
|
||||
[[ソース]](https://github.com/XRPLF/rippled/blob/a61ffab3f9010d8accfaa98aa3cacc7d38e74121/src/ripple/rpc/handlers/LedgerAccept.cpp "Source")
|
||||
|
||||
`ledger_accept`メソッドは、サーバーが現在処理中のレジャーを強制的に終了し、次のレジャー番号に進むようにします。このメソッドはテスト専用であり、`rippled`サーバーがスタンドアロンモードで実行されている場合にのみ使用できます。
|
||||
`ledger_accept`メソッドは、サーバが現在処理中のレジャーを強制的に終了し、次のレジャー番号に進むようにします。このメソッドはテスト専用であり、`rippled`サーバがスタンドアロンモードで実行されている場合にのみ使用できます。
|
||||
|
||||
*`ledger_accept`メソッドは、権限のないユーザーは実行できない[管理メソッド](../index.md)です。*
|
||||
|
||||
@@ -64,6 +64,6 @@ rippled ledger_accept
|
||||
### 考えられるエラー
|
||||
|
||||
* [汎用エラータイプ][]のすべて。
|
||||
* `notStandAlone` - `rippled`サーバーが現在スタンドアロンモードで実行されていない場合。
|
||||
* `notStandAlone` - `rippled`サーバが現在スタンドアロンモードで実行されていない場合。
|
||||
|
||||
{% raw-partial file="/docs/_snippets/common-links.md" /%}
|
||||
|
||||
@@ -2,14 +2,14 @@
|
||||
html: stop.html
|
||||
parent: server-control-methods.html
|
||||
seo:
|
||||
description: サーバーのグレースフルシャットダウンを行います。
|
||||
description: サーバのグレースフルシャットダウンを行います。
|
||||
labels:
|
||||
- コアサーバー
|
||||
- コアサーバ
|
||||
---
|
||||
# stop
|
||||
[[ソース]](https://github.com/XRPLF/rippled/blob/master/src/ripple/rpc/handlers/Stop.cpp "Source")
|
||||
|
||||
サーバーのグレースフルシャットダウンを行います。
|
||||
サーバのグレースフルシャットダウンを行います。
|
||||
|
||||
_`stop`リクエストは、権限のないユーザーは実行できない*[管理メソッド](../index.md)です。_
|
||||
|
||||
|
||||
@@ -5,12 +5,12 @@ seo:
|
||||
description: 無効。rippledが検証の署名に使用するシークレット値を一時的に設定します。
|
||||
status: removed
|
||||
labels:
|
||||
- コアサーバー
|
||||
- コアサーバ
|
||||
---
|
||||
# validation_seed
|
||||
[[ソース]](https://github.com/XRPLF/rippled/blob/a61ffab3f9010d8accfaa98aa3cacc7d38e74121/src/ripple/rpc/handlers/ValidationSeed.cpp "Source")
|
||||
|
||||
`validation_seed`コマンドは、rippledが検証の署名に使用するシークレット値を一時的に設定します。サーバーを再起動すると、この値は構成ファイルに基づいてリセットされます。{% badge href="https://github.com/XRPLF/rippled/releases/tag/0.29.1-rc1" %}rippled 0.29.1 以降では無効{% /badge %}
|
||||
`validation_seed`コマンドは、rippledが検証の署名に使用するシークレット値を一時的に設定します。サーバを再起動すると、この値は構成ファイルに基づいてリセットされます。{% badge href="https://github.com/XRPLF/rippled/releases/tag/0.29.1-rc1" %}rippled 0.29.1 以降では無効{% /badge %}
|
||||
|
||||
*`validation_seed`リクエストは、権限のないユーザーは実行できない[管理メソッド](../index.md)です。*
|
||||
|
||||
|
||||
@@ -14,7 +14,7 @@ labels:
|
||||
{% partial file="/@i18n/ja/docs/_snippets/public-signing-note.md" /%}
|
||||
|
||||
|
||||
**注意:** 独自の`rippled`サーバーを運用している場合を除き、このコマンドを使用するのではなく、[クライアントライブラリ](../../../client-libraries.md)を実行してください。詳細については[安全な署名の設定](../../../../concepts/transactions/secure-signing.md)を参照してください。
|
||||
**注意:** 独自の`rippled`サーバを運用している場合を除き、このコマンドを使用するのではなく、[クライアントライブラリ](../../../client-libraries.md)を実行してください。詳細については[安全な署名の設定](../../../../concepts/transactions/secure-signing.md)を参照してください。
|
||||
|
||||
## リクエストのフォーマット
|
||||
リクエストのフォーマットの例:
|
||||
@@ -77,7 +77,7 @@ rippled sign s██████████████████████
|
||||
|
||||
{% /tabs %}
|
||||
|
||||
トランザクションに署名するには、[トランザクションを承認](../../../../concepts/transactions/index.md#トランザクションの承認)できるシークレットキーを提供する必要があります。通常、サーバーが秘密鍵を取得するシード値を提供します。これを行うには、以下の方法があります。
|
||||
トランザクションに署名するには、[トランザクションを承認](../../../../concepts/transactions/index.md#トランザクションの承認)できるシークレットキーを提供する必要があります。通常、サーバが秘密鍵を取得するシード値を提供します。これを行うには、以下の方法があります。
|
||||
|
||||
* `secret`フィールドにシードを指定し、`key_type`フィールドを省略します。この値は、XRP Ledgerの[base58][]シード、RFC-1751、16進値のフォーマットで記述するか、文字列パスフレーズとして記述します(secp256k1キーのみ)。
|
||||
* `key_type`値と、`seed`、`seed_hex`、または`passphrase`のいずれか1つを提供します。`secret`フィールドは省略します。(コマンドライン構文ではサポートされません)。
|
||||
@@ -87,26 +87,26 @@ rippled sign s██████████████████████
|
||||
| `Field` | 型 | 説明 |
|
||||
|:---------------|:--------|:--------------------------------------------------|
|
||||
| `tx_json` | オブジェクト | JSONフォーマットの[トランザクション定義](../../../protocol/transactions/index.md) |
|
||||
| `secret` | 文字列 | _(省略可)_ トランザクションを提供するアカウントの秘密シード。トランザクションへの署名に使用されます。信頼できないサーバーに対して、またはセキュリティが確保されていないネットワーク接続を通じて機密情報を送信しないでください。`key_type`、`seed`、`seed_hex`、`passphrase`と同時に使用することはできません。 |
|
||||
| `secret` | 文字列 | _(省略可)_ トランザクションを提供するアカウントの秘密シード。トランザクションへの署名に使用されます。信頼できないサーバに対して、またはセキュリティが確保されていないネットワーク接続を通じて機密情報を送信しないでください。`key_type`、`seed`、`seed_hex`、`passphrase`と同時に使用することはできません。 |
|
||||
| `seed` | 文字列 | _(省略可)_ トランザクションを提供するアカウントの秘密シード。トランザクションへの署名に使用されます。XRP Ledgerの[base58][]フォーマットにする必要があります。指定する場合は、`key_type`も指定する必要があります。`secret`、`seed_hex`、`passphrase`と同時に使用することはできません。 |
|
||||
| `seed_hex` | 文字列 | _(省略可)_ トランザクションを提供するアカウントの秘密シード。トランザクションへの署名に使用されます。16進フォーマットにする必要があります。指定する場合は、`key_type`も指定する必要があります。`secret`、`seed`、`passphrase`と同時に使用することはできません。 |
|
||||
| `passphrase` | 文字列 | _(省略可)_ トランザクションを提供するアカウントの秘密シード。文字列パスフレーズとして、トランザクションへの署名に使用されます。指定する場合は、`key_type`も指定する必要があります。`secret`、`seed`、`seed_hex`と同時に使用することはできません。 |
|
||||
| `key_type` | 文字列 | _(省略可)_ 指定された暗号化キーペアの[署名アルゴリズム](../../../../concepts/accounts/cryptographic-keys.md#署名アルゴリズム)。有効な種類は、`secp256k1`または`ed25519`です。デフォルトは`secp256k1`です。`secret`と同時に使用することはできません。 |
|
||||
| `offline` | ブール値 | _(省略可)_ `true`の場合は、トランザクションの生成時に、トランザクションの詳細を[自動入力](#自動入力可能なフィールド)しないでください。デフォルトは`false`です。 |
|
||||
| `build_path` | ブール値 | _(省略可)_ Payment型のトランザクションに対して指定した場合、署名前に`Paths`フィールドが自動で入力されます。**注意:** サーバーは、このフィールドの値ではなく、このフィールドが存在するかどうかを調べます。この動作は変更される可能性があります。 |
|
||||
| `build_path` | ブール値 | _(省略可)_ Payment型のトランザクションに対して指定した場合、署名前に`Paths`フィールドが自動で入力されます。**注意:** サーバは、このフィールドの値ではなく、このフィールドが存在するかどうかを調べます。この動作は変更される可能性があります。 |
|
||||
| `fee_mult_max` | 整数 | _(省略可)_[自動的に提供される`Fee`フィールド](../../../protocol/transactions/common-fields.md#自動入力可能なフィールド)の上限値を設定します。現在の[トランザクションコストの負荷の乗数](../../../../concepts/transactions/transaction-cost.md#ローカル負荷コスト)が(`fee_mult_max` ÷ `fee_div_max`)よりも大きい場合、署名は`rpcHIGH_FEE`エラーで失敗します。トランザクションの`Fee`フィールド([トランザクションコスト](../../../../concepts/transactions/transaction-cost.md))を指定した場合は無視されます。デフォルトは`10`です。 |
|
||||
| `fee_div_max` | 整数 | _(省略可)_ 現在の[トランザクションコストの負荷の乗数](../../../../concepts/transactions/transaction-cost.md#ローカル負荷コスト)が(`fee_mult_max` ÷ `fee_div_max`)よりも大きい場合、署名は`rpcHIGH_FEE`エラーで失敗します。トランザクションの`Fee`フィールド([トランザクションコスト](../../../../concepts/transactions/transaction-cost.md))を指定した場合は無視されます。デフォルトは`1`です。{% badge href="https://github.com/XRPLF/rippled/releases/tag/0.30.1" %}新規: rippled 0.30.1{% /badge %} |
|
||||
|
||||
### 自動入力可能なフィールド
|
||||
|
||||
`tx_json`([トランザクションオブジェクト](../../../protocol/transactions/index.md))の特定のフィールドを省略すると、サーバーは自動的に入力しようとします。リクエストの`offline`を`true`と指定しない限り、サーバーは署名前に以下のフィールドを提供します。
|
||||
`tx_json`([トランザクションオブジェクト](../../../protocol/transactions/index.md))の特定のフィールドを省略すると、サーバは自動的に入力しようとします。リクエストの`offline`を`true`と指定しない限り、サーバは署名前に以下のフィールドを提供します。
|
||||
|
||||
* `Sequence` - サーバーは、送信者のアカウント情報にある次のシーケンス番号を自動的に使用します。
|
||||
* `Sequence` - サーバは、送信者のアカウント情報にある次のシーケンス番号を自動的に使用します。
|
||||
* **注意:** アカウントの次のシーケンス番号は、このトランザクションが適用されるまで増分されません。トランザクションの送信および個々のトランザクションへのレスポンスを待たずに複数のトランザクションに署名する場合は、最初のトランザクション以降の各トランザクションについて、正しいシーケンス番号を手動で提供する必要があります。
|
||||
* `Fee` - `Fee`パラメーターを省略した場合、サーバーは適切なトランザクションコストを自動的に入力しようとします。本番環境のXRP Ledgerでは、適切な`fee_mult_max`値を提供しない限り、この処理は`rpcHIGH_FEE`エラーで失敗します。
|
||||
* `Fee` - `Fee`パラメーターを省略した場合、サーバは適切なトランザクションコストを自動的に入力しようとします。本番環境のXRP Ledgerでは、適切な`fee_mult_max`値を提供しない限り、この処理は`rpcHIGH_FEE`エラーで失敗します。
|
||||
* `fee_mult_max`パラメーターと`fee_div_max`パラメーターは、[リファレンストランザクションコスト](../../../../concepts/transactions/transaction-cost.md#referenceトランザクションコスト)に適用される負荷スケーリング乗数によって、自動的に提供されるトランザクションコストの上限値を設定します。デフォルト設定では、自動的に提供される値が10×の乗数より大きい場合、エラーが返されます。ただし、本番環境のXRP Ledgerでは、[1000×の負荷乗数を使用することが一般的](../../../../concepts/transactions/transaction-cost.md#現在のトランザクションコスト)です。
|
||||
* コマンドライン構文では、`fee_mult_max`および`fee_div_max`はサポートされません。本番環境のXRP Ledgerの場合は、`Fee`値を提供する必要があります。
|
||||
* **注意:** 悪意のあるサーバーは、`fee_mult_max`や`fee_div_max`の値を無視して、きわめて大きなトランザクションコストを指定するおそれがあります。
|
||||
* **注意:** 悪意のあるサーバは、`fee_mult_max`や`fee_div_max`の値を無視して、きわめて大きなトランザクションコストを指定するおそれがあります。
|
||||
* `Paths` - Payment型のトランザクションの場合(XRP間の移動を除く)、Pathsフィールドは、[ripple_path_findメソッド][]を使用した場合と同様に自動的に入力できます。`build_path`を指定した場合のみ入力されます。
|
||||
|
||||
## レスポンスのフォーマット
|
||||
@@ -223,7 +223,7 @@ Connecting to 127.0.0.1:5005
|
||||
* いずれかの[汎用エラータイプ][]。
|
||||
* `invalidParams` - 1つ以上のフィールドの指定が正しくないか、1つ以上の必須フィールドが指定されていません。
|
||||
* `highFee` - トランザクションコストに適用される現在の負荷乗数が、自動的に提供されるトランザクションコストの上限を超えています。リクエストで指定する`fee_mult_max`を大きくするか(1000以上)、`tx_json`の`Fee`フィールドに値を手動で指定します。
|
||||
* `tooBusy` - トランザクションにパスが含まれていませんが、サーバーがビジーであるため、パス検出処理をすぐに実行できません。管理者として接続している場合は発生しません。
|
||||
* `noPath` - トランザクションにパスが含まれておらず、サーバーは、このペイメントの発生経路となるパスを検出できませんでした。
|
||||
* `tooBusy` - トランザクションにパスが含まれていませんが、サーバがビジーであるため、パス検出処理をすぐに実行できません。管理者として接続している場合は発生しません。
|
||||
* `noPath` - トランザクションにパスが含まれておらず、サーバは、このペイメントの発生経路となるパスを検出できませんでした。
|
||||
|
||||
{% raw-partial file="/docs/_snippets/common-links.md" /%}
|
||||
|
||||
@@ -99,7 +99,7 @@ rippled sign_for rsA2LpzuawewSBQXkiju3YQTMzW13pAAdW s█████████
|
||||
|:-------------|:---------------------|:---------------------------------------|
|
||||
| `account` | 文字列 - [アドレス][] | 署名を提供するアドレス。 |
|
||||
| `tx_json` | オブジェクト | 署名する[トランザクション](../../../protocol/transactions/index.md)。[signメソッド][]を使用する場合とは異なり、トランザクションのすべてのフィールド(`Fee`と`Sequence`を含む)を指定する必要があります。トランザクションに、空の文字列を値として指定した`SigningPubKey`フィールドを含める必要があります。このオブジェクトには、以前に収集した署名を持つ`Signers`配列を必要に応じて含めることができます。 |
|
||||
| `secret` | 文字列 | _(省略可)_ トランザクションを提供するアカウントのシークレットキー。トランザクションへの署名に使用されます。信頼できないサーバーに対して、またはセキュリティが確保されていないネットワーク接続を通じて機密情報を送信しないでください。`key_type`、`seed`、`seed_hex`、`passphrase`と同時に使用することはできません。 |
|
||||
| `secret` | 文字列 | _(省略可)_ トランザクションを提供するアカウントのシークレットキー。トランザクションへの署名に使用されます。信頼できないサーバに対して、またはセキュリティが確保されていないネットワーク接続を通じて機密情報を送信しないでください。`key_type`、`seed`、`seed_hex`、`passphrase`と同時に使用することはできません。 |
|
||||
| `seed` | 文字列 | _(省略可)_ トランザクションを提供するアカウントのシークレットキー。トランザクションへの署名に使用されます。XRP Ledgerの[base58][]フォーマットにする必要があります。指定する場合は、`key_type`も指定する必要があります。`secret`、`seed_hex`、`passphrase`と同時に使用することはできません。 |
|
||||
| `seed_hex` | 文字列 | _(省略可)_ トランザクションを提供するアカウントのシークレットキー。トランザクションへの署名に使用されます。16進フォーマットにする必要があります。指定する場合は、`key_type`も指定する必要があります。`secret`、`seed`、`passphrase`と同時に使用することはできません。 |
|
||||
| `passphrase` | 文字列 | _(省略可)_ トランザクションを提供するアカウントのシークレットキー。文字列パスフレーズとして、トランザクションへの署名に使用されます。指定する場合は、`key_type`も指定する必要があります。`secret`、`seed`、`seed_hex`と同時に使用することはできません。 |
|
||||
|
||||
@@ -5,7 +5,7 @@ seo:
|
||||
description: デバッグのためのコンセンサスプロセスに関する情報を返します。
|
||||
labels:
|
||||
- ブロックチェーン
|
||||
- コアサーバー
|
||||
- コアサーバ
|
||||
---
|
||||
# consensus_info
|
||||
[[ソース]](https://github.com/XRPLF/rippled/blob/a61ffab3f9010d8accfaa98aa3cacc7d38e74121/src/ripple/rpc/handlers/ConsensusInfo.cpp "Source")
|
||||
@@ -222,13 +222,13 @@ Connecting to 127.0.0.1:5005
|
||||
| `Field` | 型 | 説明 |
|
||||
|:-----------------|:--------|:------------------------------------------------|
|
||||
| `ledger_seq` | 数値 | 現在コンセンサスプロセスにあるレジャーのシーケンス番号。 |
|
||||
| `our_position` | オブジェクト | コンセンサスプロセスにあるレジャーについてサーバーが予期する内容。 |
|
||||
| `our_position` | オブジェクト | コンセンサスプロセスにあるレジャーについてサーバが予期する内容。 |
|
||||
| `peer_positions` | オブジェクト | コンセンサスプロセスにあるピアと各ピアが提案するレジャーバージョンのマップ。 |
|
||||
| `proposers` | 数値 | このコンセンサスプロセスに参加している信頼できるバリデータの数。信頼できるバリデータは、このサーバー構成に応じて異なります。 |
|
||||
| `synched` | ブール値 | このサーバー自体が、自分がネットワークと同期中であるとみなしているかどうか。 |
|
||||
| `proposers` | 数値 | このコンセンサスプロセスに参加している信頼できるバリデータの数。信頼できるバリデータは、このサーバ構成に応じて異なります。 |
|
||||
| `synched` | ブール値 | このサーバ自体が、自分がネットワークと同期中であるとみなしているかどうか。 |
|
||||
| `state` | 文字列 | 現在進行中のコンセンサスプロセスの部分: `open`、`consensus`、`finished`、または`accepted`。 |
|
||||
|
||||
`info`の唯一のフィールドが`"consensus": "none"`である最小限の結果となることもありますが、これは正常です。これは、サーバーがコンセンサスラウンドの合間にあることを示します。
|
||||
`info`の唯一のフィールドが`"consensus": "none"`である最小限の結果となることもありますが、これは正常です。これは、サーバがコンセンサスラウンドの合間にあることを示します。
|
||||
|
||||
`consensus_info`コマンドを短い間隔で連続して数回実行すると、このコマンドの結果が大きく変化することがあります。
|
||||
|
||||
|
||||
@@ -5,7 +5,7 @@ seo:
|
||||
description: Amendmentに関してこのサーバが認識している情報を返します。
|
||||
labels:
|
||||
- ブロックチェーン
|
||||
- コアサーバー
|
||||
- コアサーバ
|
||||
---
|
||||
# feature
|
||||
[[ソース]](https://github.com/XRPLF/rippled/blob/master/src/ripple/rpc/handlers/Feature1.cpp "Source")
|
||||
|
||||
@@ -2,14 +2,14 @@
|
||||
html: fetch_info.html
|
||||
parent: status-and-debugging-methods.html
|
||||
seo:
|
||||
description: このサーバーが現在ネットワークからフェッチしているオブジェクトに関する情報を返します。
|
||||
description: このサーバが現在ネットワークからフェッチしているオブジェクトに関する情報を返します。
|
||||
labels:
|
||||
- コアサーバー
|
||||
- コアサーバ
|
||||
---
|
||||
# fetch_info
|
||||
[[ソース]](https://github.com/XRPLF/rippled/blob/315a8b6b602798a4cff4d8e1911936011e12abdb/src/ripple/rpc/handlers/FetchInfo.cpp "Source")
|
||||
|
||||
`fetch_info`コマンドは、このサーバーが現在ネットワークからフェッチしているオブジェクトに関する情報と、その情報を所有しているピアの数を返します。これは現在の取得操作をリセットする場合にも使用できます。
|
||||
`fetch_info`コマンドは、このサーバが現在ネットワークからフェッチしているオブジェクトに関する情報と、その情報を所有しているピアの数を返します。これは現在の取得操作をリセットする場合にも使用できます。
|
||||
|
||||
_`fetch_info`メソッドは、権限のないユーザーは実行できない[管理メソッド](../index.md)です。_
|
||||
|
||||
@@ -154,8 +154,8 @@ Connecting to 127.0.0.1:5005
|
||||
| `Field` | 型 | 説明 |
|
||||
|:----------------------|:------------------------|:---------------------------|
|
||||
| `hash` | 文字列 | フェッチ対象アイテムのハッシュ。 |
|
||||
| `have_header` | ブール値 | レジャーの場合、このサーバーがすでにレジャーのヘッダーセクションを取得しているかどうか。 |
|
||||
| `have_transactions` | ブール値 | レジャーの場合、このサーバーがすでにレジャーのトランザクションセクションを取得しているかどうか。 |
|
||||
| `have_header` | ブール値 | レジャーの場合、このサーバがすでにレジャーのヘッダーセクションを取得しているかどうか。 |
|
||||
| `have_transactions` | ブール値 | レジャーの場合、このサーバがすでにレジャーのトランザクションセクションを取得しているかどうか。 |
|
||||
| `needed_state_hashes` | (ハッシュ)文字列の配列 | まだ必要とされる、このアイテムの状態オブジェクトのハッシュ値。必要なハッシュの数が16を超えている場合、レスポンスには最初の16個のハッシュのみが含まれます。 |
|
||||
| `peers` | 数値 | このアイテムが利用可能であるピアの数。 |
|
||||
| `timeouts` | 数値 | このアイテムをフェッチしようとしてタイムアウトになった(2.5秒)回数。 |
|
||||
|
||||
@@ -2,14 +2,14 @@
|
||||
html: get_counts.html
|
||||
parent: status-and-debugging-methods.html
|
||||
seo:
|
||||
description: サーバーの健全性に関するさまざまな統計情報を提供します。
|
||||
description: サーバの健全性に関するさまざまな統計情報を提供します。
|
||||
labels:
|
||||
- コアサーバー
|
||||
- コアサーバ
|
||||
---
|
||||
# get_counts
|
||||
[[ソース]](https://github.com/XRPLF/rippled/blob/c7118a183a660648aa88a3546a6b2c5bce858440/src/ripple/rpc/handlers/GetCounts.cpp "Source")
|
||||
|
||||
`get_counts`コマンドは、サーバーの健全性に関するさまざまな統計情報を提供します。そのほとんどは、現在メモリーに格納されている各種オブジェクトの数です。
|
||||
`get_counts`コマンドは、サーバの健全性に関するさまざまな統計情報を提供します。そのほとんどは、現在メモリーに格納されている各種オブジェクトの数です。
|
||||
|
||||
_`get_counts`メソッドは、権限のないユーザーは実行できない[管理メソッド](../index.md)です。_
|
||||
|
||||
@@ -147,7 +147,7 @@ Connecting to 127.0.0.1:5005
|
||||
|:--------------|:-------|:----------------------------------------------------|
|
||||
| `Transaction` | 数値 | メモリー内の`Transaction`オブジェクトの数 |
|
||||
| `Ledger` | 数値 | メモリー内のレジャーの数 |
|
||||
| `uptime` | 文字列 | このサーバーの連続稼働時間。 |
|
||||
| `uptime` | 文字列 | このサーバの連続稼働時間。 |
|
||||
|
||||
その他のほとんどのエントリーでは、値はメモリー内に現在保持されている当該タイプのオブジェクトの数を示します。
|
||||
|
||||
|
||||
@@ -6,7 +6,7 @@ metadata:
|
||||
---
|
||||
# ステータスとデバッグのメソッド
|
||||
|
||||
以下のメソッドを使用して、ネットワークとサーバーのステータスを確認することができます。
|
||||
以下のメソッドを使用して、ネットワークとサーバのステータスを確認することができます。
|
||||
|
||||
|
||||
{% child-pages /%}
|
||||
|
||||
@@ -4,7 +4,7 @@ parent: status-and-debugging-methods.html
|
||||
seo:
|
||||
description: さまざまな内部サブシステムの現在の状況を返します。
|
||||
labels:
|
||||
- コアサーバー
|
||||
- コアサーバ
|
||||
---
|
||||
# print
|
||||
[[ソース]](https://github.com/XRPLF/rippled/blob/315a8b6b602798a4cff4d8e1911936011e12abdb/src/ripple/rpc/handlers/Print.cpp "Source")
|
||||
@@ -233,7 +233,7 @@ Connecting to 127.0.0.1:5005
|
||||
|
||||
{% /tabs %}
|
||||
|
||||
レスポンスは[標準フォーマット][]に従っています。結果に含まれる追加フィールドは、`rippled`サーバーの内部状態に応じて異なります。このコマンドの実行結果は、予告なく変更されることがあります。
|
||||
レスポンスは[標準フォーマット][]に従っています。結果に含まれる追加フィールドは、`rippled`サーバの内部状態に応じて異なります。このコマンドの実行結果は、予告なく変更されることがあります。
|
||||
|
||||
### 考えられるエラー
|
||||
|
||||
|
||||
@@ -4,7 +4,7 @@ parent: status-and-debugging-methods.html
|
||||
seo:
|
||||
description: バリデータとして設定されている場合、サーバのバリデーション設定を取得します。
|
||||
labels:
|
||||
- コアサーバー
|
||||
- コアサーバ
|
||||
- ブロックチェーン
|
||||
---
|
||||
# validator_info
|
||||
|
||||
@@ -5,7 +5,7 @@ seo:
|
||||
description: バリデータリストを処理するサイトのステータス情報を返します。
|
||||
labels:
|
||||
- ブロックチェーン
|
||||
- コアサーバー
|
||||
- コアサーバ
|
||||
---
|
||||
# validator_list_sites
|
||||
[[ソース]](https://github.com/XRPLF/rippled/blob/master/src/ripple/rpc/handlers/ValidatorListSites.cpp "Source")
|
||||
|
||||
@@ -2,15 +2,15 @@
|
||||
html: validators.html
|
||||
parent: status-and-debugging-methods.html
|
||||
seo:
|
||||
description: サーバーが使用する公開済みの信頼できるバリデータの最新リストに関する情報を返します。
|
||||
description: サーバが使用する公開済みの信頼できるバリデータの最新リストに関する情報を返します。
|
||||
labels:
|
||||
- ブロックチェーン
|
||||
- コアサーバー
|
||||
- コアサーバ
|
||||
---
|
||||
# validators
|
||||
[[ソース]](https://github.com/XRPLF/rippled/blob/master/src/ripple/rpc/handlers/Validators.cpp "Source")
|
||||
|
||||
`validators`コマンドは、サーバーが使用する公開済みの信頼できるバリデータの最新リストに関する情報を、人間が読み取れる形式で返します。{% badge href="https://github.com/XRPLF/rippled/releases/tag/0.80.1" %}新規: rippled 0.80.1{% /badge %}
|
||||
`validators`コマンドは、サーバが使用する公開済みの信頼できるバリデータの最新リストに関する情報を、人間が読み取れる形式で返します。{% badge href="https://github.com/XRPLF/rippled/releases/tag/0.80.1" %}新規: rippled 0.80.1{% /badge %}
|
||||
|
||||
*`validators`リクエストは、権限のないユーザーは実行できない[管理メソッド](../index.md)です。*
|
||||
|
||||
@@ -169,8 +169,8 @@ Connecting to 127.0.0.1:5005
|
||||
| `publisher_lists` | 配列 | パブリッシャーリストオブジェクトの配列。 |
|
||||
| `signing_keys` | オブジェクト | バリデータマニフェストを使用している登録済みバリデータのマスター公開鍵から、現在の署名キーへのマッピング。 |
|
||||
| `trusted_validator_keys` | 配列 | 現在信頼されているバリデータの公開鍵の配列。 |
|
||||
| `validation_quorum` | 数値 | 1つのレジャーバージョンの検証に最低限必要となる信頼できる検証の数。状況によっては、サーバーがさらに検証をリクエストする場合があります。 |
|
||||
| `validator_list_expires` | 文字列 | 人間が読み取れる形式での現在のバリデータリストの有効期限、文字列`unknown`(サーバーが公開済みバリデータリストを読み込む必要がある場合)、または文字列`never`(サーバーが静的なバリデータリストを使用している場合)のいずれか。 |
|
||||
| `validation_quorum` | 数値 | 1つのレジャーバージョンの検証に最低限必要となる信頼できる検証の数。状況によっては、サーバがさらに検証をリクエストする場合があります。 |
|
||||
| `validator_list_expires` | 文字列 | 人間が読み取れる形式での現在のバリデータリストの有効期限、文字列`unknown`(サーバが公開済みバリデータリストを読み込む必要がある場合)、または文字列`never`(サーバが静的なバリデータリストを使用している場合)のいずれか。 |
|
||||
|
||||
`publisher_lists`配列の各メンバーは、以下のフィールドを有するオブジェクトです。
|
||||
|
||||
|
||||
@@ -6,7 +6,7 @@ seo:
|
||||
---
|
||||
# エラーのフォーマット
|
||||
|
||||
エラーが発生する可能性のある状況をすべて挙げることは不可能です。トランスポートレイヤーで発生する場合(ネットワーク接続が失われる場合など)には、使用しているクライアントとトランスポートに応じてその結果は異なります。ただし、`rippled`サーバーがリクエストを正常に受信した場合、サーバーは標準のエラー形式でのレスポンスを試みます。
|
||||
エラーが発生する可能性のある状況をすべて挙げることは不可能です。トランスポートレイヤーで発生する場合(ネットワーク接続が失われる場合など)には、使用しているクライアントとトランスポートに応じてその結果は異なります。ただし、`rippled`サーバがリクエストを正常に受信した場合、サーバは標準のエラー形式でのレスポンスを試みます。
|
||||
|
||||
**注意:** リクエストの結果がエラーになった場合、レスポンスの一部としてリクエスト全体がコピーされます。このため、エラーのデバッグに取り組むことができます。ただし、これにはリクエストで渡した機密情報がすべて含まれます。エラーメッセージを共有するときには、アカウントの重要な機密情報を他のユーザーに誤って公開することがないように、十分に注意してください。
|
||||
|
||||
@@ -105,14 +105,14 @@ HTTPステータスコード200 OKが返されるその他のエラーの場合
|
||||
|
||||
すべてのメソッドは、以下のいずれかの値の`error`コードを返す可能性があります。
|
||||
|
||||
* `unknownCmd` - リクエストに、`rippled`サーバーが認識する[コマンド](../index.md)が含まれていません。
|
||||
* `unknownCmd` - リクエストに、`rippled`サーバが認識する[コマンド](../index.md)が含まれていません。
|
||||
* `jsonInvalid` -(WebSocketのみ)リクエストは適切なJSONオブジェクトではありません。
|
||||
* この場合JSON-RPCは、代わりに400 Bad Request HTTPエラーを返します。
|
||||
* `missingCommand` -(WebSocketのみ)リクエストに`command`フィールドが指定されていませんでした。
|
||||
* この場合JSON-RPCは、代わりに400 Bad Request HTTPエラーを返します。
|
||||
* `tooBusy` - サーバーの負荷が高すぎるため、現在このコマンドを実行できません。管理者として接続している場合は、通常このエラーが返されることはありません。
|
||||
* `noNetwork` - サーバーとXRP Ledgerピアツーピアネットワークのその他の部分との接続で問題が発生しています(サーバーがスタンドアロンモードで実行されていません)。
|
||||
* `noCurrent` - 高い負荷、ネットワークの問題、バリデータ障害、誤った構成、またはその他の問題が原因で、サーバーが現行のレジャーを認識できません。
|
||||
* `noClosed` - サーバーに決済済みレジャーがありません。通常、このエラーは起動が完了していないことが原因で発生します。
|
||||
* `tooBusy` - サーバの負荷が高すぎるため、現在このコマンドを実行できません。管理者として接続している場合は、通常このエラーが返されることはありません。
|
||||
* `noNetwork` - サーバとXRP Ledgerピアツーピアネットワークのその他の部分との接続で問題が発生しています(サーバがスタンドアロンモードで実行されていません)。
|
||||
* `noCurrent` - 高い負荷、ネットワークの問題、バリデータ障害、誤った構成、またはその他の問題が原因で、サーバが現行のレジャーを認識できません。
|
||||
* `noClosed` - サーバに決済済みレジャーがありません。通常、このエラーは起動が完了していないことが原因で発生します。
|
||||
* `wsTextRequired` -(WebSocketのみ)リクエストの[opcode](https://tools.ietf.org/html/rfc6455#section-5.2)がテキストではありません。
|
||||
* `amendmentBlocked` - サーバーの状態が[Amendment blocked](../../../concepts/networks-and-servers/amendments.md#amendment-blocked)であるため、XRP Ledgerネットワークとの同期を維持するために最新バージョンに更新する必要があります。
|
||||
* `amendmentBlocked` - サーバの状態が[Amendment blocked](../../../concepts/networks-and-servers/amendments.md#amendment-blocked)であるため、XRP Ledgerネットワークとの同期を維持するために最新バージョンに更新する必要があります。
|
||||
|
||||
@@ -8,4 +8,4 @@ seo:
|
||||
|
||||
一部のメソッドから返されるデータは、1つのレスポンスに実質的に収まらないことがあります。結果全体が収まらない場合、レスポンスには`marker`フィールドが含まれます。このフィールドを使用することで、複数回の呼出しを通じてデータのページをさらに取得できます。各リクエストで直前のレスポンスの`marker`値を渡して、終わったところから再開します。レスポンスに`marker`が含まれていなければ、データセットの終わりに達しています。
|
||||
|
||||
`marker`フィールドのフォーマットは意図的に未定義になっています。各サーバーで`marker`をそれぞれに合わせて定義できるので、このフィールドの形式は文字列、ネストオブジェクトなどさまざまです。異なるサーバー、または同じサーバーの異なるメソッドでは、異なる`marker`定義を使用できます。各`marker`は一時的であり、10分以上経過すると予期されているとおりに機能しなくなることがあります。
|
||||
`marker`フィールドのフォーマットは意図的に未定義になっています。各サーバで`marker`をそれぞれに合わせて定義できるので、このフィールドの形式は文字列、ネストオブジェクトなどさまざまです。異なるサーバ、または同じサーバの異なるメソッドでは、異なる`marker`定義を使用できます。各`marker`は一時的であり、10分以上経過すると予期されているとおりに機能しなくなることがあります。
|
||||
|
||||
@@ -4,7 +4,7 @@ parent: api-conventions.html
|
||||
seo:
|
||||
description: パブリックAPIがどのようにクライアントのリクエスト数を制限しているかについての説明です。
|
||||
labels:
|
||||
- コアサーバー
|
||||
- コアサーバ
|
||||
---
|
||||
# レート制限
|
||||
|
||||
@@ -12,9 +12,9 @@ labels:
|
||||
|
||||
**ヒント:** レート制限は、クライアントが[管理者](../../../tutorials/http-websocket-apis/build-apps/get-started.md#管理者アクセス権限)として接続されているときには適用されません
|
||||
|
||||
クライアントがレート制限に近づいている場合、サーバーは[APIレスポンス](response-formatting.md)のトップレベルにフィールド`"warning": "load"`というフィールドを[APIレスポンス](response-formatting.md)のトップレベルに追加します。この警告はすべてのレスポンスに追加されるわけではありませんが、サーバはクライアントを切断する前に何度かこのような警告を送ることがあります。
|
||||
クライアントがレート制限に近づいている場合、サーバは[APIレスポンス](response-formatting.md)のトップレベルにフィールド`"warning": "load"`というフィールドを[APIレスポンス](response-formatting.md)のトップレベルに追加します。この警告はすべてのレスポンスに追加されるわけではありませんが、サーバはクライアントを切断する前に何度かこのような警告を送ることがあります。
|
||||
|
||||
クライアントがレート制限を超えると、サーバーはそのクライアントを切断し、しばらくの間、クライアントのAPIアドレスからのリクエストを受け付けません。WebSocket APIとJSON-RPC APIでは、異なる切断メッセージを使用します。
|
||||
クライアントがレート制限を超えると、サーバはそのクライアントを切断し、しばらくの間、クライアントのAPIアドレスからのリクエストを受け付けません。WebSocket APIとJSON-RPC APIでは、異なる切断メッセージを使用します。
|
||||
|
||||
## WebSocket APIの切断メッセージ
|
||||
|
||||
@@ -37,7 +37,7 @@ ws.on('close', (code,reason) => {
|
||||
|
||||
## JSON-RPCのレート制限エラー
|
||||
|
||||
JSON-RPC APIリクエストの場合、クライアントがレート制限を超えると、サーバーはHTTPステータスコード**503 Service Unavailable**でレスポンスします。このレスポンスには、サーバに負荷がかかっていることを示すテキスト(JSONではありません)の本文が含まれます。
|
||||
JSON-RPC APIリクエストの場合、クライアントがレート制限を超えると、サーバはHTTPステータスコード**503 Service Unavailable**でレスポンスします。このレスポンスには、サーバに負荷がかかっていることを示すテキスト(JSONではありません)の本文が含まれます。
|
||||
|
||||
```text
|
||||
503 Service Unavailable
|
||||
|
||||
@@ -8,7 +8,7 @@ seo:
|
||||
|
||||
## WebSocketフォーマット
|
||||
|
||||
`rippled`サーバーへのWebSocketを開いた後、以下の属性を使用して、コマンドを[JSON](https://en.wikipedia.org/wiki/JSON)オブジェクトとして送信できます。
|
||||
`rippled`サーバへのWebSocketを開いた後、以下の属性を使用して、コマンドを[JSON](https://en.wikipedia.org/wiki/JSON)オブジェクトとして送信できます。
|
||||
|
||||
* コマンド名を最上位の`"command"`フィールドに指定します。
|
||||
* このコマンドのすべての関連パラメーターも最上位に指定します。
|
||||
@@ -18,7 +18,7 @@ seo:
|
||||
|
||||
## JSON-RPCフォーマット
|
||||
|
||||
JSON-RPCリクエストを実行するには、`rippled`サーバーがJSON-RPC接続をリッスンしているポートおよびIPで、HTTP **POST**リクエストをルートパス(`/`)に送信します。HTTP/1.0またはHTTP/1.1を使用できます。HTTPSを使用する場合は、TLS v1.2を使用してください。セキュリティ上の理由から、`rippled`ではSSL v3以前を _サポートしていません_ 。
|
||||
JSON-RPCリクエストを実行するには、`rippled`サーバがJSON-RPC接続をリッスンしているポートおよびIPで、HTTP **POST**リクエストをルートパス(`/`)に送信します。HTTP/1.0またはHTTP/1.1を使用できます。HTTPSを使用する場合は、TLS v1.2を使用してください。セキュリティ上の理由から、`rippled`ではSSL v3以前を _サポートしていません_ 。
|
||||
|
||||
常に`Content-Type`ヘッダー(値`application/json`)を指定してください。
|
||||
|
||||
|
||||
@@ -13,8 +13,8 @@ seo:
|
||||
| `Field` | 型 | 説明 |
|
||||
|:----------------|:---------|:------------------------------------------------|
|
||||
| `id` | (場合により異なる) | (WebSocketのみ)このレスポンスのリクエスト元となったリクエストで指定されているID。 |
|
||||
| `status` | 文字列 | (WebSocketのみ)値が`success`である場合、リクエストがサーバーによって正常に受信され、理解されたことを示します。 |
|
||||
| `result.status` | 文字列 | (JSON-RPCおよびコマンドライン)値が`success`である場合、リクエストがサーバーによって正常に受信され、理解されたことを示します。 |
|
||||
| `status` | 文字列 | (WebSocketのみ)値が`success`である場合、リクエストがサーバによって正常に受信され、理解されたことを示します。 |
|
||||
| `result.status` | 文字列 | (JSON-RPCおよびコマンドライン)値が`success`である場合、リクエストがサーバによって正常に受信され、理解されたことを示します。 |
|
||||
| `type` | 文字列 | (WebSocketのみ)値が`response`の場合、コマンドに対する正常なレスポンスであることを示します。[非同期の通知](../public-api-methods/subscription-methods/subscribe.md)では、`ledgerClosed`や`transaction`など異なる値が使用されます。 |
|
||||
| `result` | オブジェクト | クエリーの結果。内容はコマンドによって異なります。 |
|
||||
|
||||
|
||||
@@ -4,22 +4,22 @@ parent: api-conventions.html
|
||||
seo:
|
||||
description: 一部のAPIメソッドで報告される状態情報の定義です。
|
||||
labels:
|
||||
- コアサーバー
|
||||
- コアサーバ
|
||||
---
|
||||
# rippledサーバーの状態
|
||||
# rippledサーバの状態
|
||||
|
||||
`rippled`サーバーの設定、稼働時間、その他の要素により、サーバーがグローバルなXRP Ledgerピアツーピアネットワークに参加する度合いは異なります。これは、[server_infoメソッド][]と[server_stateメソッド][]へのレスポンス内の`server_state`フィールドに示されます。レスポンスは昇順のやり取りに従い、後の値は前の値より優先されます。これらのレスポンスの定義を以下に示します(優先順位の高い順)。
|
||||
`rippled`サーバの設定、稼働時間、その他の要素により、サーバがグローバルなXRP Ledgerピアツーピアネットワークに参加する度合いは異なります。これは、[server_infoメソッド][]と[server_stateメソッド][]へのレスポンス内の`server_state`フィールドに示されます。レスポンスは昇順のやり取りに従い、後の値は前の値より優先されます。これらのレスポンスの定義を以下に示します(優先順位の高い順)。
|
||||
|
||||
| `Value` | 説明 |
|
||||
|:---------------|:------------------------------------------------------------|
|
||||
| `disconnected` | サーバーはXRP Ledgerピアツーピアネットワークにまったく接続されていません。オフラインモードで稼働しているか、何らかの理由でネットワークにアクセスできない可能性があります。 |
|
||||
| `connected` | サーバーはネットワークに接続されていると考えられます。 |
|
||||
| `syncing` | サーバーは現在、レジャーバージョンの状態に追いついていません。(通常、サーバーが始動後に最新状態になるまで数分かかります。) |
|
||||
| `tracking` | サーバーはネットワークに接続しています。 |
|
||||
| `full` | サーバーはネットワークに完全に組み込まれ、検証にも参加できますが、参加していません(検証者として設定されていないことが原因と考えられます)。 |
|
||||
| `validating` | サーバーは現在、レジャーの検証に参加しています。 |
|
||||
| `proposing` | サーバーはレジャーの検証に参加しており、現在、自身のバージョンを提案中です。 |
|
||||
| `disconnected` | サーバはXRP Ledgerピアツーピアネットワークにまったく接続されていません。オフラインモードで稼働しているか、何らかの理由でネットワークにアクセスできない可能性があります。 |
|
||||
| `connected` | サーバはネットワークに接続されていると考えられます。 |
|
||||
| `syncing` | サーバは現在、レジャーバージョンの状態に追いついていません。(通常、サーバが始動後に最新状態になるまで数分かかります。) |
|
||||
| `tracking` | サーバはネットワークに接続しています。 |
|
||||
| `full` | サーバはネットワークに完全に組み込まれ、検証にも参加できますが、参加していません(検証者として設定されていないことが原因と考えられます)。 |
|
||||
| `validating` | サーバは現在、レジャーの検証に参加しています。 |
|
||||
| `proposing` | サーバはレジャーの検証に参加しており、現在、自身のバージョンを提案中です。 |
|
||||
|
||||
**注記:** `full`、`validating`、`proposing`の区別は、グローバルネットワークの他者との同期の状況に基づいていますが、通常サーバーの上記の状態は一般的なオペレーションの中で変動します。
|
||||
**注記:** `full`、`validating`、`proposing`の区別は、グローバルネットワークの他者との同期の状況に基づいていますが、通常サーバの上記の状態は一般的なオペレーションの中で変動します。
|
||||
|
||||
{% raw-partial file="/docs/_snippets/common-links.md" /%}
|
||||
|
||||
@@ -6,7 +6,7 @@ metadata:
|
||||
---
|
||||
# HTTP / WebSocket API リファレンス
|
||||
|
||||
XRP Ledgerを管理するコアのピアツーピアサーバーであるrippledと直接通信します。
|
||||
XRP Ledgerを管理するコアのピアツーピアサーバであるrippledと直接通信します。
|
||||
|
||||
|
||||
{% child-pages /%}
|
||||
|
||||
@@ -4,7 +4,7 @@ parent: peer-port-methods.html
|
||||
seo:
|
||||
description: サーバの状態を報告するための特別なAPIメソッドです。
|
||||
labels:
|
||||
- コアサーバー
|
||||
- コアサーバ
|
||||
---
|
||||
# ヘルスチェック
|
||||
[[ソース]](https://github.com/XRPLF/rippled/blob/de0c52738785de8bf837f9124da65c7905e7bb5a/src/ripple/overlay/impl/OverlayImpl.cpp#L1084-L1168 "ソース")
|
||||
|
||||
@@ -35,7 +35,7 @@ JSONオブジェクトは次のフィールドを含んでいます。
|
||||
|:-----------------|:-----------|:-------------------------------------------------|
|
||||
| `counts` | オブジェクト | _(省略可)_ [get_countsメソッド][]のレスポンスと同じように、このサーバの状態に関する統計情報を返します。デフォルトの設定では、このフィールドは報告されません。報告される情報には、レジャーデータベースとトランザクションデータベースのサイズ、アプリケーション内キャッシュのキャッシュヒット率、さまざまな種類のオブジェクトがメモリにキャッシュされている数などがあります。メモリに保存されるオブジェクトの種類には、レジャー(`Ledger`)、トランザクション(`STTx`)、検証メッセージ (`STValidation`)などがあります。 |
|
||||
| `overlay` | オブジェクト | _(省略可)_ [peersメソッド][]のレスポンスに似ています。`active`というフィールドがあり、これはオブジェクトの配列です(下記参照)。 |
|
||||
| `server` | オブジェクト | _(省略可)_ このサーバに関する情報。[server_stateメソッド][]の公開フィールドを含みます。どの`rippled`バージョン(`build_version`)か、どの[レジャーバージョン](../../../concepts/networks-and-servers/ledger-history.md)が利用可能か(`complete_ledgers`)、サーバーの負荷量などです。{% badge href="https://github.com/XRPLF/rippled/releases/tag/1.2.1" %}更新: rippled 1.2.1{% /badge %}. |
|
||||
| `server` | オブジェクト | _(省略可)_ このサーバに関する情報。[server_stateメソッド][]の公開フィールドを含みます。どの`rippled`バージョン(`build_version`)か、どの[レジャーバージョン](../../../concepts/networks-and-servers/ledger-history.md)が利用可能か(`complete_ledgers`)、サーバの負荷量などです。{% badge href="https://github.com/XRPLF/rippled/releases/tag/1.2.1" %}更新: rippled 1.2.1{% /badge %}. |
|
||||
| `unl` | オブジェクト | _(省略可)_ [validatorsメソッド][]や[validator_list_sitesメソッド][]のレスポンスと同様です。{% badge href="https://github.com/XRPLF/rippled/releases/tag/1.2.1" %}更新: rippled 1.2.1{% /badge %}. |
|
||||
| `version` | 数値 | このピアクローラのレスポンスのフォーマットのバージョンを示します。現在のピアクローラのバージョン番号は`2`です。{% badge href="https://github.com/XRPLF/rippled/releases/tag/1.2.1" %}更新: rippled 1.2.1{% /badge %}. |
|
||||
|
||||
|
||||
@@ -4,7 +4,7 @@ parent: peer-port-methods.html
|
||||
seo:
|
||||
description: 推奨バリデータリストを共有するための特別なAPIメソッド。
|
||||
labels:
|
||||
- コアサーバー
|
||||
- コアサーバ
|
||||
- ブロックチェーン
|
||||
---
|
||||
# バリデータリストメソッド
|
||||
|
||||
@@ -63,7 +63,7 @@ rippled account_channels rf1BiGeXwwQoi8Z2ueFYTEXSwuJYfV2Jpn ra5nK24KXen9AHvsdFTK
|
||||
| `destination_account` | 文字列 | _(省略可)_ アカウントの一意のID。通常はアカウントの[アドレス][]です。指定されている場合、フィルタリングによりこのアカウントを送金先とするPayment Channelに絞り込まれます。 |
|
||||
| `ledger_hash` | 文字列 | _(省略可)_ 使用するレジャーバージョンの20バイトの16進文字列。([レジャーの指定][]を参照してください) |
|
||||
| `ledger_index` | 文字列または符号なし整数 | _(省略可)_ 使用する[レジャーインデックス][]、またはレジャーを自動的に選択するためのショートカット文字列。([レジャーの指定][]を参照してください) |
|
||||
| `limit` | 整数 | _(省略可)_ 取得するトランザクション数を制限します。サーバーはこの値に従う必要はありません。10以上400以下の範囲で値を指定する必要があります。デフォルトでは200です。 |
|
||||
| `limit` | 整数 | _(省略可)_ 取得するトランザクション数を制限します。サーバはこの値に従う必要はありません。10以上400以下の範囲で値を指定する必要があります。デフォルトでは200です。 |
|
||||
| `marker` | [マーカー][] | _(省略可)_ 以前にページネーションされたレスポンスの値。そのレスポンスを停止した箇所からデータの取得を再開します。 |
|
||||
|
||||
## レスポンスのフォーマット
|
||||
@@ -168,7 +168,7 @@ rippled account_channels rf1BiGeXwwQoi8Z2ueFYTEXSwuJYfV2Jpn ra5nK24KXen9AHvsdFTK
|
||||
| `ledger_index` | 数値 | このレスポンスの生成に使用されたレジャーバージョンの[レジャーインデックス][]。{% badge href="https://github.com/XRPLF/rippled/releases/tag/0.90.0" %}新規: rippled 0.90.0{% /badge %} |
|
||||
| `validated` | ブール値 | _(省略される場合があります)_`true`の場合、このレスポンスの情報は検証済みレジャーバージョンから取り込まれます。trueでない場合、情報は変更されることがあります。{% badge href="https://github.com/XRPLF/rippled/releases/tag/0.90.0" %}新規: rippled 0.90.0{% /badge %} |
|
||||
| `limit` | 数値 | _(省略される場合があります)_ このリクエストから実際に返されるchannelオブジェクトの数の制限。 |
|
||||
| `marker` | [マーカー][] | _(省略される場合があります)_ ページネーションのサーバー定義の値。この値を次のコールに渡して、このコールで終わった箇所から結果の取得を再開します。この後に追加のページがない場合は省略されます。 |
|
||||
| `marker` | [マーカー][] | _(省略される場合があります)_ ページネーションのサーバ定義の値。この値を次のコールに渡して、このコールで終わった箇所から結果の取得を再開します。この後に追加のページがない場合は省略されます。 |
|
||||
|
||||
各Channelオブジェクトのフィールドは次のとおりです。
|
||||
|
||||
@@ -192,6 +192,6 @@ rippled account_channels rf1BiGeXwwQoi8Z2ueFYTEXSwuJYfV2Jpn ra5nK24KXen9AHvsdFTK
|
||||
* [汎用エラータイプ][]のすべて。
|
||||
* `invalidParams` - 1つ以上のフィールドの指定が正しくないか、1つ以上の必須フィールドが指定されていません。
|
||||
* `actNotFound` - リクエストの`account`フィールドに指定されているアドレスが、レジャーのアカウントに対応していません。
|
||||
* `lgrNotFound` - `ledger_hash`または`ledger_index`で指定したレジャーが存在しないか、存在してはいるもののサーバーが保有していません。
|
||||
* `lgrNotFound` - `ledger_hash`または`ledger_index`で指定したレジャーが存在しないか、存在してはいるもののサーバが保有していません。
|
||||
|
||||
{% raw-partial file="/docs/_snippets/common-links.md" /%}
|
||||
|
||||
@@ -153,6 +153,6 @@ labels:
|
||||
* [汎用エラータイプ][]のすべて。
|
||||
* `invalidParams` - 1つ以上のフィールドの指定が正しくないか、1つ以上の必須フィールドが指定されていません。
|
||||
* `actNotFound` - リクエストの`account`フィールドに指定されているアドレスが、レジャーのアカウントに対応していません。
|
||||
* `lgrNotFound` - `ledger_hash`または`ledger_index`で指定したレジャーが存在しないか、存在してはいるもののサーバーが保有していません。
|
||||
* `lgrNotFound` - `ledger_hash`または`ledger_index`で指定したレジャーが存在しないか、存在してはいるもののサーバが保有していません。
|
||||
|
||||
{% raw-partial file="/docs/_snippets/common-links.md" /%}
|
||||
|
||||
@@ -255,7 +255,7 @@ rippled account_info rG1QQv2nh2gr7RCZ1P8YYcBUKCCN633jCn validated
|
||||
* いずれかの[汎用エラータイプ][]。
|
||||
* `invalidParams` - 1つ以上のフィールドの指定が正しくないか、1つ以上の必須フィールドが指定されていません。例えば、リクエストで`queue`を`true`と指定したが、現在開いているレジャーではない`ledger_index`を指定した場合です。
|
||||
* `actNotFound` - リクエストの`account`フィールドに指定したアドレスが、レジャー内のアカウントに対応していません。
|
||||
* `lgrNotFound` - `ledger_hash`または`ledger_index`で指定したレジャーが存在しないか、存在してはいるもののサーバーが保有していません。
|
||||
* `lgrNotFound` - `ledger_hash`または`ledger_index`で指定したレジャーが存在しないか、存在してはいるもののサーバが保有していません。
|
||||
|
||||
[手数料レベル]: ../../../../concepts/transactions/transaction-cost.md#手数料レベル
|
||||
|
||||
|
||||
@@ -443,7 +443,7 @@ rippled account_lines r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59
|
||||
* いずれかの[汎用エラータイプ][]。
|
||||
* `invalidParams` - 1つ以上のフィールドの指定が正しくないか、1つ以上の必須フィールドが指定されていません。
|
||||
* `actNotFound` - リクエストの`account`フィールドに指定されている[アドレス][]が、レジャーのアカウントに対応していません。
|
||||
* `lgrNotFound` - `ledger_hash`または`ledger_index`で指定したレジャーが存在しないか、存在してはいるもののサーバーが保有していません。
|
||||
* `lgrNotFound` - `ledger_hash`または`ledger_index`で指定したレジャーが存在しないか、存在してはいるもののサーバが保有していません。
|
||||
* `actMalformed` - 指定されている`marker`フィールドが受け入れられない場合。
|
||||
|
||||
{% raw-partial file="/docs/_snippets/common-links.md" /%}
|
||||
|
||||
@@ -158,6 +158,6 @@ _([NonFungibleTokensV1_1 amendment][]により追加されました。)_
|
||||
* いずれかの[汎用エラータイプ][]。
|
||||
* `invalidParams` - 1つ以上のフィールドの指定が正しくないか、1つ以上の必須フィールドが指定されていません。
|
||||
* `actNotFound` - リクエストの`account`フィールドに指定されている[アドレス][]が、レジャーのアカウントに対応していません。
|
||||
* `lgrNotFound` - `ledger_hash`または`ledger_index`で指定したレジャーが存在しないか、存在してはいるもののサーバーが保有していません。
|
||||
* `lgrNotFound` - `ledger_hash`または`ledger_index`で指定したレジャーが存在しないか、存在してはいるもののサーバが保有していません。
|
||||
|
||||
{% raw-partial file="/docs/_snippets/common-links.md" /%}
|
||||
|
||||
@@ -1214,7 +1214,7 @@ rippled account_objects r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59 validated
|
||||
| `ledger_index` | 数値 - [レジャーインデックス][] | _(省略される場合があります)_ このレスポンスの生成に使用されたレジャーバージョンのレジャーインデックス。 |
|
||||
| `ledger_current_index` | 数値 - [レジャーインデックス][] | _(省略される場合があります)_ このレスポンスの生成に使用された現在処理中のレジャーバージョンのレジャーインデックス。 |
|
||||
| `limit` | 数値 | _(省略される場合があります)_ このリクエストで使用されていた制限(制限の使用がある場合)。 |
|
||||
| `marker` | [マーカー][] | レスポンスがページネーションされていることを示す、サーバーが定義した値。この値を次のコールに渡して、このコールで終わった箇所から再開します。この後に追加のページがない場合は省略されます。 |
|
||||
| `marker` | [マーカー][] | レスポンスがページネーションされていることを示す、サーバが定義した値。この値を次のコールに渡して、このコールで終わった箇所から再開します。この後に追加のページがない場合は省略されます。 |
|
||||
| `validated` | 真偽値 | このフィールドが含まれていて`true`に設定されている場合、このレスポンス内の情報は検証済みのレジャーバージョンから取得されています。そうでない場合、情報は変更されることがあります。 |
|
||||
|
||||
## 考えられるエラー
|
||||
@@ -1222,6 +1222,6 @@ rippled account_objects r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59 validated
|
||||
* いずれかの[汎用エラータイプ][]。
|
||||
* `invalidParams` - 1つ以上のフィールドの指定が正しくないか、1つ以上の必須フィールドが指定されていません。
|
||||
* `actNotFound` - リクエストの`account`フィールドに指定されている[アドレス][]が、レジャーのアカウントに対応していません。
|
||||
* `lgrNotFound` - `ledger_hash`または`ledger_index`で指定したレジャーが存在しないか、存在してはいるもののサーバーが保有していません。
|
||||
* `lgrNotFound` - `ledger_hash`または`ledger_index`で指定したレジャーが存在しないか、存在してはいるもののサーバが保有していません。
|
||||
|
||||
{% raw-partial file="/docs/_snippets/common-links.md" /%}
|
||||
|
||||
@@ -215,7 +215,7 @@ rippled account_offers r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59 current
|
||||
* いずれかの[汎用エラータイプ][]。
|
||||
* `invalidParams` - 1つ以上のフィールドの指定が正しくないか、1つ以上の必須フィールドが指定されていません。
|
||||
* `actNotFound` - リクエストの`account`フィールドに指定されている[アドレス][]が、レジャーのアカウントに対応していません。
|
||||
* `lgrNotFound` - `ledger_hash`または`ledger_index`で指定したレジャーが存在しないか、存在してはいるもののサーバーが保有していません。
|
||||
* `lgrNotFound` - `ledger_hash`または`ledger_index`で指定したレジャーが存在しないか、存在してはいるもののサーバが保有していません。
|
||||
* `actMalformed` - 指定されている`marker`フィールドが受け入れられない場合。
|
||||
|
||||
{% raw-partial file="/docs/_snippets/common-links.md" /%}
|
||||
|
||||
@@ -67,14 +67,14 @@ rippled -- account_tx r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59 -1 -1 2 5 1 0 1
|
||||
| `Field` | 型 | 説明 |
|
||||
|:-------------------|:-------------------------------------------|:-----------|
|
||||
| `account` | 文字列 | アカウントの一意のIDであり、最も一般的にはアカウントのアドレスが使用されます。 |
|
||||
| `ledger_index_min` | 整数 | _(省略可能)_ 含めるトランザクションのレジャーのうち最古のものを指定するのに使用します。`-1`の値は、使用可能な検証済みレジャーのうち最古のバージョンを使用するよう、サーバーに指示します。 |
|
||||
| `ledger_index_max` | 整数 | _(省略可能)_ 含めるトランザクションのレジャーのうち最新のものを指定するのに使用します。`-1`の値は、使用可能な検証済みレジャーのうち最新のバージョンを使用するよう、サーバーに指示します。 |
|
||||
| `ledger_index_min` | 整数 | _(省略可能)_ 含めるトランザクションのレジャーのうち最古のものを指定するのに使用します。`-1`の値は、使用可能な検証済みレジャーのうち最古のバージョンを使用するよう、サーバに指示します。 |
|
||||
| `ledger_index_max` | 整数 | _(省略可能)_ 含めるトランザクションのレジャーのうち最新のものを指定するのに使用します。`-1`の値は、使用可能な検証済みレジャーのうち最新のバージョンを使用するよう、サーバに指示します。 |
|
||||
| `ledger_hash` | 文字列 | _(省略可能)_ 単一のレジャーからのみトランザクションを検索するのに使用します。([レジャーの指定][]を参照してください) |
|
||||
| `ledger_index` | 文字列または符号なし整数 | _(省略可能)_ 単一のレジャーからのみトランザクションを検索するのに使用します。([レジャーの指定][]を参照してください) |
|
||||
| `binary` | ブール値 | _(省略可能)_ デフォルトは`false`です。`true`に設定すると、JSONの代わりに16進文字列でトランザクションが返されます。 |
|
||||
| `forward` | ブール値 | _(省略可能)_ デフォルトは`false`です。`true`に設定すると、最も古いレジャーを先頭としてインデックスが付けられた値が返されます。そうしない場合、最新のレジャーを先頭として結果にインデックスが付けられます。(結果を示した各ページの中身は順序よく整理されていない場合がありますが、ページ全体としては順序付けされています。) |
|
||||
| `limit` | 整数 | _(省略可能)_ デフォルトは変化します。取得するトランザクションの数を制限します。サーバーはこの値を受け入れる必要はありません。 |
|
||||
| `marker` | [マーカー][] | 以前にページネーションされたレスポンスの値。そのレスポンスを停止した箇所からデータの取得を再開します。サーバーが使用できるレジャーの範囲に変更があっても、この値は変わりません。 |
|
||||
| `limit` | 整数 | _(省略可能)_ デフォルトは変化します。取得するトランザクションの数を制限します。サーバはこの値を受け入れる必要はありません。 |
|
||||
| `marker` | [マーカー][] | 以前にページネーションされたレスポンスの値。そのレスポンスを停止した箇所からデータの取得を再開します。サーバが使用できるレジャーの範囲に変更があっても、この値は変わりません。 |
|
||||
|
||||
次の各フィールドは省略可能とされていますが、リクエスト内で**1つ以上は使用する必要があります**: `ledger_index`、`ledger_hash`、`ledger_index_min`、または`ledger_index_max`。
|
||||
|
||||
@@ -572,12 +572,12 @@ rippled -- account_tx r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59 -1 -1 2 5 1 0 1
|
||||
| `account` | 文字列 | 関連するアカウントを識別する一意の[アドレス][]。 |
|
||||
| `ledger_index_min` | 整数 - [レジャーインデックス][] | トランザクションで実際に検索された最古のレジャーのレジャーインデックス。 |
|
||||
| `ledger_index_max` | 整数 - [レジャーインデックス][] | トランザクションで実際に検索された最新のレジャーのレジャーインデックス。 |
|
||||
| `limit` | 整数 | リクエストで使用される`limit`値。(サーバーによって強制される実際の制限値とは異なる場合があります。) |
|
||||
| `marker` | [マーカー][] | レスポンスがページネーションされていることを示す、サーバーが定義した値。この値を次のコールに渡して、このコールで終わった箇所から再開します。 |
|
||||
| `limit` | 整数 | リクエストで使用される`limit`値。(サーバによって強制される実際の制限値とは異なる場合があります。) |
|
||||
| `marker` | [マーカー][] | レスポンスがページネーションされていることを示す、サーバが定義した値。この値を次のコールに渡して、このコールで終わった箇所から再開します。 |
|
||||
| `transactions` | 配列 | 以降で説明する、リクエストの基準を満たすトランザクションの配列。 |
|
||||
| `validated` | ブール値 | このフィールドが含まれていて`true`に設定されている場合、このレスポンス内の情報は検証済みのレジャーバージョンから取得されています。そうでない場合、情報は変更されることがあります。 |
|
||||
|
||||
**注記:** サーバーから返される`ledger_index_min`および`ledger_index_max`の値がリクエストで指定したものとは異なる場合があります。例えば、サーバーに手元の指定したバージョンがない場合など。
|
||||
**注記:** サーバから返される`ledger_index_min`および`ledger_index_max`の値がリクエストで指定したものとは異なる場合があります。例えば、サーバに手元の指定したバージョンがない場合など。
|
||||
|
||||
各トランザクションのオブジェクトには以下のフィールドが含まれます。含まれるフィールドは、JSONまたは16進文字列(`"binary":true`)フォーマットのどちらでリクエストされたかによって異なります。
|
||||
|
||||
@@ -594,7 +594,7 @@ rippled -- account_tx r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59 -1 -1 2 5 1 0 1
|
||||
* いずれかの[汎用エラータイプ][]。
|
||||
* `invalidParams` - 1つ以上のフィールドの指定が正しくないか、1つ以上の必須フィールドが指定されていません。
|
||||
* `actMalformed` - リクエストの`account`フィールドに指定した[アドレス][]が、正しいフォーマットではありません。
|
||||
* `lgrIdxMalformed` - `ledger_index_min`または`ledger_index_max`で指定したレジャーが存在しないか、存在してはいるもののサーバーが保有していません。
|
||||
* `lgrIdxsInvalid` - リクエストで`ledger_index_min`の前にある`ledger_index_max`を指定したか、[ネットワークと同期](../../../../infrastructure/troubleshooting/index.md)されていないためにサーバーに検証済みレジャーの範囲が存在しません。
|
||||
* `lgrIdxMalformed` - `ledger_index_min`または`ledger_index_max`で指定したレジャーが存在しないか、存在してはいるもののサーバが保有していません。
|
||||
* `lgrIdxsInvalid` - リクエストで`ledger_index_min`の前にある`ledger_index_max`を指定したか、[ネットワークと同期](../../../../infrastructure/troubleshooting/index.md)されていないためにサーバに検証済みレジャーの範囲が存在しません。
|
||||
|
||||
{% raw-partial file="/docs/_snippets/common-links.md" /%}
|
||||
|
||||
@@ -224,6 +224,6 @@ labels:
|
||||
* `invalidParams` - 1つ以上のフィールドの指定が正しくないか、1つ以上の必須フィールドが指定されていません。
|
||||
* `invalidHotWallet` - `hotwallet`フィールドに指定されている1つ以上のアドレスが、リクエストに指定されているアカウントが発行した通貨を保有しているアカウントの[アドレス][]ではありません。
|
||||
* `actNotFound` - リクエストの`account`フィールドに指定されている[アドレス][]が、レジャーのアカウントに対応していません。
|
||||
* `lgrNotFound` - `ledger_hash`または`ledger_index`で指定したレジャーが存在しないか、存在してはいるもののサーバーが保有していません。
|
||||
* `lgrNotFound` - `ledger_hash`または`ledger_index`で指定したレジャーが存在しないか、存在してはいるもののサーバが保有していません。
|
||||
|
||||
{% raw-partial file="/docs/_snippets/common-links.md" /%}
|
||||
|
||||
@@ -186,6 +186,6 @@ labels:
|
||||
* [汎用エラータイプ][]のすべて。
|
||||
* `invalidParams` - 1つ以上のフィールドの指定が正しくないか、1つ以上の必須フィールドが指定されていません。
|
||||
* `actNotFound` - リクエストの`account`フィールドに指定されている[アドレス][]が、レジャーのアカウントに対応していません。
|
||||
* `lgrNotFound` - `ledger_hash`または`ledger_index`に指定されているレジャーが存在しないか、存在しているがサーバーにはありません。
|
||||
* `lgrNotFound` - `ledger_hash`または`ledger_index`に指定されているレジャーが存在しないか、存在しているがサーバにはありません。
|
||||
|
||||
{% raw-partial file="/docs/_snippets/common-links.md" /%}
|
||||
|
||||
@@ -6,7 +6,7 @@ metadata:
|
||||
---
|
||||
# Clio Serverメソッド
|
||||
|
||||
以下のメソッドを使用して、ClioサーバーのAPIから情報を取得することができます。
|
||||
以下のメソッドを使用して、ClioサーバのAPIから情報を取得することができます。
|
||||
|
||||
|
||||
{% child-pages /%}
|
||||
|
||||
@@ -2,15 +2,15 @@
|
||||
html: public-api-methods.html
|
||||
parent: http-websocket-apis.html
|
||||
seo:
|
||||
description: パブリックAPIメソッドを使用して、rippledサーバーと直接通信します。
|
||||
description: パブリックAPIメソッドを使用して、rippledサーバと直接通信します。
|
||||
labels:
|
||||
- コアサーバー
|
||||
- コアサーバ
|
||||
top_nav_grouping: 人気ページ
|
||||
top_nav_name: APIのメソッド
|
||||
---
|
||||
# rippledのパブリックメソッド
|
||||
|
||||
以下のパブリックAPIメソッドを使用して、[XRP Ledgerサーバー](../../../concepts/networks-and-servers/index.md)と直接通信します。パブリックメソッドは必ずしも一般大衆向けに設計されたのではありませんが、サーバーに接続されたあらゆるクライアントが使用します。パブリックメソッドは、サーバーを運用している組織のメンバーまたは顧客向けのものと考えてください。
|
||||
以下のパブリックAPIメソッドを使用して、[XRP Ledgerサーバ](../../../concepts/networks-and-servers/index.md)と直接通信します。パブリックメソッドは必ずしも一般大衆向けに設計されたのではありませんが、サーバに接続されたあらゆるクライアントが使用します。パブリックメソッドは、サーバを運用している組織のメンバーまたは顧客向けのものと考えてください。
|
||||
|
||||
|
||||
## [アカウントメソッド](account-methods/index.md)
|
||||
@@ -75,19 +75,19 @@ Payment Channel は、2名の当事者間での一方向の繰り返しの支払
|
||||
|
||||
## [サブスクリプションメソッド](subscription-methods/index.md)
|
||||
|
||||
以下のメソッドにより、各種イベントの発生時にサーバーからクライアントに更新が通知されるように設定できます。これにより、イベントを即座に把握し、対処することができます。_WebSocket APIのみ。_
|
||||
以下のメソッドにより、各種イベントの発生時にサーバからクライアントに更新が通知されるように設定できます。これにより、イベントを即座に把握し、対処することができます。_WebSocket APIのみ。_
|
||||
|
||||
* **[`subscribe`](subscription-methods/subscribe.md)** - 特定の対象について更新の通知を受けます。
|
||||
* **[`unsubscribe`](subscription-methods/unsubscribe.md)** - 特定の対象についての更新の通知を停止します。
|
||||
|
||||
|
||||
## [サーバー情報メソッド](server-info-methods/index.md)
|
||||
## [サーバ情報メソッド](server-info-methods/index.md)
|
||||
|
||||
以下のメソッドを使用して、`rippled`サーバーの現在の状態についての情報を取得します。
|
||||
以下のメソッドを使用して、`rippled`サーバの現在の状態についての情報を取得します。
|
||||
|
||||
* **[`fee`](server-info-methods/fee.md)** - トランザクションコストについての情報を取得します。
|
||||
* **[`server_info`](server-info-methods/server_info.md)** - サーバーのステータスを人間が読めるフォーマットで取得します。
|
||||
* **[`server_state`](server-info-methods/server_state.md)** - サーバーのステータスを機械が読み取れるフォーマットで取得します。
|
||||
* **[`server_info`](server-info-methods/server_info.md)** - サーバのステータスを人間が読めるフォーマットで取得します。
|
||||
* **[`server_state`](server-info-methods/server_state.md)** - サーバのステータスを機械が読み取れるフォーマットで取得します。
|
||||
|
||||
|
||||
## [ユーティリティメソッド](utility-methods/index.md)
|
||||
@@ -95,7 +95,7 @@ Payment Channel は、2名の当事者間での一方向の繰り返しの支払
|
||||
以下のメソッドを使用して、pingや乱数生成などの便利なタスクを実行します。
|
||||
|
||||
* **[`json`](utility-methods/json.md)** - プロキシとして使用して、他のコマンドを実行します。コマンドのパラメーターをJSON値として受け入れます。_コマンドラインのみ。_
|
||||
* **[`ping`](utility-methods/ping.md)** - サーバーとの接続を確認します。
|
||||
* **[`ping`](utility-methods/ping.md)** - サーバとの接続を確認します。
|
||||
* **[`random`](utility-methods/random.md)** - 乱数を生成します。
|
||||
|
||||
|
||||
|
||||
@@ -144,8 +144,8 @@ rippled ledger current
|
||||
|
||||
* [汎用エラータイプ][]のすべて。
|
||||
* `invalidParams` - 1つ以上のフィールドの指定が正しくないか、1つ以上の必須フィールドが指定されていません。
|
||||
* `lgrNotFound` - `ledger_hash`または`ledger_index`で指定したレジャーが存在しないか、存在してはいるもののサーバーが保有していません。
|
||||
* `noPermission` - `full`または`accounts`をtrueとして指定したが、管理者としてサーバーに接続していない場合(通常、管理者はローカルポートで接続する必要があります)。
|
||||
* `lgrNotFound` - `ledger_hash`または`ledger_index`で指定したレジャーが存在しないか、存在してはいるもののサーバが保有していません。
|
||||
* `noPermission` - `full`または`accounts`をtrueとして指定したが、管理者としてサーバに接続していない場合(通常、管理者はローカルポートで接続する必要があります)。
|
||||
|
||||
|
||||
<!-- TODO: we should add this fee levels link to rippled-api-links.md. server_state.md is also including this as a one-off.-->
|
||||
|
||||
@@ -56,7 +56,7 @@ label:
|
||||
| `ledger_hash` | 文字列 | _(省略可)_ 使用するレジャーバージョンの20バイトの16進文字列。([レジャーの指定][]を参照してください) |
|
||||
| `ledger_index` | 文字列または符号なし整数 | _(省略可)_ 使用するレジャーのシーケンス番号、またはレジャーを自動的に選択するためのショートカット文字列。([レジャーの指定][]を参照してください) |
|
||||
| `binary` | ブール値 | (省略可、デフォルトではfalseです)trueに設定すると、レジャーオブジェクトがJSONではなくハッシュされた16進文字列として返されます。 |
|
||||
| `limit` | 整数 | (省略可、デフォルト値は可変)取得するレジャーオブジェクトの数を制限します。サーバーはこの値に従う必要はありません。 |
|
||||
| `limit` | 整数 | (省略可、デフォルト値は可変)取得するレジャーオブジェクトの数を制限します。サーバはこの値に従う必要はありません。 |
|
||||
| `marker` | [マーカー][] | 以前にページネーションされたレスポンスの値。そのレスポンスを停止した箇所からデータの取得を再開します。 |
|
||||
|
||||
`ledger`フィールドは廃止予定であり、今後予告なしに削除される可能性があります。
|
||||
@@ -249,7 +249,7 @@ label:
|
||||
| `ledger_index` | 符号なし整数 | このレジャーのシーケンス番号 |
|
||||
| `ledger_hash` | 文字列 | レジャー全体の一意の識別用ハッシュ。 |
|
||||
| `state` | 配列 | ツリーのデータが含まれているJSONオブジェクトの配列。以下のように定義されています。 |
|
||||
| `marker` | [マーカー][] | レスポンスがページネーションされていることを示す、サーバーが定義した値。この値を次のコールに渡して、このコールで終わった箇所から再開します。 |
|
||||
| `marker` | [マーカー][] | レスポンスがページネーションされていることを示す、サーバが定義した値。この値を次のコールに渡して、このコールで終わった箇所から再開します。 |
|
||||
|
||||
`state`配列の各オブジェクトのフォーマットは、リクエストで`binary`がtrueに設定されているかどうかによって異なります。各`state`オブジェクトには以下のフィールドが含まれます。
|
||||
|
||||
@@ -264,6 +264,6 @@ label:
|
||||
|
||||
* [汎用エラータイプ][]のすべて。
|
||||
* `invalidParams` - 1つ以上のフィールドの指定が正しくないか、1つ以上の必須フィールドが指定されていません。
|
||||
* `lgrNotFound` - `ledger_hash`または`ledger_index`で指定したレジャーが存在しないか、存在してはいるもののサーバーが保有していません。
|
||||
* `lgrNotFound` - `ledger_hash`または`ledger_index`で指定したレジャーが存在しないか、存在してはいるもののサーバが保有していません。
|
||||
|
||||
{% raw-partial file="/docs/_snippets/common-links.md" /%}
|
||||
|
||||
@@ -795,7 +795,7 @@ rippled json ledger_entry '{ "nft_page": "255DD86DDF59D778081A06D02701E9B2C9F4F0
|
||||
* `deprecatedFeature` - 削除されたフィールド(`generator`など)がリクエストに指定されていました。
|
||||
* `entryNotFound` - リクエストされたレジャーオブジェクトはレジャーに存在しません。
|
||||
* `invalidParams` - 1つ以上のフィールドの指定が正しくないか、1つ以上の必須フィールドが指定されていません。
|
||||
* `lgrNotFound` - `ledger_hash`または`ledger_index`で指定したレジャーが存在しないか、存在してはいるもののサーバーが保有していません。
|
||||
* `lgrNotFound` - `ledger_hash`または`ledger_index`で指定したレジャーが存在しないか、存在してはいるもののサーバが保有していません。
|
||||
* `malformedAddress` - リクエストの[アドレス][]フィールドが誤って指定されています。
|
||||
* `malformedCurrency` - リクエストの[通貨コード][]フィールドが誤って指定されています。
|
||||
* `malformedOwner` - リクエストの`escrow.owner`サブフィールドが誤って指定されています。
|
||||
|
||||
@@ -73,7 +73,7 @@ rippled book_offers 'USD/rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B' 'EUR/rvYAfWj5gh67oV6
|
||||
|:---------------|:-------------------------------------------|:-------------------------------|
|
||||
| `ledger_hash` | 文字列 | _(省略可)_ 使用するレジャーバージョンの20バイトの16進文字列。([レジャーの指定][]を参照してください) |
|
||||
| `ledger_index` | 文字列または符号なし整数 | _(省略可)_ 使用するレジャーの[レジャーインデックス][]、またはレジャーを自動的に選択するためのショートカット文字列。([レジャーの指定][]を参照してください) |
|
||||
| `limit` | 符号なし整数 | _(省略可)_ 指定されている場合、サーバーはこの制限を超える数のオファーを結果に含めません。資金供給のないオファーはサーバーにより省略されるため、返される結果の総数はこの制限よりも少ないことがあります。 |
|
||||
| `limit` | 符号なし整数 | _(省略可)_ 指定されている場合、サーバはこの制限を超える数のオファーを結果に含めません。資金供給のないオファーはサーバにより省略されるため、返される結果の総数はこの制限よりも少ないことがあります。 |
|
||||
| `marker` | [マーカー][] | _(省略可)_ 以前にページネーションされたレスポンスの値。そのレスポンスを停止した箇所からデータの取得を再開します。 |
|
||||
| `taker` | 文字列 | _(省略可)_ パースペクティブとして使用するアカウントの[アドレス][]。このアカウントが発行した[資金供給のないオファー](../../../../concepts/tokens/decentralized-exchange/offers.md#オファーのライフサイクル)は常にレスポンスに含まれます。(これを使用して、キャンセルしたい各自のオーダーを検索できます。) |
|
||||
| `taker_gets` | オブジェクト | オファーを受諾するアカウントが受け取る通貨を、[通貨額][通貨額]と同様に、`currency`フィールドと`issuer`フィールドを持つオブジェクトとして指定します(XRPの場合はissuerを省略)。 |
|
||||
@@ -170,7 +170,7 @@ rippled book_offers 'USD/rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B' 'EUR/rvYAfWj5gh67oV6
|
||||
| `ledger_current_index` | 数値 - [レジャーインデックス][] | _(`ledger_current_index`が指定されている場合は省略)_ この情報の取得時に使用した、現在処理中のレジャーバージョンの[レジャーインデックス][]。 |
|
||||
| `ledger_index` | 数値 - [レジャーインデックス][] | _(`ledger_current_index`が指定されている場合は省略可)_ リクエストに従って、このデータの取得時に使用されたレジャーバージョンのレジャーインデックス。 |
|
||||
| `ledger_hash` | 文字列 - [ハッシュ][] | _(省略される場合があります)_ リクエストに従って、このデータの取得時に使用されたレジャーバージョンの識別用ハッシュ。 |
|
||||
| `marker` | [マーカー][] | _(省略される場合があります)_ レスポンスがページネーションされていることを示す、サーバーが定義した値。この値を次のコールに渡して、このコールで終わった箇所から再開します。この後に情報ページがない場合は省略されます。 |
|
||||
| `marker` | [マーカー][] | _(省略される場合があります)_ レスポンスがページネーションされていることを示す、サーバが定義した値。この値を次のコールに渡して、このコールで終わった箇所から再開します。この後に情報ページがない場合は省略されます。 |
|
||||
| `offers` | 配列 | Offerオブジェクトの配列。各オブジェクトには[Offer オブジェクト](../../../protocol/ledger-data/ledger-entry-types/offer.md)のフィールドが含まれています。 |
|
||||
|
||||
`offers`配列の要素には、Offerの標準フィールドの他に以下のフィールドが含まれます。
|
||||
@@ -186,7 +186,7 @@ rippled book_offers 'USD/rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B' 'EUR/rvYAfWj5gh67oV6
|
||||
|
||||
* いずれかの[汎用エラータイプ][]。
|
||||
* `invalidParams` - 1つ以上のフィールドの指定が正しくないか、1つ以上の必須フィールドが指定されていません。
|
||||
* `lgrNotFound` - `ledger_hash`または`ledger_index`で指定したレジャーが存在しないか、存在してはいるもののサーバーが保有していません。
|
||||
* `lgrNotFound` - `ledger_hash`または`ledger_index`で指定したレジャーが存在しないか、存在してはいるもののサーバが保有していません。
|
||||
* `srcCurMalformed` - リクエストの`taker_pays`フィールドのフォーマットが適切ではありません。
|
||||
* `dstAmtMalformed` - リクエストの`taker_gets`フィールドのフォーマットが適切ではありません。
|
||||
* `srcIsrMalformed` - リクエストの`taker_pays`フィールドの`issuer`フィールドが無効です。
|
||||
|
||||
@@ -144,7 +144,7 @@ Loading: "/etc/rippled.cfg"
|
||||
* `invalidParams` - 1つ以上のフィールドの指定が正しくないか、1つ以上の必須フィールドが指定されていません。
|
||||
* `actMalformed` - リクエストの`source_account`フィールドまたは`destination_account`フィールドに指定されている[アドレス][]のフォーマットが適切ではありません。(入力ミスが含まれていたり、長さが正しくない場合は、チェックサムは失敗します。)
|
||||
* `dstActNotFound` - リクエストの`destination_account`フィールドがレジャーのアカウントに対応していません。
|
||||
* `lgrNotFound` - `ledger_hash`または`ledger_index`で指定したレジャーが存在しないか、存在してはいるもののサーバーが保有していません。
|
||||
* `lgrNotFound` - `ledger_hash`または`ledger_index`で指定したレジャーが存在しないか、存在してはいるもののサーバが保有していません。
|
||||
* `srcActNotFound` - リクエストの`source_account`フィールドがレジャーのアカウントに対応していません。
|
||||
|
||||
{% raw-partial file="/docs/_snippets/common-links.md" /%}
|
||||
|
||||
@@ -128,6 +128,6 @@ _([NonFungibleTokensV1_1 amendment][]により追加されました。)_
|
||||
* いずれかの[汎用エラータイプ][]。
|
||||
* `invalidParams` - 1つ以上のフィールドの指定が正しくないか、1つ以上の必須フィールドが指定されていません。
|
||||
* `actNotFound` - リクエストの`account`フィールドに指定されているアドレスが、レジャーのアカウントに対応していません。
|
||||
* `lgrNotFound` - `ledger_hash`または`ledger_index`で指定したレジャーが存在しないか、存在してはいるもののサーバーが保有していません。
|
||||
* `lgrNotFound` - `ledger_hash`または`ledger_index`で指定したレジャーが存在しないか、存在してはいるもののサーバが保有していません。
|
||||
|
||||
{% raw-partial file="/docs/_snippets/common-links.md" /%}
|
||||
|
||||
@@ -129,6 +129,6 @@ _([NonFungibleTokensV1_1 amendment][]により追加されました。)_
|
||||
* いずれかの[汎用エラータイプ][]。
|
||||
* `invalidParams` - 1つ以上のフィールドの指定が正しくないか、1つ以上の必須フィールドが指定されていません。
|
||||
* `actNotFound` - リクエストの`account`フィールドに指定されているアドレスが、レジャーのアカウントに対応していません。
|
||||
* `lgrNotFound` - `ledger_hash`または`ledger_index`で指定したレジャーが存在しないか、存在してはいるもののサーバーが保有していません。
|
||||
* `lgrNotFound` - `ledger_hash`または`ledger_index`で指定したレジャーが存在しないか、存在してはいるもののサーバが保有していません。
|
||||
|
||||
{% raw-partial file="/docs/_snippets/common-links.md" /%}
|
||||
|
||||
@@ -18,12 +18,12 @@ path_findコマンドには3種類のモード(サブコマンド)があり
|
||||
* `close` - Pathfinding情報の送信を停止します
|
||||
* `status` - 現在処理中のPathfindingリクエストに関する情報を取得します
|
||||
|
||||
`rippled`サーバーは支払いを行うにあたり最も安価なパスまたはパスの組み合わせを探索しますが、このメソッドで返されるパスが最良のパスであることは保証されません。サーバーの負荷が原因で、Pathfindingで最良のパスを検出できないことがあります。また、信頼できないサーバーからのPathfindingの結果には注意する必要があります。オペレーターの収益となるように、最良ではないパスを返すようにサーバーが改ざんされる可能性があります。Pathfindingについて信頼できる独自サーバーがない場合は、1つのサーバーから不適切な結果が返されるリスクを最小限に抑えるため、異なる当事者が実行する複数のサーバーからのPathfindingの結果を比較してください。(**注記:** サーバーから最良ではない結果が返されても、必ずしも悪意のある振る舞いの証拠とはなりません。サーバーの負荷が高い場合の症状である可能性もあります。)
|
||||
`rippled`サーバは支払いを行うにあたり最も安価なパスまたはパスの組み合わせを探索しますが、このメソッドで返されるパスが最良のパスであることは保証されません。サーバの負荷が原因で、Pathfindingで最良のパスを検出できないことがあります。また、信頼できないサーバからのPathfindingの結果には注意する必要があります。オペレーターの収益となるように、最良ではないパスを返すようにサーバが改ざんされる可能性があります。Pathfindingについて信頼できる独自サーバがない場合は、1つのサーバから不適切な結果が返されるリスクを最小限に抑えるため、異なる当事者が実行する複数のサーバからのPathfindingの結果を比較してください。(**注記:** サーバから最良ではない結果が返されても、必ずしも悪意のある振る舞いの証拠とはなりません。サーバの負荷が高い場合の症状である可能性もあります。)
|
||||
|
||||
## path_find create
|
||||
[[ソース]](https://github.com/XRPLF/rippled/blob/master/src/ripple/rpc/handlers/PathFind.cpp#L50-L56 "Source")
|
||||
|
||||
`path_find`の`create`サブコマンドは、指定された特定アカウントから支払トランザクションを実行できるパスを探索する継続的なリクエストを作成し、別のアカウントが何らかの通貨で希望する額を受領できるようにします。初期レスポンスには2つのアドレス間で提案されるパスが含まれています。このパスにより、希望する額を受領できます。その後サーバーは、`"type": "path_find"`で有効なパスの更新を含む追加メッセージを送信します。更新の頻度はサーバーにより決定されますが、新しいレジャーバージョンがある場合には通常、数秒間に1回です。
|
||||
`path_find`の`create`サブコマンドは、指定された特定アカウントから支払トランザクションを実行できるパスを探索する継続的なリクエストを作成し、別のアカウントが何らかの通貨で希望する額を受領できるようにします。初期レスポンスには2つのアドレス間で提案されるパスが含まれています。このパスにより、希望する額を受領できます。その後サーバは、`"type": "path_find"`で有効なパスの更新を含む追加メッセージを送信します。更新の頻度はサーバにより決定されますが、新しいレジャーバージョンがある場合には通常、数秒間に1回です。
|
||||
|
||||
クライアントは一度に1つのPathfindingリクエストのみ実行できます。同じ接続ですでに他のPathfindingリクエストが実行されている場合、古いリクエストが自動的にクローズされ、新しいリクエストに置き換えられます。
|
||||
|
||||
@@ -64,7 +64,7 @@ path_findコマンドには3種類のモード(サブコマンド)があり
|
||||
| `send_max` | 文字列またはオブジェクト | _(省略可)_ トランザクションに使用する[通貨額][]。`source_currencies`と同時に指定することはできません。{% badge href="https://github.com/XRPLF/rippled/releases/tag/0.30.0" %}新規: rippled 0.30.0{% /badge %} |
|
||||
| `paths` | 配列 | _(省略可)_ チェックする[ペイメントパス](../../../../concepts/tokens/fungible-tokens/paths.md)を表すオブジェクトの配列。すでに判明している特定パスの変更内容を常に把握する場合や、特定パスに沿った支払いにかかる総コストを確認する場合にこのフィールドを使用できます。 |
|
||||
|
||||
サーバーは`source_currencies`および`bridges`フィールドも認識しますが、これらのフィールドを使用した場合の結果は保証されません。これらのフィールドは将来のために予約されているものと考えてください。
|
||||
サーバは`source_currencies`および`bridges`フィールドも認識しますが、これらのフィールドを使用した場合の結果は保証されません。これらのフィールドは将来のために予約されているものと考えてください。
|
||||
|
||||
### レスポンスのフォーマット
|
||||
|
||||
@@ -468,7 +468,7 @@ path_findコマンドには3種類のモード(サブコマンド)があり
|
||||
|
||||
### 非同期フォローアップ
|
||||
|
||||
サーバーからは初期レスポンスの他に、時間の経過にともなう[ペイメントパス](../../../../concepts/tokens/fungible-tokens/paths.md)のステータスを更新するため類似したフォーマットでさらにメッセージが送信されます。これらのメッセージには、元のWebSocketリクエストの`id`が含まれているので、どのリクエストからメッセージが送信されたかを確認できます。また、最上位レベルの`"type": "path_find"`フィールドは、追加レスポンスであることを示します。その他のフィールドは、初期レスポンスと同じ方法で定義されます。
|
||||
サーバからは初期レスポンスの他に、時間の経過にともなう[ペイメントパス](../../../../concepts/tokens/fungible-tokens/paths.md)のステータスを更新するため類似したフォーマットでさらにメッセージが送信されます。これらのメッセージには、元のWebSocketリクエストの`id`が含まれているので、どのリクエストからメッセージが送信されたかを確認できます。また、最上位レベルの`"type": "path_find"`フィールドは、追加レスポンスであることを示します。その他のフィールドは、初期レスポンスと同じ方法で定義されます。
|
||||
|
||||
フォローアップに`"full_reply": true`が含まれている場合、これは現行レジャーの時点でrippledが検出できる最良のパスです。
|
||||
|
||||
@@ -500,7 +500,7 @@ path_find createリクエストからの非同期フォローアップの例を
|
||||
## path_find close
|
||||
[[ソース]](https://github.com/XRPLF/rippled/blob/master/src/ripple/rpc/handlers/PathFind.cpp#L58-L67 "Source")
|
||||
|
||||
`path_find`の`close`サブコマンドは、サーバーに対して現在実行中のPathfindingリクエストに関する情報の送信を停止するように指示します。
|
||||
`path_find`の`close`サブコマンドは、サーバに対して現在実行中のPathfindingリクエストに関する情報の送信を停止するように指示します。
|
||||
|
||||
### リクエストのフォーマット
|
||||
リクエストのフォーマットの例:
|
||||
|
||||
@@ -12,9 +12,9 @@ labels:
|
||||
|
||||
`ripple_path_find`メソッドは、[path_findメソッド][]のシンプルなバージョンであり、すぐに利用できる[ペイメントパス](../../../../concepts/tokens/fungible-tokens/paths.md)を含む1つのレスポンスを返します。WebSocket APIとJSON-RPC APIの両方で使用できます。ただし、結果は時間の経過とともに古くなる傾向にあります。最新の状態を維持するために複数のコールを実行する代わりに、可能な場合には[path_findメソッド][]を使用して、継続的な更新をサブスクライブします。
|
||||
|
||||
`rippled`サーバーは支払いを行うため最も安価なパスまたはパスの組み合わせを探索しますが、このメソッドで返されるパスが最良のパスであることは保証されません。
|
||||
`rippled`サーバは支払いを行うため最も安価なパスまたはパスの組み合わせを探索しますが、このメソッドで返されるパスが最良のパスであることは保証されません。
|
||||
|
||||
**注意:** 信頼できないサーバーからのPathfindingの結果には注意してください。オペレーターの収益となるように、最良ではないパスを返すようにサーバーが改ざんされる可能性があります。サーバーの負荷が非常に高い場合にも不適切な結果が返される可能性があります。Pathfindingについて信頼できる独自サーバーがない場合は、1つのサーバーから不適切な結果が返されるリスクを最小限に抑えるため、異なる当事者が実行する複数のサーバーからのPathfindingの結果を比較してください。
|
||||
**注意:** 信頼できないサーバからのPathfindingの結果には注意してください。オペレーターの収益となるように、最良ではないパスを返すようにサーバが改ざんされる可能性があります。サーバの負荷が非常に高い場合にも不適切な結果が返される可能性があります。Pathfindingについて信頼できる独自サーバがない場合は、1つのサーバから不適切な結果が返されるリスクを最小限に抑えるため、異なる当事者が実行する複数のサーバからのPathfindingの結果を比較してください。
|
||||
|
||||
## リクエストのフォーマット
|
||||
リクエストのフォーマットの例:
|
||||
@@ -341,7 +341,7 @@ rippled ripple_path_find '{"source_account":"r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59"
|
||||
## 考えられるエラー
|
||||
|
||||
* [汎用エラータイプ][]のすべて。
|
||||
* `tooBusy` - サーバーの負荷が高すぎるため、パスを計算できません。管理者として接続している場合は、このエラーが返されることはありません。
|
||||
* `tooBusy` - サーバの負荷が高すぎるため、パスを計算できません。管理者として接続している場合は、このエラーが返されることはありません。
|
||||
* `invalidParams` - 1つ以上のフィールドの指定が正しくないか、1つ以上の必須フィールドが指定されていません。
|
||||
* `srcActMissing` - `source_account`フィールドがリクエストで省略されています。
|
||||
* `srcActMalformed` - リクエストの`source_account`フィールドのフォーマットが適切ではありません。
|
||||
|
||||
@@ -71,7 +71,7 @@ rippled channel_authorize s█████████████████
|
||||
|
||||
リクエストでは、`secret`、`seed`、`seed_hex`、`passphrase`のうち1つだけを指定する**必要があります**。
|
||||
|
||||
**警告:** 信頼できないサーバーに対して、またはセキュリティが確保されていないネットワーク接続を通じて秘密鍵を送信しないでください。(これには、このリクエストの`secret`、`seed`、`seed_hex`、または`passphrase`フィールドも含まれます)このメソッドは、自身が実行するサーバー、または資金を預けている十分に信頼できるサーバーへの、安全で暗号化されたネットワーク接続でのみ使用してください。そうでない場合、盗聴者があなたの秘密鍵を使用してクレームに署名し、同じキーペアを使用してこのPayment Channelなどから資金をすべて持ち出す可能性があります。手順については、[安全な署名の設定](../../../../concepts/transactions/secure-signing.md)を参照してください。
|
||||
**警告:** 信頼できないサーバに対して、またはセキュリティが確保されていないネットワーク接続を通じて秘密鍵を送信しないでください。(これには、このリクエストの`secret`、`seed`、`seed_hex`、または`passphrase`フィールドも含まれます)このメソッドは、自身が実行するサーバ、または資金を預けている十分に信頼できるサーバへの、安全で暗号化されたネットワーク接続でのみ使用してください。そうでない場合、盗聴者があなたの秘密鍵を使用してクレームに署名し、同じキーペアを使用してこのPayment Channelなどから資金をすべて持ち出す可能性があります。手順については、[安全な署名の設定](../../../../concepts/transactions/secure-signing.md)を参照してください。
|
||||
|
||||
## レスポンスのフォーマット
|
||||
|
||||
|
||||
@@ -6,7 +6,7 @@ metadata:
|
||||
---
|
||||
# Server Infoメソッド
|
||||
|
||||
以下のメソッドを使用して、rippledサーバーの現在の状態についての情報を取得することができます。
|
||||
以下のメソッドを使用して、rippledサーバの現在の状態についての情報を取得することができます。
|
||||
|
||||
|
||||
{% child-pages /%}
|
||||
|
||||
@@ -4,7 +4,7 @@ parent: server-info-methods.html
|
||||
seo:
|
||||
description: サーバについての各種情報を、人間が読めるフォーマットでサーバにリクエストします。
|
||||
labels:
|
||||
- コアサーバー
|
||||
- コアサーバ
|
||||
---
|
||||
# server_info (rippled)
|
||||
[[ソース]](https://github.com/XRPLF/rippled/blob/master/src/ripple/rpc/handlers/ServerInfo.cpp "Source")
|
||||
|
||||
@@ -4,13 +4,13 @@ parent: server-info-methods.html
|
||||
seo:
|
||||
description: サーバの現在の状態に関するさまざまなマシンが読み取り可能な情報を問い合わせます。
|
||||
labels:
|
||||
- コアサーバー
|
||||
- コアサーバ
|
||||
---
|
||||
# server_state
|
||||
|
||||
[[ソース]](https://github.com/XRPLF/rippled/blob/master/src/ripple/rpc/handlers/ServerState.cpp "Source")
|
||||
|
||||
`server_state`コマンドは、サーバーに対し`rippled`サーバーの現在の状態に関するさまざまな機械可読の情報を問い合わせます。レスポンスは[server_infoメソッド][]の場合とほぼ同じですが、読み取りやすい単位ではなく処理しやすい単位を使用します。(たとえば、XRP値は科学的記数法や10進数値の代わりに整数のdrop数で示され、時刻は秒単位ではなくミリ秒単位で示されます。)
|
||||
`server_state`コマンドは、サーバに対し`rippled`サーバの現在の状態に関するさまざまな機械可読の情報を問い合わせます。レスポンスは[server_infoメソッド][]の場合とほぼ同じですが、読み取りやすい単位ではなく処理しやすい単位を使用します。(たとえば、XRP値は科学的記数法や10進数値の代わりに整数のdrop数で示され、時刻は秒単位ではなくミリ秒単位で示されます。)
|
||||
|
||||
## リクエストのフォーマット
|
||||
リクエストのフォーマットの例:
|
||||
@@ -270,11 +270,11 @@ Headers
|
||||
|
||||
| `Field` | 型 | 説明 |
|
||||
|:---------------------------------|:-----------|:-----------------------|
|
||||
| `amendment_blocked` | 真偽値 | _(省略される場合があります)_`true`の場合、このサーバは[Amendmentブロック](../../../../concepts/networks-and-servers/amendments.md#amendment-blocked)の状態です。サーバーがAmendmentブロックではない場合、レスポンスではこのフィールドが省略されます。 |
|
||||
| `amendment_blocked` | 真偽値 | _(省略される場合があります)_`true`の場合、このサーバは[Amendmentブロック](../../../../concepts/networks-and-servers/amendments.md#amendment-blocked)の状態です。サーバがAmendmentブロックではない場合、レスポンスではこのフィールドが省略されます。 |
|
||||
| `build_version` | 文字列 | 実行中の`rippled`バージョンのバージョン番号。 |
|
||||
| `complete_ledgers` | 文字列 | ローカルの`rippled`がデータベース内に有するレジャーバージョンのシーケンス番号の範囲を示す表現。例えば、「2500-5000,32570-7695432」のように互いに素なシーケンスの場合があります。サーバーに完全なレジャーがない場合(例えば、ネットワークとの同期を始めたばかりの場合)、文字列`empty`になります。 |
|
||||
| `complete_ledgers` | 文字列 | ローカルの`rippled`がデータベース内に有するレジャーバージョンのシーケンス番号の範囲を示す表現。例えば、「2500-5000,32570-7695432」のように互いに素なシーケンスの場合があります。サーバに完全なレジャーがない場合(例えば、ネットワークとの同期を始めたばかりの場合)、文字列`empty`になります。 |
|
||||
| `closed_ledger` | オブジェクト | (省略される場合があります)コンセンサスによって検証されていない、最新の閉鎖済みレジャーに関する情報。最新の検証済みレジャーが使用可能な場合、レスポンスではこのフィールドは省略され、代わりに`validated_ledger`が含まれます。メンバーフィールドは`validated_ledger`フィールドと同じです。 |
|
||||
| `io_latency_ms` | 数値 | I/O処理の待機に費やされた時間数(ミリ秒単位)。この数値が極端に低くない場合、`rippled`サーバーでは深刻な負荷の問題が発生している可能性があります。 |
|
||||
| `io_latency_ms` | 数値 | I/O処理の待機に費やされた時間数(ミリ秒単位)。この数値が極端に低くない場合、`rippled`サーバでは深刻な負荷の問題が発生している可能性があります。 |
|
||||
| `jq_trans_overflow` | 文字列-数値 | Tこのサーバが一度に処理待ちのトランザクションが250回を超えた回数(起動以来)。この数値が大きい場合、サーバがXRP Ledgerネットワークのトランザクション負荷に対応できていない可能性があります。将来を見据えたサーバの詳細な推奨仕様については、[容量の計画](../../../../infrastructure/installation/capacity-planning.md)をご覧ください |
|
||||
| `last_close` | オブジェクト | サーバが最後にレジャーを閉鎖したときの情報。これには、コンセンサスの取得に要した時間や、参加した信頼できるバリデータ(検証者)の数が含まれます。 |
|
||||
| `last_close.converge_time` | 数値 | 直近で検証されたレジャーバージョンでコンセンサスに達するまでにかかった時間(ミリ秒)。 |
|
||||
@@ -282,24 +282,24 @@ Headers
|
||||
| `load` | オブジェクト | _(管理者専用)_ サーバの現在の負荷状態についての詳細な情報。 |
|
||||
| `load.job_types` | 配列 | _(管理者専用)_ サーバが実行している各種ジョブのレートや、各ジョブに要する時間についての情報。 |
|
||||
| `load.threads` | 数値 | _(管理者専用)_ サーバの主要なジョブプール内のスレッド数。 |
|
||||
| `load_base` | 整数 | [トランザクションコスト](../../../../concepts/transactions/transaction-cost.md)の計算で使用されるサーバー負荷のベースライン量です。`load_factor`が`load_base`と同等の場合、基本トランザクションコストのみが適用されます。`load_factor`が`load_base`よりも大きい場合、トランザクションコストにそれらの値の比率が乗算されます。たとえば`load_factor`が`load_base`の2倍である場合、トランザクションコストは2倍になります。 |
|
||||
| `load_factor` | 数値 | サーバーが現在適用している負荷係数。トランザクションコストの乗数は、この値と`load_base`の比率によって決まります。負荷係数は、個別サーバーの最も高い負荷係数、クラスターの負荷係数、[オープンレジャーコスト](../../../../concepts/transactions/transaction-cost.md#オープンレジャーコスト)、およびネットワーク全体の負荷係数によって決定します。 |
|
||||
| `load_base` | 整数 | [トランザクションコスト](../../../../concepts/transactions/transaction-cost.md)の計算で使用されるサーバ負荷のベースライン量です。`load_factor`が`load_base`と同等の場合、基本トランザクションコストのみが適用されます。`load_factor`が`load_base`よりも大きい場合、トランザクションコストにそれらの値の比率が乗算されます。たとえば`load_factor`が`load_base`の2倍である場合、トランザクションコストは2倍になります。 |
|
||||
| `load_factor` | 数値 | サーバが現在適用している負荷係数。トランザクションコストの乗数は、この値と`load_base`の比率によって決まります。負荷係数は、個別サーバの最も高い負荷係数、クラスターの負荷係数、[オープンレジャーコスト](../../../../concepts/transactions/transaction-cost.md#オープンレジャーコスト)、およびネットワーク全体の負荷係数によって決定します。 |
|
||||
| `load_factor_fee_escalation` | 整数 | (省略される場合があります)オープンレジャーに入るときに[トランザクションコスト][]に適用される現在の乗数([手数料レベル][])。 |
|
||||
| `load_factor_fee_queue` | 整数 | (省略される場合があります)キューが一杯になっている場合に、キューへ入るときに[トランザクションコスト][]に適用される現在の乗数([手数料レベル][])。 |
|
||||
| `load_factor_fee_reference` | 整数 | (省略される場合があります)負荷スケーリングのない[トランザクションコスト][]([手数料レベル][])。 |
|
||||
| `load_factor_server` | 数値 | (省略される場合があります)サーバーが適用している負荷係数。[オープンレジャーコスト](../../../../concepts/transactions/transaction-cost.md#オープンレジャーコスト)は含まれません。 |
|
||||
| `peers` | 数値 | このサーバーが現在接続している他の`rippled`サーバーの数。 |
|
||||
| `load_factor_server` | 数値 | (省略される場合があります)サーバが適用している負荷係数。[オープンレジャーコスト](../../../../concepts/transactions/transaction-cost.md#オープンレジャーコスト)は含まれません。 |
|
||||
| `peers` | 数値 | このサーバが現在接続している他の`rippled`サーバの数。 |
|
||||
| `ports` | 配列 | サーバがAPIコマンドを待ち受けているポートの一覧。配列の各エントリは[ポート記述子オブジェクト](#ポート記述子オブジェクト) となります。 {% badge href="https://github.com/XRPLF/rippled/releases/tag/1.12.0" %}新規: rippled 1.12.0{% /badge %} |
|
||||
| `pubkey_node` | 文字列 | ピアツーピア通信のためにこのサーバーを検証する際に使用される公開鍵。サーバーを初めて起動すると、サーバーにより _ノードキーペア_ が自動的に生成されます。(キーペアが削除されている場合、サーバーは新しいキーペアを作成できます。)`[node_seed]`構成オプションを使用して構成ファイルの永続値を設定できます。これは[クラスター化](../../../../concepts/networks-and-servers/clustering.md)で便利です。 |
|
||||
| `pubkey_node` | 文字列 | ピアツーピア通信のためにこのサーバを検証する際に使用される公開鍵。サーバを初めて起動すると、サーバにより _ノードキーペア_ が自動的に生成されます。(キーペアが削除されている場合、サーバは新しいキーペアを作成できます。)`[node_seed]`構成オプションを使用して構成ファイルの永続値を設定できます。これは[クラスター化](../../../../concepts/networks-and-servers/clustering.md)で便利です。 |
|
||||
| `pubkey_validator` | 文字列 | _(管理者専用)_ このノードがレジャー検証の署名に使用する公開鍵。_検証キーペア_ は、`[validator_token]`構成フィールドまたは`[validation_seed]`構成フィールドから生成されます。 |
|
||||
| `reporting` | オブジェクト | _([レポートモード](../../../../concepts/networks-and-servers/rippled-server-modes.md)サーバのみ)_ このサーバのレポートモード固有の設定に関する情報。 |
|
||||
| `reporting.etl_sources` | 配列 | _([レポートモード](../../../../concepts/networks-and-servers/rippled-server-modes.md)サーバのみ)_ このレポートモードがデータを取得する P2P モードサーバのリスト。この配列の各エントリは[ETLソースオブジェクト](#etlソースオブジェクト)です。 |
|
||||
| `reporting.is_writer` | 真偽値 | _([レポートモード](../../../../concepts/networks-and-servers/rippled-server-modes.md)サーバのみ)_ `true`の場合、このサーバは外部データベースにレジャーデータを書き込んでいます。`false`の場合、他のレポートモードサーバが共有データベースにデータを書き込んでいるか、読み取り専用に設定されているため、現在は書き込んでいません。 |
|
||||
| `reporting.last_publish_time` | 文字列 | _([レポートモード](../../../../concepts/networks-and-servers/rippled-server-modes.md)サーバのみ)_このサーバが最後に有効なレジャーを[サブスクリプションストリーム](../subscription-methods/subscribe.md)に公開した日時を示すISO 8601タイムスタンプ。 |
|
||||
| `server_state` | 文字列 | サーバーのネットワークへの参加度を示す文字列。詳細は、[考えられるサーバーの状態](../../api-conventions/rippled-server-states.md)をご覧ください。 |
|
||||
| `server_state` | 文字列 | サーバのネットワークへの参加度を示す文字列。詳細は、[考えられるサーバの状態](../../api-conventions/rippled-server-states.md)をご覧ください。 |
|
||||
| `server_state_duration_us` | 数値 | サーバが現在の状態になってから経過した連続マイクロ秒数。{% badge href="https://github.com/XRPLF/rippled/releases/tag/1.2.0" %}新規: rippled 1.2.0{% /badge %} |
|
||||
| `state_accounting` | オブジェクト | 各種[サーバ状態](../../api-conventions/rippled-server-states.md)のマップと、サーバーが各状態に費やした時間についての情報。これは、サーバーのネットワーク接続性の健全性を長期的に追跡するのに便利です。 |
|
||||
| `state_accounting.*.duration_us` | 文字列 | サーバがこの状態になってから経過したマイクロ秒数。(サーバーが別の状態に移行するたびに更新されます。) |
|
||||
| `state_accounting` | オブジェクト | 各種[サーバ状態](../../api-conventions/rippled-server-states.md)のマップと、サーバが各状態に費やした時間についての情報。これは、サーバのネットワーク接続性の健全性を長期的に追跡するのに便利です。 |
|
||||
| `state_accounting.*.duration_us` | 文字列 | サーバがこの状態になってから経過したマイクロ秒数。(サーバが別の状態に移行するたびに更新されます。) |
|
||||
| `state_accounting.*.transitions` | 数値 | サーバがこの状態に移行した回数。 |
|
||||
| `time` | 文字列 | サーバの時計によるUTCでの現在時刻。 |
|
||||
| `uptime` | 数値 | サーバが連続稼働している秒数。 |
|
||||
@@ -310,8 +310,8 @@ Headers
|
||||
| `validated_ledger.reserve_base` | 符号なし整数 | すべてのアカウントで準備金として保有する必要がある最小額(XRPのdrop数) |
|
||||
| `validated_ledger.reserve_inc` | 符号なし整数 | アカウントがレジャー内に保有する各アイテムのアカウント準備金に追加する額(XRPのdrop数)。 |
|
||||
| `validated_ledger.seq` | 符号なし整数 | このレジャーの一意のシーケンス番号 |
|
||||
| `validation_quorum` | 数値 | 1つのレジャーバージョンの検証に最低限必要となる信頼できる検証の数。状況によっては、サーバーがさらに検証をリクエストする場合があります。 |
|
||||
| `validator_list_expires` | 数値 | _(管理者専用)_ 現在のバリデータリストが期限切れになる時点([Rippleエポック以降の経過秒数][])。サーバーが発行済みのバリデータリストをロードしていない場合は0。 |
|
||||
| `validation_quorum` | 数値 | 1つのレジャーバージョンの検証に最低限必要となる信頼できる検証の数。状況によっては、サーバがさらに検証をリクエストする場合があります。 |
|
||||
| `validator_list_expires` | 数値 | _(管理者専用)_ 現在のバリデータリストが期限切れになる時点([Rippleエポック以降の経過秒数][])。サーバが発行済みのバリデータリストをロードしていない場合は0。 |
|
||||
|
||||
{% partial file="/@i18n/ja/docs/_snippets/etl-source-object.md" /%}
|
||||
|
||||
|
||||
@@ -6,7 +6,7 @@ metadata:
|
||||
---
|
||||
# Subscriptionメソッド
|
||||
|
||||
以下のメソッドを使用して、さまざまなイベントが発生したときに更新情報をサーバーからクライアントにプッシュできるようになるため、即座に情報を取得することができます。WebSocket APIのみ対応しています。
|
||||
以下のメソッドを使用して、さまざまなイベントが発生したときに更新情報をサーバからクライアントにプッシュできるようになるため、即座に情報を取得することができます。WebSocket APIのみ対応しています。
|
||||
|
||||
|
||||
{% child-pages /%}
|
||||
|
||||
@@ -2,7 +2,7 @@
|
||||
html: subscribe.html
|
||||
parent: subscription-methods.html
|
||||
seo:
|
||||
description: 特定のイベントが発生した場合に、定期的に通知するようサーバーにリクエストします。
|
||||
description: 特定のイベントが発生した場合に、定期的に通知するようサーバにリクエストします。
|
||||
labels:
|
||||
- 支払い
|
||||
- アカウント
|
||||
@@ -12,7 +12,7 @@ labels:
|
||||
# subscribe
|
||||
[[ソース]](https://github.com/XRPLF/rippled/blob/master/src/ripple/rpc/handlers/Subscribe.cpp "Source")
|
||||
|
||||
`subscribe`メソッドは、特定のイベントが発生した場合に、定期的に通知するようサーバーにリクエストします。
|
||||
`subscribe`メソッドは、特定のイベントが発生した場合に、定期的に通知するようサーバにリクエストします。
|
||||
|
||||
## リクエストのフォーマット
|
||||
リクエストのフォーマットの例:
|
||||
@@ -69,10 +69,10 @@ labels:
|
||||
| `Field` | 型 | 説明 |
|
||||
|:--------------------|:-------|:----------------------------------------------|
|
||||
| `streams` | 配列 | _(省略可)_ 以下に説明する、サブスクライブする汎用ストリームの文字列名の配列。 |
|
||||
| `accounts` | 配列 | _(省略可)_ 検証済みトランザクションを監視するアカウントの一意のアドレスを持つ配列。これらのアドレスはXRP Ledgerの[base58][]フォーマットで記述されている必要があります。サーバーは、1つ以上のアカウントに影響するすべてのトランザクションについて通知を送信します。 |
|
||||
| `accounts` | 配列 | _(省略可)_ 検証済みトランザクションを監視するアカウントの一意のアドレスを持つ配列。これらのアドレスはXRP Ledgerの[base58][]フォーマットで記述されている必要があります。サーバは、1つ以上のアカウントに影響するすべてのトランザクションについて通知を送信します。 |
|
||||
| `accounts_proposed` | 配列 | _(省略可)_ `accounts`と同様ですが、まだファイナライズされていないトランザクションを含みます。 |
|
||||
| `books` | 配列 | _(省略可)_ 以下に説明するとおり、更新の監視のために[オーダーブック](http://www.investopedia.com/terms/o/order-book.asp)を定義するオブジェクトの配列。 |
|
||||
| `url` | 文字列 | (Websocketでは省略可、それ以外では必須)サーバーが各イベントのJSON-RPCコールバックを送信するURL。*管理者専用。* |
|
||||
| `url` | 文字列 | (Websocketでは省略可、それ以外では必須)サーバが各イベントのJSON-RPCコールバックを送信するURL。*管理者専用。* |
|
||||
| `url_username` | 文字列 | _(省略可)_ コールバックURLで基本認証を行うためのユーザー名。 |
|
||||
| `url_password` | 文字列 | _(省略可)_ コールバックURLで基本認証を行うためのパスワード。 |
|
||||
|
||||
@@ -80,13 +80,13 @@ labels:
|
||||
|
||||
`streams`パラメーターは、以下のデフォルトの情報ストリームへのアクセスを可能にします。
|
||||
|
||||
* `server` - `rippled`サーバーのステータス(ネットワーク接続など)が変更されるたびにメッセージを送信します。
|
||||
* `server` - `rippled`サーバのステータス(ネットワーク接続など)が変更されるたびにメッセージを送信します。
|
||||
* `ledger` - コンセンサスプロセスで新しい検証済みレジャーが宣言されるたびにメッセージを送信します。
|
||||
* `transactions` - 決済済みレジャーにトランザクションが追加されるたびにメッセージを送信します。
|
||||
* `transactions_proposed` - 決済済みレジャーにトランザクションが追加される場合や、検証済みレジャーにまだ追加されておらず、今後も追加される見込みのない一部のトランザクションが決済済みレジャーに追加される場合に、メッセージを送信します。提案されたすべてのトランザクションが検証前に表示されるわけではありません。**注記:** 検証済みレジャーには[失敗したトランザクションも記録されます](../../../protocol/transactions/transaction-results/index.md)。これは、このようなトランザクションにはスパム対策のトランザクション手数料が課されるためです。
|
||||
* `validations` - サーバーがバリデータを信頼しているか否かにかかわらず、サーバーが検証メッセージを受信するたびに、メッセージを送信します。(個々の`rippled`は、サーバーが少なくとも定数の信頼できるバリデータから検証メッセージを受信した時点で、レジャーが検証済みであると宣言します。)
|
||||
* `consensus` - サーバーがコンセンサスサイクルのフェーズ(open、establish、acceptedなど)を変更するたびにメッセージを送信します。
|
||||
* `peer_status` - **(管理者専用)** 接続しているピア`rippled`サーバーに関する情報(特にコンセンサスプロセスに関する情報)。
|
||||
* `validations` - サーバがバリデータを信頼しているか否かにかかわらず、サーバが検証メッセージを受信するたびに、メッセージを送信します。(個々の`rippled`は、サーバが少なくとも定数の信頼できるバリデータから検証メッセージを受信した時点で、レジャーが検証済みであると宣言します。)
|
||||
* `consensus` - サーバがコンセンサスサイクルのフェーズ(open、establish、acceptedなど)を変更するたびにメッセージを送信します。
|
||||
* `peer_status` - **(管理者専用)** 接続しているピア`rippled`サーバに関する情報(特にコンセンサスプロセスに関する情報)。
|
||||
|
||||
`books`配列が指定されている場合、この配列の各要素は、以下のフィールドを持つオブジェクトです。
|
||||
|
||||
@@ -120,7 +120,7 @@ labels:
|
||||
レスポンスは[標準フォーマット][]に従っています。レスポンスに含まれるフィールドは、リクエストに指定されたサブスクリプションに応じて異なります。
|
||||
|
||||
* `accounts`および`accounts_proposed` - フィールドが返されません。
|
||||
* *Stream: server* - `load_base`(サーバーの現在の読み込みレベル)、`random`(ランダムに生成された値)などのサーバーのステータスに関する情報。これらの情報は変更される可能性があります。
|
||||
* *Stream: server* - `load_base`(サーバの現在の読み込みレベル)、`random`(ランダムに生成された値)などのサーバのステータスに関する情報。これらの情報は変更される可能性があります。
|
||||
* *Stream: transactions*、*Stream: transactions_proposed*、*Stream: validations*、および*Stream: consensus* - フィールドは返されません。
|
||||
* *Stream: ledger* - 手元にあるレジャーと現在の手数料体系に関する情報。`fee_base`(XRP単位のトランザクションの現行基本手数料)、`fee_ref`(手数料単位のトランザクションの現行基本手数料)、`ledger_hash`(最新の検証済みレジャーのハッシュ)、`reserve_base`(アカウントの最低必要準備金)などがあります。
|
||||
* `books` - フィールドはデフォルトで返されません。リクエストが`"snapshot": true`に設定されている場合、`offers`(オーダーブックを定義するオファー定義オブジェクトの配列)を返します。
|
||||
@@ -173,7 +173,7 @@ labels:
|
||||
| `reserve_base` | 数値 | アカウントの最低必要[準備金](../../../../concepts/accounts/reserves.md)([XRPのdrop数][])。このレジャーバージョンに[SetFee疑似トランザクション](../../../protocol/transactions/pseudo-transaction-types/setfee.md)が含まれる場合は、次のレジャーバージョンから新しい基本準備金が適用されます。 |
|
||||
| `reserve_inc` | 数値 | アカウントがレジャーに所有しているオブジェクトごとの[所有者準備金](../../../../concepts/accounts/reserves.md#所有者準備金)([XRPのdrop数][])。レジャーに[SetFee疑似トランザクション](../../../protocol/transactions/pseudo-transaction-types/setfee.md)が記録されている場合、このレジャー以降は新しい所有者準備金が適用されます。 |
|
||||
| `txn_count` | 数値 | このレジャーバージョンに含まれる新規トランザクションの数。 |
|
||||
| `validated_ledgers` | 文字列 | _(省略される場合があります)_ サーバーで使用可能なレジャーの範囲。これは連続的ではない可能性があります。サーバーがネットワークに接続されていない場合や、サーバーが接続されていてもネットワークからレジャーをまだ取得していない場合は、このフィールドは返されません。 |
|
||||
| `validated_ledgers` | 文字列 | _(省略される場合があります)_ サーバで使用可能なレジャーの範囲。これは連続的ではない可能性があります。サーバがネットワークに接続されていない場合や、サーバが接続されていてもネットワークからレジャーをまだ取得していない場合は、このフィールドは返されません。 |
|
||||
|
||||
|
||||
## 検証ストリーム
|
||||
@@ -212,14 +212,14 @@ labels:
|
||||
| `Field` | 型 | 説明 |
|
||||
|:------------------------|:-----------------|:--------------------------------|
|
||||
| `type` | 文字列 | 値`validationReceived`は、このメッセージが検証ストリームからであることを示します。 |
|
||||
| `amendments` | 文字列の配列 | (省略される場合があります)このサーバーがプロトコルへの追加を求める[Amendment](../../../../concepts/networks-and-servers/amendments.md)。{% badge href="https://github.com/XRPLF/rippled/releases/tag/0.32.0" %}新規: rippled 0.32.0{% /badge %} |
|
||||
| `base_fee` | 整数 | (省略される場合があります)サーバーが[手数料投票](../../../../concepts/consensus-protocol/fee-voting.md)による設定を希望するスケーリングされていないトランザクションコスト(`reference_fee`値)。{% badge href="https://github.com/XRPLF/rippled/releases/tag/0.32.0" %}新規: rippled 0.32.0{% /badge %} |
|
||||
| `amendments` | 文字列の配列 | (省略される場合があります)このサーバがプロトコルへの追加を求める[Amendment](../../../../concepts/networks-and-servers/amendments.md)。{% badge href="https://github.com/XRPLF/rippled/releases/tag/0.32.0" %}新規: rippled 0.32.0{% /badge %} |
|
||||
| `base_fee` | 整数 | (省略される場合があります)サーバが[手数料投票](../../../../concepts/consensus-protocol/fee-voting.md)による設定を希望するスケーリングされていないトランザクションコスト(`reference_fee`値)。{% badge href="https://github.com/XRPLF/rippled/releases/tag/0.32.0" %}新規: rippled 0.32.0{% /badge %} |
|
||||
| `flags` | 数値 | この検証メッセージに追加されるフラグのビットマスク。フラグ0x80000000は、検証の署名が完全に正規であることを示します。フラグ0x00000001は、完全な検証であることを示します。それ以外の場合は部分検証です。部分検証とは、特定のレジャーに対する投票ではありません。部分検証は、バリデータがオンラインであるがコンセンサスにまだ同意していないことを示します。{% badge href="https://github.com/XRPLF/rippled/releases/tag/0.32.0" %}新規: rippled 0.32.0{% /badge %} |
|
||||
| `full` | ブール値 | `true`の場合は、完全な検証です。それ以外の場合は部分検証です。部分検証とは、特定のレジャーに対する投票ではありません。部分検証は、バリデータがオンラインであるがコンセンサスにまだ同意していないことを示します。{% badge href="https://github.com/XRPLF/rippled/releases/tag/0.32.0" %}新規: rippled 0.32.0{% /badge %} |
|
||||
| `ledger_hash` | 文字列 | 提案されたレジャーの識別ハッシュを検証中です。 |
|
||||
| `ledger_index` | 文字列 - 整数 | 提案されたレジャーの[レジャーインデックス][]。{% badge href="https://github.com/XRPLF/rippled/releases/tag/0.31.0" %}新規: rippled 0.31.0{% /badge %} |
|
||||
| `load_fee` | 整数 | (省略される場合があります)このバリデータにより現在施行されているローカルの負荷スケーリングされたトランザクションコスト(手数料単位)。{% badge href="https://github.com/XRPLF/rippled/releases/tag/0.32.0" %}新規: rippled 0.32.0{% /badge %} |
|
||||
| `master_key` | 文字列 | _(省略される場合があります)_ バリデータのマスター公開鍵(バリデータがXRP Ledgerの[base58][]フォーマットのバリデータトークンを使用している場合)。(関連項目: [`rippled`サーバーで検証を有効化](../../../../infrastructure/configuration/server-modes/run-rippled-as-a-validator.md#3-rippledサーバーで検証を有効化)。){% badge href="https://github.com/XRPLF/rippled/releases/tag/1.4.0" %}新規: rippled 1.4.0{% /badge %} |
|
||||
| `master_key` | 文字列 | _(省略される場合があります)_ バリデータのマスター公開鍵(バリデータがXRP Ledgerの[base58][]フォーマットのバリデータトークンを使用している場合)。(関連項目: [`rippled`サーバで検証を有効化](../../../../infrastructure/configuration/server-modes/run-rippled-as-a-validator.md#3-rippledサーバで検証を有効化)。){% badge href="https://github.com/XRPLF/rippled/releases/tag/1.4.0" %}新規: rippled 1.4.0{% /badge %} |
|
||||
| `reserve_base` | 整数 | (省略される場合があります)このバリデータが[手数料投票](../../../../concepts/consensus-protocol/fee-voting.md)による設定を希望する最低必要準備金(`account_reserve`値)。{% badge href="https://github.com/XRPLF/rippled/releases/tag/0.32.0" %}新規: rippled 0.32.0{% /badge %} |
|
||||
| `reserve_inc` | 整数 | (省略される場合があります)このバリデータが[手数料投票](../../../../concepts/consensus-protocol/fee-voting.md)による設定を希望する必要準備金(`owner_reserve`値)の増分。{% badge href="https://github.com/XRPLF/rippled/releases/tag/0.32.0" %}新規: rippled 0.32.0{% /badge %} |
|
||||
| `signature` | 文字列 | バリデータがこのレジャーへの投票に署名するときに使用する署名。 |
|
||||
@@ -367,7 +367,7 @@ labels:
|
||||
|
||||
## ピアステータスストリーム
|
||||
|
||||
管理者専用の`peer_status`ストリームは、このサーバーが接続している他の`rippled`サーバーの活動に関する大量の情報、特にコンセンサスプロセスでのサーバーのステータスを報告します。
|
||||
管理者専用の`peer_status`ストリームは、このサーバが接続している他の`rippled`サーバの活動に関する大量の情報、特にコンセンサスプロセスでのサーバのステータスを報告します。
|
||||
|
||||
ピアステータスストリームメッセージの例:
|
||||
|
||||
@@ -383,7 +383,7 @@ labels:
|
||||
}
|
||||
```
|
||||
|
||||
ピアステータスストリームメッセージは、ピア`rippled`サーバーのステータスが変化したイベントを表します。これらのメッセージは、次のフィールドを持つJSONオブジェクトです。
|
||||
ピアステータスストリームメッセージは、ピア`rippled`サーバのステータスが変化したイベントを表します。これらのメッセージは、次のフィールドを持つJSONオブジェクトです。
|
||||
|
||||
| `Field` | 値 | 説明 |
|
||||
|:-------------------|:-------|:-----------------------------------------------|
|
||||
@@ -549,7 +549,7 @@ labels:
|
||||
|
||||
{% badge href="https://github.com/XRPLF/rippled/releases/tag/1.4.0" %}新規: rippled 1.4.0{% /badge %}
|
||||
|
||||
`consensus`ストリームは、[コンセンサスプロセス](../../../../concepts/consensus-protocol/index.md)でフェーズが変更されると、`consensusPhase`メッセージを送信します。このメッセージには、サーバーで実行されているコンセンサスの新しいフェーズが含まれます。
|
||||
`consensus`ストリームは、[コンセンサスプロセス](../../../../concepts/consensus-protocol/index.md)でフェーズが変更されると、`consensusPhase`メッセージを送信します。このメッセージには、サーバで実行されているコンセンサスの新しいフェーズが含まれます。
|
||||
|
||||
```json
|
||||
{
|
||||
@@ -563,6 +563,6 @@ labels:
|
||||
| `Field` | 型 | 説明 |
|
||||
|:--------------------|:--------------------------|:---------------------------|
|
||||
| `type` | 文字列 | `consensusPhase`は、このメッセージがコンセンサスストリームからのものであることを示します。 |
|
||||
| `consensus` | 文字列 | サーバーで実行されている新しいコンセンサスフェーズ。値には、open、establish、acceptedなどがあります。 |
|
||||
| `consensus` | 文字列 | サーバで実行されている新しいコンセンサスフェーズ。値には、open、establish、acceptedなどがあります。 |
|
||||
|
||||
{% raw-partial file="/docs/_snippets/common-links.md" /%}
|
||||
|
||||
@@ -12,7 +12,7 @@ labels:
|
||||
# unsubscribe
|
||||
[[ソース]](https://github.com/XRPLF/rippled/blob/master/src/ripple/rpc/handlers/Unsubscribe.cpp "Source")
|
||||
|
||||
`unsubscribe`コマンドはサーバーに対して、特定のサブスクリプションまたは一連のサブスクリプションへのメッセージ送信の停止を指示します。
|
||||
`unsubscribe`コマンドはサーバに対して、特定のサブスクリプションまたは一連のサブスクリプションへのメッセージ送信の停止を指示します。
|
||||
|
||||
## リクエストのフォーマット
|
||||
リクエストのフォーマットの例:
|
||||
|
||||
@@ -26,7 +26,7 @@ labels:
|
||||
| `Field` | 型 | 説明 |
|
||||
|:------------|:--------|:-----------------------------------------------------|
|
||||
| `tx_blob` | 文字列 | 送信する署名済みトランザクションの16進表現。[マルチシグトランザクション](../../../../concepts/accounts/multi-signing.md)を送信することもできます。 |
|
||||
| `fail_hard` | ブール値 | (省略可。デフォルトはfalse)trueにした場合は、トランザクションがローカルで失敗したときに再試行されず、他のサーバーにも中継されません。 |
|
||||
| `fail_hard` | ブール値 | (省略可。デフォルトはfalse)trueにした場合は、トランザクションがローカルで失敗したときに再試行されず、他のサーバにも中継されません。 |
|
||||
|
||||
### リクエストのフォーマット
|
||||
|
||||
@@ -71,7 +71,7 @@ submit 1200002280000000240000000361D4838D7EA4C6800000000000000000000000000055534
|
||||
|
||||
このモードでは、トランザクションに署名してただちに送信します。このモードは、テストで使用することを目的としています。[マルチシグトランザクション](../../../../concepts/accounts/multi-signing.md)には使用できません。
|
||||
|
||||
_デフォルトでは、署名と送信モードは[管理者専用](../../admin-api-methods/index.md)です。_ サーバーで[パブリック署名が有効になっている](../../../../infrastructure/configuration/enable-public-signing.md)場合は、パブリックメソッドとして使用できます。
|
||||
_デフォルトでは、署名と送信モードは[管理者専用](../../admin-api-methods/index.md)です。_ サーバで[パブリック署名が有効になっている](../../../../infrastructure/configuration/enable-public-signing.md)場合は、パブリックメソッドとして使用できます。
|
||||
|
||||
トランザクションの署名に使用するシークレットキーは、以下の方法で提供できます。
|
||||
|
||||
@@ -83,18 +83,18 @@ submit 1200002280000000240000000361D4838D7EA4C6800000000000000000000000000055534
|
||||
| `Field` | 型 | 説明 |
|
||||
|:---------------|:--------|:--------------------------------------------------|
|
||||
| `tx_json` | オブジェクト | JSONフォーマットの[トランザクション定義](../../../protocol/transactions/index.md)。自動入力可能なフィールドについては、省略することも可能です。 |
|
||||
| `secret` | 文字列 | _(省略可)_ トランザクションを提供するアカウントのシークレットキー。トランザクションへの署名に使用されます。信頼できないサーバーに対して、またはセキュリティが確保されていないネットワーク接続を通じて機密情報を送信しないでください。`key_type`、`seed`、`seed_hex`、`passphrase`と同時に使用することはできません。 |
|
||||
| `secret` | 文字列 | _(省略可)_ トランザクションを提供するアカウントのシークレットキー。トランザクションへの署名に使用されます。信頼できないサーバに対して、またはセキュリティが確保されていないネットワーク接続を通じて機密情報を送信しないでください。`key_type`、`seed`、`seed_hex`、`passphrase`と同時に使用することはできません。 |
|
||||
| `seed` | 文字列 | _(省略可)_ トランザクションを提供するアカウントのシークレットキー。トランザクションへの署名に使用されます。XRP Ledgerの[base58][]フォーマットにする必要があります。指定する場合は、`key_type`も指定する必要があります。`secret`、`seed_hex`、`passphrase`と同時に使用することはできません。 |
|
||||
| `seed_hex` | 文字列 | _(省略可)_ トランザクションを提供するアカウントのシークレットキー。トランザクションへの署名に使用されます。16進フォーマットにする必要があります。指定する場合は、`key_type`も指定する必要があります。`secret`、`seed`、`passphrase`と同時に使用することはできません。 |
|
||||
| `passphrase` | 文字列 | _(省略可)_ トランザクションを提供するアカウントのシークレットキー。文字列パスフレーズとして、トランザクションへの署名に使用されます。指定する場合は、`key_type`も指定する必要があります。`secret`、`seed`、`seed_hex`と同時に使用することはできません。 |
|
||||
| `key_type` | 文字列 | _(省略可)_ このリクエストで提供する暗号鍵の種類。有効な種類は、`secp256k1`または`ed25519`です。デフォルトは`secp256k1`です。`secret`と同時に使用することはできません。**注意:** Ed25519のサポートは実験的な機能です。 |
|
||||
| `fail_hard` | ブール値 | (省略可。デフォルトはfalse)trueにした場合は、トランザクションがローカルで失敗したときに再試行されず、他のサーバーにも中継されません。 |
|
||||
| `fail_hard` | ブール値 | (省略可。デフォルトはfalse)trueにした場合は、トランザクションがローカルで失敗したときに再試行されず、他のサーバにも中継されません。 |
|
||||
| `offline` | ブール値 | (省略可。デフォルトはfalse)trueにする場合は、トランザクションの生成時に、値を自動で入力または検証しようとしないでください。 |
|
||||
| `build_path` | ブール値 | _(省略可)_ Payment型のトランザクションに対して指定した場合、署名前に`Paths`フィールドが自動で入力されます。トランザクションがXRP間の直接移動である場合は、このフィールドを省略してください。**注意:** サーバーは、このフィールドの値ではなく、このフィールドが存在するかどうかを調べます。この動作は変更される可能性があります。 |
|
||||
| `build_path` | ブール値 | _(省略可)_ Payment型のトランザクションに対して指定した場合、署名前に`Paths`フィールドが自動で入力されます。トランザクションがXRP間の直接移動である場合は、このフィールドを省略してください。**注意:** サーバは、このフィールドの値ではなく、このフィールドが存在するかどうかを調べます。この動作は変更される可能性があります。 |
|
||||
| `fee_mult_max` | 整数 | (省略可。デフォルトは10、推奨値は1000)`Fee`パラメーターを省略する場合は、自動的に提供される`Fee`値が長期の基本トランザクションコストとこの値の積以下になるよう、このフィールドで制限します。 |
|
||||
| `fee_div_max` | 整数 | (省略可。デフォルトは1)`fee_mult_max`と併用して、制限に使用される分数の乗数を作成します。具体的には、サーバーは基本[トランザクションコスト](../../../../concepts/transactions/transaction-cost.md)を`fee_mult_max`で乗算した後、この値で除算して上限値(整数値に丸められます)を割り出します。自動的に提供される`Fee`値が上限値を超えている場合、submitコマンドは失敗します。{% badge href="https://github.com/XRPLF/rippled/releases/tag/0.30.1" %}新規: rippled 0.30.1{% /badge %} |
|
||||
| `fee_div_max` | 整数 | (省略可。デフォルトは1)`fee_mult_max`と併用して、制限に使用される分数の乗数を作成します。具体的には、サーバは基本[トランザクションコスト](../../../../concepts/transactions/transaction-cost.md)を`fee_mult_max`で乗算した後、この値で除算して上限値(整数値に丸められます)を割り出します。自動的に提供される`Fee`値が上限値を超えている場合、submitコマンドは失敗します。{% badge href="https://github.com/XRPLF/rippled/releases/tag/0.30.1" %}新規: rippled 0.30.1{% /badge %} |
|
||||
|
||||
サーバーによって特定のフィールドにどのように値が自動入力されるかについては、[signメソッド][]を参照してください。
|
||||
サーバによって特定のフィールドにどのように値が自動入力されるかについては、[signメソッド][]を参照してください。
|
||||
|
||||
### リクエストのフォーマット
|
||||
リクエストのフォーマットの例:
|
||||
@@ -284,14 +284,14 @@ Connecting to 127.0.0.1:5005
|
||||
## 考えられるエラー
|
||||
|
||||
* いずれかの[汎用エラータイプ][]。
|
||||
* `amendmentBlocked` - `rippled`サーバーでの[修正がブロックされている](../../../../concepts/networks-and-servers/amendments.md#amendment-blocked)ため、トランザクションをネットワークに送信できません。
|
||||
* `highFee` - `fee_mult_max`パラメーターが指定されましたが、サーバーの現在の手数料の乗数が指定値を超えています(署名と送信モードのみ)。
|
||||
* `amendmentBlocked` - `rippled`サーバでの[修正がブロックされている](../../../../concepts/networks-and-servers/amendments.md#amendment-blocked)ため、トランザクションをネットワークに送信できません。
|
||||
* `highFee` - `fee_mult_max`パラメーターが指定されましたが、サーバの現在の手数料の乗数が指定値を超えています(署名と送信モードのみ)。
|
||||
* `internalJson` - トランザクションをJSONへとシリアル化するときに、内部エラーが発生しました。このエラーは、無効な署名や一部フィールドの形式の誤りなど、トランザクションのさまざまな側面が原因となって発生する可能性があります。
|
||||
* `internalSubmit` - トランザクションを送信するときに内部エラーが発生しました。このエラーは、無効な署名や一部フィールドの形式の誤りなど、トランザクションのさまざまな側面が原因となって発生する可能性があります。
|
||||
* `internalTransaction` - トランザクションを処理するときに内部エラーが発生しました。このエラーは、無効な署名や一部フィールドの形式の誤りなど、トランザクションのさまざまな側面が原因となって発生する可能性があります。
|
||||
* `invalidParams` - 1つ以上のフィールドの指定が正しくないか、1つ以上の必須フィールドが指定されていません。
|
||||
* `invalidTransaction` - トランザクションの形式が誤っているか、その他の理由で無効なものになっています。
|
||||
* `noPath` - トランザクションにパスが含まれておらず、サーバーは、このペイメントの発生経路となるパスを検出できませんでした。(署名と送信モードのみ)。
|
||||
* `tooBusy` - トランザクションにパスが含まれていませんが、サーバーがビジーであるため、パス検出処理をすぐに実行できません。管理者として接続している場合は発生しません。(署名と送信モードのみ)。
|
||||
* `noPath` - トランザクションにパスが含まれておらず、サーバは、このペイメントの発生経路となるパスを検出できませんでした。(署名と送信モードのみ)。
|
||||
* `tooBusy` - トランザクションにパスが含まれていませんが、サーバがビジーであるため、パス検出処理をすぐに実行できません。管理者として接続している場合は発生しません。(署名と送信モードのみ)。
|
||||
|
||||
{% raw-partial file="/docs/_snippets/common-links.md" /%}
|
||||
|
||||
@@ -139,7 +139,7 @@ rippled submit_multisigned '{
|
||||
| `Field` | 型 | 説明 |
|
||||
|:------------|:--------|:-----------------------------------------------------|
|
||||
| `tx_json` | オブジェクト | `Signers`からなる配列が指定された[JSONフォーマットのトランザクション](../../../protocol/transactions/index.md)。成功させるには、署名の重みが[SignerList](../../../protocol/ledger-data/ledger-entry-types/signerlist.md)の定数以上でなければなりません。 |
|
||||
| `fail_hard` | ブール値 | (省略可、デフォルトではfalseです)trueで、かつトランザクションがローカルで失敗する場合は、このトランザクションの再試行や、他のサーバーへのリレーは行わないでください。 |
|
||||
| `fail_hard` | ブール値 | (省略可、デフォルトではfalseです)trueで、かつトランザクションがローカルで失敗する場合は、このトランザクションの再試行や、他のサーバへのリレーは行わないでください。 |
|
||||
|
||||
## レスポンスのフォーマット
|
||||
|
||||
|
||||
@@ -210,18 +210,18 @@ rippled transaction_entry E08D6E9754025BA2534A78707605E0601F03ACE063687A0CA1BDDA
|
||||
| `metadata` | オブジェクト | [トランザクションのメタデータ](../../../protocol/transactions/metadata.md)。トランザクションの正確な結果を詳細に表示します。 |
|
||||
| `tx_json` | オブジェクト | [Transactionオブジェクト](../../../protocol/transactions/index.md)のJSON表現。 |
|
||||
|
||||
サーバーがトランザクションの検出に失敗する原因として、次のようなものが考えられます。
|
||||
サーバがトランザクションの検出に失敗する原因として、次のようなものが考えられます。
|
||||
|
||||
* トランザクションが存在しません。
|
||||
* トランザクションが存在しますが、指定のレジャーバージョンに含まれていません。
|
||||
* サーバーには、使用可能な指定のレジャーバージョンがありません。正しいバージョンを保管する別のサーバーからのレスポンスは、異なる可能性があります。
|
||||
* サーバには、使用可能な指定のレジャーバージョンがありません。正しいバージョンを保管する別のサーバからのレスポンスは、異なる可能性があります。
|
||||
|
||||
## 考えられるエラー
|
||||
|
||||
* いずれかの[汎用エラータイプ][]。
|
||||
* `fieldNotFoundTransaction` - `tx_hash`フィールドがリクエストで省略されています。
|
||||
* `notYetImplemented` - レジャーバージョンがリクエストに指定されていません。
|
||||
* `lgrNotFound` - `ledger_hash`または`ledger_index`で指定したレジャーが存在しないか、存在してはいるもののサーバーが保有していません。
|
||||
* `lgrNotFound` - `ledger_hash`または`ledger_index`で指定したレジャーが存在しないか、存在してはいるもののサーバが保有していません。
|
||||
* `transactionNotFound` - リクエストに指定されているトランザクションが指定のレジャーで見つかりませんでした。(トランザクションが異なるレジャーバージョンにあるか、またはトランザクションがまったく使用できない可能性があります。)
|
||||
|
||||
{% raw-partial file="/docs/_snippets/common-links.md" /%}
|
||||
|
||||
@@ -898,6 +898,6 @@ rippled tx_history 0
|
||||
|
||||
* [汎用エラータイプ][]のすべて。
|
||||
* `invalidParams` - 1つ以上のフィールドの指定が正しくないか、1つ以上の必須フィールドが指定されていません。
|
||||
* `noPermission` - `start`フィールドに指定されている値が10000を超えていますが、サーバーに管理者として接続していません。
|
||||
* `noPermission` - `start`フィールドに指定されている値が10000を超えていますが、サーバに管理者として接続していません。
|
||||
|
||||
{% raw-partial file="/docs/_snippets/common-links.md" /%}
|
||||
|
||||
@@ -4,7 +4,7 @@ parent: utility-methods.html
|
||||
seo:
|
||||
description: コマンドのパラメーターをJSON値として受け入れ、他のコマンドを実行します。
|
||||
labels:
|
||||
- コアサーバー
|
||||
- コアサーバ
|
||||
---
|
||||
# json
|
||||
|
||||
|
||||
@@ -4,7 +4,7 @@ parent: utility-methods.html
|
||||
seo:
|
||||
description: 確認レスポンスを返します。これにより、接続のステータスと遅延をテストできます。
|
||||
labels:
|
||||
- コアサーバー
|
||||
- コアサーバ
|
||||
---
|
||||
# ping
|
||||
[[ソース]](https://github.com/XRPLF/rippled/blob/master/src/ripple/rpc/handlers/Ping.cpp "Source")
|
||||
|
||||
@@ -4,7 +4,7 @@ parent: utility-methods.html
|
||||
seo:
|
||||
description: クライアントが乱数生成のエントロピー生成源として使用する乱数を提供します。
|
||||
labels:
|
||||
- コアサーバー
|
||||
- コアサーバ
|
||||
---
|
||||
# random
|
||||
[[ソース]](https://github.com/XRPLF/rippled/blob/master/src/ripple/rpc/handlers/Random.cpp "Source")
|
||||
|
||||
Reference in New Issue
Block a user