mirror of
https://github.com/XRPLF/xrpl-dev-portal.git
synced 2025-12-01 09:05:49 +00:00
Re-levelization: move non-docs content, rename content→docs
For better URLs, the content folder has been renamed 'docs' and all other files have been moved up a level. Also, non-docs images have been moved to the static folder at the top level where they belong. Many relative paths had to be fixed to make this work.
This commit is contained in:
mDuo13
@@ -0,0 +1,68 @@
|
||||
---
|
||||
html: admin-api-methods.html
|
||||
parent: http-websocket-apis.html
|
||||
seo:
|
||||
description: これらの管理APIメソッドを使用してrippledサーバーを管理します。
|
||||
labels:
|
||||
- コアサーバー
|
||||
---
|
||||
# 管理APIメソッド
|
||||
|
||||
`rippled`サーバーと直接通信する際には管理APIメソッドを使用します。管理メソッドは、信頼できるサーバー運用担当者のみを対象としています。管理メソッドには、サーバーの管理、監視、デバッグのためのコマンドが含まれています。
|
||||
|
||||
管理コマンドを使用できるのは、管理者として、`rippled.cfg`ファイルに指定されているホストとポートで`rippled`サーバーに接続している場合に限られます。デフォルトでは、コマンドラインクライアントが管理接続を使用します。`rippled`への接続についての詳細は、[rippled API入門](../../../tutorials/get-started/get-started-using-http-websocket-apis.md)を参照してください。
|
||||
|
||||
|
||||
## [キー生成メソッド](key-generation-methods/index.md)
|
||||
|
||||
キーを生成および管理するには、以下のメソッドを使用します。
|
||||
|
||||
* **[`validation_create`](key-generation-methods/validation_create.md)** - 新しいrippledバリデータのキーを生成します。
|
||||
* **[`wallet_propose`](key-generation-methods/wallet_propose.md)** - 新規アカウントのキーを生成します。
|
||||
|
||||
|
||||
## [ロギングおよびデータ管理のメソッド](logging-and-data-management-methods/index.md)
|
||||
|
||||
ログレベルとその他のデータ（レジャーなど）の管理には、以下のメソッドを使用します。
|
||||
|
||||
* **[`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)** - ピアサーバーに対し特定のレジャーバージョンを照会します。
|
||||
* **[`log_level`](logging-and-data-management-methods/log_level.md)** - ログの詳細レベルを取得または変更します。
|
||||
* **[`logrotate`](logging-and-data-management-methods/logrotate.md)** - ログファイルを再度開きます。
|
||||
|
||||
|
||||
## [サーバー制御メソッド](server-control-methods/index.md)
|
||||
|
||||
rippledサーバーの管理には、以下のメソッドを使用します。
|
||||
|
||||
* **[`connect`](peer-management-methods/connect.md)** - rippledサーバーを特定のピアに強制的に接続します。
|
||||
* **[`ledger_accept`](server-control-methods/ledger_accept.md)** - スタンドアロンモードでレジャーを閉鎖し、次のレジャーに進みます。
|
||||
* **[`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)** - 接続しているピアサーバーに関する情報を取得します。
|
||||
* **[`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)** - バリデータリストを公開するサイトに関する情報を取得します。
|
||||
|
||||
|
||||
## 廃止予定のメソッド
|
||||
|
||||
以下の管理コマンドは廃止予定であり、今後予告なしに削除される可能性があります。
|
||||
|
||||
* `ledger_header` - 代わりに[ledgerメソッド][]を使用してください。
|
||||
* `unl_add`、`unl_delete`、`unl_list`、`unl_load`、`unl_network`、`unl_reset`、`unl_score` - 代わりに UNL管理用構成ファイルを使用してください。
|
||||
* `wallet_seed` - 代わりに[wallet_proposeメソッド][]を使用してください。
|
||||
|
||||
{% raw-partial file="/docs/_snippets/common-links.md" /%}
|
||||
@@ -0,0 +1,12 @@
|
||||
---
|
||||
html: key-generation-methods.html
|
||||
parent: admin-api-methods.html
|
||||
metadata:
|
||||
indexPage: true
|
||||
---
|
||||
# キー生成メソッド
|
||||
|
||||
以下のメソッドを使用してキーを生成および管理することができます。
|
||||
|
||||
|
||||
{% child-pages /%}
|
||||
@@ -0,0 +1,117 @@
|
||||
---
|
||||
html: validation_create.html
|
||||
parent: key-generation-methods.html
|
||||
seo:
|
||||
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`メソッドは、権限のないユーザーは実行できない[管理メソッド](../index.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サーバーで検証を有効化)を参照してください。
|
||||
|
||||
|
||||
### リクエストのフォーマット
|
||||
リクエストのフォーマットの例:
|
||||
|
||||
{% tabs %}
|
||||
|
||||
{% tab label="WebSocket" %}
|
||||
```json
|
||||
{
|
||||
"id": 0,
|
||||
"command": "validation_create",
|
||||
"secret": "BAWL MAN JADE MOON DOVE GEM SON NOW HAD ADEN GLOW TIRE"
|
||||
}
|
||||
```
|
||||
{% /tab %}
|
||||
|
||||
{% tab label="JSON-RPC" %}
|
||||
```json
|
||||
{
|
||||
"method": "validation_create",
|
||||
"params": [
|
||||
{
|
||||
"secret": "BAWL MAN JADE MOON DOVE GEM SON NOW HAD ADEN GLOW TIRE"
|
||||
}
|
||||
]
|
||||
}
|
||||
```
|
||||
{% /tab %}
|
||||
|
||||
{% tab label="コマンドライン" %}
|
||||
```sh
|
||||
#Syntax: validation_create [secret]
|
||||
rippled validation_create "BAWL MAN JADE MOON DOVE GEM SON NOW HAD ADEN GLOW TIRE"
|
||||
```
|
||||
{% /tab %}
|
||||
|
||||
{% /tabs %}
|
||||
|
||||
リクエストには以下のパラメーターが含まれます。
|
||||
|
||||
| `Field` | 型 | 説明 |
|
||||
|:---------|:-------|:---------------------------------------------------------|
|
||||
| `secret` | 文字列 | _（省略可）_ クレデンシャルを生成するときにこの値をシードとして使用します。同じシークレットを使用すると常に同じクレデンシャルが生成されます。シードは[RFC-1751](https://tools.ietf.org/html/rfc1751)フォーマットまたはXRP Ledgerの[base58][]フォーマットで指定できます。省略すると、ランダムシードが生成されます。 |
|
||||
|
||||
**注記:** バリデータのセキュリティは、シードのエントロピーに応じて異なります。シークレット値が強力なランダム性のソースを使用して生成されている場合を除き、実際の事業目的のためにシークレット値を使用しないでください。新しいクレデンシャルを初めて生成するときには`secret`を省略することが推奨されます。
|
||||
|
||||
### レスポンスのフォーマット
|
||||
|
||||
処理が成功したレスポンスの例:
|
||||
|
||||
{% tabs %}
|
||||
|
||||
{% tab label="JSON-RPC" %}
|
||||
```json
|
||||
{
|
||||
"result" : {
|
||||
"status" : "success",
|
||||
"validation_key" : "FAWN JAVA JADE HEAL VARY HER REEL SHAW GAIL ARCH BEN IRMA",
|
||||
"validation_public_key" : "n9Mxf6qD4J55XeLSCEpqaePW4GjoCR5U1ZeGZGJUCNe3bQa4yQbG",
|
||||
"validation_seed" : "ssZkdwURFMBXenJPbrpE14b6noJSu"
|
||||
}
|
||||
}
|
||||
```
|
||||
{% /tab %}
|
||||
|
||||
{% tab label="コマンドライン" %}
|
||||
```json
|
||||
Loading: "/etc/rippled.cfg"
|
||||
Connecting to 127.0.0.1:5005
|
||||
|
||||
{
|
||||
"result" : {
|
||||
"status" : "success",
|
||||
"validation_key" : "FAWN JAVA JADE HEAL VARY HER REEL SHAW GAIL ARCH BEN IRMA",
|
||||
"validation_public_key" : "n9Mxf6qD4J55XeLSCEpqaePW4GjoCR5U1ZeGZGJUCNe3bQa4yQbG",
|
||||
"validation_seed" : "ssZkdwURFMBXenJPbrpE14b6noJSu"
|
||||
}
|
||||
}
|
||||
```
|
||||
{% /tab %}
|
||||
|
||||
{% /tabs %}
|
||||
|
||||
このレスポンスは[標準フォーマット][]に従っており、正常に完了した場合は結果に次のフィールドが含まれています。
|
||||
|
||||
| `Field` | 型 | 説明 |
|
||||
|:------------------------|:-------|:------------------------------------------|
|
||||
| `validation_key` | 文字列 | これらの検証クレデンシャルのシークレットキー（[RFC-1751](https://tools.ietf.org/html/rfc1751)フォーマット）。 |
|
||||
| `validation_public_key` | 文字列 | これらの検証クレデンシャルの公開鍵（XRP Ledgerの[base58][]エンコード文字列フォーマット）。 |
|
||||
| `validation_seed` | 文字列 | これらの検証クレデンシャルのシークレットキー（XRP Ledgerの[base58][]エンコード文字列フォーマット）。 |
|
||||
|
||||
### 考えられるエラー
|
||||
|
||||
* [汎用エラータイプ][]のすべて。
|
||||
* `badSeed` - リクエストに無効なシード値が指定されていました。この場合は通常、シード値が異なるフォーマットの有効文字列（アカウントアドレス、検証の公開鍵など）である可能性があります。
|
||||
|
||||
{% raw-partial file="/docs/_snippets/common-links.md" /%}
|
||||
@@ -0,0 +1,204 @@
|
||||
---
|
||||
html: wallet_propose.html
|
||||
parent: key-generation-methods.html
|
||||
seo:
|
||||
description: キーペアとXRP Ledgerアドレスを生成します。
|
||||
labels:
|
||||
- セキュリティ
|
||||
- アカウント
|
||||
---
|
||||
# wallet_propose
|
||||
[[ソース]](https://github.com/XRPLF/rippled/blob/master/src/ripple/rpc/handlers/WalletPropose.cpp "Source")
|
||||
|
||||
`wallet_propose`メソッドを使用して、キーペアとXRP Ledgerアドレスを生成します。このコマンドは単にキーとアドレス値を生成し、XRP Ledger自体には何ら影響しません。レジャー上で資金供給済みのアドレスになるには、そのアドレスで、[必要準備金](../../../../concepts/accounts/reserves.md)を満たすのに十分なXRPの[Paymentトランザクションを受け取る](../../../../concepts/accounts/accounts.md#アカウントの作成)必要があります。
|
||||
|
||||
*`wallet_propose`メソッドは、権限のないユーザーは実行できない[管理メソッド](../index.md)です。*(このコマンドは、アカウントの機密情報を求めてネットワーク上の伝送情報をスニッフィングする人々から守るためにadminコマンドとされています。adminコマンドは通常、外部ネットワーク上で伝送されることはありません。）
|
||||
|
||||
{% badge href="https://github.com/XRPLF/rippled/releases/tag/0.31.0" %}更新: rippled 0.31.0{% /badge %}
|
||||
|
||||
### リクエストのフォーマット
|
||||
|
||||
リクエストのフォーマットの例:
|
||||
|
||||
{% tabs %}
|
||||
|
||||
{% tab label="WebSocket（キータイプあり）" %}
|
||||
```json
|
||||
{
|
||||
"command": "wallet_propose",
|
||||
"seed": "snoPBrXtMeMyMHUVTgbuqAfg1SUTb",
|
||||
"key_type": "secp256k1"
|
||||
}
|
||||
```
|
||||
{% /tab %}
|
||||
|
||||
{% tab label="WebSocket（キータイプなし）" %}
|
||||
```json
|
||||
{
|
||||
"command": "wallet_propose",
|
||||
"passphrase": "masterpassphrase"
|
||||
}
|
||||
```
|
||||
{% /tab %}
|
||||
|
||||
{% tab label="JSON-RPC（キータイプあり）" %}
|
||||
```json
|
||||
{
|
||||
"method": "wallet_propose",
|
||||
"params": [
|
||||
{
|
||||
"seed": "snoPBrXtMeMyMHUVTgbuqAfg1SUTb",
|
||||
"key_type": "secp256k1"
|
||||
}
|
||||
]
|
||||
}
|
||||
```
|
||||
{% /tab %}
|
||||
|
||||
{% tab label="JSON-RPC（キータイプなし）" %}
|
||||
```json
|
||||
{
|
||||
"method": "wallet_propose",
|
||||
"params": [
|
||||
{
|
||||
"passphrase": "snoPBrXtMeMyMHUVTgbuqAfg1SUTb"
|
||||
}
|
||||
]
|
||||
}
|
||||
```
|
||||
{% /tab %}
|
||||
|
||||
{% tab label="コマンドライン" %}
|
||||
```sh
|
||||
#Syntax: wallet_propose [passphrase]
|
||||
rippled wallet_propose masterpassphrase
|
||||
```
|
||||
{% /tab %}
|
||||
|
||||
{% /tabs %}
|
||||
|
||||
リクエストには以下のパラメーターを含めることができます。
|
||||
|
||||
| `Field` | 型 | 説明 |
|
||||
|:-------------|:-------|:-----------------------------------------------------|
|
||||
| `key_type` | 文字列 | このキーペアの導出に使用する[署名アルゴリズム](../../../../concepts/accounts/cryptographic-keys.md#署名アルゴリズム)。有効な値は`ed25519`と`secp256k1`（すべて小文字）です。デフォルトは`secp256k1`です。 |
|
||||
| `passphrase` | 文字列 | _（省略可）_ このシード値からキーペアとアドレスを生成します。この値は、[16進数][]、XRP Ledgerの[base58][]フォーマット、[RFC-1751][]、または任意の文字列でフォーマットできます。`seed`または`seed_hex`とともに使用することはできません。 |
|
||||
| `seed` | 文字列 | _（省略可能）_ このシード値からXRP Ledgerの[base58][]エンコードフォーマットでキーペアとアドレスを生成します。`passphrase`または`seed_hex`とともに使用することはできません。 |
|
||||
| `seed_hex` | 文字列 | _（省略可能）_ このシード値から[16進数][]形式でキーペアとアドレスを生成します。`passphrase`または`seed`とともに使用することはできません。 |
|
||||
|
||||
以下のフィールドのうち**1つ**を指定する必要があります。`passphrase`、`seed`、または`seed_hex`。3つすべてを省略すると、`rippled`によってランダムシードが使用されます。
|
||||
|
||||
**注記:** このコマンドのコマンドラインバージョンでは[Ed25519](https://ed25519.cr.yp.to/)キーを生成できません。
|
||||
|
||||
#### シードの指定
|
||||
|
||||
ほとんどの場合、強力な乱数ソースから生成されたシード値を使用する必要があります。あるアドレスのシード値を知っている人は、[そのアドレスで署名されたトランザクションを送信する](../../../../concepts/transactions/index.md#トランザクションの承認)すべての権限を持っています。一般的に、ランダムシードの生成には、このコマンドにパラメーターを指定しないで実行する方法が適しています。
|
||||
|
||||
以下の場合には、既知のシードを指定します。
|
||||
|
||||
* アドレスに関連するシードのみを知っていて、アドレスを再計算する
|
||||
* `rippled`の機能をテストする
|
||||
|
||||
シードは、以下のどのフォーマットでも指定できます。
|
||||
|
||||
* XRP Ledgerの[base58][]フォーマットのシークレットキー文字列。例: `snoPBrXtMeMyMHUVTgbuqAfg1SUTb`。
|
||||
* [RFC-1751][]フォーマット文字列（secp256k1キーペアのみ）。例: `I IRE BOND BOW TRIO LAID SEAT GOAL HEN IBIS IBIS DARE`。
|
||||
* 128ビットの[16進数][]文字列。例: `DEDCE9CE67B451D852FD4E846FCDE31C`。
|
||||
* シード値として使用する任意の文字列。例: `masterpassphrase`。
|
||||
|
||||
[RFC-1751]: https://tools.ietf.org/html/rfc1751 ""
|
||||
[16進数]: https://en.wikipedia.org/wiki/Hexadecimal ""
|
||||
|
||||
### レスポンスのフォーマット
|
||||
|
||||
処理が成功したレスポンスの例:
|
||||
|
||||
{% tabs %}
|
||||
|
||||
{% tab label="WebSocket" %}
|
||||
```json
|
||||
{
|
||||
"id": 2,
|
||||
"status": "success",
|
||||
"type": "response",
|
||||
"result": {
|
||||
"account_id": "rHb9CJAWyB4rj91VRWn96DkukG4bwdtyTh",
|
||||
"key_type": "secp256k1",
|
||||
"master_key": "I IRE BOND BOW TRIO LAID SEAT GOAL HEN IBIS IBIS DARE",
|
||||
"master_seed": "snoPBrXtMeMyMHUVTgbuqAfg1SUTb",
|
||||
"master_seed_hex": "DEDCE9CE67B451D852FD4E846FCDE31C",
|
||||
"public_key": "aBQG8RQAzjs1eTKFEAQXr2gS4utcDiEC9wmi7pfUPTi27VCahwgw",
|
||||
"public_key_hex": "0330E7FC9D56BB25D6893BA3F317AE5BCF33B3291BD63DB32654A313222F7FD020"
|
||||
}
|
||||
}
|
||||
```
|
||||
{% /tab %}
|
||||
|
||||
{% tab label="JSON-RPC" %}
|
||||
```json
|
||||
{
|
||||
"result": {
|
||||
"account_id": "rHb9CJAWyB4rj91VRWn96DkukG4bwdtyTh",
|
||||
"key_type": "secp256k1",
|
||||
"master_key": "I IRE BOND BOW TRIO LAID SEAT GOAL HEN IBIS IBIS DARE",
|
||||
"master_seed": "snoPBrXtMeMyMHUVTgbuqAfg1SUTb",
|
||||
"master_seed_hex": "DEDCE9CE67B451D852FD4E846FCDE31C",
|
||||
"public_key": "aBQG8RQAzjs1eTKFEAQXr2gS4utcDiEC9wmi7pfUPTi27VCahwgw",
|
||||
"public_key_hex": "0330E7FC9D56BB25D6893BA3F317AE5BCF33B3291BD63DB32654A313222F7FD020",
|
||||
"status": "success"
|
||||
}
|
||||
}
|
||||
```
|
||||
{% /tab %}
|
||||
|
||||
{% tab label="コマンドライン" %}
|
||||
```json
|
||||
Loading: "/etc/rippled.cfg"
|
||||
Connecting to 127.0.0.1:5005
|
||||
|
||||
{
|
||||
"result" : {
|
||||
"account_id" : "rHb9CJAWyB4rj91VRWn96DkukG4bwdtyTh",
|
||||
"key_type" : "secp256k1",
|
||||
"master_key" : "I IRE BOND BOW TRIO LAID SEAT GOAL HEN IBIS IBIS DARE",
|
||||
"master_seed" : "snoPBrXtMeMyMHUVTgbuqAfg1SUTb",
|
||||
"master_seed_hex" : "DEDCE9CE67B451D852FD4E846FCDE31C",
|
||||
"public_key" : "aBQG8RQAzjs1eTKFEAQXr2gS4utcDiEC9wmi7pfUPTi27VCahwgw",
|
||||
"public_key_hex" : "0330E7FC9D56BB25D6893BA3F317AE5BCF33B3291BD63DB32654A313222F7FD020",
|
||||
"status" : "success"
|
||||
}
|
||||
}
|
||||
```
|
||||
{% /tab %}
|
||||
|
||||
{% /tabs %}
|
||||
|
||||
レスポンスは[標準フォーマット][]に従い、正常に終了した場合、新しい（可能性がある）アカウントについての重要な各種情報を含みます。以下のフィールドを含みます。
|
||||
|
||||
| `Field` | 型 | 説明 |
|
||||
|:------------------|:-------|:------------------------------------------------|
|
||||
| `key_type` | 文字列 | このキーペアの導出に使用された[署名アルゴリズム](../../../../concepts/accounts/cryptographic-keys.md#署名アルゴリズム)。有効な値は`ed25519`と`secp256k1`（すべて小文字）です。 |
|
||||
| `master_seed` | 文字列 | これはキーペアの秘密鍵です。このアカウントに関するその他のあらゆる情報が、マスターシードからXRP Ledgerの[base58][]エンコード文字列フォーマットで引き出されます。通常、このフォーマットのキーを使用してトランザクションに署名します。 |
|
||||
| `master_seed_hex` | 文字列 | 16進数形式のマスターシード。単純で広く支持されている秘密鍵表示法。トランザクションの署名に使用できます。 |
|
||||
| `master_key` | 文字列 | **廃止予定** [RFC-1751][]形式のマスターシード。覚えやすく書き留めやすい秘密鍵。トランザクションの署名に使用できます。**注記:** `rippled`の実装では、RFC-1751からデコードした後、RFC-1751にエンコードする前に、キーのバイト順序が逆になります。別のRFC-1751実装を使用して、XRP Ledgerで使用するキーの読み書きを行う場合は、同様にして、`rippled`のRFC-1751エンコーディングとの互換性を保つ必要があります。 |
|
||||
| `account_id` | 文字列 | XRP Ledgerの[base58][]フォーマットで作成されたアカウントの[アドレス][]。これは公開鍵ではありませんが、公開鍵を2回ハッシュ化したものです。チェックサムも持っているため、タイプミスした場合はほぼ間違いなく無効なアドレスとみなされ、有効だが異なるアドレスとはみなされません。これはXRP LedgerのアカウントのプライマリIDです。支払いを受けるときにこれを人に伝えたり、トランザクションにおいて、自身や、支払先、委託先識別するのに使用します。[マルチシグリスト](../../../../concepts/accounts/multi-signing.md)でもこれを使用して、他の署名者を識別します。 |
|
||||
| `public_key` | 文字列 | XRP Ledgerの[base58][]エンコード文字列フォーマットで作成された、キーペアの公開鍵。`master_seed`から生成されます。 |
|
||||
| `public_key_hex` | 文字列 | これは16進数で作成されたキーペアの公開鍵です。`master_seed`から生成されます。トランザクションの署名を検証する場合、`rippled`にはこの公開鍵が必要です。そのため、署名されたトランザクションのフォーマットの`SigningPubKey`フィールドには公開鍵が入力されています。 |
|
||||
| `warning` | 文字列 | （削除される可能性あり）リクエストにシード値を指定した場合、このフィールドに安全でない可能性があるという警告が表示されます。{% badge href="https://github.com/XRPLF/rippled/releases/tag/0.32.0" %}新規: rippled 0.32.0{% /badge %} |
|
||||
|
||||
このメソッドを使用してキーペアを生成し、アカウントのレギュラーキーペアとして使用することもできます。アカウントにレギュラーキーペアを割り当てて、それを使用してほとんどのトランザクションに署名し、マスターキーペアをできるだけオフラインにしておくことも可能です。
|
||||
|
||||
レギュラーキーペアとして使用するほかに、マルチシグのリスト（SignerList）のメンバーとして使用することもできます。
|
||||
|
||||
マスターキーペアとレギュラーキーペアの詳細は、[暗号鍵](../../../../concepts/accounts/cryptographic-keys.md)を参照してください。
|
||||
|
||||
マルチシグの詳細は、[マルチシグ](../../../../concepts/accounts/multi-signing.md)を参照してください。
|
||||
|
||||
|
||||
### 考えられるエラー
|
||||
|
||||
* いずれかの[汎用エラータイプ][]。
|
||||
* `invalidParams` - 1つ以上のフィールドが不正に指定されています。
|
||||
* `badSeed` - リクエストには、空の文字列やXRP Ledgerアドレスに似た文字列などの許可されないシード値が（`passphrase`、`seed`、または`seed_hex`フィールド内に）指定されています。
|
||||
|
||||
{% raw-partial file="/docs/_snippets/common-links.md" /%}
|
||||
@@ -0,0 +1,83 @@
|
||||
---
|
||||
html: can_delete.html
|
||||
parent: logging-and-data-management-methods.html
|
||||
seo:
|
||||
description: 指定したレジャーバージョン以前のレジャー履歴を削除可能にします。
|
||||
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`メソッドは、権限のないユーザーは実行できない[管理メソッド](../index.md)です。_
|
||||
|
||||
### リクエストのフォーマット
|
||||
|
||||
リクエストのフォーマットの例:
|
||||
|
||||
{% tabs %}
|
||||
|
||||
{% tab label="WebSocket" %}
|
||||
```json
|
||||
{
|
||||
"id": 2,
|
||||
"command": "can_delete",
|
||||
"can_delete": 11320417
|
||||
}
|
||||
```
|
||||
{% /tab %}
|
||||
|
||||
{% tab label="JSON-RPC" %}
|
||||
```json
|
||||
{
|
||||
"method": "can_delete",
|
||||
"params": [
|
||||
{
|
||||
"can_delete": 11320417
|
||||
}
|
||||
]
|
||||
}
|
||||
```
|
||||
{% /tab %}
|
||||
|
||||
{% tab label="コマンドライン" %}
|
||||
```sh
|
||||
#Syntax: can_delete [<ledger_index>|<ledger_hash>|now|always|never]
|
||||
rippled can_delete 11320417
|
||||
```
|
||||
{% /tab %}
|
||||
|
||||
{% /tabs %}
|
||||
|
||||
リクエストには以下のパラメーターを指定できます。
|
||||
|
||||
| `Field` | 型 | 説明 |
|
||||
|:-------------|:------------------|:------------------------------------------|
|
||||
| `can_delete` | 文字列 または整数 | _（省略可）_ 削除可能な最大レジャーバージョンの[レジャーインデックス][]。特殊ケース`never`を指定すると、オンライン削除が無効になります。特殊ケース`always`を指定すると、指示による削除が無効な場合と同様に、自動オンライン削除が有効になります。特殊ケース`now`を指定すると、設定されている`online_delete`値に一致するかまたはこの値を超える次の検証済みレジャーで、オンライン削除が1回実行されます。省略すると、サーバーは変更を行いません（ただし現在の`can_delete`の値でレスポンスします）。 |
|
||||
|
||||
### レスポンスのフォーマット
|
||||
|
||||
レスポンスは[標準フォーマット][]に従っており、正常に完了した場合は結果に次のフィールドが含まれています。
|
||||
|
||||
| `Field` | 型 | 説明 |
|
||||
|:-------------|:--------|:----------------------------------------------------|
|
||||
| `can_delete` | 整数 | オンライン削除ルーチンにより削除できる最大レジャーインデックス。 |
|
||||
|
||||
既存の`can_delete`設定を照会する場合は、パラメーターを指定せずにこのコマンドを実行します。
|
||||
|
||||
### 考えられるエラー
|
||||
|
||||
- [汎用エラータイプ][]のすべて。
|
||||
- `invalidParams` - 1つ以上のフィールドの指定が正しくないか、1つ以上の必須フィールドが指定されていません。
|
||||
- `lgrNotFound` リクエストの`can_delete`フィールドに指定されているレジャーが存在しないか、存在しているがサーバーにはありません。
|
||||
- `notEnabled` - オンライン削除または指示による削除のいずれかがサーバーの設定で有効になっていない場合。
|
||||
- `notReady` - サーバーは現在オンライン削除を実行する準備ができていません。これは通常、サーバーが起動したが、検証済みレジャーをまだ取得していないことを意味します。
|
||||
|
||||
## 参照項目
|
||||
|
||||
- [オンライン削除](../../../../infrastructure/configuration/data-retention/online-deletion.md)
|
||||
- [指示による削除の設定](../../../../infrastructure/configuration/data-retention/configure-advisory-deletion.md)
|
||||
|
||||
{% raw-partial file="/docs/_snippets/common-links.md" /%}
|
||||
@@ -0,0 +1,140 @@
|
||||
---
|
||||
html: crawl_shards.html
|
||||
parent: logging-and-data-management-methods.html
|
||||
seo:
|
||||
description: ピアが持つ履歴シャードについての情報をリクエストします。
|
||||
labels:
|
||||
- データ保持
|
||||
---
|
||||
# crawl_shards
|
||||
|
||||
[[ソース]](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 %}
|
||||
|
||||
_`crawl_shards`メソッドは、権限のないユーザーは実行できない[管理メソッド](../index.md)です。_
|
||||
|
||||
### リクエストのフォーマット
|
||||
|
||||
リクエストのフォーマットの例:
|
||||
|
||||
{% tabs %}
|
||||
|
||||
{% tab label="WebSocket" %}
|
||||
```json
|
||||
{
|
||||
"command": "crawl_shards",
|
||||
"pubkey": true,
|
||||
"limit": 0
|
||||
}
|
||||
```
|
||||
{% /tab %}
|
||||
|
||||
{% tab label="JSON-RPC" %}
|
||||
```json
|
||||
{
|
||||
"method": "crawl_shards",
|
||||
"params": [
|
||||
{
|
||||
"pubkey": true,
|
||||
"limit": 0
|
||||
}
|
||||
]
|
||||
}
|
||||
```
|
||||
{% /tab %}
|
||||
|
||||
{% /tabs %}
|
||||
|
||||
**注記:** このメソッドのコマンドライン構文はありません。コマンドラインからアクセスするには[jsonメソッド][]を使用してください。
|
||||
|
||||
リクエストには以下のフィールドが含まれます。
|
||||
|
||||
| `Field` | 型 | 説明 |
|
||||
|:---------|:--------|:--------------------------------------------------------|
|
||||
| `pubkey` | ブール値 | _（省略可）_ `true`の場合、レスポンスには、クロールされたサーバーのノード公開鍵（ピアツーピア通信用）が含まれます。デフォルトは`false`です。 |
|
||||
| `limit` | 数値 | _（省略可）_ 検索の深さを示すホップ数。デフォルトは0で、ダイレクトピアのみを検索します。`1`を制限値にすると、ピアのピアも検索します。最大値は`3`です。 |
|
||||
|
||||
**注意:** `limit`が増加すると、検索される可能性のあるピアの数は、指数関数的に増加します。2または3を制限値にすると、サーバーがAPIリクエストにレスポンスするのに数秒かかる場合があります。
|
||||
|
||||
|
||||
### レスポンスのフォーマット
|
||||
|
||||
処理が成功したレスポンスの例:
|
||||
|
||||
{% tabs %}
|
||||
|
||||
{% tab label="WebSocket" %}
|
||||
```json
|
||||
{
|
||||
"result": {
|
||||
"complete_shards": "1-2,5,8-9,584,1973,2358",
|
||||
"peers": [
|
||||
{
|
||||
"complete_shards": "1-2,8,47,371,464,554,653,857,1076,1402,1555,1708,1813,1867",
|
||||
"public_key": "n9LxFZiySnfDSvfh23N94UxsFkCjWyrchTeKHcYE6tJJQL5iejb2"
|
||||
},
|
||||
{
|
||||
"complete_shards": "8-9,584",
|
||||
"ip": "192.168.1.132",
|
||||
"public_key": "n9MN5xwYqbrj64rtfZAXQy7Y3sNxXZJeLt7Lj61a9DYEZ4SE2tQQ"
|
||||
}
|
||||
]
|
||||
},
|
||||
"status": "success",
|
||||
"type": "response"
|
||||
}
|
||||
```
|
||||
{% /tab %}
|
||||
|
||||
{% tab label="JSON-RPC" %}
|
||||
```json
|
||||
200 OK
|
||||
|
||||
{
|
||||
"result": {
|
||||
"complete_shards": "1-2,5,8-9,584,1973,2358",
|
||||
"peers": [
|
||||
{
|
||||
"complete_shards": "1-2,8,47,371,464,554,653,857,1076,1402,1555,1708,1813,1867",
|
||||
"public_key": "n9LxFZiySnfDSvfh23N94UxsFkCjWyrchTeKHcYE6tJJQL5iejb2"
|
||||
},
|
||||
{
|
||||
"complete_shards": "8-9,584",
|
||||
"ip": "192.168.1.132",
|
||||
"public_key": "n9MN5xwYqbrj64rtfZAXQy7Y3sNxXZJeLt7Lj61a9DYEZ4SE2tQQ"
|
||||
}
|
||||
],
|
||||
"status": "success"
|
||||
}
|
||||
}
|
||||
```
|
||||
{% /tab %}
|
||||
|
||||
{% /tabs %}
|
||||
|
||||
このレスポンスは[標準フォーマット][]に従っており、正常に完了した場合は結果に次のフィールドが含まれます。
|
||||
|
||||
| `Field` | 型 | 説明 |
|
||||
|:------------------|:-------|:------------------------------------------------|
|
||||
| `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)が使用可能なピアのみが含まれます。配列の各オブジェクトには以下のフィールドが含まれます。
|
||||
|
||||
|
||||
| `Field` | 型 | 説明 |
|
||||
|:----------|:-------|:--------------------------------------------------------|
|
||||
| `complete_shards` | 文字列 | このピアが使用可能な履歴シャードの範囲。連続していない場合があります。たとえば、`1-2,5,7-9`は、シャード1、2、5、7、8、9が利用可能であることを示します。 |
|
||||
| `ip` | 文字列 | _（省略される場合があります）_ このオブジェクトが表すピアのIPアドレス。IPv4アドレスまたはIPv6アドレスを指定できます。[プライベートピア](../../../../concepts/networks-and-servers/peer-protocol.md#プライベートピア)の場合は省略されます。 |
|
||||
| `public_key` | 文字列 | _(リクエストで`"pubkey": true`が指定されている場合を除き省略)_ XRP Ledgerの[base58フォーマット](../../../protocol/data-types/base58-encodings.md)で、このピアでピアツーピア通信に使用される公開鍵。 |
|
||||
|
||||
|
||||
### 考えられるエラー
|
||||
|
||||
- いずれかの[汎用エラータイプ][]。
|
||||
- `invalidParams` - リクエストで1つ以上の必須フィールドが省略されていたか、または指定されたフィールドのデータタイプが誤っています。
|
||||
|
||||
{% raw-partial file="/docs/_snippets/common-links.md" /%}
|
||||
@@ -0,0 +1,122 @@
|
||||
---
|
||||
html: download_shard.html
|
||||
parent: logging-and-data-management-methods.html
|
||||
seo:
|
||||
description: レジャー履歴の特定のシャードをダウンロードします。
|
||||
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 %}
|
||||
|
||||
_`download_shard`メソッドは、権限のないユーザーは実行できない[管理メソッド](../index.md)です。_
|
||||
|
||||
外部ソースからHTTPSを使用してシャードが[lz4圧縮](https://lz4.github.io/lz4/) [tarアーカイブ](https://en.wikipedia.org/wiki/Tar_(computing))として提供される必要があります。アーカイブには、NuDB形式のシャードディレクトリとデータファイルが含まれている必要があります。
|
||||
|
||||
通常、このメソッドを使用してシャードをダウンロードしてインポートすれば、ピアツーピアネットワークからシャードを個別に取得するよりも短い時間で取得できます。また、サーバーから提供される特定範囲のシャードまたはシャードのセットを選択する場合にもこのメソッドを使用できます。
|
||||
|
||||
### リクエストのフォーマット
|
||||
|
||||
リクエストのフォーマットの例:
|
||||
|
||||
{% tabs %}
|
||||
|
||||
{% tab label="WebSocket" %}
|
||||
```json
|
||||
{
|
||||
"command": "download_shard",
|
||||
"shards": [
|
||||
{"index": 1, "url": "https://example.com/1.tar.lz4"},
|
||||
{"index": 2, "url": "https://example.com/2.tar.lz4"},
|
||||
{"index": 5, "url": "https://example.com/5.tar.lz4"}
|
||||
]
|
||||
}
|
||||
```
|
||||
{% /tab %}
|
||||
|
||||
{% tab label="JSON-RPC" %}
|
||||
```json
|
||||
{
|
||||
"method": "download_shard",
|
||||
"params": [
|
||||
{
|
||||
"shards": [
|
||||
{"index": 1, "url": "https://example.com/1.tar.lz4"},
|
||||
{"index": 2, "url": "https://example.com/2.tar.lz4"},
|
||||
{"index": 5, "url": "https://example.com/5.tar.lz4"}
|
||||
]
|
||||
}
|
||||
]
|
||||
}
|
||||
```
|
||||
{% /tab %}
|
||||
|
||||
{% /tabs %}
|
||||
|
||||
|
||||
リクエストには以下のフィールドが含まれます。
|
||||
|
||||
| `Field` | 型 | 説明 |
|
||||
|:-----------|:--------|:------------------------------------------------------|
|
||||
| `shards` | 配列 | ダウンロードするシャードとダウンロード元を記述したShard Descriptorオブジェクト（以下の説明を参照）のリスト。 |
|
||||
|
||||
`validate`のフィールドは廃止予定であり、今後予告なしに削除される可能性があります。`rippled`は全てのシャードの検証を実行します。{% badge href="https://github.com/XRPLF/rippled/releases/tag/1.6.0" %}更新: rippled 1.6.0{% /badge %}
|
||||
|
||||
`shards`配列の各**Shard Descriptorオブジェクト**には以下のフィールドが含まれています。
|
||||
|
||||
| `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 %} |
|
||||
|
||||
### レスポンスのフォーマット
|
||||
|
||||
処理が成功したレスポンスの例:
|
||||
|
||||
{% tabs %}
|
||||
|
||||
{% tab label="WebSocket" %}
|
||||
```json
|
||||
{
|
||||
"result": {
|
||||
"message": "downloading shards 1-2,5"
|
||||
},
|
||||
"status": "success",
|
||||
"type": "response"
|
||||
}
|
||||
```
|
||||
{% /tab %}
|
||||
|
||||
{% tab label="JSON-RPC" %}
|
||||
```json
|
||||
200 OK
|
||||
|
||||
{
|
||||
"result": {
|
||||
"message": "downloading shards 1-2,5",
|
||||
"status": "success"
|
||||
}
|
||||
}
|
||||
```
|
||||
{% /tab %}
|
||||
|
||||
{% /tabs %}
|
||||
|
||||
このレスポンスは[標準フォーマット][]に従っており、正常に完了した場合は結果に次のフィールドが含まれます。
|
||||
|
||||
| `Field` | 型 | 説明 |
|
||||
|:----------|:-------|:--------------------------------------------------------|
|
||||
| `message` | 文字列 | このリクエストに対応して実行されたアクションを説明するメッセージ。 |
|
||||
|
||||
**ヒント:** サーバーで使用可能なシャードを確認するには、[crawl_shardsメソッド[]を使用します。または、シャードストアーとして設定されたロケーションのサブフォルダー（`rippled.cfg`の`[shard_db]`の`path`パラメーター）を調べます。フォルダーには、シャードの番号に対応する名前が付いています。これらのフォルダーの1つに、シャードが未完了であることを示す`control.txt`ファイルが含まれていることがあります。
|
||||
|
||||
### 考えられるエラー
|
||||
|
||||
- いずれかの[汎用エラータイプ][]。
|
||||
- `notEnabled` - サーバーでシャードストアーを使用するように設定されていません。
|
||||
- `tooBusy` - サーバーはすでに、ピアツーピアネットワークから、または以前の`download_shard`リクエストの結果として、シャードをダウンロード中です。
|
||||
- `invalidParams` - リクエストで1つ以上の必須フィールドが省略されていたか、または指定されたフィールドのデータタイプが誤っています。
|
||||
|
||||
{% raw-partial file="/docs/_snippets/common-links.md" /%}
|
||||
@@ -0,0 +1,12 @@
|
||||
---
|
||||
html: logging-and-data-management-methods.html
|
||||
parent: admin-api-methods.html
|
||||
metadata:
|
||||
indexPage: true
|
||||
---
|
||||
# ログとデータの管理メソッド
|
||||
|
||||
以下のメソッドを使用して、ログレベルや台帳などのデータを管理することができます。
|
||||
|
||||
|
||||
{% child-pages /%}
|
||||
@@ -0,0 +1,79 @@
|
||||
---
|
||||
html: ledger_cleaner.html
|
||||
parent: logging-and-data-management-methods.html
|
||||
seo:
|
||||
description: レジャークリーナーを制御し、レジャーデータベースの破損を検出して修復できる非同期メンテナンスをする。
|
||||
labels:
|
||||
- データ保持
|
||||
---
|
||||
# ledger_cleaner
|
||||
[[ソース]](https://github.com/XRPLF/rippled/blob/df54b47cd0957a31837493cd69e4d9aade0b5055/src/ripple/rpc/handlers/LedgerCleaner.cpp "Source")
|
||||
|
||||
`ledger_cleaner`コマンドは[レジャークリーナー](https://github.com/XRPLF/rippled/blob/f313caaa73b0ac89e793195dcc2a5001786f916f/src/ripple/app/ledger/README.md#the-ledger-cleaner)を制御します。レジャークリーナーは、`rippled`のレジャーデータベースの破損を検出して修復できる非同期メンテナンスプロセスです。
|
||||
|
||||
_`ledger_cleaner`メソッドは、権限のないユーザーは実行できない[管理メソッド](../index.md)です。_
|
||||
|
||||
### リクエストのフォーマット
|
||||
リクエストのフォーマットの例:
|
||||
|
||||
{% tabs %}
|
||||
|
||||
{% tab label="WebSocket" %}
|
||||
```json
|
||||
{
|
||||
"command": "ledger_cleaner",
|
||||
"max_ledger": 13818756,
|
||||
"min_ledger": 13818000,
|
||||
"stop": false
|
||||
}
|
||||
```
|
||||
{% /tab %}
|
||||
|
||||
{% /tabs %}
|
||||
|
||||
リクエストには以下のパラメーターが含まれます。
|
||||
|
||||
| `Field` | 型 | 説明 |
|
||||
|:--------------|:--------------------------|:---------------------------------|
|
||||
| `ledger` | 数値 - [レジャーインデックス][] | _（省略可）_ 指定されている場合は、指定されたレジャーのみをチェックして訂正します。 |
|
||||
| `max_ledger` | 数値 - [レジャーインデックス][] | _（省略可）_ レジャーインデックスがこの番号以下のレジャーをチェックするようにレジャークリーナーを設定します。 |
|
||||
| `min_ledger` | 数値 - [レジャーインデックス][] | _（省略可）_ レジャーインデックスがこの番号以上のレジャーをチェックするようにレジャークリーナーを設定します。 |
|
||||
| `full` | ブール値 | _（省略可）_ trueの場合は、指定されたレジャーのレジャー状態オブジェクトとトランザクションを修正します。デフォルトではfalseです。`ledger`が指定されている場合は、自動的に`true`に設定されます。 |
|
||||
| `fix_txns` | ブール値 | _（省略可）_ trueの場合は、指定されたレジャーのトランザクションを修正します。指定されている場合は`full`をオーバーライドします。 |
|
||||
| `check_nodes` | ブール値 | _（省略可）_ trueの場合は、指定されているレジャーのレジャー状態オブジェクトを修正します。指定されている場合は`full`をオーバーライドします。 |
|
||||
| `stop` | ブール値 | _（省略可）_ trueの場合は、レジャークリーナーを無効にします。 |
|
||||
|
||||
### レスポンスのフォーマット
|
||||
|
||||
処理が成功したレスポンスの例:
|
||||
|
||||
{% tabs %}
|
||||
|
||||
{% tab label="JSON-RPC" %}
|
||||
```json
|
||||
200 OK
|
||||
|
||||
{
|
||||
"result" : {
|
||||
"message" : "Cleaner configured",
|
||||
"status" : "success"
|
||||
}
|
||||
}
|
||||
|
||||
```
|
||||
{% /tab %}
|
||||
|
||||
{% /tabs %}
|
||||
|
||||
このレスポンスは[標準フォーマット][]に従っており、正常に完了した場合は結果に次のフィールドが含まれます。
|
||||
|
||||
| `Field` | 型 | 説明 |
|
||||
|:----------|:-------|:---------------------------------|
|
||||
| `message` | 文字列 | `Cleaner configured`: 正常終了の場合。 |
|
||||
|
||||
### 考えられるエラー
|
||||
|
||||
* いずれかの[汎用エラータイプ][]。
|
||||
* `internal`: いずれかのパラメーターが正しく指定されていない場合。（これはバグです。本来のエラーコードは`invalidParams`です。）
|
||||
|
||||
{% raw-partial file="/docs/_snippets/common-links.md" /%}
|
||||
@@ -0,0 +1,191 @@
|
||||
---
|
||||
html: ledger_request.html
|
||||
parent: logging-and-data-management-methods.html
|
||||
seo:
|
||||
description: サーバーに対し接続しているピアから特定のレジャーバージョンを取得するように指示します。
|
||||
labels:
|
||||
- データ保持
|
||||
---
|
||||
# ledger_request
|
||||
[[ソース]](https://github.com/XRPLF/rippled/blob/e980e69eca9ea843d200773eb1f43abe3848f1a0/src/ripple/rpc/handlers/LedgerRequest.cpp "Source")
|
||||
|
||||
`ledger_request`コマンドは、サーバーに対し接続しているピアから特定のレジャーバージョンを取得するように指示します。これは、サーバーが直接接続しているピアの1つにそのレジャーが存在している場合にのみ機能します。場合によっては、レジャーを完全に取得するにはこのコマンドを繰り返し実行する必要があります。
|
||||
|
||||
*`ledger_request`リクエストは、権限のないユーザーは実行できない[管理メソッド](../index.md)です。*
|
||||
|
||||
### リクエストのフォーマット
|
||||
リクエストのフォーマットの例:
|
||||
|
||||
{% tabs %}
|
||||
|
||||
{% tab label="WebSocket" %}
|
||||
```json
|
||||
{
|
||||
"id": 102,
|
||||
"command": "ledger_request",
|
||||
"ledger_index": 13800000
|
||||
}
|
||||
```
|
||||
{% /tab %}
|
||||
|
||||
{% tab label="コマンドライン" %}
|
||||
```
|
||||
rippled ledger_request 13800000
|
||||
```
|
||||
{% /tab %}
|
||||
|
||||
{% /tabs %}
|
||||
|
||||
リクエストには以下のパラメーターが含まれます。
|
||||
|
||||
| `Field` | 型 | 説明 |
|
||||
|:---------------|:-------|:---------------------------------------------------|
|
||||
| `ledger_index` | 数値 | _（省略可）_[レジャーインデックス][]により指定されたレジャーを取得します。 |
|
||||
| `ledger_hash` | 文字列 | _（省略可）_ 識別用[ハッシュ][]により指定されたレジャーを取得します。 |
|
||||
|
||||
`ledger_index`または`ledger_hash`のいずれかを指定する必要がありますが、両方は指定しないでください。
|
||||
|
||||
### レスポンスのフォーマット
|
||||
|
||||
レスポンスは[標準フォーマット][]に従っています。ただし、_`rippled`サーバーに対してレジャーの取得開始を正常に指示できた場合でも_、指定されたレジャーがない場合には失敗を示すレスポンスがリクエストから返されます。
|
||||
|
||||
**注記:** レジャーを取得するには、rippledサーバーのダイレクトピアの履歴にそのレジャーが含まれている必要があります。どのピアにもリクエストされたレジャーがない場合は、[connectメソッド][]または構成ファイルの`fixed_ips`セクションを使用して、`s2.ripple.com`にあるRippleのすべての履歴が記録されるサーバーを追加すれば、`ledger_request`リクエストを再度実行できます。
|
||||
|
||||
失敗した場合のレスポンスには、レジャーの取得状況が示されます。成功した場合のレスポンスには、[ledgerメソッド][]に類似したフォーマットでレジャーの情報が含まれます。
|
||||
|
||||
{% tabs %}
|
||||
|
||||
{% tab label="コマンドライン（失敗）" %}
|
||||
```json
|
||||
Loading: "/etc/rippled.cfg"
|
||||
Connecting to 127.0.0.1:5005
|
||||
|
||||
{
|
||||
"result" : {
|
||||
"acquiring" : {
|
||||
"hash" : "01DDD89B6605E20338B8EEB8EB2B0E0DD2F685A2B164F3790C4D634B5734CC26",
|
||||
"have_header" : false,
|
||||
"peers" : 2,
|
||||
"timeouts" : 0
|
||||
},
|
||||
"error" : "lgrNotFound",
|
||||
"error_code" : 20,
|
||||
"error_message" : "acquiring ledger containing requested index",
|
||||
"request" : {
|
||||
"command" : "ledger_request",
|
||||
"ledger_index" : 18851277
|
||||
},
|
||||
"status" : "error"
|
||||
}
|
||||
}
|
||||
```
|
||||
{% /tab %}
|
||||
|
||||
{% tab label="コマンドライン（進行中）" %}
|
||||
```json
|
||||
Loading: "/etc/rippled.cfg"
|
||||
Connecting to 127.0.0.1:5005
|
||||
|
||||
{
|
||||
"result" : {
|
||||
"hash" : "EB68B5B4F6F06BF59B6D7532BCB98BB98E2F10C2435D895217AA0AA7E910FBD5",
|
||||
"have_header" : true,
|
||||
"have_state" : false,
|
||||
"have_transactions" : false,
|
||||
"needed_state_hashes" : [
|
||||
"C46F7B9E795135447AF24BAF999AB8FC1612A997F6EAAF8B784C226FF0BD8E25",
|
||||
"E48F528E4FC2A1DC492C6264B27B420E2285B2A3ECF3A253DB480DA5BFB7F858",
|
||||
"B62CD0B2E1277F78BC279FA037F3F747587299B60D23A551C3F63DD137DC0CF8",
|
||||
"30014C55701FB8426E496A47B297BEC9E8F5BFA47763CC22DBD9024CC81D39DD",
|
||||
"7EB59A853913898FCEA7B701637F33B1054BD36C32A0B910B612EFB9CDFF6334",
|
||||
"07ECAD3066D62583883979A2FADAADC8F7D89FA07375843C8A47452639AB2421",
|
||||
"97A87E5246AF78463485CB27E08D561E22AAF33D5E2F08FE2FACAE0D05CB5478",
|
||||
"50A0525E238629B32324C9F59B4ECBEFE3C21DC726DB9AB3B6758BD1838DFF68",
|
||||
"8C541B1ED47C9282E2A28F0B7F3DDFADF06644CAB71B15A3E67D04C5FAFE9BF4",
|
||||
"2C6CC536C778D8C0F601E35DA7DD9888C288897E4F603E76357CE2F47E8A7A9F",
|
||||
"309E78DEC67D5725476A59E114850556CC693FB6D92092997ADE97E3EFF473CC",
|
||||
"8EFF61B6A636AF6B4314CAC0C08F4FED0759E1F782178A822EDE98275E5E4B10",
|
||||
"9535645E5D249AC0B6126005B79BB981CBA00286E00154D20A3BCF65743EA3CA",
|
||||
"69F5D6FCB41D1E6CEA5ADD42CBD194086B45E957D497DF7AEE62ADAD485660CE",
|
||||
"07E93A95DBB0B8A00925DE0DF6D27E41CACC77EF75055A89815006109D82EAD3",
|
||||
"7FDF25F660235DCAD649676E3E6729DF920A9B0B4B6A3B090A3C64D7BDE2FB20"
|
||||
],
|
||||
"needed_transaction_hashes" : [
|
||||
"BA914854F2F5EDFCBD6E3E0B168E5D4CD0FC92927BEE408C6BD38D4F52505A34",
|
||||
"AE3A2DB537B01EB33BB3A677242DE52C9AE0A64BD9222EE55E52855276E7EA2A",
|
||||
"E145F737B255D93769673CBA6DEBA4F6AC7387A309DAACC72EA5B07ECF03C215",
|
||||
"073A118552AA60E1D3C6BE6F65E4AFA01C582D9C41CCC2887244C19D9BFA7741",
|
||||
"562DB8580CD3FE19AF5CEA61C2858C10091151B924DBF2AEB7CBB8722E683204",
|
||||
"437C0D1C2391057079E9539CF028823D29E6437A965284F6E54CEBF1D25C5D56",
|
||||
"1F069486AF5533883609E5C8DB907E97273D9A782DF26F5E5811F1C42ED63A3D",
|
||||
"CAA6B7DA68EBA71254C218C81A9EA029A179694BDD0D75A49FB03A7D57BCEE49"
|
||||
],
|
||||
"peers" : 6,
|
||||
"status" : "success",
|
||||
"timeouts" : 1
|
||||
}
|
||||
}
|
||||
```
|
||||
{% /tab %}
|
||||
|
||||
{% tab label="コマンドライン（成功）" %}
|
||||
```json
|
||||
Loading: "/etc/rippled.cfg"
|
||||
Connecting to 127.0.0.1:5005
|
||||
|
||||
{
|
||||
"result" : {
|
||||
"ledger" : {
|
||||
"accepted" : true,
|
||||
"account_hash" : "84EBB27D9510AD5B9A3A328201921B3FD418D4A349E85D3DC69E33C7B506407F",
|
||||
"close_time" : 486691300,
|
||||
"close_time_human" : "2015-Jun-04 00:01:40",
|
||||
"close_time_resolution" : 10,
|
||||
"closed" : true,
|
||||
"hash" : "DCF5D723ECEE1EF56D2B0024CD9BDFF2D8E3DC211BD2B9460165922564ACD863",
|
||||
"ledger_hash" : "DCF5D723ECEE1EF56D2B0024CD9BDFF2D8E3DC211BD2B9460165922564ACD863",
|
||||
"ledger_index" : "13840000",
|
||||
"parent_hash" : "8A3F6FBC62C11DE4538D969F9C7966234635FE6CEB1133DDC37220978F8100A9",
|
||||
"seqNum" : "13840000",
|
||||
"totalCoins" : "99999022883526403",
|
||||
"total_coins" : "99999022883526403",
|
||||
"transaction_hash" : "3D759EF3AF1AE2F78716A8CCB2460C3030F82687E54206E883703372B9E1770C"
|
||||
},
|
||||
"ledger_index" : 13840000,
|
||||
"status" : "success"
|
||||
}
|
||||
}
|
||||
|
||||
```
|
||||
{% /tab %}
|
||||
|
||||
{% /tabs %}
|
||||
|
||||
3つのレスポンスのフォーマットは次のとおりです。
|
||||
|
||||
1. `lgrNotFound`エラーが返された場合、レスポンスの`acquiring`フィールドには、ピアツーピアネットワークからのレジャー取得状況を示す[レジャーリクエストオブジェクト](#レジャーリクエストオブジェクト)が指定されています。
|
||||
2. サーバーが現在データを取得中であるとレスポンスに示される場合、その結果の本文として、ピアツーピアネットワークからのレジャー取得状況を示す[レジャーリクエストオブジェクト](#レジャーリクエストオブジェクト)が表示されます。
|
||||
3. レジャーが完全に利用可能な場合、レスポンスには[レジャーヘッダー](../../../protocol/ledger-data/ledger-header.md)が表示されます。
|
||||
|
||||
### レジャーリクエストオブジェクト
|
||||
|
||||
サーバーでレジャーの取得操作が進行中であり、まだ完了していない場合は、`rippled`サーバーはレジャー取得状況を示すレジャーリクエストオブジェクトを返します。このオブジェクトのフィールドを次に示します。
|
||||
|
||||
| `Field` | 型 | 説明 |
|
||||
|:----------------------------|:-----------------|:----------------------------|
|
||||
| `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]
|
||||
|
||||
{% raw-partial file="/docs/_snippets/common-links.md" /%}
|
||||
@@ -0,0 +1,147 @@
|
||||
---
|
||||
html: log_level.html
|
||||
parent: logging-and-data-management-methods.html
|
||||
seo:
|
||||
description: ログ詳細レベルを変更するか、現在のログレベルを返します。
|
||||
labels:
|
||||
- データ保持
|
||||
---
|
||||
# log_level
|
||||
[[ソース]](https://github.com/XRPLF/rippled/blob/155fcdbcd0b4927152892c8c8be01d9cf62bed68/src/ripple/rpc/handlers/LogLevel.cpp "Source")
|
||||
|
||||
`log_level`コマンドは`rippled`サーバーのログ詳細レベルを変更するか、各ログメッセージカテゴリー（_パーティション_）の現在のログレベルを返します。
|
||||
|
||||
_`log_level`メソッドは、権限のないユーザーは実行できない[管理メソッド](../index.md)です。_
|
||||
|
||||
### リクエストのフォーマット
|
||||
リクエストのフォーマットの例:
|
||||
|
||||
{% tabs %}
|
||||
|
||||
{% tab label="WebSocket" %}
|
||||
```json
|
||||
{
|
||||
"id": "ll1",
|
||||
"command": "log_level",
|
||||
"severity": "debug",
|
||||
"partition": "PathRequest"
|
||||
}
|
||||
```
|
||||
{% /tab %}
|
||||
|
||||
{% tab label="コマンドライン" %}
|
||||
```sh
|
||||
#Syntax: log_level [[partition] severity]
|
||||
rippled log_level PathRequest debug
|
||||
```
|
||||
{% /tab %}
|
||||
|
||||
{% /tabs %}
|
||||
|
||||
リクエストには以下のパラメーターが含まれます。
|
||||
|
||||
| `Field` | 型 | 説明 |
|
||||
|:------------|:-------|:------------------------------------------------------|
|
||||
| `severity` | 文字列 | _（省略可）_ 設定するログの詳細レベル。以下に、有効な値を詳細レベルの低いものから順に示します。`fatal`、`error`、`warn`、`info`、`debug`、および`trace`。省略すると、すべてのカテゴリーの現在のログ詳細レベルが返されます。 |
|
||||
| `partition` | 文字列 | _（省略可）_`severity`が指定されていない場合は無視されます。変更するログカテゴリー。省略されている場合、または`base`の値が指定されている場合は、すべてのカテゴリーのログレベルを設定します。 |
|
||||
|
||||
### レスポンスのフォーマット
|
||||
|
||||
成功した場合のレスポンス例:
|
||||
|
||||
{% tabs %}
|
||||
|
||||
{% tab label="コマンドライン（ログレベルの設定）" %}
|
||||
```json
|
||||
Loading: "/etc/rippled.cfg"
|
||||
Connecting to 127.0.0.1:5005
|
||||
|
||||
{
|
||||
"result" : {
|
||||
"status" : "success"
|
||||
}
|
||||
}
|
||||
```
|
||||
{% /tab %}
|
||||
|
||||
{% tab label="コマンドライン（ログレベルの確認）" %}
|
||||
```json
|
||||
Loading: "/etc/rippled.cfg"
|
||||
Connecting to 127.0.0.1:5005
|
||||
|
||||
{
|
||||
"result" : {
|
||||
"levels" : {
|
||||
"AmendmentTable" : "Error",
|
||||
"Application" : "Error",
|
||||
"CancelOffer" : "Error",
|
||||
"Collector" : "Error",
|
||||
"CreateOffer" : "Error",
|
||||
"DeferredCredits" : "Error",
|
||||
"FeeVote" : "Error",
|
||||
"InboundLedger" : "Error",
|
||||
"JobQueue" : "Error",
|
||||
"Ledger" : "Error",
|
||||
"LedgerCleaner" : "Error",
|
||||
"LedgerConsensus" : "Error",
|
||||
"LedgerEntrySet" : "Error",
|
||||
"LedgerMaster" : "Error",
|
||||
"LedgerTiming" : "Error",
|
||||
"LoadManager" : "Error",
|
||||
"LoadMonitor" : "Error",
|
||||
"NetworkOPs" : "Error",
|
||||
"NodeObject" : "Error",
|
||||
"OrderBookDB" : "Error",
|
||||
"Overlay" : "Error",
|
||||
"PathRequest" : "Debug",
|
||||
"Payment" : "Error",
|
||||
"Peer" : "Error",
|
||||
"PeerFinder" : "Error",
|
||||
"Protocol" : "Error",
|
||||
"RPC" : "Error",
|
||||
"RPCErr" : "Error",
|
||||
"RPCHandler" : "Error",
|
||||
"RPCManager" : "Error",
|
||||
"Resolver" : "Error",
|
||||
"Resource" : "Error",
|
||||
"RippleCalc" : "Error",
|
||||
"SHAMap" : "Error",
|
||||
"SHAMapStore" : "Error",
|
||||
"SNTPClient" : "Error",
|
||||
"STAmount" : "Error",
|
||||
"SerializedLedger" : "Error",
|
||||
"Server" : "Error",
|
||||
"SetAccount" : "Error",
|
||||
"SetTrust" : "Error",
|
||||
"TaggedCache" : "Error",
|
||||
"TransactionAcquire" : "Error",
|
||||
"TransactionEngine" : "Error",
|
||||
"UVL" : "Error",
|
||||
"UniqueNodeList" : "Error",
|
||||
"Validations" : "Error",
|
||||
"WALCheckpointer" : "Error",
|
||||
"WebSocket" : "Trace",
|
||||
"base" : "Error"
|
||||
},
|
||||
"status" : "success"
|
||||
}
|
||||
}
|
||||
```
|
||||
{% /tab %}
|
||||
|
||||
{% /tabs %}
|
||||
|
||||
レスポンスは[標準フォーマット][]に従っています。レスポンスのフォーマットは、リクエストに`severity`が指定されているかどうかに応じて異なります。指定されていた場合はログレベルが変更され、成功した場合の結果には追加フィールドが含まれません。
|
||||
|
||||
それ以外の場合、リクエストには以下のフィールドが含まれます。
|
||||
|
||||
| `Field` | 型 | 説明 |
|
||||
|:--------|:-------|:----------------------------------------------------------|
|
||||
| `level` | オブジェクト | 各カテゴリーの現在のログレベル。このカテゴリーリストは、今後のリリースで予告なく変更される場合があります。このコマンドに対するリクエストで、フィールド名を`partition`の値として使用できます。 |
|
||||
|
||||
### 考えられるエラー
|
||||
|
||||
* [汎用エラータイプ][]のすべて。
|
||||
* `invalidParams` - 1つ以上のフィールドの指定が正しくないか、1つ以上の必須フィールドが指定されていません。
|
||||
|
||||
{% raw-partial file="/docs/_snippets/common-links.md" /%}
|
||||
@@ -0,0 +1,116 @@
|
||||
---
|
||||
html: logrotate.html
|
||||
parent: logging-and-data-management-methods.html
|
||||
seo:
|
||||
description: ログファイルを閉じて再度開きます。
|
||||
labels:
|
||||
- データ保持
|
||||
---
|
||||
# logrotate
|
||||
[[ソース]](https://github.com/XRPLF/rippled/blob/743bd6c9175c472814448ea889413be79dfd1c07/src/ripple/rpc/handlers/LogRotate.cpp "Source")
|
||||
|
||||
`logrotate`コマンドは、ログファイルを閉じて再度開きます。これは、Linuxファイルシステムでのログローテーションを促進することを目的としています。
|
||||
|
||||
通常、Linuxシステムには、[`logrotate`](https://linux.die.net/man/8/logrotate)プログラムがプリインストールされていますが、このコマンドとは異なります。アプリケーション固有のログローテーションスクリプトは、`/etc/logrotate.d`に配置されています。
|
||||
|
||||
次のスクリプトは、`/etc/logrotate.d/rippled`として作成できるサンプルです。
|
||||
|
||||
```logrotate
|
||||
/var/log/rippled/*.log {
|
||||
daily
|
||||
minsize 200M
|
||||
rotate 7
|
||||
nocreate
|
||||
missingok
|
||||
notifempty
|
||||
compress
|
||||
compresscmd /usr/bin/nice
|
||||
compressoptions -n19 ionice -c3 gzip
|
||||
compressext .gz
|
||||
postrotate
|
||||
/opt/ripple/bin/rippled --conf /opt/ripple/etc/rippled.cfg logrotate
|
||||
endscript
|
||||
}
|
||||
```
|
||||
|
||||
保持するログの量に応じて、`minsize`や`rotate`などのパラメーターを構成できます。`rippled.cfg`ファイルの`log_level`設定を使用して、サーバーのログの詳細度を設定します。このサンプルスクリプトは標準の`log_level`に基づいており、約2週間分のログを圧縮形式で保存します。
|
||||
|
||||
`rippled` 1.3以降、スクリプト`/etc/logrotate.d/rippled`は、DEBおよびRPMパッケージによって自動的にインストールされます。この設定は、必要に応じて変更できます。パッケージのアップグレード時に変更内容が上書きされることはありません。
|
||||
|
||||
**注記:** システムのlogrotateスクリプトは、アプリケーションごとに1つしか持てません。同じディレクトリを処理するログローテーションが他にないことを確認してください。
|
||||
|
||||
_`logrotate`メソッドは、権限のないユーザーは実行できない[管理メソッド](../index.md)です。_
|
||||
|
||||
### リクエストのフォーマット
|
||||
リクエストのフォーマットの例:
|
||||
|
||||
{% tabs %}
|
||||
|
||||
{% tab label="WebSocket" %}
|
||||
```json
|
||||
{
|
||||
"id": "lr1",
|
||||
"command": "logrotate"
|
||||
}
|
||||
```
|
||||
{% /tab %}
|
||||
|
||||
{% tab label="コマンドライン" %}
|
||||
```sh
|
||||
#Syntax: logrotate
|
||||
rippled logrotate
|
||||
```
|
||||
{% /tab %}
|
||||
|
||||
{% /tabs %}
|
||||
|
||||
リクエストにはパラメーターが含まれていません。
|
||||
|
||||
### レスポンスのフォーマット
|
||||
|
||||
処理が成功したレスポンスの例:
|
||||
|
||||
{% tabs %}
|
||||
|
||||
{% tab label="JSON-RPC" %}
|
||||
```json
|
||||
200 OK
|
||||
|
||||
{
|
||||
"result" : {
|
||||
"message" : "The log file was closed and reopened.",
|
||||
"status" : "success"
|
||||
}
|
||||
}
|
||||
|
||||
```
|
||||
{% /tab %}
|
||||
|
||||
{% tab label="コマンドライン" %}
|
||||
```json
|
||||
Loading: "/etc/rippled.cfg"
|
||||
Connecting to 127.0.0.1:5005
|
||||
|
||||
{
|
||||
"result" : {
|
||||
"message" : "The log file was closed and reopened.",
|
||||
"status" : "success"
|
||||
}
|
||||
}
|
||||
|
||||
```
|
||||
{% /tab %}
|
||||
|
||||
{% /tabs %}
|
||||
|
||||
このレスポンスは[標準フォーマット][]に従っており、正常に完了した場合は結果に次のフィールドが含まれます。
|
||||
|
||||
| `Field` | 型 | 説明 |
|
||||
|:----------|:-------|:--------------------------------------------------------|
|
||||
| `message` | 文字列 | 正常に完了した場合、次のメッセージが含まれています。`The log file was closed and reopened.` |
|
||||
|
||||
### 考えられるエラー
|
||||
|
||||
* いずれかの[汎用エラータイプ][]。
|
||||
|
||||
{% raw-partial file="/docs/_snippets/common-links.md" /%}
|
||||
@@ -0,0 +1,120 @@
|
||||
---
|
||||
html: node_to_shard.html
|
||||
parent: logging-and-data-management-methods.html
|
||||
seo:
|
||||
description: レジャーストアからシャードストアにデータをコピーします。
|
||||
labels:
|
||||
- データ保持
|
||||
---
|
||||
# node_to_shard
|
||||
[[ソース]](https://github.com/XRPLF/rippled/blob/develop/src/ripple/rpc/handlers/NodeToShard.cpp "Source")
|
||||
|
||||
{% code-page-name /%}メソッドは、レジャーストアから[シャードストア](../../../../infrastructure/configuration/data-retention/history-sharding.md)へのデータコピーを管理します。データコピーの開始、停止、状態チェックが可能です。
|
||||
|
||||
_{% code-page-name /%}メソッドは、権限のないユーザーには実行できない[管理メソッド](../index.md)です。_
|
||||
|
||||
|
||||
### リクエストのフォーマット
|
||||
|
||||
リクエストのフォーマット例:
|
||||
|
||||
{% tabs %}
|
||||
|
||||
{% tab label="WebSocket" %}
|
||||
```json
|
||||
{
|
||||
"command": "{% $frontmatter.seo.title %}",
|
||||
"action": "start"
|
||||
}
|
||||
```
|
||||
{% /tab %}
|
||||
|
||||
{% tab label="JSON-RPC" %}
|
||||
```json
|
||||
{
|
||||
"method": "{% $frontmatter.seo.title %}",
|
||||
"params": [{
|
||||
"action": "start"
|
||||
}]
|
||||
}
|
||||
```
|
||||
{% /tab %}
|
||||
|
||||
{% tab label="Commandline" %}
|
||||
```sh
|
||||
#Syntax: {% $frontmatter.seo.title %} start|stop|status
|
||||
rippled {% $frontmatter.seo.title %} start
|
||||
```
|
||||
{% /tab %}
|
||||
|
||||
{% /tabs %}
|
||||
|
||||
リクエストは、以下のパラメータを含みます:
|
||||
|
||||
| `項目` | 型 | 説明
|
||||
|:---------|:-------|:---------------------------------------------------------|
|
||||
| `action` | String | どのような動作をさせるかによって、 `start`、`stop` または `status` のいずれかを指定します。 |
|
||||
|
||||
|
||||
### レスポンスのフォーマット
|
||||
|
||||
正常レスポンス例:
|
||||
|
||||
{% tabs %}
|
||||
|
||||
{% tab label="WebSocket" %}
|
||||
```json
|
||||
{
|
||||
"result": {
|
||||
"message": "Database import initiated..."
|
||||
},
|
||||
"status": "success",
|
||||
"type": "response"
|
||||
}
|
||||
```
|
||||
{% /tab %}
|
||||
|
||||
{% tab label="JSON-RPC" %}
|
||||
```json
|
||||
{
|
||||
"result" : {
|
||||
"message" : "Database import initiated...",
|
||||
"status" : "success"
|
||||
}
|
||||
}
|
||||
|
||||
```
|
||||
{% /tab %}
|
||||
|
||||
{% tab label="Commandline" %}
|
||||
```json
|
||||
Loading: "/etc/rippled.cfg"
|
||||
Connecting to 127.0.0.1:5005
|
||||
|
||||
{
|
||||
"result" : {
|
||||
"message" : "Database import initiated...",
|
||||
"status" : "success"
|
||||
}
|
||||
}
|
||||
|
||||
```
|
||||
{% /tab %}
|
||||
|
||||
{% /tabs %}
|
||||
|
||||
レスポンスは、[標準フォーマット][]に従っており、成功した場合は、以下の項目を含みます:
|
||||
|
||||
| `項目` | 型 | 説明 |
|
||||
|:----------|:-------|:--------------------------------------------------------|
|
||||
| `message` | 文字列 | コマンドにレスポンスして実行されたアクションを示す、可読性の高いメッセージ。 |
|
||||
|
||||
|
||||
### 起こり得るエラー
|
||||
|
||||
- いずれかの[汎用エラータイプ][]。
|
||||
- `internal` - コピーが実行されていない時にコピーの状態チェックをするといったような無効な操作の場合。
|
||||
- `notEnabled` - サーバが[履歴シャード](../../../../infrastructure/configuration/data-retention/history-sharding.md)を保存するように環境設定されていない場合。
|
||||
- `invalidParams` - 1つ以上の項目が誤って定義されている、もしくは、1つ以上の必須項目が抜けている。
|
||||
|
||||
{% raw-partial file="/docs/_snippets/common-links.md" /%}
|
||||
@@ -0,0 +1,106 @@
|
||||
---
|
||||
html: connect.html
|
||||
parent: peer-management-methods.html
|
||||
seo:
|
||||
description: 特定のピアrippledサーバーに強制的に接続します。
|
||||
labels:
|
||||
- コアサーバー
|
||||
---
|
||||
# connect
|
||||
[[ソース]](https://github.com/XRPLF/rippled/blob/a61ffab3f9010d8accfaa98aa3cacc7d38e74121/src/ripple/rpc/handlers/Connect.cpp "Source")
|
||||
|
||||
`connect`コマンドは、`rippled`サーバーを特定のピア`rippled`サーバーに強制的に接続します。
|
||||
|
||||
*`connect`リクエストは、権限のないユーザーは実行できない[管理メソッド](../index.md)です。*
|
||||
|
||||
### リクエストのフォーマット
|
||||
リクエストのフォーマットの例:
|
||||
|
||||
{% tabs %}
|
||||
|
||||
{% tab label="WebSocket" %}
|
||||
```json
|
||||
{
|
||||
"command": "connect",
|
||||
"ip": "192.170.145.88",
|
||||
"port": 51235
|
||||
}
|
||||
```
|
||||
{% /tab %}
|
||||
|
||||
{% tab label="JSON-RPC" %}
|
||||
```json
|
||||
{
|
||||
"method": "connect",
|
||||
"params": [
|
||||
{
|
||||
"ip": "192.170.145.88",
|
||||
"port": 51235
|
||||
}
|
||||
]
|
||||
}
|
||||
```
|
||||
{% /tab %}
|
||||
|
||||
{% tab label="コマンドライン" %}
|
||||
```sh
|
||||
#Syntax: connect ip [port]
|
||||
rippled connect 192.170.145.88 51235
|
||||
```
|
||||
{% /tab %}
|
||||
|
||||
{% /tabs %}
|
||||
|
||||
リクエストには以下のパラメーターが含まれます。
|
||||
|
||||
| `Field` | 型 | 説明 |
|
||||
|:--------|:-------|:----------------------------------------------------------|
|
||||
| `ip` | 文字列 | 接続するサーバーのIPアドレス。 |
|
||||
| `port` | 数値 | _（省略可）_ 接続時に使用するポート番号。デフォルトでは**2459**です。 {% badge href="https://github.com/XRPLF/rippled/releases/tag/1.6.0" %}新規: rippled 1.6.0{% /badge %} |
|
||||
|
||||
### レスポンスのフォーマット
|
||||
|
||||
処理が成功したレスポンスの例:
|
||||
|
||||
{% tabs %}
|
||||
|
||||
{% tab label="JSON-RPC" %}
|
||||
```json
|
||||
{
|
||||
"result" : {
|
||||
"message" : "connecting",
|
||||
"status" : "success"
|
||||
}
|
||||
}
|
||||
```
|
||||
{% /tab %}
|
||||
|
||||
{% tab label="コマンドライン" %}
|
||||
```json
|
||||
Loading: "/etc/rippled.cfg"
|
||||
Connecting to 127.0.0.1:5005
|
||||
|
||||
{
|
||||
"result" : {
|
||||
"message" : "connecting",
|
||||
"status" : "success"
|
||||
}
|
||||
}
|
||||
```
|
||||
{% /tab %}
|
||||
|
||||
{% /tabs %}
|
||||
|
||||
このレスポンスは[標準フォーマット][]に従っており、正常に完了した場合は結果に次のフィールドが含まれています。
|
||||
|
||||
| `Field` | 型 | 説明 |
|
||||
|:----------|:-------|:-------------------------------------------------------|
|
||||
| `message` | 文字列 | コマンドが成功した場合の値は`connecting`。 |
|
||||
|
||||
### 考えられるエラー
|
||||
|
||||
* [汎用エラータイプ][]のすべて。
|
||||
* `invalidParams` - 1つ以上のフィールドの指定が正しくないか、1つ以上の必須フィールドが指定されていません。
|
||||
* スタンドアロンモードでは接続できません - スタンドアロンモードではネットワーク関連のコマンドが無効にされています。
|
||||
|
||||
{% raw-partial file="/docs/_snippets/common-links.md" /%}
|
||||
@@ -0,0 +1,12 @@
|
||||
---
|
||||
html: peer-management-methods.html
|
||||
parent: admin-api-methods.html
|
||||
metadata:
|
||||
indexPage: true
|
||||
---
|
||||
# ピア管理メソッド
|
||||
|
||||
以下のメソッドを使用して、サーバーのピアツーピア接続を管理することができます。
|
||||
|
||||
|
||||
{% child-pages /%}
|
||||
@@ -0,0 +1,141 @@
|
||||
---
|
||||
html: peer_reservations_add.html
|
||||
parent: peer-management-methods.html
|
||||
seo:
|
||||
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 /%}メソッドは、権限のないユーザーは実行できない[管理メソッド](../index.md)です。_
|
||||
|
||||
|
||||
### リクエストのフォーマット
|
||||
|
||||
リクエストのフォーマットの例:
|
||||
|
||||
{% tabs %}
|
||||
|
||||
{% tab label="WebSocket" %}
|
||||
```json
|
||||
{
|
||||
"id": "peer_reservations_add_example_1",
|
||||
"command": "{% $frontmatter.seo.title %}",
|
||||
"public_key": "n9Jt8awsPzWLjBCNKVEEDQnw4bQEPjezfcQ4gttD1UzbLT1FoG99",
|
||||
"description": "Ripple s1 server 'WOOL'"
|
||||
}
|
||||
```
|
||||
{% /tab %}
|
||||
|
||||
{% tab label="JSON-RPC" %}
|
||||
```json
|
||||
{
|
||||
"method": "{% $frontmatter.seo.title %}",
|
||||
"params": [{
|
||||
"public_key": "n9Jt8awsPzWLjBCNKVEEDQnw4bQEPjezfcQ4gttD1UzbLT1FoG99",
|
||||
"description": "Ripple s1 server 'WOOL'"
|
||||
}]
|
||||
}
|
||||
```
|
||||
{% /tab %}
|
||||
|
||||
{% tab label="コマンドライン" %}
|
||||
```sh
|
||||
#Syntax: {% $frontmatter.seo.title %} <public_key> [<description>]
|
||||
rippled {% $frontmatter.seo.title %} n9Jt8awsPzWLjBCNKVEEDQnw4bQEPjezfcQ4gttD1UzbLT1FoG99 "Ripple s1 server 'WOOL'"
|
||||
```
|
||||
{% /tab %}
|
||||
|
||||
{% /tabs %}
|
||||
|
||||
リクエストには以下のパラメーターが含まれます。
|
||||
|
||||
| `Field` | 型 | 説明 |
|
||||
|:--------------|:-------|:----------------------------------------------------|
|
||||
| `public_key` | 文字列 | [base58][]での予約を追加するピアリザベーションの[ノード公開鍵][] 。 |
|
||||
| `description` | 文字列 | _(省略可)_ ピアリザベーションに関するカスタムの説明。64文字を超える部分は、再起動時にサーバーによって切り捨てられます。 |
|
||||
|
||||
|
||||
|
||||
### レスポンスのフォーマット
|
||||
|
||||
処理が成功したレスポンスの例:
|
||||
|
||||
{% tabs %}
|
||||
|
||||
{% tab label="WebSocket" %}
|
||||
```json
|
||||
{
|
||||
"id": "peer_reservations_add_example_1",
|
||||
"result": {
|
||||
"previous": {
|
||||
"description": "Maecenas atavis edite regibus, O et praesidium et dulce decus meum, Sunt quos curriculo pulverem Olympicum Collegisse iuvat metaque fervidis Evitata rotis palmaque nobilis Terrarum dominos evehit ad deos; Hunc, si mobilium turba Quiritium Certat tergeminis tollere honoribus; Illum, si proprio condidit horreo, Quidquid de Libycis verritur areis.",
|
||||
"node": "n9Jt8awsPzWLjBCNKVEEDQnw4bQEPjezfcQ4gttD1UzbLT1FoG99"
|
||||
}
|
||||
},
|
||||
"status": "success",
|
||||
"type": "response"
|
||||
}
|
||||
```
|
||||
{% /tab %}
|
||||
|
||||
{% tab label="JSON-RPC" %}
|
||||
```json
|
||||
{
|
||||
"result": {
|
||||
"previous": {
|
||||
"description": "Maecenas atavis edite regibus, O et praesidium et dulce decus meum, Sunt quos curriculo pulverem Olympicum Collegisse iuvat metaque fervidis Evitata rotis palmaque nobilis Terrarum dominos evehit ad deos; Hunc, si mobilium turba Quiritium Certat tergeminis tollere honoribus; Illum, si proprio condidit horreo, Quidquid de Libycis verritur areis.",
|
||||
"node": "n9Jt8awsPzWLjBCNKVEEDQnw4bQEPjezfcQ4gttD1UzbLT1FoG99"
|
||||
},
|
||||
"status": "success"
|
||||
}
|
||||
}
|
||||
```
|
||||
{% /tab %}
|
||||
|
||||
{% tab label="コマンドライン" %}
|
||||
```json
|
||||
Loading: "/etc/rippled.cfg"
|
||||
Connecting to 127.0.0.1:5005
|
||||
|
||||
{
|
||||
"result": {
|
||||
"previous": {
|
||||
"description": "Maecenas atavis edite regibus, O et praesidium et dulce decus meum, Sunt quos curriculo pulverem Olympicum Collegisse iuvat metaque fervidis Evitata rotis palmaque nobilis Terrarum dominos evehit ad deos; Hunc, si mobilium turba Quiritium Certat tergeminis tollere honoribus; Illum, si proprio condidit horreo, Quidquid de Libycis verritur areis.",
|
||||
"node": "n9Jt8awsPzWLjBCNKVEEDQnw4bQEPjezfcQ4gttD1UzbLT1FoG99"
|
||||
},
|
||||
"status": "success"
|
||||
}
|
||||
}
|
||||
```
|
||||
{% /tab %}
|
||||
|
||||
{% /tabs %}
|
||||
|
||||
このレスポンスは[標準フォーマット][]に従っており、正常に完了した場合は結果に次のフィールドが含まれます。
|
||||
|
||||
| `Field` | 型 | 説明 |
|
||||
|:-----------|:-------|:-------------------------------------------------------|
|
||||
| `previous` | オブジェクト | _（省略される場合があります）_ 同じ[ノード公開鍵][]の以前のエントリ（同じノード公開鍵を使用した予約がすでに存在する場合）。以下で説明するように、このオブジェクトは、**ピアリザベーションオブジェクト**というフォーマットになります。 |
|
||||
|
||||
同じ[ノード公開鍵][]に以前のエントリがなかった場合、`result`オブジェクトは空です。
|
||||
|
||||
#### ピアリザベーションオブジェクト
|
||||
|
||||
`previous`フィールドが指定されている場合は、このピアリザベーションの以前のステータスが次のフィールドとともに表示されます。
|
||||
|
||||
{% partial file="/docs/_snippets/peer_reservation_object.md" /%}
|
||||
|
||||
|
||||
|
||||
### 考えられるエラー
|
||||
|
||||
- いずれかの[汎用エラータイプ][]。
|
||||
- `invalidParams` - 1つ以上のフィールドの指定が正しくないか、1つ以上の必須フィールドが指定されていません。
|
||||
- `publicMalformed` - リクエストの`public_key`フィールドが無効です。[base58][]フォーマットの有効なノード公開鍵である必要があります。
|
||||
|
||||
{% raw-partial file="/docs/_snippets/common-links.md" /%}
|
||||
@@ -0,0 +1,138 @@
|
||||
---
|
||||
html: peer_reservations_del.html
|
||||
parent: peer-management-methods.html
|
||||
seo:
|
||||
description: 特定のピアサーバー用の予約済みスロットを削除します。
|
||||
labels:
|
||||
- コアサーバー
|
||||
---
|
||||
# peer_reservations_del
|
||||
|
||||
[[ソース]](https://github.com/XRPLF/rippled/blob/4a1148eb2849513dd1e7ae080288fd47ab57a376/src/ripple/rpc/handlers/Reservations.cpp#L89 "Source")
|
||||
|
||||
{% code-page-name /%}メソッドは、特定の[ピアリザベーション][]を削除します（存在する場合）。{% badge href="https://github.com/XRPLF/rippled/releases/tag/1.4.0" %}新規: rippled 1.4.0{% /badge %}
|
||||
|
||||
_{% code-page-name /%}メソッドは、権限のないユーザーは実行できない[管理メソッド](../index.md)です。_
|
||||
|
||||
**注記:** ピアリザベーションを削除しても、対応するピアが接続されている場合、そのピアは自動的に切断されません。
|
||||
|
||||
### リクエストのフォーマット
|
||||
|
||||
リクエストのフォーマットの例:
|
||||
|
||||
{% tabs %}
|
||||
|
||||
{% tab label="WebSocket" %}
|
||||
```json
|
||||
{
|
||||
"id": "peer_reservations_del_example_1",
|
||||
"command": "{% $frontmatter.seo.title %}",
|
||||
"public_key": "n9Jt8awsPzWLjBCNKVEEDQnw4bQEPjezfcQ4gttD1UzbLT1FoG99"
|
||||
}
|
||||
```
|
||||
{% /tab %}
|
||||
|
||||
{% tab label="JSON-RPC" %}
|
||||
```json
|
||||
{
|
||||
"method": "{% $frontmatter.seo.title %}",
|
||||
"params": [{
|
||||
"public_key": "n9Jt8awsPzWLjBCNKVEEDQnw4bQEPjezfcQ4gttD1UzbLT1FoG99"
|
||||
}]
|
||||
}
|
||||
```
|
||||
{% /tab %}
|
||||
|
||||
{% tab label="コマンドライン" %}
|
||||
```sh
|
||||
#Syntax: {% $frontmatter.seo.title %} <public_key>
|
||||
rippled {% $frontmatter.seo.title %} n9Jt8awsPzWLjBCNKVEEDQnw4bQEPjezfcQ4gttD1UzbLT1FoG99
|
||||
```
|
||||
{% /tab %}
|
||||
|
||||
{% /tabs %}
|
||||
|
||||
リクエストには以下のパラメーターが含まれます。
|
||||
|
||||
| `Field` | 型 | 説明 |
|
||||
|:------------|:--------------------------|:-----------------------------------|
|
||||
| `public_key` | 文字列 | 削除する[ピアリザベーション][]の[ノード公開鍵][]（[base58][]フォーマット） |
|
||||
|
||||
|
||||
### レスポンスのフォーマット
|
||||
|
||||
処理が成功したレスポンスの例:
|
||||
|
||||
{% tabs %}
|
||||
|
||||
{% tab label="WebSocket" %}
|
||||
```json
|
||||
{
|
||||
"id": "peer_reservations_del_example_1",
|
||||
"result": {
|
||||
"previous": {
|
||||
"description": "Ripple s1 server 'WOOL'",
|
||||
"node": "n9Jt8awsPzWLjBCNKVEEDQnw4bQEPjezfcQ4gttD1UzbLT1FoG99"
|
||||
}
|
||||
},
|
||||
"status": "success",
|
||||
"type": "response"
|
||||
}
|
||||
```
|
||||
{% /tab %}
|
||||
|
||||
{% tab label="JSON-RPC" %}
|
||||
```json
|
||||
{
|
||||
"result" : {
|
||||
"previous" : {
|
||||
"description" : "Ripple s1 server 'WOOL'",
|
||||
"node" : "n9Jt8awsPzWLjBCNKVEEDQnw4bQEPjezfcQ4gttD1UzbLT1FoG99"
|
||||
},
|
||||
"status" : "success"
|
||||
}
|
||||
}
|
||||
```
|
||||
{% /tab %}
|
||||
|
||||
{% tab label="コマンドライン" %}
|
||||
```json
|
||||
Loading: "/etc/rippled.cfg"
|
||||
Connecting to 127.0.0.1:5005
|
||||
|
||||
{
|
||||
"result" : {
|
||||
"previous" : {
|
||||
"description" : "Ripple s1 server 'WOOL'",
|
||||
"node" : "n9Jt8awsPzWLjBCNKVEEDQnw4bQEPjezfcQ4gttD1UzbLT1FoG99"
|
||||
},
|
||||
"status" : "success"
|
||||
}
|
||||
}
|
||||
```
|
||||
{% /tab %}
|
||||
|
||||
{% /tabs %}
|
||||
|
||||
このレスポンスは[標準フォーマット][]に従っており、正常に完了した場合は結果に次のフィールドが含まれます。
|
||||
|
||||
| `Field` | 型 | 説明 |
|
||||
|:--------|:-------|:----------------------------------------------------------|
|
||||
| `previous` | オブジェクト | _（省略される場合があります）_ 削除する前のピアリザベーションの最後のステータスを伴った、**ピアリザベーションオブジェクト**。このフィールドは、ピアリザベーションが正常に削除された場合、必ず表示されます。 |
|
||||
|
||||
**注記:** 指定された予約が存在しなかった場合は、このコマンドによって、成功を示す空の結果オブジェクトが返されます。この場合、`previous`フィールドは省略されます。
|
||||
|
||||
#### ピアリザベーションオブジェクト
|
||||
|
||||
`previous`フィールドが指定されている場合は、このピアリザベーションの以前のステータスが次のフィールドとともに表示されます。
|
||||
|
||||
{% partial file="/docs/_snippets/peer_reservation_object.md" /%}
|
||||
|
||||
|
||||
### 考えられるエラー
|
||||
|
||||
- いずれかの[汎用エラータイプ][]。
|
||||
- `invalidParams` - 1つ以上のフィールドの指定が正しくないか、1つ以上の必須フィールドが指定されていません。
|
||||
- `publicMalformed` - リクエストの`public_key`フィールドが無効です。[base58][]フォーマットの有効なノード公開鍵である必要があります。
|
||||
|
||||
{% raw-partial file="/docs/_snippets/common-links.md" /%}
|
||||
@@ -0,0 +1,139 @@
|
||||
---
|
||||
html: peer_reservations_list.html
|
||||
parent: peer-management-methods.html
|
||||
seo:
|
||||
description: 特定のピアサーバー用の予約済みスロットをリスト表示します。
|
||||
labels:
|
||||
- コアサーバー
|
||||
---
|
||||
# peer_reservations_list
|
||||
[[ソース]](https://github.com/XRPLF/rippled/blob/4a1148eb2849513dd1e7ae080288fd47ab57a376/src/ripple/rpc/handlers/Reservations.cpp#L116 "Source")
|
||||
|
||||
{% code-page-name /%}メソッドは、[ピアリザベーション][]を一覧表示します。{% badge href="https://github.com/XRPLF/rippled/releases/tag/1.4.0" %}新規: rippled 1.4.0{% /badge %}
|
||||
|
||||
_{% code-page-name /%}メソッドは、権限のないユーザーは実行できない[管理メソッド](../index.md)です。_
|
||||
|
||||
|
||||
### リクエストのフォーマット
|
||||
|
||||
リクエストのフォーマットの例:
|
||||
|
||||
{% tabs %}
|
||||
|
||||
{% tab label="WebSocket" %}
|
||||
```json
|
||||
{
|
||||
"id": "peer_reservations_list_example_1",
|
||||
"command": "{% $frontmatter.seo.title %}"
|
||||
}
|
||||
```
|
||||
{% /tab %}
|
||||
|
||||
{% tab label="JSON-RPC" %}
|
||||
```json
|
||||
{
|
||||
"method": "{% $frontmatter.seo.title %}"
|
||||
}
|
||||
```
|
||||
{% /tab %}
|
||||
|
||||
{% tab label="コマンドライン" %}
|
||||
```sh
|
||||
#Syntax: {% $frontmatter.seo.title %}
|
||||
rippled {% $frontmatter.seo.title %}
|
||||
```
|
||||
{% /tab %}
|
||||
|
||||
{% /tabs %}
|
||||
|
||||
このリクエストにはパラメーターは含まれません。
|
||||
|
||||
|
||||
### レスポンスのフォーマット
|
||||
|
||||
処理が成功したレスポンスの例:
|
||||
|
||||
{% tabs %}
|
||||
|
||||
{% tab label="WebSocket" %}
|
||||
```json
|
||||
{
|
||||
"id": "peer_reservations_list_example_1",
|
||||
"result": {
|
||||
"reservations": [
|
||||
{
|
||||
"description": "Ripple s1 server 'WOOL'",
|
||||
"node": "n9Jt8awsPzWLjBCNKVEEDQnw4bQEPjezfcQ4gttD1UzbLT1FoG99"
|
||||
},
|
||||
{
|
||||
"node": "n9MZRo92mzYjjsa5XcqnPC7GFYAnENo9VfJzKmpcS9EFZvw5fgwz"
|
||||
}
|
||||
]
|
||||
},
|
||||
"status": "success",
|
||||
"type": "response"
|
||||
}
|
||||
```
|
||||
{% /tab %}
|
||||
|
||||
{% tab label="JSON-RPC" %}
|
||||
```json
|
||||
{
|
||||
"result" : {
|
||||
"reservations" : [
|
||||
{
|
||||
"description" : "Ripple s1 server 'WOOL'",
|
||||
"node" : "n9Jt8awsPzWLjBCNKVEEDQnw4bQEPjezfcQ4gttD1UzbLT1FoG99"
|
||||
},
|
||||
{
|
||||
"node" : "n9MZRo92mzYjjsa5XcqnPC7GFYAnENo9VfJzKmpcS9EFZvw5fgwz"
|
||||
}
|
||||
],
|
||||
"status" : "success"
|
||||
}
|
||||
}
|
||||
```
|
||||
{% /tab %}
|
||||
|
||||
{% tab label="コマンドライン" %}
|
||||
```json
|
||||
Loading: "/etc/rippled.cfg"
|
||||
2019-Dec-27 21:56:07.253260422 HTTPClient:NFO Connecting to 127.0.0.1:5005
|
||||
|
||||
{
|
||||
"result" : {
|
||||
"reservations" : [
|
||||
{
|
||||
"description" : "Ripple s1 server 'WOOL'",
|
||||
"node" : "n9Jt8awsPzWLjBCNKVEEDQnw4bQEPjezfcQ4gttD1UzbLT1FoG99"
|
||||
},
|
||||
{
|
||||
"node" : "n9MZRo92mzYjjsa5XcqnPC7GFYAnENo9VfJzKmpcS9EFZvw5fgwz"
|
||||
}
|
||||
],
|
||||
"status" : "success"
|
||||
}
|
||||
}
|
||||
```
|
||||
{% /tab %}
|
||||
|
||||
{% /tabs %}
|
||||
|
||||
このレスポンスは[標準フォーマット][]に従っており、正常に完了した場合は結果に次のフィールドが含まれます。
|
||||
|
||||
| `Field` | 型 | 説明 |
|
||||
|:---------------|:------|:----------------------------------------------------|
|
||||
| `reservations` | 配列 | 既存の[ピアリザベーション][]のリスト。各メンバーはピアリザベーションオブジェクトです。詳細は以下のとおりです。 |
|
||||
|
||||
#### ピアリザベーションオブジェクト
|
||||
|
||||
`reservations`配列の各メンバーは、1つの[ピアリザベーション][]を表すJSONオブジェクトです。このオブジェクトのフィールドを次に示します。
|
||||
|
||||
{% partial file="/docs/_snippets/peer_reservation_object.md" /%}
|
||||
|
||||
|
||||
### 考えられるエラー
|
||||
|
||||
- いずれかの[汎用エラータイプ][]。
|
||||
|
||||
{% raw-partial file="/docs/_snippets/common-links.md" /%}
|
||||
@@ -0,0 +1,420 @@
|
||||
---
|
||||
html: peers.html
|
||||
parent: peer-management-methods.html
|
||||
seo:
|
||||
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`リクエストは、権限のないユーザーは実行できない[管理メソッド](../index.md)です。*
|
||||
|
||||
### リクエストのフォーマット
|
||||
リクエストのフォーマットの例:
|
||||
|
||||
{% tabs %}
|
||||
|
||||
{% tab label="WebSocket" %}
|
||||
```json
|
||||
{
|
||||
"id": 2,
|
||||
"command": "peers"
|
||||
}
|
||||
```
|
||||
{% /tab %}
|
||||
|
||||
{% tab label="コマンドライン" %}
|
||||
```
|
||||
rippled peers
|
||||
```
|
||||
{% /tab %}
|
||||
|
||||
{% /tabs %}
|
||||
|
||||
このリクエストには追加パラメーターはありません。
|
||||
|
||||
### レスポンスのフォーマット
|
||||
|
||||
処理が成功したレスポンスの例:
|
||||
|
||||
{% tabs %}
|
||||
|
||||
{% tab label="WebSocket" %}
|
||||
```json
|
||||
{
|
||||
"id": 2,
|
||||
"status": "success",
|
||||
"type": "response",
|
||||
"result": {
|
||||
"cluster": {},
|
||||
"peers": [
|
||||
{
|
||||
"address": "184.172.237.226:51235",
|
||||
"complete_ledgers": "14534883 - 18828973",
|
||||
"latency": 117,
|
||||
"ledger": "50A2577CE6EB8A92847C443BDA45F5C5F0A22B9C6F4B47DBA0C12BDA75001D01",
|
||||
"load": 54,
|
||||
"public_key": "n9KNYm52mgcUQ7R2RA4kyw9Nk1yc6S35PaiuyqjYsy6UjhCXpw12",
|
||||
"uptime": 55036,
|
||||
"version": "rippled-0.30.0-hf1"
|
||||
},
|
||||
{
|
||||
"address": "54.186.248.91:51235",
|
||||
"complete_ledgers": "18827949 - 18828973",
|
||||
"latency": 91,
|
||||
"ledger": "50A2577CE6EB8A92847C443BDA45F5C5F0A22B9C6F4B47DBA0C12BDA75001D01",
|
||||
"load": 62,
|
||||
"public_key": "n9MT5EjnV912KGuBUqPs4tpdhzMPGcnDBrTuWkD9sWQHJ1kDcUcz",
|
||||
"uptime": 83814,
|
||||
"version": "rippled-0.30.1"
|
||||
},
|
||||
{
|
||||
"address": "54.84.21.230:51235",
|
||||
"complete_ledgers": "18827949 - 18828973",
|
||||
"latency": 202,
|
||||
"ledger": "50A2577CE6EB8A92847C443BDA45F5C5F0A22B9C6F4B47DBA0C12BDA75001D01",
|
||||
"load": 60,
|
||||
"public_key": "n9KJb7NMxGySRcjCqh69xEPMUhwJx22qntYYXsnUqYgjsJhNoW7g",
|
||||
"uptime": 99625,
|
||||
"version": "rippled-0.30.1"
|
||||
},
|
||||
{
|
||||
"address": "72.251.233.162:51235",
|
||||
"complete_ledgers": "18827949 - 18828973",
|
||||
"latency": 36,
|
||||
"ledger": "50A2577CE6EB8A92847C443BDA45F5C5F0A22B9C6F4B47DBA0C12BDA75001D01",
|
||||
"load": 66,
|
||||
"public_key": "n9M8RSk6hrvXZKFQ6CxPbJsjt73xW1xsnjn7G69VAMbE2j4sBQNQ",
|
||||
"uptime": 99619,
|
||||
"version": "rippled-0.30.1"
|
||||
},
|
||||
{
|
||||
"address": "162.217.98.136:51235",
|
||||
"complete_ledgers": "32570 - 18828973",
|
||||
"latency": 118,
|
||||
"ledger": "50A2577CE6EB8A92847C443BDA45F5C5F0A22B9C6F4B47DBA0C12BDA75001D01",
|
||||
"load": 69,
|
||||
"public_key": "n944PcXEoZaiEHnwFD92xA4bxsS7jjYb27WcdDQwkHYyk1MWTEsX",
|
||||
"uptime": 99625,
|
||||
"version": "rippled-0.30.1"
|
||||
},
|
||||
{
|
||||
"address": "72.251.233.163:51235",
|
||||
"complete_ledgers": "18827949 - 18828973",
|
||||
"latency": 51,
|
||||
"ledger": "50A2577CE6EB8A92847C443BDA45F5C5F0A22B9C6F4B47DBA0C12BDA75001D01",
|
||||
"load": 61,
|
||||
"public_key": "n94ne2Z5dX8qcJNa8cPtAbtn21gEaCoEduS8TwdGAhi1iLfCUMDm",
|
||||
"uptime": 99625,
|
||||
"version": "rippled-0.30.1"
|
||||
},
|
||||
{
|
||||
"address": "54.186.73.52:51235",
|
||||
"complete_ledgers": "18827949 - 18828973",
|
||||
"latency": 72,
|
||||
"ledger": "50A2577CE6EB8A92847C443BDA45F5C5F0A22B9C6F4B47DBA0C12BDA75001D01",
|
||||
"load": 60,
|
||||
"public_key": "n9JySgyBVcQKvyDoeRKg7s2Mm6ZcFHk22vUZb3o1HSosWxcj9xPt",
|
||||
"uptime": 99625,
|
||||
"version": "rippled-0.30.1"
|
||||
},
|
||||
{
|
||||
"address": "72.251.233.165:51235",
|
||||
"complete_ledgers": "18827949 - 18828973",
|
||||
"latency": 40,
|
||||
"ledger": "50A2577CE6EB8A92847C443BDA45F5C5F0A22B9C6F4B47DBA0C12BDA75001D01",
|
||||
"load": 63,
|
||||
"public_key": "n9M77Uc9CSaSFZqt5V7sxPR4kFwbha7hwUFBD5v5kZt2SQjBeoDs",
|
||||
"uptime": 99625,
|
||||
"version": "rippled-0.30.1"
|
||||
},
|
||||
{
|
||||
"address": "72.251.232.173:51235",
|
||||
"complete_ledgers": "32570 - 18828973",
|
||||
"latency": 40,
|
||||
"ledger": "50A2577CE6EB8A92847C443BDA45F5C5F0A22B9C6F4B47DBA0C12BDA75001D01",
|
||||
"load": 71,
|
||||
"public_key": "n9JveA1hHDGjZECaYC7KM4JP8NXXzNXAxixbzcLTGnrsFZsA9AD1",
|
||||
"uptime": 99625,
|
||||
"version": "rippled-0.31.0-b6"
|
||||
},
|
||||
{
|
||||
"address": "98.167.120.212:51235",
|
||||
"complete_ledgers": "18828845 - 18828973",
|
||||
"latency": 99,
|
||||
"ledger": "50A2577CE6EB8A92847C443BDA45F5C5F0A22B9C6F4B47DBA0C12BDA75001D01",
|
||||
"load": 60,
|
||||
"public_key": "n9LDBRoqPYY7RdkNXbX1dqZXVtUKcSqzs2CZPhTH7ymA9X7Xzmpj",
|
||||
"uptime": 99625,
|
||||
"version": "rippled-0.30.1-rc4"
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
```
|
||||
{% /tab %}
|
||||
|
||||
{% tab label="JSON-RPC" %}
|
||||
```json
|
||||
{
|
||||
"result" : {
|
||||
"cluster" : {},
|
||||
"peers" : [
|
||||
{
|
||||
"address" : "184.172.237.226:51235",
|
||||
"complete_ledgers" : "14535005 - 18828957",
|
||||
"latency" : 114,
|
||||
"ledger" : "80FCB89BC5B90D2B9C2CE33786738809796F04FB9CB1E5EEE768DD9A9C399FB0",
|
||||
"load" : 47,
|
||||
"public_key" : "n9KNYm52mgcUQ7R2RA4kyw9Nk1yc6S35PaiuyqjYsy6UjhCXpw12",
|
||||
"uptime" : 54976,
|
||||
"version" : "rippled-0.30.0-hf1"
|
||||
},
|
||||
{
|
||||
"address" : "54.186.248.91:51235",
|
||||
"complete_ledgers" : "18827934 - 18828958",
|
||||
"latency" : 68,
|
||||
"ledger" : "9447480E351221123B1A454356435A66C188D9794B0197A060637E19F074B421",
|
||||
"load" : 56,
|
||||
"public_key" : "n9MT5EjnV912KGuBUqPs4tpdhzMPGcnDBrTuWkD9sWQHJ1kDcUcz",
|
||||
"uptime" : 83754,
|
||||
"version" : "rippled-0.30.1"
|
||||
},
|
||||
{
|
||||
"address" : "54.84.21.230:51235",
|
||||
"complete_ledgers" : "18827934 - 18828958",
|
||||
"latency" : 135,
|
||||
"ledger" : "9447480E351221123B1A454356435A66C188D9794B0197A060637E19F074B421",
|
||||
"load" : 54,
|
||||
"public_key" : "n9KJb7NMxGySRcjCqh69xEPMUhwJx22qntYYXsnUqYgjsJhNoW7g",
|
||||
"uptime" : 99565,
|
||||
"version" : "rippled-0.30.1"
|
||||
},
|
||||
{
|
||||
"address" : "72.251.233.162:51235",
|
||||
"complete_ledgers" : "18827934 - 18828958",
|
||||
"latency" : 24,
|
||||
"ledger" : "9447480E351221123B1A454356435A66C188D9794B0197A060637E19F074B421",
|
||||
"load" : 61,
|
||||
"public_key" : "n9M8RSk6hrvXZKFQ6CxPbJsjt73xW1xsnjn7G69VAMbE2j4sBQNQ",
|
||||
"uptime" : 99560,
|
||||
"version" : "rippled-0.30.1"
|
||||
},
|
||||
{
|
||||
"address" : "162.217.98.136:51235",
|
||||
"complete_ledgers" : "32570 - 18828958",
|
||||
"latency" : 88,
|
||||
"ledger" : "9447480E351221123B1A454356435A66C188D9794B0197A060637E19F074B421",
|
||||
"load" : 55,
|
||||
"public_key" : "n944PcXEoZaiEHnwFD92xA4bxsS7jjYb27WcdDQwkHYyk1MWTEsX",
|
||||
"uptime" : 99566,
|
||||
"version" : "rippled-0.30.1"
|
||||
},
|
||||
{
|
||||
"address" : "72.251.233.163:51235",
|
||||
"complete_ledgers" : "18827934 - 18828958",
|
||||
"latency" : 24,
|
||||
"ledger" : "9447480E351221123B1A454356435A66C188D9794B0197A060637E19F074B421",
|
||||
"load" : 56,
|
||||
"public_key" : "n94ne2Z5dX8qcJNa8cPtAbtn21gEaCoEduS8TwdGAhi1iLfCUMDm",
|
||||
"uptime" : 99566,
|
||||
"version" : "rippled-0.30.1"
|
||||
},
|
||||
{
|
||||
"address" : "54.186.73.52:51235",
|
||||
"complete_ledgers" : "18827934 - 18828958",
|
||||
"latency" : 51,
|
||||
"ledger" : "9447480E351221123B1A454356435A66C188D9794B0197A060637E19F074B421",
|
||||
"load" : 56,
|
||||
"public_key" : "n9JySgyBVcQKvyDoeRKg7s2Mm6ZcFHk22vUZb3o1HSosWxcj9xPt",
|
||||
"uptime" : 99566,
|
||||
"version" : "rippled-0.30.1"
|
||||
},
|
||||
{
|
||||
"address" : "72.251.233.165:51235",
|
||||
"complete_ledgers" : "18827934 - 18828958",
|
||||
"latency" : 25,
|
||||
"ledger" : "9447480E351221123B1A454356435A66C188D9794B0197A060637E19F074B421",
|
||||
"load" : 56,
|
||||
"public_key" : "n9M77Uc9CSaSFZqt5V7sxPR4kFwbha7hwUFBD5v5kZt2SQjBeoDs",
|
||||
"uptime" : 99566,
|
||||
"version" : "rippled-0.30.1"
|
||||
},
|
||||
{
|
||||
"address" : "72.251.232.173:51235",
|
||||
"complete_ledgers" : "32570 - 18828958",
|
||||
"latency" : 24,
|
||||
"ledger" : "9447480E351221123B1A454356435A66C188D9794B0197A060637E19F074B421",
|
||||
"load" : 81,
|
||||
"public_key" : "n9JveA1hHDGjZECaYC7KM4JP8NXXzNXAxixbzcLTGnrsFZsA9AD1",
|
||||
"uptime" : 99566,
|
||||
"version" : "rippled-0.31.0-b6"
|
||||
},
|
||||
{
|
||||
"address" : "98.167.120.212:51235",
|
||||
"complete_ledgers" : "18828830 - 18828957",
|
||||
"latency" : 137,
|
||||
"ledger" : "9447480E351221123B1A454356435A66C188D9794B0197A060637E19F074B421",
|
||||
"load" : 54,
|
||||
"public_key" : "n9LDBRoqPYY7RdkNXbX1dqZXVtUKcSqzs2CZPhTH7ymA9X7Xzmpj",
|
||||
"uptime" : 99566,
|
||||
"version" : "rippled-0.30.1-rc4"
|
||||
}
|
||||
],
|
||||
"status" : "success"
|
||||
}
|
||||
}
|
||||
```
|
||||
{% /tab %}
|
||||
|
||||
{% tab label="コマンドライン" %}
|
||||
```json
|
||||
Loading: "/etc/rippled.cfg"
|
||||
Connecting to 127.0.0.1:5005
|
||||
|
||||
{
|
||||
"result" : {
|
||||
"cluster" : {},
|
||||
"peers" : [
|
||||
{
|
||||
"address" : "72.251.232.173:51235",
|
||||
"complete_ledgers" : "32570 - 18851276",
|
||||
"latency" : 22,
|
||||
"ledger" : "592C723DDBB1C5119F0D8288894060C83C8C2975A061D7C9971427D6798098F5",
|
||||
"load" : 20,
|
||||
"public_key" : "n9JveA1hHDGjZECaYC7KM4JP8NXXzNXAxixbzcLTGnrsFZsA9AD1",
|
||||
"uptime" : 26,
|
||||
"version" : "rippled-0.31.0-b6"
|
||||
},
|
||||
{
|
||||
"address" : "169.53.155.36:51235",
|
||||
"complete_ledgers" : "12920801 - 18851275",
|
||||
"latency" : 127,
|
||||
"load" : 16,
|
||||
"public_key" : "n9L42gouyppsmsMXXUdByXnVDUZv1eu6KLZUWUkNHsukzv3pr7po",
|
||||
"uptime" : 18,
|
||||
"version" : "rippled-0.30.0-hf1"
|
||||
},
|
||||
{
|
||||
"address" : "169.53.155.44:51235",
|
||||
"complete_ledgers" : "12920779 - 18851276",
|
||||
"latency" : 20,
|
||||
"ledger" : "592C723DDBB1C5119F0D8288894060C83C8C2975A061D7C9971427D6798098F5",
|
||||
"load" : 49,
|
||||
"public_key" : "n94BpoEqEf1PxpAv3Bmyy2WoKHyeMpHPH4tcj6P9NW98zdzEyRhi",
|
||||
"uptime" : 50,
|
||||
"version" : "rippled-0.30.0-hf1"
|
||||
},
|
||||
{
|
||||
"address" : "192.170.145.77:51235",
|
||||
"complete_ledgers" : "32570 - 18851277",
|
||||
"latency" : 145,
|
||||
"ledger" : "592C723DDBB1C5119F0D8288894060C83C8C2975A061D7C9971427D6798098F5",
|
||||
"load" : 29,
|
||||
"public_key" : "n9LwcmtjDAJQz4u8DZCMGQ9GXHuMEV4Cf8KpPL9NgqAV2puxdYc2",
|
||||
"uptime" : 51,
|
||||
"version" : "rippled-0.30.1"
|
||||
},
|
||||
{
|
||||
"address" : "162.217.98.136:51235",
|
||||
"complete_ledgers" : "32570 - 18851277",
|
||||
"latency" : 83,
|
||||
"ledger" : "592C723DDBB1C5119F0D8288894060C83C8C2975A061D7C9971427D6798098F5",
|
||||
"load" : 30,
|
||||
"public_key" : "n944PcXEoZaiEHnwFD92xA4bxsS7jjYb27WcdDQwkHYyk1MWTEsX",
|
||||
"uptime" : 50,
|
||||
"version" : "rippled-0.30.1"
|
||||
},
|
||||
{
|
||||
"address" : "184.172.237.241:51235",
|
||||
"complete_ledgers" : "14153089 - 18851277",
|
||||
"latency" : 104,
|
||||
"ledger" : "592C723DDBB1C5119F0D8288894060C83C8C2975A061D7C9971427D6798098F5",
|
||||
"load" : 29,
|
||||
"public_key" : "n9L3LdCTVYUhCKtQtxiHrQ5ocNXVqZFiEJpF5pX9DXahYLrvi5R7",
|
||||
"uptime" : 51,
|
||||
"version" : "rippled-0.30.0-hf1"
|
||||
},
|
||||
{
|
||||
"address" : "99.110.49.91:51301",
|
||||
"complete_ledgers" : "32570 - 18851277",
|
||||
"latency" : 152,
|
||||
"ledger" : "592C723DDBB1C5119F0D8288894060C83C8C2975A061D7C9971427D6798098F5",
|
||||
"load" : 55,
|
||||
"public_key" : "n9LGv3xKVqhxq6vcTfmJZhxyhjywsZbvJvpFbZRXzzz5uQ64xTLy",
|
||||
"uptime" : 51,
|
||||
"version" : "rippled-0.31.0-b6"
|
||||
},
|
||||
{
|
||||
"address" : "169.53.155.45:51235",
|
||||
"complete_ledgers" : "12920779 - 18851277",
|
||||
"latency" : 15,
|
||||
"ledger" : "592C723DDBB1C5119F0D8288894060C83C8C2975A061D7C9971427D6798098F5",
|
||||
"load" : 30,
|
||||
"public_key" : "n9MRiHyMk43YpqATWeT8Zyu4HJq1btb5oNKmnHTkLJKQg9LQQq3v",
|
||||
"uptime" : 51,
|
||||
"version" : "rippled-0.30.0-hf1"
|
||||
},
|
||||
{
|
||||
"address" : "54.186.248.91:51235",
|
||||
"complete_ledgers" : "18850253 - 18851277",
|
||||
"latency" : 63,
|
||||
"ledger" : "592C723DDBB1C5119F0D8288894060C83C8C2975A061D7C9971427D6798098F5",
|
||||
"load" : 36,
|
||||
"public_key" : "n9MT5EjnV912KGuBUqPs4tpdhzMPGcnDBrTuWkD9sWQHJ1kDcUcz",
|
||||
"uptime" : 51,
|
||||
"version" : "rippled-0.30.1"
|
||||
}
|
||||
],
|
||||
"status" : "success"
|
||||
}
|
||||
}
|
||||
|
||||
```
|
||||
{% /tab %}
|
||||
|
||||
{% /tabs %}
|
||||
|
||||
レスポンスは[標準フォーマット][]に従っており、正常に完了した場合は結果に次のフィールドからなるJSONオブジェクトが含まれます。
|
||||
|
||||
| `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 %} |
|
||||
| `peers` | 配列 | peerオブジェクトからなる配列。 |
|
||||
|
||||
`cluster`オブジェクトの各フィールドは、該当する`rippled`サーバーの識別用キーペアの公開鍵です。（これは、[server_infoメソッド][]で当該サーバーから`pubkey_node`として返される値と同じです。）そのフィールドの内容は、以下のフィールドを持つオブジェクトです。
|
||||
|
||||
| `Field` | 型 | 説明 |
|
||||
|:--------|:-------|:----------------------------------------------------------|
|
||||
| `tag` | 文字列 | 構成ファイルで定義されているこのクラスターメンバーの表示名。 |
|
||||
| `fee` | 数値 | （省略される場合があります）このクラスターメンバーが[トランザクションコスト](../../../../concepts/transactions/transaction-cost.md)に適用する負荷乗数。 |
|
||||
| `age` | 数値 | このクラスターメンバーからの最終クラスターレポート以降の経過秒数。 |
|
||||
|
||||
`peers`配列の各メンバーは、以下のフィールドを持つpeerオブジェクトです。
|
||||
|
||||
| `Field` | 型 | 説明 |
|
||||
|:-------------------|:--------|:----------------------------------------------|
|
||||
| `address` | 文字列 | このピアが接続しているIPアドレスとポート。 |
|
||||
| `cluster` | ブール値 | （省略される場合があります）`true`の場合、現在のサーバーとピアサーバーは同じ`rippled`クラスターに含まれています。 |
|
||||
| `name` | 文字列 | （省略される場合があります）ピアが同じクラスターに含まれている場合、この名前は構成ファイルで定義されているそのピアサーバーの表示名です。 |
|
||||
| `complete_ledgers` | 文字列 | ピア`rippled`で利用可能なレジャーバージョンのシーケンス番号を示す範囲式 |
|
||||
| `inbound` | ブール値 | （省略される場合があります）`true`の場合は、ピアはローカルサーバーに接続しています。 |
|
||||
| `latency` | 数値 | ピアへのネットワーク遅延（ミリ秒単位） |
|
||||
| `ledger` | 文字列 | 最後に閉鎖されたピアのレジャーのハッシュ。 |
|
||||
| `load` | 数値 | ピアサーバーによるローカルサーバーへの負荷の測定値。この数値が大きいほど負荷が高くなります。（負荷の測定単位は正式には定義されていません。） |
|
||||
| `protocol` | 文字列 | （省略される場合があります）ピアが使用しているプロトコルバージョン（ローカルサーバーのプロトコルバージョンと異なる場合）。 |
|
||||
| `public_key` | 文字列 | （省略される場合があります）ピアのメッセージの整合性の検証に使用できる公開鍵。これは、検証に使用する公開鍵とは異なりますが、フォーマットは同じです。 |
|
||||
| `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`バージョン番号 |
|
||||
|
||||
### 考えられるエラー
|
||||
|
||||
* [汎用エラータイプ][]のすべて。
|
||||
|
||||
{% raw-partial file="/docs/_snippets/common-links.md" /%}
|
||||
@@ -0,0 +1,12 @@
|
||||
---
|
||||
html: server-control-methods.html
|
||||
parent: admin-api-methods.html
|
||||
metadata:
|
||||
indexPage: true
|
||||
---
|
||||
# サーバ操作メソッド
|
||||
|
||||
以下のメソッドを使用して、rippledサーバーを管理することができます。
|
||||
|
||||
|
||||
{% child-pages /%}
|
||||
@@ -0,0 +1,69 @@
|
||||
---
|
||||
html: ledger_accept.html
|
||||
parent: server-control-methods.html
|
||||
seo:
|
||||
description: スタンドアロンモードでサーバーが現在処理中のレジャーを強制的に終了し、次のレジャー番号に進むようにします。
|
||||
labels:
|
||||
- コアサーバー
|
||||
---
|
||||
# ledger_accept
|
||||
[[ソース]](https://github.com/XRPLF/rippled/blob/a61ffab3f9010d8accfaa98aa3cacc7d38e74121/src/ripple/rpc/handlers/LedgerAccept.cpp "Source")
|
||||
|
||||
`ledger_accept`メソッドは、サーバーが現在処理中のレジャーを強制的に終了し、次のレジャー番号に進むようにします。このメソッドはテスト専用であり、`rippled`サーバーがスタンドアロンモードで実行されている場合にのみ使用できます。
|
||||
|
||||
*`ledger_accept`メソッドは、権限のないユーザーは実行できない[管理メソッド](../index.md)です。*
|
||||
|
||||
### リクエストのフォーマット
|
||||
|
||||
リクエストのフォーマットの例:
|
||||
|
||||
{% tabs %}
|
||||
|
||||
{% tab label="WebSocket" %}
|
||||
```json
|
||||
{
|
||||
"id": "Accept my ledger!",
|
||||
"command": "ledger_accept"
|
||||
}
|
||||
```
|
||||
{% /tab %}
|
||||
|
||||
{% tab label="コマンドライン" %}
|
||||
```sh
|
||||
#Syntax: ledger_accept
|
||||
rippled ledger_accept
|
||||
```
|
||||
{% /tab %}
|
||||
|
||||
{% /tabs %}
|
||||
|
||||
このリクエストはパラメーターを受け入れません。
|
||||
|
||||
### レスポンスのフォーマット
|
||||
|
||||
処理が成功したレスポンスの例:
|
||||
```js
|
||||
{
|
||||
"id": "Accept my ledger!",
|
||||
"status": "success",
|
||||
"type": "response",
|
||||
"result": {
|
||||
"ledger_current_index": 6643240
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
レスポンスは[標準フォーマット][]に従っており、正常に完了した場合は結果に次のフィールドが含まれます。
|
||||
|
||||
| `Field` | 型 | 説明 |
|
||||
|:-----------------------|:-----------------|:---------------------------------|
|
||||
| `ledger_current_index` | 符号なし整数 | 新規に作成される「現行」レジャーインデックス |
|
||||
|
||||
**注記:** レジャーを閉鎖すると、`rippled`がそのレジャーのトランザクションの正規順序を決定してリプレイします。これにより、以前に現行レジャーに暫定的に適用されていたトランザクションの結果が変化することがあります。
|
||||
|
||||
### 考えられるエラー
|
||||
|
||||
* [汎用エラータイプ][]のすべて。
|
||||
* `notStandAlone` - `rippled`サーバーが現在スタンドアロンモードで実行されていない場合。
|
||||
|
||||
{% raw-partial file="/docs/_snippets/common-links.md" /%}
|
||||
@@ -0,0 +1,94 @@
|
||||
---
|
||||
html: stop.html
|
||||
parent: server-control-methods.html
|
||||
seo:
|
||||
description: サーバーのグレースフルシャットダウンを行います。
|
||||
labels:
|
||||
- コアサーバー
|
||||
---
|
||||
# stop
|
||||
[[ソース]](https://github.com/XRPLF/rippled/blob/master/src/ripple/rpc/handlers/Stop.cpp "Source")
|
||||
|
||||
サーバーのグレースフルシャットダウンを行います。
|
||||
|
||||
_`stop`リクエストは、権限のないユーザーは実行できない*[管理メソッド](../index.md)です。_
|
||||
|
||||
### リクエストのフォーマット
|
||||
リクエストのフォーマットの例:
|
||||
|
||||
{% tabs %}
|
||||
|
||||
{% tab label="WebSocket" %}
|
||||
```json
|
||||
{
|
||||
"id": 0,
|
||||
"command": "stop"
|
||||
}
|
||||
```
|
||||
{% /tab %}
|
||||
|
||||
{% tab label="JSON-RPC" %}
|
||||
```json
|
||||
{
|
||||
"method": "stop",
|
||||
"params": [
|
||||
{}
|
||||
]
|
||||
}
|
||||
```
|
||||
{% /tab %}
|
||||
|
||||
{% tab label="コマンドライン" %}
|
||||
```
|
||||
rippled stop
|
||||
```
|
||||
{% /tab %}
|
||||
|
||||
{% /tabs %}
|
||||
|
||||
リクエストにはパラメーターが含まれていません。
|
||||
|
||||
### レスポンスのフォーマット
|
||||
|
||||
処理が成功したレスポンスの例:
|
||||
|
||||
{% tabs %}
|
||||
|
||||
{% tab label="JSON-RPC" %}
|
||||
```json
|
||||
{
|
||||
"result" : {
|
||||
"message" : "ripple server stopping",
|
||||
"status" : "success"
|
||||
}
|
||||
}
|
||||
```
|
||||
{% /tab %}
|
||||
|
||||
{% tab label="コマンドライン" %}
|
||||
```json
|
||||
Loading: "/etc/rippled.cfg"
|
||||
Connecting to 127.0.0.1:5005
|
||||
|
||||
{
|
||||
"result" : {
|
||||
"message" : "ripple server stopping",
|
||||
"status" : "success"
|
||||
}
|
||||
}
|
||||
```
|
||||
{% /tab %}
|
||||
|
||||
{% /tabs %}
|
||||
|
||||
レスポンスは[標準フォーマット][]に従っており、正常に完了した場合は結果に次のフィールドが含まれています。
|
||||
|
||||
| `Field` | 型 | 説明 |
|
||||
|:----------|:-------|:-------------------------------------|
|
||||
| `message` | 文字列 | `ripple server stopping` : 正常終了の場合。 |
|
||||
|
||||
### 考えられるエラー
|
||||
|
||||
* [汎用エラータイプ][]のすべて。
|
||||
|
||||
{% raw-partial file="/docs/_snippets/common-links.md" /%}
|
||||
@@ -0,0 +1,99 @@
|
||||
---
|
||||
html: validation_seed.html
|
||||
parent: server-control-methods.html
|
||||
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`リクエストは、権限のないユーザーは実行できない[管理メソッド](../index.md)です。*
|
||||
|
||||
### リクエストのフォーマット
|
||||
リクエストのフォーマットの例:
|
||||
|
||||
{% tabs %}
|
||||
|
||||
{% tab label="WebSocket" %}
|
||||
```json
|
||||
{
|
||||
"id": "set_seed_1",
|
||||
"command": "validation_seed",
|
||||
"secret": "BAWL MAN JADE MOON DOVE GEM SON NOW HAD ADEN GLOW TIRE"
|
||||
}
|
||||
```
|
||||
{% /tab %}
|
||||
|
||||
{% tab label="コマンドライン" %}
|
||||
```sh
|
||||
#Syntax: validation_seed [secret]
|
||||
rippled validation_seed 'BAWL MAN JADE MOON DOVE GEM SON NOW HAD ADEN GLOW TIRE'
|
||||
```
|
||||
{% /tab %}
|
||||
|
||||
{% /tabs %}
|
||||
|
||||
リクエストには以下のパラメーターが含まれます。
|
||||
|
||||
| `Field` | 型 | 説明 |
|
||||
|:---------|:-------|:---------------------------------------------------------|
|
||||
| `secret` | 文字列 | _（省略可）_ 指定されている場合は、この値はキーペアの検証のためのシークレット値として使用されます。有効なフォーマットには、XRP Ledgerの[base58][]フォーマット、[RFC-1751](https://tools.ietf.org/html/rfc1751)、またはパスフレーズがあります。省略されている場合は、ネットワークへの検証の提案が無効になります。 |
|
||||
|
||||
### レスポンスのフォーマット
|
||||
|
||||
処理が成功したレスポンスの例:
|
||||
|
||||
{% tabs %}
|
||||
|
||||
{% tab label="JSON-RPC" %}
|
||||
```json
|
||||
200 OK
|
||||
|
||||
{
|
||||
"result" : {
|
||||
"status" : "success",
|
||||
"validation_key" : "BAWL MAN JADE MOON DOVE GEM SON NOW HAD ADEN GLOW TIRE",
|
||||
"validation_public_key" : "n9Jx6RS6zSgqsgnuWJifNA9EqgjTKAywqYNReK5NRd1yLBbfC3ng",
|
||||
"validation_seed" : "snjJkyBGogTem5dFGbcRaThKq2Rt3"
|
||||
}
|
||||
}
|
||||
```
|
||||
{% /tab %}
|
||||
|
||||
{% tab label="コマンドライン" %}
|
||||
```json
|
||||
Loading: "/etc/rippled.cfg"
|
||||
Connecting to 127.0.0.1:5005
|
||||
|
||||
{
|
||||
"result" : {
|
||||
"status" : "success",
|
||||
"validation_key" : "BAWL MAN JADE MOON DOVE GEM SON NOW HAD ADEN GLOW TIRE",
|
||||
"validation_public_key" : "n9Jx6RS6zSgqsgnuWJifNA9EqgjTKAywqYNReK5NRd1yLBbfC3ng",
|
||||
"validation_seed" : "snjJkyBGogTem5dFGbcRaThKq2Rt3"
|
||||
}
|
||||
}
|
||||
```
|
||||
{% /tab %}
|
||||
|
||||
{% /tabs %}
|
||||
|
||||
このレスポンスは[標準フォーマット][]に従っており、正常に完了した場合は結果に次のフィールドが含まれています。
|
||||
|
||||
| `Field` | 型 | 説明 |
|
||||
|:------------------------|:-------|:------------------------------------------|
|
||||
| `validation_key` | 文字列 | （提案が無効な場合には省略可）これらの検証クレデンシャルのシークレットキー（[RFC-1751](https://tools.ietf.org/html/rfc1751)フォーマット）。 |
|
||||
| `validation_public_key` | 文字列 | （提案が無効な場合には省略可）これらの検証クレデンシャルの公開鍵（XRP Ledgerの[base58][]エンコード文字列フォーマット） |
|
||||
| `validation_seed` | 文字列 | （提案が無効な場合には省略可）これらの検証クレデンシャルのシークレットキー（XRP Ledgerの[base58][]エンコード文字列フォーマット） |
|
||||
|
||||
### 考えられるエラー
|
||||
|
||||
* [汎用エラータイプ][]のすべて。
|
||||
* `badSeed` - リクエストに無効なシークレット値が指定されていました。この場合は通常、シークレット値が異なるフォーマットの有効文字列（アカウントアドレス、検証の公開鍵など）である可能性があります。
|
||||
|
||||
{% raw-partial file="/docs/_snippets/common-links.md" /%}
|
||||
@@ -0,0 +1,12 @@
|
||||
---
|
||||
html: signing-methods.html
|
||||
parent: admin-api-methods.html
|
||||
metadata:
|
||||
indexPage: true
|
||||
---
|
||||
# 署名メソッド
|
||||
|
||||
以下のメソッドを使用して、トランザクションを扱うことができます。
|
||||
|
||||
|
||||
{% child-pages /%}
|
||||
@@ -0,0 +1,229 @@
|
||||
---
|
||||
html: sign.html # watch for clashes w/ this filename
|
||||
parent: signing-methods.html
|
||||
seo:
|
||||
description: トランザクションの署名済みバイナリー表現を返します。
|
||||
labels:
|
||||
- トランザクション送信
|
||||
---
|
||||
# sign
|
||||
[[ソース]](https://github.com/XRPLF/rippled/blob/master/src/ripple/rpc/handlers/SignHandler.cpp "ソース")
|
||||
|
||||
`sign`メソッドは[JSONフォーマットのトランザクション](../../../protocol/transactions/index.md)と[シード値](../../../../concepts/accounts/cryptographic-keys.md)を受け取り、トランザクションの署名済みバイナリー表現を返します。[マルチシグトランザクション](../../../../concepts/accounts/multi-signing.md)に署名を付与する場合は、代わりに[sign_forメソッド][]を使用します。
|
||||
|
||||
{% partial file="/docs/_snippets/public-signing-note.md" /%}
|
||||
|
||||
|
||||
**注意:** 独自の`rippled`サーバーを運用している場合を除き、このコマンドを使用するのではなく、[クライアントライブラリ](../../../client-libraries.md)を実行してください。詳細については[安全な署名の設定](../../../../concepts/transactions/secure-signing.md)を参照してください。
|
||||
|
||||
## リクエストのフォーマット
|
||||
リクエストのフォーマットの例:
|
||||
|
||||
{% tabs %}
|
||||
|
||||
{% tab label="WebSocket" %}
|
||||
```json
|
||||
{
|
||||
"id": 2,
|
||||
"command": "sign",
|
||||
"tx_json" : {
|
||||
"TransactionType" : "Payment",
|
||||
"Account" : "rf1BiGeXwwQoi8Z2ueFYTEXSwuJYfV2Jpn",
|
||||
"Destination" : "ra5nK24KXen9AHvsdFTKHSANinZseWnPcX",
|
||||
"Amount" : {
|
||||
"currency" : "USD",
|
||||
"value" : "1",
|
||||
"issuer" : "rf1BiGeXwwQoi8Z2ueFYTEXSwuJYfV2Jpn"
|
||||
}
|
||||
},
|
||||
"secret" : "s████████████████████████████",
|
||||
"offline": false,
|
||||
"fee_mult_max": 1000
|
||||
}
|
||||
```
|
||||
{% /tab %}
|
||||
|
||||
{% tab label="JSON-RPC" %}
|
||||
```json
|
||||
{
|
||||
"method": "sign",
|
||||
"params": [
|
||||
{
|
||||
"offline": false,
|
||||
"secret": "s████████████████████████████",
|
||||
"tx_json": {
|
||||
"Account": "rf1BiGeXwwQoi8Z2ueFYTEXSwuJYfV2Jpn",
|
||||
"Amount": {
|
||||
"currency": "USD",
|
||||
"issuer": "rf1BiGeXwwQoi8Z2ueFYTEXSwuJYfV2Jpn",
|
||||
"value": "1"
|
||||
},
|
||||
"Destination": "ra5nK24KXen9AHvsdFTKHSANinZseWnPcX",
|
||||
"TransactionType": "Payment"
|
||||
},
|
||||
"fee_mult_max": 1000
|
||||
}
|
||||
]
|
||||
}
|
||||
```
|
||||
{% /tab %}
|
||||
|
||||
{% tab label="コマンドライン" %}
|
||||
```sh
|
||||
#Syntax: sign secret tx_json [offline]
|
||||
rippled sign s████████████████████████████ '{"TransactionType": "Payment", "Account": "rf1BiGeXwwQoi8Z2ueFYTEXSwuJYfV2Jpn", "Destination": "ra5nK24KXen9AHvsdFTKHSANinZseWnPcX", "Amount": { "currency": "USD", "value": "1", "issuer" : "rf1BiGeXwwQoi8Z2ueFYTEXSwuJYfV2Jpn" }, "Sequence": 360, "Fee": "10000"}' offline
|
||||
```
|
||||
{% /tab %}
|
||||
|
||||
{% /tabs %}
|
||||
|
||||
トランザクションに署名するには、[トランザクションを承認](../../../../concepts/transactions/index.md#トランザクションの承認)できるシークレットキーを提供する必要があります。通常、サーバーが秘密鍵を取得するシード値を提供します。これを行うには、以下の方法があります。
|
||||
|
||||
* `secret`フィールドにシードを指定し、`key_type`フィールドを省略します。この値は、XRP Ledgerの[base58][]シード、RFC-1751、16進値のフォーマットで記述するか、文字列パスフレーズとして記述します（secp256k1キーのみ）。
|
||||
* `key_type`値と、`seed`、`seed_hex`、または`passphrase`のいずれか1つを提供します。`secret`フィールドは省略します。（コマンドライン構文ではサポートされません）。
|
||||
|
||||
リクエストには以下のパラメーターが含まれます。
|
||||
|
||||
| `Field` | 型 | 説明 |
|
||||
|:---------------|:--------|:--------------------------------------------------|
|
||||
| `tx_json` | オブジェクト | JSONフォーマットの[トランザクション定義](../../../protocol/transactions/index.md) |
|
||||
| `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`フィールドが自動で入力されます。**注意:** サーバーは、このフィールドの値ではなく、このフィールドが存在するかどうかを調べます。この動作は変更される可能性があります。 |
|
||||
| `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`と指定しない限り、サーバーは署名前に以下のフィールドを提供します。
|
||||
|
||||
* `Sequence` - サーバーは、送信者のアカウント情報にある次のシーケンス番号を自動的に使用します。
|
||||
* **注意:** アカウントの次のシーケンス番号は、このトランザクションが適用されるまで増分されません。トランザクションの送信および個々のトランザクションへのレスポンスを待たずに複数のトランザクションに署名する場合は、最初のトランザクション以降の各トランザクションについて、正しいシーケンス番号を手動で提供する必要があります。
|
||||
* `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`の値を無視して、きわめて大きなトランザクションコストを指定するおそれがあります。
|
||||
* `Paths` - Payment型のトランザクションの場合（XRP間の移動を除く）、Pathsフィールドは、[ripple_path_findメソッド][]を使用した場合と同様に自動的に入力できます。`build_path`を指定した場合のみ入力されます。
|
||||
|
||||
## レスポンスのフォーマット
|
||||
|
||||
処理が成功したレスポンスの例:
|
||||
|
||||
{% tabs %}
|
||||
|
||||
{% tab label="WebSocket" %}
|
||||
```json
|
||||
{
|
||||
"id": 2,
|
||||
"status": "success",
|
||||
"type": "response",
|
||||
"result": {
|
||||
"tx_blob": "1200002280000000240000016861D4838D7EA4C6800000000000000000000000000055534400000000004B4E9C06F24296074F7BC48F92A97916C6DC5EA9684000000000002710732103AB40A0490F9B7ED8DF29D246BF2D6269820A0EE7742ACDD457BEA7C7D0931EDB7446304402200E5C2DD81FDF0BE9AB2A8D797885ED49E804DBF28E806604D878756410CA98B102203349581946B0DDA06B36B35DBC20EDA27552C1F167BCF5C6ECFF49C6A46F858081144B4E9C06F24296074F7BC48F92A97916C6DC5EA983143E9D4A2B8AA0780F682D136F7A56D6724EF53754",
|
||||
"tx_json": {
|
||||
"Account": "rf1BiGeXwwQoi8Z2ueFYTEXSwuJYfV2Jpn",
|
||||
"Amount": {
|
||||
"currency": "USD",
|
||||
"issuer": "rf1BiGeXwwQoi8Z2ueFYTEXSwuJYfV2Jpn",
|
||||
"value": "1"
|
||||
},
|
||||
"Destination": "ra5nK24KXen9AHvsdFTKHSANinZseWnPcX",
|
||||
"Fee": "10000",
|
||||
"Flags": 2147483648,
|
||||
"Sequence": 360,
|
||||
"SigningPubKey": "03AB40A0490F9B7ED8DF29D246BF2D6269820A0EE7742ACDD457BEA7C7D0931EDB",
|
||||
"TransactionType": "Payment",
|
||||
"TxnSignature": "304402200E5C2DD81FDF0BE9AB2A8D797885ED49E804DBF28E806604D878756410CA98B102203349581946B0DDA06B36B35DBC20EDA27552C1F167BCF5C6ECFF49C6A46F8580",
|
||||
"hash": "4D5D90890F8D49519E4151938601EF3D0B30B16CD6A519D9C99102C9FA77F7E0"
|
||||
}
|
||||
}
|
||||
}
|
||||
```
|
||||
{% /tab %}
|
||||
|
||||
{% tab label="JSON-RPC" %}
|
||||
```json
|
||||
200 OK
|
||||
|
||||
{
|
||||
"result": {
|
||||
"status": "success",
|
||||
"tx_blob": "1200002280000000240000016861D4838D7EA4C6800000000000000000000000000055534400000000004B4E9C06F24296074F7BC48F92A97916C6DC5EA9684000000000002710732103AB40A0490F9B7ED8DF29D246BF2D6269820A0EE7742ACDD457BEA7C7D0931EDB7446304402200E5C2DD81FDF0BE9AB2A8D797885ED49E804DBF28E806604D878756410CA98B102203349581946B0DDA06B36B35DBC20EDA27552C1F167BCF5C6ECFF49C6A46F858081144B4E9C06F24296074F7BC48F92A97916C6DC5EA983143E9D4A2B8AA0780F682D136F7A56D6724EF53754",
|
||||
"tx_json": {
|
||||
"Account": "rf1BiGeXwwQoi8Z2ueFYTEXSwuJYfV2Jpn",
|
||||
"Amount": {
|
||||
"currency": "USD",
|
||||
"issuer": "rf1BiGeXwwQoi8Z2ueFYTEXSwuJYfV2Jpn",
|
||||
"value": "1"
|
||||
},
|
||||
"Destination": "ra5nK24KXen9AHvsdFTKHSANinZseWnPcX",
|
||||
"Fee": "10000",
|
||||
"Flags": 2147483648,
|
||||
"Sequence": 360,
|
||||
"SigningPubKey": "03AB40A0490F9B7ED8DF29D246BF2D6269820A0EE7742ACDD457BEA7C7D0931EDB",
|
||||
"TransactionType": "Payment",
|
||||
"TxnSignature": "304402200E5C2DD81FDF0BE9AB2A8D797885ED49E804DBF28E806604D878756410CA98B102203349581946B0DDA06B36B35DBC20EDA27552C1F167BCF5C6ECFF49C6A46F8580",
|
||||
"hash": "4D5D90890F8D49519E4151938601EF3D0B30B16CD6A519D9C99102C9FA77F7E0"
|
||||
}
|
||||
}
|
||||
}
|
||||
```
|
||||
{% /tab %}
|
||||
|
||||
{% tab label="コマンドライン" %}
|
||||
```json
|
||||
Loading: "/etc/rippled.cfg"
|
||||
Connecting to 127.0.0.1:5005
|
||||
|
||||
{
|
||||
"result" : {
|
||||
"status" : "success",
|
||||
"tx_blob" : "1200002280000000240000016861D4838D7EA4C6800000000000000000000000000055534400000000004B4E9C06F24296074F7BC48F92A97916C6DC5EA9684000000000002710732103AB40A0490F9B7ED8DF29D246BF2D6269820A0EE7742ACDD457BEA7C7D0931EDB7447304502210094D24C795CFFA8E46FE338AF63421DA5CE5E171ED56F8E4CE70FFABA15D3CFA2022063994C52BF0393C8157EBFFCDE6A7E7EDC7B16A462CA53214F64CC8FCBB5E54A81144B4E9C06F24296074F7BC48F92A97916C6DC5EA983143E9D4A2B8AA0780F682D136F7A56D6724EF53754",
|
||||
"tx_json" : {
|
||||
"Account" : "rf1BiGeXwwQoi8Z2ueFYTEXSwuJYfV2Jpn",
|
||||
"Amount" : {
|
||||
"currency" : "USD",
|
||||
"issuer" : "rf1BiGeXwwQoi8Z2ueFYTEXSwuJYfV2Jpn",
|
||||
"value" : "1"
|
||||
},
|
||||
"Destination" : "ra5nK24KXen9AHvsdFTKHSANinZseWnPcX",
|
||||
"Fee" : "10000",
|
||||
"Flags" : 2147483648,
|
||||
"Sequence" : 360,
|
||||
"SigningPubKey" : "03AB40A0490F9B7ED8DF29D246BF2D6269820A0EE7742ACDD457BEA7C7D0931EDB",
|
||||
"TransactionType" : "Payment",
|
||||
"TxnSignature" : "304502210094D24C795CFFA8E46FE338AF63421DA5CE5E171ED56F8E4CE70FFABA15D3CFA2022063994C52BF0393C8157EBFFCDE6A7E7EDC7B16A462CA53214F64CC8FCBB5E54A",
|
||||
"hash" : "DE80DA6FF9F93FE4CE87C99441F403E0290E35867FF48382204CB89975BF343E"
|
||||
}
|
||||
}
|
||||
}
|
||||
```
|
||||
{% /tab %}
|
||||
|
||||
{% /tabs %}
|
||||
|
||||
このレスポンスは[標準フォーマット][]に従っており、正常に完了した場合は結果に次のフィールドが含まれます。
|
||||
|
||||
| `Field` | 型 | 説明 |
|
||||
|:----------|:-------|:--------------------------------------------------------|
|
||||
| `tx_blob` | 文字列 | 正しく作成された署名済みトランザクションの16進バイナリー表現 |
|
||||
| `tx_json` | オブジェクト | 自動的に入力されたフィールドを含む、署名済み[トランザクション全体](../../../protocol/transactions/index.md)のJSON仕様 |
|
||||
|
||||
**注意:** このコマンドの結果としてエラーメッセージが表示された場合は、リクエストで指定されたシークレット値がメッセージの中に含まれている可能性があります。これらのエラーが他者から見えない状態であることを確認してください。
|
||||
|
||||
* このエラーは、複数の人物が参照できるログファイルに書き込まないでください。
|
||||
* デバッグを目的として、誰でも参照できる場所にこのエラーを貼り付けないでください。
|
||||
* このエラーメッセージは、誤ってWebサイトに表示しないようにしてください。
|
||||
|
||||
## 考えられるエラー
|
||||
|
||||
* いずれかの[汎用エラータイプ][]。
|
||||
* `invalidParams` - 1つ以上のフィールドの指定が正しくないか、1つ以上の必須フィールドが指定されていません。
|
||||
* `highFee` - トランザクションコストに適用される現在の負荷乗数が、自動的に提供されるトランザクションコストの上限を超えています。リクエストで指定する`fee_mult_max`を大きくするか（1000以上）、`tx_json`の`Fee`フィールドに値を手動で指定します。
|
||||
* `tooBusy` - トランザクションにパスが含まれていませんが、サーバーがビジーであるため、パス検出処理をすぐに実行できません。管理者として接続している場合は発生しません。
|
||||
* `noPath` - トランザクションにパスが含まれておらず、サーバーは、このペイメントの発生経路となるパスを検出できませんでした。
|
||||
|
||||
{% raw-partial file="/docs/_snippets/common-links.md" /%}
|
||||
@@ -0,0 +1,245 @@
|
||||
---
|
||||
html: sign_for.html
|
||||
parent: signing-methods.html
|
||||
seo:
|
||||
description: マルチシグトランザクションの署名を1つ提供します。
|
||||
labels:
|
||||
- トランザクション送信
|
||||
---
|
||||
# sign_for
|
||||
[[ソース]](https://github.com/XRPLF/rippled/blob/release/src/ripple/rpc/handlers/SignFor.cpp "Source")
|
||||
|
||||
`sign_for`コマンドは、[マルチシグトランザクション](../../../../concepts/accounts/multi-signing.md)の署名を1つ提供します。
|
||||
|
||||
{% partial file="/docs/_snippets/public-signing-note.md" /%}
|
||||
|
||||
|
||||
このコマンドを使用するには、[MultiSign Amendment][]が有効になっている必要があります。{% badge href="https://github.com/XRPLF/rippled/releases/tag/0.31.0" %}新規: rippled 0.31.0{% /badge %}
|
||||
|
||||
## リクエストのフォーマット
|
||||
リクエストのフォーマットの例:
|
||||
|
||||
{% tabs %}
|
||||
|
||||
{% tab label="WebSocket" %}
|
||||
```json
|
||||
{
|
||||
"id":"sign_for_example",
|
||||
"command":"sign_for",
|
||||
"account":"rLFd1FzHMScFhLsXeaxStzv3UC97QHGAbM",
|
||||
"seed":"s████████████████████████████",
|
||||
"key_type":"ed25519",
|
||||
"tx_json":{
|
||||
"TransactionType":"TrustSet",
|
||||
"Account":"rEuLyBCvcw4CFmzv8RepSiAoNgF8tTGJQC",
|
||||
"Flags":262144,
|
||||
"LimitAmount":{
|
||||
"currency":"USD",
|
||||
"issuer":"rHb9CJAWyB4rj91VRWn96DkukG4bwdtyTh",
|
||||
"value":"100"
|
||||
},
|
||||
"Sequence":2,
|
||||
"SigningPubKey":"",
|
||||
"Fee":"30000"
|
||||
}
|
||||
}
|
||||
```
|
||||
{% /tab %}
|
||||
|
||||
{% tab label="JSON-RPC" %}
|
||||
```json
|
||||
{
|
||||
"method":"sign_for",
|
||||
"params":[{
|
||||
"account":"rLFd1FzHMScFhLsXeaxStzv3UC97QHGAbM",
|
||||
"seed":"s████████████████████████████",
|
||||
"key_type":"ed25519",
|
||||
"tx_json":{
|
||||
"TransactionType":"TrustSet",
|
||||
"Account":"rEuLyBCvcw4CFmzv8RepSiAoNgF8tTGJQC",
|
||||
"Flags":262144,
|
||||
"LimitAmount":{
|
||||
"currency":"USD",
|
||||
"issuer":"rHb9CJAWyB4rj91VRWn96DkukG4bwdtyTh",
|
||||
"value":"100"
|
||||
},
|
||||
"Sequence":2,
|
||||
"SigningPubKey":"",
|
||||
"Fee":"30000"
|
||||
}
|
||||
}]
|
||||
}
|
||||
```
|
||||
{% /tab %}
|
||||
|
||||
{% tab label="コマンドライン" %}
|
||||
```sh
|
||||
#Syntax: rippled sign_for <signer_address> <signer_secret> [offline]
|
||||
rippled sign_for rsA2LpzuawewSBQXkiju3YQTMzW13pAAdW s████████████████████████████ '{
|
||||
"TransactionType":"TrustSet",
|
||||
"Account":"rEuLyBCvcw4CFmzv8RepSiAoNgF8tTGJQC",
|
||||
"Flags":262144,
|
||||
"LimitAmount":{
|
||||
"currency":"USD",
|
||||
"issuer":"rHb9CJAWyB4rj91VRWn96DkukG4bwdtyTh",
|
||||
"value":"100"
|
||||
},
|
||||
"Sequence":2,
|
||||
"SigningPubKey":"",
|
||||
"Fee":"30000"
|
||||
}'
|
||||
```
|
||||
{% /tab %}
|
||||
|
||||
{% /tabs %}
|
||||
|
||||
リクエストには以下のパラメーターが含まれます。
|
||||
|
||||
| `Field` | 型 | 説明 |
|
||||
|:-------------|:---------------------|:---------------------------------------|
|
||||
| `account` | 文字列 - [アドレス][] | 署名を提供するアドレス。 |
|
||||
| `tx_json` | オブジェクト | 署名する[トランザクション](../../../protocol/transactions/index.md)。[signメソッド][]を使用する場合とは異なり、トランザクションのすべてのフィールド（`Fee`と`Sequence`を含む）を指定する必要があります。トランザクションに、空の文字列を値として指定した`SigningPubKey`フィールドを含める必要があります。このオブジェクトには、以前に収集した署名を持つ`Signers`配列を必要に応じて含めることができます。 |
|
||||
| `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のサポートは実験的な機能です。 |
|
||||
|
||||
シークレットキーを指定した**1つのフィールドのみ**を指定する必要があります。次のいずれかになります。
|
||||
|
||||
* `secret`値を指定し、`key_type`フィールドを省略します。この値は、XRP Ledgerの[base58][]シード、RFC-1751、16進値のフォーマットで記述するか、文字列パスフレーズとして記述します（secp256k1キーのみ）。
|
||||
* `key_type`値と、`seed`、`seed_hex`、または`passphrase`のいずれか1つを提供します。`secret`フィールドは省略します。（コマンドライン構文ではサポートされません。）
|
||||
|
||||
## レスポンスのフォーマット
|
||||
|
||||
処理が成功したレスポンスの例:
|
||||
|
||||
{% tabs %}
|
||||
|
||||
{% tab label="WebSocket" %}
|
||||
```json
|
||||
{
|
||||
"id":"sign_for_example",
|
||||
"status":"success",
|
||||
"type":"response",
|
||||
"result":{
|
||||
"tx_blob":"1200142200040000240000000263D5038D7EA4C680000000000000000000000000005553440000000000B5F762798A53D543A014CAF8B297CFF8F2F937E868400000000000753073008114A3780F5CB5A44D366520FC44055E8ED44D9A2270F3E0107321EDDF4ECB8F34A168143B928D48EFE625501FB8552403BBBD3FC038A5788951D7707440C3DCA3FEDE6D785398EEAB10A46B44047FF1B0863FC4313051FB292C991D1E3A9878FABB301128FE4F86F3D8BE4706D53FA97F5536DBD31AF14CD83A5ACDEB068114D96CB910955AB40A0E987EEE82BB3CEDD4441AAAE1F1",
|
||||
"tx_json":{
|
||||
"Account":"rEuLyBCvcw4CFmzv8RepSiAoNgF8tTGJQC",
|
||||
"Fee":"30000",
|
||||
"Flags":262144,
|
||||
"LimitAmount":{
|
||||
"currency":"USD",
|
||||
"issuer":"rHb9CJAWyB4rj91VRWn96DkukG4bwdtyTh",
|
||||
"value":"100"
|
||||
},
|
||||
"Sequence":2,
|
||||
"Signers":[
|
||||
{
|
||||
"Signer":{
|
||||
"Account":"rLFd1FzHMScFhLsXeaxStzv3UC97QHGAbM",
|
||||
"SigningPubKey":"EDDF4ECB8F34A168143B928D48EFE625501FB8552403BBBD3FC038A5788951D770",
|
||||
"TxnSignature":"C3DCA3FEDE6D785398EEAB10A46B44047FF1B0863FC4313051FB292C991D1E3A9878FABB301128FE4F86F3D8BE4706D53FA97F5536DBD31AF14CD83A5ACDEB06"
|
||||
}
|
||||
}
|
||||
],
|
||||
"SigningPubKey":"",
|
||||
"TransactionType":"TrustSet",
|
||||
"hash":"5216A13A3E3CF662352F0B430C7D82B7450415B6883DD428B5EC1DF1DE45DD8C"
|
||||
}
|
||||
}
|
||||
}
|
||||
```
|
||||
{% /tab %}
|
||||
|
||||
{% tab label="JSON-RPC" %}
|
||||
```
|
||||
200 OK
|
||||
{
|
||||
"result" :{
|
||||
"status" :"success",
|
||||
"tx_blob" :"1200142200040000240000000263D5038D7EA4C680000000000000000000000000005553440000000000B5F762798A53D543A014CAF8B297CFF8F2F937E868400000000000753073008114A3780F5CB5A44D366520FC44055E8ED44D9A2270F3E010732102B3EC4E5DD96029A647CFA20DA07FE1F85296505552CCAC114087E66B46BD77DF744730450221009C195DBBF7967E223D8626CA19CF02073667F2B22E206727BFE848FF42BEAC8A022048C323B0BED19A988BDBEFA974B6DE8AA9DCAE250AA82BBD1221787032A864E58114204288D2E47F8EF6C99BCC457966320D12409711E1F1",
|
||||
"tx_json" :{
|
||||
"Account" :"rEuLyBCvcw4CFmzv8RepSiAoNgF8tTGJQC",
|
||||
"Fee" :"30000",
|
||||
"Flags" :262144,
|
||||
"LimitAmount" :{
|
||||
"currency" :"USD",
|
||||
"issuer" :"rHb9CJAWyB4rj91VRWn96DkukG4bwdtyTh",
|
||||
"value" :"100"
|
||||
},
|
||||
"Sequence" :2,
|
||||
"Signers" :[
|
||||
{
|
||||
"Signer" :{
|
||||
"Account" :"rsA2LpzuawewSBQXkiju3YQTMzW13pAAdW",
|
||||
"SigningPubKey" :"02B3EC4E5DD96029A647CFA20DA07FE1F85296505552CCAC114087E66B46BD77DF",
|
||||
"TxnSignature" :"30450221009C195DBBF7967E223D8626CA19CF02073667F2B22E206727BFE848FF42BEAC8A022048C323B0BED19A988BDBEFA974B6DE8AA9DCAE250AA82BBD1221787032A864E5"
|
||||
}
|
||||
}
|
||||
],
|
||||
"SigningPubKey" :"",
|
||||
"TransactionType" :"TrustSet",
|
||||
"hash" :"A94A6417D1A7AAB059822B894E13D322ED3712F7212CE9257801F96DE6C3F6AE"
|
||||
}
|
||||
}
|
||||
}
|
||||
```
|
||||
{% /tab %}
|
||||
|
||||
{% tab label="コマンドライン" %}
|
||||
```json
|
||||
Loading:"/etc/rippled.cfg"
|
||||
Connecting to 127.0.0.1:5005
|
||||
|
||||
{
|
||||
"result" :{
|
||||
"status" :"success",
|
||||
"tx_blob" :"1200142200040000240000000263D5038D7EA4C680000000000000000000000000005553440000000000B5F762798A53D543A014CAF8B297CFF8F2F937E868400000000000753073008114A3780F5CB5A44D366520FC44055E8ED44D9A2270F3E010732102B3EC4E5DD96029A647CFA20DA07FE1F85296505552CCAC114087E66B46BD77DF744730450221009C195DBBF7967E223D8626CA19CF02073667F2B22E206727BFE848FF42BEAC8A022048C323B0BED19A988BDBEFA974B6DE8AA9DCAE250AA82BBD1221787032A864E58114204288D2E47F8EF6C99BCC457966320D12409711E1F1",
|
||||
"tx_json" :{
|
||||
"Account" :"rEuLyBCvcw4CFmzv8RepSiAoNgF8tTGJQC",
|
||||
"Fee" :"30000",
|
||||
"Flags" :262144,
|
||||
"LimitAmount" :{
|
||||
"currency" :"USD",
|
||||
"issuer" :"rHb9CJAWyB4rj91VRWn96DkukG4bwdtyTh",
|
||||
"value" :"100"
|
||||
},
|
||||
"Sequence" :2,
|
||||
"Signers" :[
|
||||
{
|
||||
"Signer" :{
|
||||
"Account" :"rsA2LpzuawewSBQXkiju3YQTMzW13pAAdW",
|
||||
"SigningPubKey" :"02B3EC4E5DD96029A647CFA20DA07FE1F85296505552CCAC114087E66B46BD77DF",
|
||||
"TxnSignature" :"30450221009C195DBBF7967E223D8626CA19CF02073667F2B22E206727BFE848FF42BEAC8A022048C323B0BED19A988BDBEFA974B6DE8AA9DCAE250AA82BBD1221787032A864E5"
|
||||
}
|
||||
}
|
||||
],
|
||||
"SigningPubKey" :"",
|
||||
"TransactionType" :"TrustSet",
|
||||
"hash" :"A94A6417D1A7AAB059822B894E13D322ED3712F7212CE9257801F96DE6C3F6AE"
|
||||
}
|
||||
}
|
||||
}
|
||||
```
|
||||
{% /tab %}
|
||||
|
||||
{% /tabs %}
|
||||
|
||||
このレスポンスは[標準フォーマット][]に従っており、正常に完了した場合は結果に次のフィールドが含まれます。
|
||||
|
||||
| `Field` | 型 | 説明 |
|
||||
|:----------|:-------|:--------------------------------------------------------|
|
||||
| `tx_blob` | 文字列 | 新規に追加した署名を含む署名済みトランザクションの16進数表記。トランザクションに十分な数の署名がある場合には、[`submit`メソッドを使用してこの文字列を送信](../../public-api-methods/transaction-methods/submit.md#送信専用モード)できます。 |
|
||||
| `tx_json` | オブジェクト | 新規に追加された署名を含む`Signers`配列を持つ[トランザクションの指定](../../../protocol/transactions/index.md)（JSONフォーマット） 。トランザクションに十分な数の署名がある場合には、[submit_multisignedメソッド][]を使用してこのオブジェクトを送信できます。 |
|
||||
|
||||
## 考えられるエラー
|
||||
|
||||
* [汎用エラータイプ][]のすべて。
|
||||
* `invalidParams` - 1つ以上のフィールドの指定が正しくないか、1つ以上の必須フィールドが指定されていません。
|
||||
* `srcActNotFound` - トランザクションの`Account`が、レジャーの資金供給のあるアドレスではない場合。
|
||||
* `srcActMalformed` - リクエストの署名アドレス（`account`フィールド）の形式が無効である場合。
|
||||
* `badSeed` - 指定されたシード値のフォーマットが正しくありません。
|
||||
* `badSecret` - 指定されたシークレット値のフォーマットが正しくありません。
|
||||
|
||||
{% raw-partial file="/docs/_snippets/common-links.md" /%}
|
||||
@@ -0,0 +1,240 @@
|
||||
---
|
||||
html: consensus_info.html
|
||||
parent: status-and-debugging-methods.html
|
||||
seo:
|
||||
description: デバッグのためのコンセンサスプロセスに関する情報を返します。
|
||||
labels:
|
||||
- ブロックチェーン
|
||||
- コアサーバー
|
||||
---
|
||||
# consensus_info
|
||||
[[ソース]](https://github.com/XRPLF/rippled/blob/a61ffab3f9010d8accfaa98aa3cacc7d38e74121/src/ripple/rpc/handlers/ConsensusInfo.cpp "Source")
|
||||
|
||||
`consensus_info`メソッドは、デバッグのための[コンセンサスプロセス](../../../../concepts/consensus-protocol/index.md)に関する情報を返します。
|
||||
|
||||
_`consensus_info`メソッドは、権限のないユーザーは実行できない[管理メソッド](../index.md)です。_
|
||||
|
||||
### リクエストのフォーマット
|
||||
リクエストのフォーマットの例:
|
||||
|
||||
{% tabs %}
|
||||
|
||||
{% tab label="WebSocket" %}
|
||||
```json
|
||||
{
|
||||
"id": 99,
|
||||
"command": "consensus_info"
|
||||
}
|
||||
```
|
||||
{% /tab %}
|
||||
|
||||
{% tab label="JSON-RPC" %}
|
||||
```json
|
||||
{
|
||||
"method": "consensus_info",
|
||||
"params": [
|
||||
{}
|
||||
]
|
||||
}
|
||||
```
|
||||
{% /tab %}
|
||||
|
||||
{% tab label="コマンドライン" %}
|
||||
```sh
|
||||
#Syntax: consensus_info
|
||||
rippled consensus_info
|
||||
```
|
||||
{% /tab %}
|
||||
|
||||
{% /tabs %}
|
||||
|
||||
このリクエストにはパラメーターはありません。
|
||||
|
||||
### レスポンスのフォーマット
|
||||
|
||||
処理が成功したレスポンスの例:
|
||||
|
||||
{% tabs %}
|
||||
|
||||
{% tab label="JSON-RPC" %}
|
||||
```json
|
||||
{
|
||||
"result" : {
|
||||
"info" : {
|
||||
"acquired" : {
|
||||
"4BC2CE596CBD1321775320E2067F9C06D3862826212C16EF42ABB6A2B0414306" : "acquired"
|
||||
},
|
||||
"close_granularity" : 10,
|
||||
"close_percent" : 50,
|
||||
"close_resolution" : 10,
|
||||
"close_times" : {
|
||||
"486082972" : 1,
|
||||
"486082973" : 4
|
||||
},
|
||||
"current_ms" : 1003,
|
||||
"have_time_consensus" : false,
|
||||
"ledger_seq" : 13701086,
|
||||
"our_position" : {
|
||||
"close_time" : 486082973,
|
||||
"previous_ledger" : "0BB01379B51234BAAF501A71C7AB147F595460B689BB9E8252A0B87B5A483623",
|
||||
"propose_seq" : 0,
|
||||
"transaction_hash" : "4BC2CE596CBD1321775320E2067F9C06D3862826212C16EF42ABB6A2B0414306"
|
||||
},
|
||||
"peer_positions" : {
|
||||
"0A2EAF919033A036D363D4E5610A66209DDBE8EE" : {
|
||||
"close_time" : 486082972,
|
||||
"peer_id" : "n9KiYM9CgngLvtRCQHZwgC2gjpdaZcCcbt3VboxiNFcKuwFVujzS",
|
||||
"previous_ledger" : "0BB01379B51234BAAF501A71C7AB147F595460B689BB9E8252A0B87B5A483623",
|
||||
"propose_seq" : 0,
|
||||
"transaction_hash" : "4BC2CE596CBD1321775320E2067F9C06D3862826212C16EF42ABB6A2B0414306"
|
||||
},
|
||||
"1567A8C953A86F8428C7B01641D79BBF2FD508F3" : {
|
||||
"close_time" : 486082973,
|
||||
"peer_id" : "n9LdgEtkmGB9E2h3K4Vp7iGUaKuq23Zr32ehxiU8FWY7xoxbWTSA",
|
||||
"previous_ledger" : "0BB01379B51234BAAF501A71C7AB147F595460B689BB9E8252A0B87B5A483623",
|
||||
"propose_seq" : 0,
|
||||
"transaction_hash" : "4BC2CE596CBD1321775320E2067F9C06D3862826212C16EF42ABB6A2B0414306"
|
||||
},
|
||||
"202397A81F20B44CF44EA99AF761295E5A8397D2" : {
|
||||
"close_time" : 486082973,
|
||||
"peer_id" : "n9MD5h24qrQqiyBC8aeqqCWvpiBiYQ3jxSr91uiDvmrkyHRdYLUj",
|
||||
"previous_ledger" : "0BB01379B51234BAAF501A71C7AB147F595460B689BB9E8252A0B87B5A483623",
|
||||
"propose_seq" : 0,
|
||||
"transaction_hash" : "4BC2CE596CBD1321775320E2067F9C06D3862826212C16EF42ABB6A2B0414306"
|
||||
},
|
||||
"5C29005CF4FB479FC49EEFB4A5B075C86DD963CC" : {
|
||||
"close_time" : 486082973,
|
||||
"peer_id" : "n9L81uNCaPgtUJfaHh89gmdvXKAmSt5Gdsw2g1iPWaPkAHW5Nm4C",
|
||||
"previous_ledger" : "0BB01379B51234BAAF501A71C7AB147F595460B689BB9E8252A0B87B5A483623",
|
||||
"propose_seq" : 0,
|
||||
"transaction_hash" : "4BC2CE596CBD1321775320E2067F9C06D3862826212C16EF42ABB6A2B0414306"
|
||||
},
|
||||
"EFC49EB648E557CC50A72D715249B80E071F7705" : {
|
||||
"close_time" : 486082973,
|
||||
"peer_id" : "n949f75evCHwgyP4fPVgaHqNHxUVN15PsJEZ3B3HnXPcPjcZAoy7",
|
||||
"previous_ledger" : "0BB01379B51234BAAF501A71C7AB147F595460B689BB9E8252A0B87B5A483623",
|
||||
"propose_seq" : 0,
|
||||
"transaction_hash" : "4BC2CE596CBD1321775320E2067F9C06D3862826212C16EF42ABB6A2B0414306"
|
||||
}
|
||||
},
|
||||
"previous_mseconds" : 2005,
|
||||
"previous_proposers" : 5,
|
||||
"proposers" : 5,
|
||||
"proposing" : false,
|
||||
"state" : "consensus",
|
||||
"synched" : true,
|
||||
"validating" : false
|
||||
},
|
||||
"status" : "success"
|
||||
}
|
||||
}
|
||||
```
|
||||
{% /tab %}
|
||||
|
||||
{% tab label="コマンドライン" %}
|
||||
```json
|
||||
Loading: "/etc/rippled.cfg"
|
||||
Connecting to 127.0.0.1:5005
|
||||
|
||||
{
|
||||
"result" : {
|
||||
"info" : {
|
||||
"acquired" : {
|
||||
"4BC2CE596CBD1321775320E2067F9C06D3862826212C16EF42ABB6A2B0414306" : "acquired"
|
||||
},
|
||||
"close_granularity" : 10,
|
||||
"close_percent" : 50,
|
||||
"close_resolution" : 10,
|
||||
"close_times" : {
|
||||
"486082972" : 1,
|
||||
"486082973" : 4
|
||||
},
|
||||
"current_ms" : 1003,
|
||||
"have_time_consensus" : false,
|
||||
"ledger_seq" : 13701086,
|
||||
"our_position" : {
|
||||
"close_time" : 486082973,
|
||||
"previous_ledger" : "0BB01379B51234BAAF501A71C7AB147F595460B689BB9E8252A0B87B5A483623",
|
||||
"propose_seq" : 0,
|
||||
"transaction_hash" : "4BC2CE596CBD1321775320E2067F9C06D3862826212C16EF42ABB6A2B0414306"
|
||||
},
|
||||
"peer_positions" : {
|
||||
"0A2EAF919033A036D363D4E5610A66209DDBE8EE" : {
|
||||
"close_time" : 486082972,
|
||||
"peer_id" : "n9KiYM9CgngLvtRCQHZwgC2gjpdaZcCcbt3VboxiNFcKuwFVujzS",
|
||||
"previous_ledger" : "0BB01379B51234BAAF501A71C7AB147F595460B689BB9E8252A0B87B5A483623",
|
||||
"propose_seq" : 0,
|
||||
"transaction_hash" : "4BC2CE596CBD1321775320E2067F9C06D3862826212C16EF42ABB6A2B0414306"
|
||||
},
|
||||
"1567A8C953A86F8428C7B01641D79BBF2FD508F3" : {
|
||||
"close_time" : 486082973,
|
||||
"peer_id" : "n9LdgEtkmGB9E2h3K4Vp7iGUaKuq23Zr32ehxiU8FWY7xoxbWTSA",
|
||||
"previous_ledger" : "0BB01379B51234BAAF501A71C7AB147F595460B689BB9E8252A0B87B5A483623",
|
||||
"propose_seq" : 0,
|
||||
"transaction_hash" : "4BC2CE596CBD1321775320E2067F9C06D3862826212C16EF42ABB6A2B0414306"
|
||||
},
|
||||
"202397A81F20B44CF44EA99AF761295E5A8397D2" : {
|
||||
"close_time" : 486082973,
|
||||
"peer_id" : "n9MD5h24qrQqiyBC8aeqqCWvpiBiYQ3jxSr91uiDvmrkyHRdYLUj",
|
||||
"previous_ledger" : "0BB01379B51234BAAF501A71C7AB147F595460B689BB9E8252A0B87B5A483623",
|
||||
"propose_seq" : 0,
|
||||
"transaction_hash" : "4BC2CE596CBD1321775320E2067F9C06D3862826212C16EF42ABB6A2B0414306"
|
||||
},
|
||||
"5C29005CF4FB479FC49EEFB4A5B075C86DD963CC" : {
|
||||
"close_time" : 486082973,
|
||||
"peer_id" : "n9L81uNCaPgtUJfaHh89gmdvXKAmSt5Gdsw2g1iPWaPkAHW5Nm4C",
|
||||
"previous_ledger" : "0BB01379B51234BAAF501A71C7AB147F595460B689BB9E8252A0B87B5A483623",
|
||||
"propose_seq" : 0,
|
||||
"transaction_hash" : "4BC2CE596CBD1321775320E2067F9C06D3862826212C16EF42ABB6A2B0414306"
|
||||
},
|
||||
"EFC49EB648E557CC50A72D715249B80E071F7705" : {
|
||||
"close_time" : 486082973,
|
||||
"peer_id" : "n949f75evCHwgyP4fPVgaHqNHxUVN15PsJEZ3B3HnXPcPjcZAoy7",
|
||||
"previous_ledger" : "0BB01379B51234BAAF501A71C7AB147F595460B689BB9E8252A0B87B5A483623",
|
||||
"propose_seq" : 0,
|
||||
"transaction_hash" : "4BC2CE596CBD1321775320E2067F9C06D3862826212C16EF42ABB6A2B0414306"
|
||||
}
|
||||
},
|
||||
"previous_mseconds" : 2005,
|
||||
"previous_proposers" : 5,
|
||||
"proposers" : 5,
|
||||
"proposing" : false,
|
||||
"state" : "consensus",
|
||||
"synched" : true,
|
||||
"validating" : false
|
||||
},
|
||||
"status" : "success"
|
||||
}
|
||||
}
|
||||
```
|
||||
{% /tab %}
|
||||
|
||||
{% /tabs %}
|
||||
|
||||
このレスポンスは[標準フォーマット][]に従っており、正常に完了した場合は結果に次のフィールドが含まれています。
|
||||
|
||||
| `Field` | 型 | 説明 |
|
||||
|:--------|:-------|:----------------------------------------------------------|
|
||||
| `info` | オブジェクト | コンセンサスのデバッグで役立つ可能性のある情報。この出力は、予告なく変更される可能性があります。 |
|
||||
|
||||
`info`オブジェクトに含まれる可能性のあるフィールドについて以下に簡単に説明します。
|
||||
|
||||
| `Field` | 型 | 説明 |
|
||||
|:-----------------|:--------|:------------------------------------------------|
|
||||
| `ledger_seq` | 数値 | 現在コンセンサスプロセスにあるレジャーのシーケンス番号。 |
|
||||
| `our_position` | オブジェクト | コンセンサスプロセスにあるレジャーについてサーバーが予期する内容。 |
|
||||
| `peer_positions` | オブジェクト | コンセンサスプロセスにあるピアと各ピアが提案するレジャーバージョンのマップ。 |
|
||||
| `proposers` | 数値 | このコンセンサスプロセスに参加している信頼できるバリデータの数。信頼できるバリデータは、このサーバー構成に応じて異なります。 |
|
||||
| `synched` | ブール値 | このサーバー自体が、自分がネットワークと同期中であるとみなしているかどうか。 |
|
||||
| `state` | 文字列 | 現在進行中のコンセンサスプロセスの部分: `open`、`consensus`、`finished`、または`accepted`。 |
|
||||
|
||||
`info`の唯一のフィールドが`"consensus": "none"`である最小限の結果となることもありますが、これは正常です。これは、サーバーがコンセンサスラウンドの合間にあることを示します。
|
||||
|
||||
`consensus_info`コマンドを短い間隔で連続して数回実行すると、このコマンドの結果が大きく変化することがあります。
|
||||
|
||||
|
||||
### 考えられるエラー
|
||||
|
||||
* [汎用エラータイプ][]のすべて。
|
||||
|
||||
{% raw-partial file="/docs/_snippets/common-links.md" /%}
|
||||
@@ -0,0 +1,202 @@
|
||||
---
|
||||
html: feature.html
|
||||
parent: status-and-debugging-methods.html
|
||||
seo:
|
||||
description: Amendmentに関してこのサーバが認識している情報を返します。
|
||||
labels:
|
||||
- ブロックチェーン
|
||||
- コアサーバー
|
||||
---
|
||||
# feature
|
||||
[[ソース]](https://github.com/XRPLF/rippled/blob/master/src/ripple/rpc/handlers/Feature1.cpp "Source")
|
||||
|
||||
`feature`コマンドは、[Amendment](../../../../concepts/networks-and-servers/amendments.md)に関してこのサーバが認識している情報（Amendmentが有効であるかどうか、サーバが[Amendmentプロセス](../../../../concepts/networks-and-servers/amendments.md#amendmentプロセス)でこれらのAmendmentに賛成票を投じたかどうかなど）を返します。{% badge href="https://github.com/XRPLF/rippled/releases/tag/0.31.0" %}新規: rippled 0.31.0{% /badge %}
|
||||
|
||||
`feature`コマンドを使用して、Amendmentへの賛成票または反対票を投じるようにサーバを一時的に設定できます。この変更は、サーバの再起動後も保持されます。{% badge href="https://github.com/XRPLF/rippled/releases/tag/1.7.0" %}更新: rippled 1.7.0{% /badge %}
|
||||
|
||||
_`feature`メソッドは、権限のないユーザーは実行できない[管理メソッド](../index.md)です。_
|
||||
|
||||
### リクエストのフォーマット
|
||||
リクエストのフォーマットの例:
|
||||
|
||||
{% tabs %}
|
||||
|
||||
{% tab label="WebSocket - すべてリスト" %}
|
||||
```json
|
||||
{
|
||||
"id": "list_all_features",
|
||||
"command": "feature"
|
||||
}
|
||||
```
|
||||
{% /tab %}
|
||||
|
||||
{% tab label="WebSocket - 拒否" %}
|
||||
```json
|
||||
{
|
||||
"id": "reject_multi_sign",
|
||||
"command": "feature",
|
||||
"feature": "4C97EBA926031A7CF7D7B36FDE3ED66DDA5421192D63DE53FFB46E43B9DC8373",
|
||||
"vetoed": true
|
||||
}
|
||||
```
|
||||
{% /tab %}
|
||||
|
||||
{% tab label="JSON-RPC" %}
|
||||
```json
|
||||
{
|
||||
"method": "feature",
|
||||
"params": [
|
||||
{
|
||||
"feature": "4C97EBA926031A7CF7D7B36FDE3ED66DDA5421192D63DE53FFB46E43B9DC8373",
|
||||
"vetoed": false
|
||||
}
|
||||
]
|
||||
}
|
||||
```
|
||||
{% /tab %}
|
||||
|
||||
{% tab label="コマンドライン" %}
|
||||
```sh
|
||||
#Syntax: feature [<feature_id> [accept|reject]]
|
||||
rippled feature 4C97EBA926031A7CF7D7B36FDE3ED66DDA5421192D63DE53FFB46E43B9DC8373 accept
|
||||
```
|
||||
{% /tab %}
|
||||
|
||||
{% /tabs %}
|
||||
|
||||
リクエストには以下のパラメーターが含まれます。
|
||||
|
||||
| `Field` | 型 | 説明 |
|
||||
|:----------|:--------|:-------------------------------------------------------|
|
||||
| `feature` | 文字列 | _（省略可）_ Amendmentの一意のID（16進数）またはAmendmentの短い名前。指定されている場合は、レスポンスが1つのAmendmentに限定されます。それ以外の場合はレスポンスにすべてのAmendmentのリストが表示されます。 |
|
||||
| `vetoed` | ブール値 | （省略可、`feature`が指定されていない場合は無視されます）trueの場合、サーバに対し`feature`で指定されたAmendmentに反対票を投じるように指示します。falseの場合、サーバに対しAmendmentに賛成票を投じるように指示します。 |
|
||||
|
||||
**注記:** サーバが新しいAmendmentの適用方法を現在認識していない場合でも、`feature`フィールドにAmendment IDを指定すれば、新しいAmendmentに賛成票を投じるようにサーバを設定できます。たとえば、Amendmentをサポートする新しい`rippled`バージョンに _確実に_ アップグレードする予定がある場合などにこのように設定できます。
|
||||
|
||||
### レスポンスのフォーマット
|
||||
|
||||
処理が成功したレスポンスの例:
|
||||
|
||||
{% tabs %}
|
||||
|
||||
{% tab label="WebSocket - すべてリスト" %}
|
||||
```json
|
||||
{
|
||||
"id": "list_all_features",
|
||||
"status": "success",
|
||||
"type": "response",
|
||||
"result": {
|
||||
"features": {
|
||||
"42426C4D4F1009EE67080A9B7965B44656D7714D104A72F9B4369F97ABF044EE": {
|
||||
"enabled": false,
|
||||
"name": "FeeEscalation",
|
||||
"supported": true,
|
||||
"vetoed": false
|
||||
},
|
||||
"4C97EBA926031A7CF7D7B36FDE3ED66DDA5421192D63DE53FFB46E43B9DC8373": {
|
||||
"enabled": false,
|
||||
"name": "MultiSign",
|
||||
"supported": true,
|
||||
"vetoed": false
|
||||
},
|
||||
"6781F8368C4771B83E8B821D88F580202BCB4228075297B19E4FDC5233F1EFDC": {
|
||||
"enabled": false,
|
||||
"name": "TrustSetAuth",
|
||||
"supported": true,
|
||||
"vetoed": false
|
||||
},
|
||||
"C1B8D934087225F509BEB5A8EC24447854713EE447D277F69545ABFA0E0FD490": {
|
||||
"enabled": false,
|
||||
"name": "Tickets",
|
||||
"supported": true,
|
||||
"vetoed": false
|
||||
},
|
||||
"DA1BD556B42D85EA9C84066D028D355B52416734D3283F85E216EA5DA6DB7E13": {
|
||||
"enabled": false,
|
||||
"name": "SusPay",
|
||||
"supported": true,
|
||||
"vetoed": false
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
```
|
||||
{% /tab %}
|
||||
|
||||
{% tab label="WebSocket - 拒否" %}
|
||||
```json
|
||||
{
|
||||
"id": "reject_multi_sign",
|
||||
"status": "success",
|
||||
"type": "response",
|
||||
"result": {
|
||||
"features": {
|
||||
"4C97EBA926031A7CF7D7B36FDE3ED66DDA5421192D63DE53FFB46E43B9DC8373": {
|
||||
"enabled": false,
|
||||
"name": "MultiSign",
|
||||
"supported": true,
|
||||
"vetoed": true
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
```
|
||||
{% /tab %}
|
||||
|
||||
{% tab label="JSON-RPC" %}
|
||||
```json
|
||||
200 OK
|
||||
|
||||
{
|
||||
"result": {
|
||||
"4C97EBA926031A7CF7D7B36FDE3ED66DDA5421192D63DE53FFB46E43B9DC8373": {
|
||||
"enabled": false,
|
||||
"name": "MultiSign",
|
||||
"supported": true,
|
||||
"vetoed": false
|
||||
},
|
||||
"status": "success"
|
||||
}
|
||||
}
|
||||
```
|
||||
{% /tab %}
|
||||
|
||||
{% tab label="コマンドライン" %}
|
||||
```json
|
||||
Loading: "/etc/rippled.cfg"
|
||||
Connecting to 127.0.0.1:5005
|
||||
|
||||
{
|
||||
"result": {
|
||||
"4C97EBA926031A7CF7D7B36FDE3ED66DDA5421192D63DE53FFB46E43B9DC8373": {
|
||||
"enabled": false,
|
||||
"name": "MultiSign",
|
||||
"supported": true,
|
||||
"vetoed": false
|
||||
},
|
||||
"status": "success"
|
||||
}
|
||||
}
|
||||
```
|
||||
{% /tab %}
|
||||
|
||||
{% /tabs %}
|
||||
|
||||
レスポンスは[標準フォーマット][]に従っており、正常に完了した場合は結果に**Amendmentのマップ**がJSONプロジェクトとして含まれています。オブジェクトのキーはAmendment IDです。各キーの値は、そのIDのAmendmentのステータスを記述した _Amendmentオブジェクト_ です。リクエストに`feature`が指定されいる場合、リクエストによる変更の適用後には、リクエストされたAmendmentオブジェクトだけがマップに含まれます。各Amendmentオブジェクトのフィールドを次に示します。
|
||||
|
||||
| `Field` | 型 | 説明 |
|
||||
|:------------|:--------|:-----------------------------------------------------|
|
||||
| `enabled` | ブール値 | 最新レジャーでこのAmendmentが現在有効であるかどうか。 |
|
||||
| `name` | 文字列 | （省略される場合があります）このAmendmentの人間が読める形式の名前（判明している場合）。 |
|
||||
| `supported` | ブール値 | サーバがこのAmendmentの適用方法を認識しているかどうか。このフィールドが`false`（サーバがこのAmendmentの適用方法を認識していない）に設定されており、`enabled`が`true`（このAmendmentが最新レジャーで有効である）に設定されている場合、このAmendmentによりサーバが[Amendmentブロック](../../../../concepts/networks-and-servers/amendments.md#amendment-blocked)される可能性があります。 |
|
||||
| `vetoed` | ブール値 または 文字列 | ほとんどのAmendmentにおいて、これはサーバがこのAmendmentに反対票を投じるように指示されているかどうかを示すブール値です。コードの中で廃止とマークされているAmendmentについては、代わりに`Obsolete`という文字列を指定します。{% badge href="https://github.com/XRPLF/rippled/releases/tag/1.11.0" %}更新: rippled 1.11.0{% /badge %}. |
|
||||
|
||||
**注意:** Amendmentの`name`は、Amendmentの内容を厳密に示すものではありません。サーバ間でこの名前が一意であることや整合性があることは保証されません。
|
||||
|
||||
### 考えられるエラー
|
||||
|
||||
* [汎用エラータイプ][]のすべて。
|
||||
* `badFeature` - 指定されている`feature`のフォーマットが正しくないか、サーバがその名前のAmendmentを認識していません。
|
||||
- `reportingUnsupported` - ([レポートモード][]サーバのみ) このメソッドはレポートモードでは使用できません。
|
||||
|
||||
{% raw-partial file="/docs/_snippets/common-links.md" /%}
|
||||
@@ -0,0 +1,167 @@
|
||||
---
|
||||
html: fetch_info.html
|
||||
parent: status-and-debugging-methods.html
|
||||
seo:
|
||||
description: このサーバーが現在ネットワークからフェッチしているオブジェクトに関する情報を返します。
|
||||
labels:
|
||||
- コアサーバー
|
||||
---
|
||||
# fetch_info
|
||||
[[ソース]](https://github.com/XRPLF/rippled/blob/315a8b6b602798a4cff4d8e1911936011e12abdb/src/ripple/rpc/handlers/FetchInfo.cpp "Source")
|
||||
|
||||
`fetch_info`コマンドは、このサーバーが現在ネットワークからフェッチしているオブジェクトに関する情報と、その情報を所有しているピアの数を返します。これは現在の取得操作をリセットする場合にも使用できます。
|
||||
|
||||
_`fetch_info`メソッドは、権限のないユーザーは実行できない[管理メソッド](../index.md)です。_
|
||||
|
||||
### リクエストのフォーマット
|
||||
リクエストのフォーマットの例:
|
||||
|
||||
{% tabs %}
|
||||
|
||||
{% tab label="WebSocket" %}
|
||||
```json
|
||||
{
|
||||
"id": 91,
|
||||
"command": "fetch_info",
|
||||
"clear": false
|
||||
}
|
||||
```
|
||||
{% /tab %}
|
||||
|
||||
{% tab label="JSON-RPC" %}
|
||||
```json
|
||||
{
|
||||
"method": "fetch_info",
|
||||
"params": [
|
||||
{
|
||||
"clear": false
|
||||
}
|
||||
]
|
||||
}
|
||||
```
|
||||
{% /tab %}
|
||||
|
||||
{% tab label="コマンドライン" %}
|
||||
```sh
|
||||
#Syntax: fetch_info [clear]
|
||||
rippled fetch_info
|
||||
```
|
||||
{% /tab %}
|
||||
|
||||
{% /tabs %}
|
||||
|
||||
リクエストには以下のパラメーターが含まれます。
|
||||
|
||||
| `Field` | 型 | 説明 |
|
||||
|:--------|:--------|:---------------------------------------------------------|
|
||||
| `clear` | ブール値 | `true`の場合、現在のフェッチ操作がリセットされます。それ以外の場合、進行中のフェッチ操作のステータスのみが取得されます。 |
|
||||
|
||||
### レスポンスのフォーマット
|
||||
|
||||
処理が成功したレスポンスの例:
|
||||
|
||||
{% tabs %}
|
||||
|
||||
{% tab label="JSON-RPC" %}
|
||||
```json
|
||||
{
|
||||
"result" : {
|
||||
"info" : {
|
||||
"348928" : {
|
||||
"hash" : "C26D432B06F84861BCACD7942EDC3FE0B2E1DEB966A9E516A0FD275A375C2010",
|
||||
"have_header" : true,
|
||||
"have_state" : false,
|
||||
"have_transactions" : true,
|
||||
"needed_state_hashes" : [
|
||||
"BF8DC6B1E10D1D3565BF0649075D22EBFD34F751AFCC0E53E81D74786BC88922",
|
||||
"34E37A71CB51A12C73A435250E6A6349F7884C7EEBA6B88FA31F0244E967E88F",
|
||||
"BFB7D3008A7D61FD6A0538D1C2E70CFB94CE8DC66606319C372F278A48629765",
|
||||
"41C0C61D701FB1EA586F0EF1FC7A91FEC476D979589DA60507F05C13F7C21975",
|
||||
"6DDE8840A2C3C7FF05E5FFEE4D06408694C16A8357338FE0C4581DC3D8A00BBA",
|
||||
"6C69D833B582C849917806FA009518832BB50E900E43716FD7CC1966428DD0CF",
|
||||
"1EDC020CFC4AF19B625C52E20B66D6AE672821CCC461E8A9C457A3B2955657F7",
|
||||
"FC0616A66A2B0589CA513F3341D4EA51E782C4601E5072308478E3CC19264640",
|
||||
"19FC607B5DE1B64681A676EC1ED5507B9555B0E098CD9D898320297DE1A64033",
|
||||
"5E128D3FC990074E35687387A14AA12D9FD287E5AB57CB9B2FD83DE635DF5CA9",
|
||||
"DE72820F3981770F2AA8770BC233B80661F1A452819D8529008875FF8DED87A9",
|
||||
"3ACB84BEE2C45556351FF60FD787D235C9CF5623FB8A35B01446B773598E7CC0",
|
||||
"0DD3A8DF69874148057F1F2BF305442FF2E89A76A08B4CC8C051E2ED69B874F3",
|
||||
"4AE9A9C4F12A5BD0355037DA40A0B145420A2168A9FEDE43E643BD13062F8ECE",
|
||||
"08CBF8CFFEC207F5AC4E4F24BC447011FD8C79D25B344281FBFB4732D7058ED4",
|
||||
"779B2577C5C4BAED6657421448EA506BBF50F86BE363E0924127C4EA17A58BBE"
|
||||
],
|
||||
"peers" : 2,
|
||||
"timeouts" : 0
|
||||
}
|
||||
},
|
||||
"status" : "success"
|
||||
}
|
||||
}
|
||||
```
|
||||
{% /tab %}
|
||||
|
||||
{% tab label="コマンドライン" %}
|
||||
```json
|
||||
Loading: "/etc/rippled.cfg"
|
||||
Connecting to 127.0.0.1:5005
|
||||
|
||||
{
|
||||
"result" : {
|
||||
"info" : {
|
||||
"348928" : {
|
||||
"hash" : "C26D432B06F84861BCACD7942EDC3FE0B2E1DEB966A9E516A0FD275A375C2010",
|
||||
"have_header" : true,
|
||||
"have_state" : false,
|
||||
"have_transactions" : true,
|
||||
"needed_state_hashes" : [
|
||||
"BF8DC6B1E10D1D3565BF0649075D22EBFD34F751AFCC0E53E81D74786BC88922",
|
||||
"34E37A71CB51A12C73A435250E6A6349F7884C7EEBA6B88FA31F0244E967E88F",
|
||||
"BFB7D3008A7D61FD6A0538D1C2E70CFB94CE8DC66606319C372F278A48629765",
|
||||
"41C0C61D701FB1EA586F0EF1FC7A91FEC476D979589DA60507F05C13F7C21975",
|
||||
"6DDE8840A2C3C7FF05E5FFEE4D06408694C16A8357338FE0C4581DC3D8A00BBA",
|
||||
"6C69D833B582C849917806FA009518832BB50E900E43716FD7CC1966428DD0CF",
|
||||
"1EDC020CFC4AF19B625C52E20B66D6AE672821CCC461E8A9C457A3B2955657F7",
|
||||
"FC0616A66A2B0589CA513F3341D4EA51E782C4601E5072308478E3CC19264640",
|
||||
"19FC607B5DE1B64681A676EC1ED5507B9555B0E098CD9D898320297DE1A64033",
|
||||
"5E128D3FC990074E35687387A14AA12D9FD287E5AB57CB9B2FD83DE635DF5CA9",
|
||||
"DE72820F3981770F2AA8770BC233B80661F1A452819D8529008875FF8DED87A9",
|
||||
"3ACB84BEE2C45556351FF60FD787D235C9CF5623FB8A35B01446B773598E7CC0",
|
||||
"0DD3A8DF69874148057F1F2BF305442FF2E89A76A08B4CC8C051E2ED69B874F3",
|
||||
"4AE9A9C4F12A5BD0355037DA40A0B145420A2168A9FEDE43E643BD13062F8ECE",
|
||||
"08CBF8CFFEC207F5AC4E4F24BC447011FD8C79D25B344281FBFB4732D7058ED4",
|
||||
"779B2577C5C4BAED6657421448EA506BBF50F86BE363E0924127C4EA17A58BBE"
|
||||
],
|
||||
"peers" : 2,
|
||||
"timeouts" : 0
|
||||
}
|
||||
},
|
||||
"status" : "success"
|
||||
}
|
||||
}
|
||||
```
|
||||
{% /tab %}
|
||||
|
||||
{% /tabs %}
|
||||
|
||||
このレスポンスは[標準フォーマット][]に従っており、正常に完了した場合は結果に次のフィールドが含まれています。
|
||||
|
||||
| `Field` | 型 | 説明 |
|
||||
|:--------|:-------|:----------------------------------------------------------|
|
||||
| `info` | オブジェクト | フェッチ対象のオブジェクトと、そのフェッチ対象オブジェクトのステータスのマップ。フェッチ対象のレジャーはその[レジャーインデックス]によって識別されます。フェッチ対象のレジャーとその他のオブジェクトがハッシュによって識別されることもあります。 |
|
||||
|
||||
進行中のフェッチ操作を記述するフィールドは、予告なく変更される可能性があります。以下のフィールドが含まれている可能性があります。
|
||||
|
||||
| `Field` | 型 | 説明 |
|
||||
|:----------------------|:------------------------|:---------------------------|
|
||||
| `hash` | 文字列 | フェッチ対象アイテムのハッシュ。 |
|
||||
| `have_header` | ブール値 | レジャーの場合、このサーバーがすでにレジャーのヘッダーセクションを取得しているかどうか。 |
|
||||
| `have_transactions` | ブール値 | レジャーの場合、このサーバーがすでにレジャーのトランザクションセクションを取得しているかどうか。 |
|
||||
| `needed_state_hashes` | （ハッシュ）文字列の配列 | まだ必要とされる、このアイテムの状態オブジェクトのハッシュ値。必要なハッシュの数が16を超えている場合、レスポンスには最初の16個のハッシュのみが含まれます。 |
|
||||
| `peers` | 数値 | このアイテムが利用可能であるピアの数。 |
|
||||
| `timeouts` | 数値 | このアイテムをフェッチしようとしてタイムアウトになった（2.5秒）回数。 |
|
||||
|
||||
### 考えられるエラー
|
||||
|
||||
* [汎用エラータイプ][]のすべて。
|
||||
|
||||
{% raw-partial file="/docs/_snippets/common-links.md" /%}
|
||||
@@ -0,0 +1,159 @@
|
||||
---
|
||||
html: get_counts.html
|
||||
parent: status-and-debugging-methods.html
|
||||
seo:
|
||||
description: サーバーの健全性に関するさまざまな統計情報を提供します。
|
||||
labels:
|
||||
- コアサーバー
|
||||
---
|
||||
# get_counts
|
||||
[[ソース]](https://github.com/XRPLF/rippled/blob/c7118a183a660648aa88a3546a6b2c5bce858440/src/ripple/rpc/handlers/GetCounts.cpp "Source")
|
||||
|
||||
`get_counts`コマンドは、サーバーの健全性に関するさまざまな統計情報を提供します。そのほとんどは、現在メモリーに格納されている各種オブジェクトの数です。
|
||||
|
||||
_`get_counts`メソッドは、権限のないユーザーは実行できない[管理メソッド](../index.md)です。_
|
||||
|
||||
### リクエストのフォーマット
|
||||
リクエストのフォーマットの例:
|
||||
|
||||
{% tabs %}
|
||||
|
||||
{% tab label="WebSocket" %}
|
||||
```json
|
||||
{
|
||||
"id": 90,
|
||||
"command": "get_counts",
|
||||
"min_count": 100
|
||||
}
|
||||
```
|
||||
{% /tab %}
|
||||
|
||||
{% tab label="JSON-RPC" %}
|
||||
```json
|
||||
{
|
||||
"method": "get_counts",
|
||||
"params": [
|
||||
{
|
||||
"min_count": 100
|
||||
}
|
||||
]
|
||||
}
|
||||
```
|
||||
{% /tab %}
|
||||
|
||||
{% tab label="コマンドライン" %}
|
||||
```sh
|
||||
#Syntax: get_counts [min_count]
|
||||
rippled get_counts 100
|
||||
```
|
||||
{% /tab %}
|
||||
|
||||
{% /tabs %}
|
||||
|
||||
リクエストには以下のパラメーターが含まれます。
|
||||
|
||||
| `Field` | 型 | 説明 |
|
||||
|:------------|:--------------------------|:-----------------------------------|
|
||||
| `min_count` | 数値（符号なし整数） | この値以上の値を含むフィールドのみを返します。 |
|
||||
|
||||
### レスポンスのフォーマット
|
||||
|
||||
処理が成功したレスポンスの例:
|
||||
|
||||
{% tabs %}
|
||||
|
||||
{% tab label="JSON-RPC" %}
|
||||
```json
|
||||
{
|
||||
"result" : {
|
||||
"AL_hit_rate" : 48.36725616455078,
|
||||
"HashRouterEntry" : 3048,
|
||||
"Ledger" : 46,
|
||||
"NodeObject" : 10417,
|
||||
"SLE_hit_rate" : 64.62035369873047,
|
||||
"STArray" : 1299,
|
||||
"STLedgerEntry" : 646,
|
||||
"STObject" : 6987,
|
||||
"STTx" : 4104,
|
||||
"STValidation" : 610,
|
||||
"Transaction" : 4069,
|
||||
"dbKBLedger" : 10733,
|
||||
"dbKBTotal" : 39069,
|
||||
"dbKBTransaction" : 26982,
|
||||
"fullbelow_size" : 0,
|
||||
"historical_perminute" : 0,
|
||||
"ledger_hit_rate" : 71.0565185546875,
|
||||
"node_hit_rate" : 3.808214902877808,
|
||||
"node_read_bytes" : 393611911,
|
||||
"node_reads_hit" : 1283098,
|
||||
"node_reads_total" : 679410,
|
||||
"node_writes" : 1744285,
|
||||
"node_written_bytes" : 794368909,
|
||||
"status" : "success",
|
||||
"treenode_cache_size" : 6650,
|
||||
"treenode_track_size" : 598631,
|
||||
"uptime" : "3 hours, 50 minutes, 27 seconds",
|
||||
"write_load" : 0
|
||||
}
|
||||
}
|
||||
```
|
||||
{% /tab %}
|
||||
|
||||
{% tab label="コマンドライン" %}
|
||||
```json
|
||||
Loading: "/etc/rippled.cfg"
|
||||
Connecting to 127.0.0.1:5005
|
||||
|
||||
{
|
||||
"result" : {
|
||||
"AL_hit_rate" : 48.36725616455078,
|
||||
"HashRouterEntry" : 3048,
|
||||
"Ledger" : 46,
|
||||
"NodeObject" : 10417,
|
||||
"SLE_hit_rate" : 64.62035369873047,
|
||||
"STArray" : 1299,
|
||||
"STLedgerEntry" : 646,
|
||||
"STObject" : 6987,
|
||||
"STTx" : 4104,
|
||||
"STValidation" : 610,
|
||||
"Transaction" : 4069,
|
||||
"dbKBLedger" : 10733,
|
||||
"dbKBTotal" : 39069,
|
||||
"dbKBTransaction" : 26982,
|
||||
"fullbelow_size" : 0,
|
||||
"historical_perminute" : 0,
|
||||
"ledger_hit_rate" : 71.0565185546875,
|
||||
"node_hit_rate" : 3.808214902877808,
|
||||
"node_read_bytes" : 393611911,
|
||||
"node_reads_hit" : 1283098,
|
||||
"node_reads_total" : 679410,
|
||||
"node_writes" : 1744285,
|
||||
"node_written_bytes" : 794368909,
|
||||
"status" : "success",
|
||||
"treenode_cache_size" : 6650,
|
||||
"treenode_track_size" : 598631,
|
||||
"uptime" : "3 hours, 50 minutes, 27 seconds",
|
||||
"write_load" : 0
|
||||
}
|
||||
}
|
||||
```
|
||||
{% /tab %}
|
||||
|
||||
{% /tabs %}
|
||||
|
||||
レスポンスは[標準フォーマット][]に従っています。結果に含まれるフィールドのリストは、予告なく変更される可能性がありますが、（特に）以下のいずれかが含まれます。
|
||||
|
||||
| `Field` | 型 | 説明 |
|
||||
|:--------------|:-------|:----------------------------------------------------|
|
||||
| `Transaction` | 数値 | メモリー内の`Transaction`オブジェクトの数 |
|
||||
| `Ledger` | 数値 | メモリー内のレジャーの数 |
|
||||
| `uptime` | 文字列 | このサーバーの連続稼働時間。 |
|
||||
|
||||
その他のほとんどのエントリーでは、値はメモリー内に現在保持されている当該タイプのオブジェクトの数を示します。
|
||||
|
||||
### 考えられるエラー
|
||||
|
||||
* [汎用エラータイプ][]のすべて。
|
||||
* `invalidParams` - 1つ以上のフィールドの指定が正しくないか、1つ以上の必須フィールドが指定されていません。
|
||||
|
||||
{% raw-partial file="/docs/_snippets/common-links.md" /%}
|
||||
@@ -0,0 +1,12 @@
|
||||
---
|
||||
html: status-and-debugging-methods.html
|
||||
parent: admin-api-methods.html
|
||||
metadata:
|
||||
indexPage: true
|
||||
---
|
||||
# ステータスとデバッグのメソッド
|
||||
|
||||
以下のメソッドを使用して、ネットワークとサーバーのステータスを確認することができます。
|
||||
|
||||
|
||||
{% child-pages /%}
|
||||
@@ -0,0 +1,242 @@
|
||||
---
|
||||
html: print.html
|
||||
parent: status-and-debugging-methods.html
|
||||
seo:
|
||||
description: さまざまな内部サブシステムの現在の状況を返します。
|
||||
labels:
|
||||
- コアサーバー
|
||||
---
|
||||
# print
|
||||
[[ソース]](https://github.com/XRPLF/rippled/blob/315a8b6b602798a4cff4d8e1911936011e12abdb/src/ripple/rpc/handlers/Print.cpp "Source")
|
||||
|
||||
`print`コマンドは、さまざまな内部サブシステム（ピア、レジャークリーナー、リソースマネージャーなど）の現在の状況を返します。
|
||||
|
||||
*`print`リクエストは、権限のないユーザーは実行できない[管理メソッド](../index.md)です。*
|
||||
|
||||
### リクエストのフォーマット
|
||||
リクエストのフォーマットの例:
|
||||
|
||||
{% tabs %}
|
||||
|
||||
{% tab label="WebSocket" %}
|
||||
```json
|
||||
{
|
||||
"id": "print_req_1",
|
||||
"command": "print"
|
||||
}
|
||||
```
|
||||
{% /tab %}
|
||||
|
||||
{% tab label="コマンドライン" %}
|
||||
```
|
||||
rippled print
|
||||
```
|
||||
{% /tab %}
|
||||
|
||||
{% /tabs %}
|
||||
|
||||
リクエストにはパラメーターが含まれていません。
|
||||
|
||||
### レスポンスのフォーマット
|
||||
|
||||
処理が成功したレスポンスの例:
|
||||
|
||||
{% tabs %}
|
||||
|
||||
{% tab label="コマンドライン" %}
|
||||
```json
|
||||
Loading: "/etc/rippled.cfg"
|
||||
Connecting to 127.0.0.1:5005
|
||||
|
||||
{
|
||||
"result" : {
|
||||
"app" : {
|
||||
"ledgercleaner" : {
|
||||
"status" : "idle"
|
||||
},
|
||||
"peers" : {
|
||||
"peerfinder" : {
|
||||
"bootcache" : {
|
||||
"entries" : 109
|
||||
},
|
||||
"config" : {
|
||||
"auto_connect" : "true",
|
||||
"features" : "",
|
||||
"max_peers" : 21,
|
||||
"out_peers" : 10,
|
||||
"port" : 51235,
|
||||
"want_incoming" : "true"
|
||||
},
|
||||
"counts" : {
|
||||
"accept" : 0,
|
||||
"close" : 0,
|
||||
"cluster" : "0",
|
||||
"connect" : 0,
|
||||
"fixed" : "0",
|
||||
"in" : "0/11",
|
||||
"out" : "10/10",
|
||||
"total" : "10"
|
||||
},
|
||||
"fixed" : 0,
|
||||
"livecache" : {
|
||||
"entries" : [
|
||||
{
|
||||
"address" : "23.239.3.247:51235",
|
||||
"expires" : "30000000000 nanoseconds",
|
||||
"hops" : 2
|
||||
},
|
||||
{
|
||||
"address" : "192.170.145.88:51235",
|
||||
"expires" : "30000000000 nanoseconds",
|
||||
"hops" : 1
|
||||
},
|
||||
{
|
||||
"address" : "198.204.238.130:51235",
|
||||
"expires" : "26000024558 nanoseconds",
|
||||
"hops" : 1
|
||||
},
|
||||
{
|
||||
"address" : "203.127.12.115:51235",
|
||||
"expires" : "26000024558 nanoseconds",
|
||||
"hops" : 2
|
||||
},
|
||||
{
|
||||
"address" : "212.83.147.67:51235",
|
||||
"expires" : "26000024558 nanoseconds",
|
||||
"hops" : 2
|
||||
}
|
||||
],
|
||||
"hist" : "0, 10, 74, 10, 0, 0, 0, 0",
|
||||
"size" : "94"
|
||||
},
|
||||
"peers" : [
|
||||
{
|
||||
"local_address" : "10.1.10.78:48923",
|
||||
"remote_address" : "52.24.43.83:51235",
|
||||
"state" : "active"
|
||||
},
|
||||
{
|
||||
"local_address" : "10.1.10.78:50004",
|
||||
"remote_address" : "52.26.205.197:51235",
|
||||
"state" : "active"
|
||||
},
|
||||
{
|
||||
"local_address" : "10.1.10.78:37019",
|
||||
"remote_address" : "168.1.60.132:51235",
|
||||
"state" : "active"
|
||||
},
|
||||
{
|
||||
"local_address" : "10.1.10.78:38775",
|
||||
"remote_address" : "192.170.145.88:51235",
|
||||
"state" : "active"
|
||||
},
|
||||
{
|
||||
"local_address" : "10.1.10.78:34793",
|
||||
"remote_address" : "198.204.238.130:51235",
|
||||
"state" : "active"
|
||||
}
|
||||
]
|
||||
}
|
||||
},
|
||||
"resource" : {
|
||||
"admin" : [
|
||||
{
|
||||
"balance" : 0,
|
||||
"count" : 1,
|
||||
"name" : "\"127.0.0.1\""
|
||||
}
|
||||
],
|
||||
"inactive" : [],
|
||||
"inbound" : [],
|
||||
"outbound" : [
|
||||
{
|
||||
"balance" : 23,
|
||||
"count" : 1,
|
||||
"name" : "93.190.138.234:51235"
|
||||
},
|
||||
{
|
||||
"balance" : 35,
|
||||
"count" : 1,
|
||||
"name" : "198.204.238.130:51235"
|
||||
},
|
||||
{
|
||||
"balance" : 31,
|
||||
"count" : 1,
|
||||
"name" : "52.26.205.197:51235"
|
||||
},
|
||||
{
|
||||
"balance" : 32,
|
||||
"count" : 1,
|
||||
"name" : "54.186.73.52:51235"
|
||||
},
|
||||
{
|
||||
"balance" : 15,
|
||||
"count" : 1,
|
||||
"name" : "72.251.233.164:51235"
|
||||
}
|
||||
]
|
||||
},
|
||||
"server" : {
|
||||
"active" : "2",
|
||||
"hist" : "16",
|
||||
"history" : [
|
||||
{
|
||||
"bytes_in" : "214",
|
||||
"bytes_out" : "11688",
|
||||
"elapsed" : "0 seconds",
|
||||
"id" : "16",
|
||||
"requests" : 1,
|
||||
"when" : "2015-Jun-16 16:33:50"
|
||||
},
|
||||
{
|
||||
"bytes_in" : "214",
|
||||
"bytes_out" : "11431",
|
||||
"elapsed" : "0 seconds",
|
||||
"id" : "15",
|
||||
"requests" : 1,
|
||||
"when" : "2015-Jun-16 16:11:59"
|
||||
},
|
||||
{
|
||||
"bytes_in" : "227",
|
||||
"bytes_out" : "337",
|
||||
"elapsed" : "0 seconds",
|
||||
"id" : "3",
|
||||
"requests" : 1,
|
||||
"when" : "2015-Jun-16 14:57:23"
|
||||
},
|
||||
{
|
||||
"bytes_in" : "214",
|
||||
"bytes_out" : "2917",
|
||||
"elapsed" : "0 seconds",
|
||||
"id" : "2",
|
||||
"requests" : 1,
|
||||
"when" : "2015-Jun-16 12:39:29"
|
||||
},
|
||||
{
|
||||
"bytes_in" : "220",
|
||||
"bytes_out" : "1426",
|
||||
"elapsed" : "0 seconds",
|
||||
"id" : "1",
|
||||
"requests" : 1,
|
||||
"when" : "2015-Jun-16 12:39:13"
|
||||
}
|
||||
]
|
||||
},
|
||||
"validators" : {}
|
||||
},
|
||||
"status" : "success"
|
||||
}
|
||||
}
|
||||
|
||||
```
|
||||
{% /tab %}
|
||||
|
||||
{% /tabs %}
|
||||
|
||||
レスポンスは[標準フォーマット][]に従っています。結果に含まれる追加フィールドは、`rippled`サーバーの内部状態に応じて異なります。このコマンドの実行結果は、予告なく変更されることがあります。
|
||||
|
||||
### 考えられるエラー
|
||||
|
||||
* [汎用エラータイプ][]のすべて。
|
||||
|
||||
{% raw-partial file="/docs/_snippets/common-links.md" /%}
|
||||
@@ -0,0 +1,129 @@
|
||||
---
|
||||
html: validator_info.html
|
||||
parent: status-and-debugging-methods.html
|
||||
seo:
|
||||
description: バリデータとして設定されている場合、サーバのバリデーション設定を取得します。
|
||||
labels:
|
||||
- コアサーバー
|
||||
- ブロックチェーン
|
||||
---
|
||||
# validator_info
|
||||
[[ソース]](https://github.com/XRPLF/rippled/blob/master/src/ripple/rpc/handlers/ValidatorInfo.cpp "ソース")
|
||||
|
||||
{% code-page-name /%}メソッドは、サーバがバリデータとして設定されている場合に、現在のバリデータの設定を返します。
|
||||
|
||||
_{% code-page-name /%}メソッドは[管理メソッド](../index.md)で、権限のないユーザは実行できません。_
|
||||
|
||||
|
||||
### リクエストのフォーマット
|
||||
|
||||
リクエストのフォーマットの例:
|
||||
|
||||
{% tabs %}
|
||||
|
||||
{% tab label="WebSocket" %}
|
||||
```json
|
||||
{
|
||||
"command": "{% $frontmatter.seo.title %}"
|
||||
}
|
||||
```
|
||||
{% /tab %}
|
||||
|
||||
{% tab label="JSON-RPC" %}
|
||||
```json
|
||||
{
|
||||
"method": "{% $frontmatter.seo.title %}"
|
||||
}
|
||||
```
|
||||
{% /tab %}
|
||||
|
||||
{% tab label="コマンドライン" %}
|
||||
```sh
|
||||
#Syntax: {% $frontmatter.seo.title %}
|
||||
rippled {% $frontmatter.seo.title %}
|
||||
```
|
||||
{% /tab %}
|
||||
|
||||
{% /tabs %}
|
||||
|
||||
リクエストはパラメータを使用しません。
|
||||
|
||||
|
||||
### レスポンスのフォーマット
|
||||
|
||||
成功したレスポンスの例:
|
||||
|
||||
{% tabs %}
|
||||
|
||||
{% tab label="WebSocket" %}
|
||||
```json
|
||||
{
|
||||
"result": {
|
||||
"domain": "mduo13.com",
|
||||
"ephemeral_key": "n9KnrcCmL5psyKtk2KWP6jy14Hj4EXuZDg7XMdQJ9cSDoFSp53hu",
|
||||
"manifest": "JAAAAAFxIe002KClGBUlRA7h5J2Y5B7Xdlxn1Z5OxY7ZC2UmqUIikHMhAkVIeB7McBf4NFsBceQQlScTVUWMdpYzwmvs115SUGDKdkcwRQIhAJnKfYWnPsBsATIIRfgkAAK+HE4zp8G8AmOPrHmLZpZAAiANiNECVQTKktoD7BEoEmS8jaFBNMgRdcG0dttPurCAGXcKbWR1bzEzLmNvbXASQPjO6wxOfhtWsJ6oMWBg8Rs5STAGvQV2ArI5MG3KbpFrNSMxbx630Ars9d9j1ORsUS5v1biZRShZfg9180JuZAo=",
|
||||
"master_key": "nHBk5DPexBjinXV8qHn7SEKzoxh2W92FxSbNTPgGtQYBzEF4msn9",
|
||||
"seq": 1
|
||||
},
|
||||
"status": "success",
|
||||
"type": "response"
|
||||
}
|
||||
```
|
||||
{% /tab %}
|
||||
|
||||
{% tab label="JSON-RPC" %}
|
||||
```json
|
||||
200 OK
|
||||
|
||||
{
|
||||
"result": {
|
||||
"domain": "mduo13.com",
|
||||
"ephemeral_key": "n9KnrcCmL5psyKtk2KWP6jy14Hj4EXuZDg7XMdQJ9cSDoFSp53hu",
|
||||
"manifest": "JAAAAAFxIe002KClGBUlRA7h5J2Y5B7Xdlxn1Z5OxY7ZC2UmqUIikHMhAkVIeB7McBf4NFsBceQQlScTVUWMdpYzwmvs115SUGDKdkcwRQIhAJnKfYWnPsBsATIIRfgkAAK+HE4zp8G8AmOPrHmLZpZAAiANiNECVQTKktoD7BEoEmS8jaFBNMgRdcG0dttPurCAGXcKbWR1bzEzLmNvbXASQPjO6wxOfhtWsJ6oMWBg8Rs5STAGvQV2ArI5MG3KbpFrNSMxbx630Ars9d9j1ORsUS5v1biZRShZfg9180JuZAo=",
|
||||
"master_key": "nHBk5DPexBjinXV8qHn7SEKzoxh2W92FxSbNTPgGtQYBzEF4msn9",
|
||||
"seq": 1,
|
||||
"status": "success"
|
||||
}
|
||||
}
|
||||
```
|
||||
{% /tab %}
|
||||
|
||||
{% tab label="コマンドライン" %}
|
||||
```json
|
||||
Loading: "/etc/rippled.cfg"
|
||||
Connecting to 127.0.0.1:5005
|
||||
|
||||
{
|
||||
"result" : {
|
||||
"domain" : "mduo13.com",
|
||||
"ephemeral_key" : "n9KnrcCmL5psyKtk2KWP6jy14Hj4EXuZDg7XMdQJ9cSDoFSp53hu",
|
||||
"manifest" : "JAAAAAFxIe002KClGBUlRA7h5J2Y5B7Xdlxn1Z5OxY7ZC2UmqUIikHMhAkVIeB7McBf4NFsBceQQlScTVUWMdpYzwmvs115SUGDKdkcwRQIhAJnKfYWnPsBsATIIRfgkAAK+HE4zp8G8AmOPrHmLZpZAAiANiNECVQTKktoD7BEoEmS8jaFBNMgRdcG0dttPurCAGXcKbWR1bzEzLmNvbXASQPjO6wxOfhtWsJ6oMWBg8Rs5STAGvQV2ArI5MG3KbpFrNSMxbx630Ars9d9j1ORsUS5v1biZRShZfg9180JuZAo=",
|
||||
"master_key" : "nHBk5DPexBjinXV8qHn7SEKzoxh2W92FxSbNTPgGtQYBzEF4msn9",
|
||||
"seq" : 1,
|
||||
"status" : "success"
|
||||
}
|
||||
}
|
||||
```
|
||||
{% /tab %}
|
||||
|
||||
{% /tabs %}
|
||||
|
||||
レスポンスは[標準フォーマット][]に従い、成功した結果には以下のフィールドが含まれます.
|
||||
|
||||
| `Field` | 型 | 説明 |
|
||||
|:----------------|:------|:----------------------------------------------------------|
|
||||
| `domain` | 文字列 | _(省略される場合があります)_ このバリデータに関連付けられたドメイン名 (ドメイン名が設定されている場合)。 |
|
||||
| `ephemeral_key` | 文字列 | _(省略される場合があります)_ このサーバが検証メッセージに署名する際に使用する公開鍵。この鍵は、バリデータが設定したトークンを変更した際に変更されます。 |
|
||||
| `manifest` | 文字列 | _(省略される場合があります)_ このバリデータが設定したトークンに対応するパブリックな「マニフェスト」を[バイナリにシリアライズ](../../../protocol/binary-format.md)して、base64でエンコードしたもの。このフィールドには個人情報は含まれません。 |
|
||||
| `master_key` | 文字列 | このバリデータのマスターキーペアの公開鍵。このキーはバリデータを一意に識別するもので、バリデータが公開鍵をローテーションする場合でも同じです。サーバが`[validator_token]`ではなく`[validation_seed]`を用いて設定されている場合、レスポンスのフィールドはこれだけとなります。 |
|
||||
| `seq` | 数値 | _(省略される場合があります)_ このバリデータのバリデーション用トークンおよび設定のシーケンス番号。この番号は、バリデータのオペレータがトークンを更新して鍵をローテーションしたり設定を変更したりするたびに増加します。 |
|
||||
|
||||
バリデータトークンとキーローテーションの詳細については、[validator-keys-toolガイド](https://github.com/ripple/validator-keys-tool/blob/master/doc/validator-keys-tool-guide.md)をご覧ください。
|
||||
|
||||
|
||||
### 考えられるエラー
|
||||
|
||||
* [汎用エラータイプ][]のすべて。
|
||||
- `invalidParams` - サーバが[バリデータとして設定されていない](../../../../infrastructure/configuration/server-modes/run-rippled-as-a-validator.md)場合、サーバはこのエラーを`"error_message" : "not a validator"`と共に返します。
|
||||
|
||||
{% raw-partial file="/docs/_snippets/common-links.md" /%}
|
||||
@@ -0,0 +1,142 @@
|
||||
---
|
||||
html: validator_list_sites.html
|
||||
parent: status-and-debugging-methods.html
|
||||
seo:
|
||||
description: バリデータリストを処理するサイトのステータス情報を返します。
|
||||
labels:
|
||||
- ブロックチェーン
|
||||
- コアサーバー
|
||||
---
|
||||
# validator_list_sites
|
||||
[[ソース]](https://github.com/XRPLF/rippled/blob/master/src/ripple/rpc/handlers/ValidatorListSites.cpp "Source")
|
||||
|
||||
`validator_list_sites`コマンドは、バリデータリストを処理するサイトのステータス情報を返します。{% badge href="https://github.com/XRPLF/rippled/releases/tag/0.80.1" %}新規: rippled 0.80.1{% /badge %}
|
||||
|
||||
*`validator_list_sites`リクエストは、権限のないユーザーは実行できない[管理メソッド](../index.md)です。*
|
||||
|
||||
### リクエストのフォーマット
|
||||
リクエストのフォーマットの例:
|
||||
|
||||
{% tabs %}
|
||||
|
||||
{% tab label="WebSocket" %}
|
||||
```json
|
||||
{
|
||||
"id": 1,
|
||||
"command": "validator_list_sites"
|
||||
}
|
||||
```
|
||||
{% /tab %}
|
||||
|
||||
{% tab label="JSON-RPC" %}
|
||||
```json
|
||||
{
|
||||
"method": "validator_list_sites",
|
||||
"params": [
|
||||
{}
|
||||
]
|
||||
}
|
||||
```
|
||||
{% /tab %}
|
||||
|
||||
{% tab label="コマンドライン" %}
|
||||
```sh
|
||||
#Syntax: validator_list_sites
|
||||
rippled validator_list_sites
|
||||
```
|
||||
{% /tab %}
|
||||
|
||||
{% /tabs %}
|
||||
|
||||
リクエストにはパラメーターが含まれていません。
|
||||
|
||||
### レスポンスのフォーマット
|
||||
|
||||
処理が成功したレスポンスの例:
|
||||
|
||||
{% tabs %}
|
||||
|
||||
{% tab label="WebSocket" %}
|
||||
```json
|
||||
{
|
||||
"id":5,
|
||||
"status":"success",
|
||||
"type":"response",
|
||||
"result": {
|
||||
"validator_sites": [
|
||||
{
|
||||
"last_refresh_status": "accepted",
|
||||
"last_refresh_time": "2017-Oct-13 21:26:37",
|
||||
"refresh_interval_min": 5,
|
||||
"uri": "http://127.0.0.1:51447/validators"
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
}
|
||||
```
|
||||
{% /tab %}
|
||||
|
||||
{% tab label="JSON-RPC" %}
|
||||
```json
|
||||
200 OK
|
||||
|
||||
{
|
||||
"result": {
|
||||
"status": "success",
|
||||
"validator_sites": [
|
||||
{
|
||||
"last_refresh_status": "accepted",
|
||||
"last_refresh_time": "2017-Oct-13 21:26:37",
|
||||
"refresh_interval_min": 5,
|
||||
"uri": "http://127.0.0.1:51447/validators"
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
```
|
||||
{% /tab %}
|
||||
|
||||
{% tab label="コマンドライン" %}
|
||||
```json
|
||||
Loading: "/etc/rippled.cfg"
|
||||
Connecting to 127.0.0.1:5005
|
||||
|
||||
{
|
||||
"result": {
|
||||
"status": "success",
|
||||
"validator_sites": [
|
||||
{
|
||||
"last_refresh_status": "accepted",
|
||||
"last_refresh_time": "2017-Oct-13 21:26:37",
|
||||
"refresh_interval_min": 5,
|
||||
"uri": "http://127.0.0.1:51447/validators"
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
```
|
||||
{% /tab %}
|
||||
|
||||
{% /tabs %}
|
||||
|
||||
レスポンスは[標準フォーマット][]に従っており、正常に完了した場合は結果に次のフィールドが含まれています。
|
||||
|
||||
| `Field` | 型 | 説明 |
|
||||
|:------------------|:------|----------------------------------|
|
||||
| `validator_sites` | 配列 | バリデータサイトオブジェクトからなる配列。 |
|
||||
|
||||
`validator_sites`フィールドの配列の各メンバーは、次のフィールドを有するオブジェクトです。
|
||||
|
||||
| `Field` | 型 | 説明 |
|
||||
|:-----------------------|:-----------------|:--------------------------------|
|
||||
| `last_refresh_status` | 文字列 | 存在する場合は、サイトの最終更新の[`ListDisposition`](https://github.com/XRPLF/rippled/blob/master/src/ripple/app/misc/ValidatorList.h)です。存在しない場合は、サイトに対するクエリーがまだ成功していません。 |
|
||||
| `last_refresh_time` | 文字列 | サイトの最終照会時刻を人間が読み取れる形式で表示します。存在しない場合は、サイトに対するクエリーがまだ成功していません。 |
|
||||
| `refresh_interval_min` | 符号なし整数 | 更新試行間隔の分数。 |
|
||||
| `uri` | 文字列 | サイトのURI。 |
|
||||
|
||||
### 考えられるエラー
|
||||
|
||||
* [汎用エラータイプ][]のすべて。
|
||||
|
||||
{% raw-partial file="/docs/_snippets/common-links.md" /%}
|
||||
@@ -0,0 +1,190 @@
|
||||
---
|
||||
html: validators.html
|
||||
parent: status-and-debugging-methods.html
|
||||
seo:
|
||||
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`リクエストは、権限のないユーザーは実行できない[管理メソッド](../index.md)です。*
|
||||
|
||||
### リクエストのフォーマット
|
||||
リクエストのフォーマットの例:
|
||||
|
||||
{% tabs %}
|
||||
|
||||
{% tab label="WebSocket" %}
|
||||
```json
|
||||
{
|
||||
"id": 1,
|
||||
"command": "validators"
|
||||
}
|
||||
```
|
||||
{% /tab %}
|
||||
|
||||
{% tab label="JSON-RPC" %}
|
||||
```json
|
||||
{
|
||||
"method": "validators",
|
||||
"params": [
|
||||
{}
|
||||
]
|
||||
}
|
||||
```
|
||||
{% /tab %}
|
||||
|
||||
{% tab label="コマンドライン" %}
|
||||
```sh
|
||||
#Syntax: validators
|
||||
rippled validators
|
||||
```
|
||||
{% /tab %}
|
||||
|
||||
{% /tabs %}
|
||||
|
||||
リクエストにはパラメーターが含まれていません。
|
||||
|
||||
### レスポンスのフォーマット
|
||||
|
||||
処理が成功したレスポンスの例:
|
||||
|
||||
{% tabs %}
|
||||
|
||||
{% tab label="WebSocket" %}
|
||||
```json
|
||||
{
|
||||
"id":5,
|
||||
"status":"success",
|
||||
"type":"response",
|
||||
"result":{
|
||||
"local_static_keys": [],
|
||||
"publisher_lists":[
|
||||
{
|
||||
"available":true,
|
||||
"expiration":"2017-Oct-13 14:56:00",
|
||||
"list":[
|
||||
"nHBtBkHGfL4NpB54H1AwBaaSJkSJLUSPvnUNAcuNpuffYB51VjH6",
|
||||
"nHBe4vqSAzjpPRLKwSFzRFtmvzXaf5wPPmuVrQCAoJoS1zskgDA4"
|
||||
],
|
||||
"pubkey_publisher":"ED58ED4AA543B524F16771F6E1367BAA220D99DCF22CD8CF7A11309E9EAB1B647B",
|
||||
"seq":1,
|
||||
"version":1
|
||||
}
|
||||
],
|
||||
"signing_keys":{},
|
||||
"status":"success",
|
||||
"trusted_validator_keys":[
|
||||
"nHBe4vqSAzjpPRLKwSFzRFtmvzXaf5wPPmuVrQCAoJoS1zskgDA4",
|
||||
"nHBtBkHGfL4NpB54H1AwBaaSJkSJLUSPvnUNAcuNpuffYB51VjH6"
|
||||
],
|
||||
"validation_quorum":2,
|
||||
"validator_list_expires":"2017-Oct-13 14:56:00"
|
||||
}
|
||||
}
|
||||
```
|
||||
{% /tab %}
|
||||
|
||||
{% tab label="JSON-RPC" %}
|
||||
```json
|
||||
200 OK
|
||||
|
||||
{
|
||||
"result":{
|
||||
"local_static_keys": [],
|
||||
"publisher_lists":[
|
||||
{
|
||||
"available":true,
|
||||
"expiration":"2017-Oct-13 14:56:00",
|
||||
"list":[
|
||||
"nHBtBkHGfL4NpB54H1AwBaaSJkSJLUSPvnUNAcuNpuffYB51VjH6",
|
||||
"nHBe4vqSAzjpPRLKwSFzRFtmvzXaf5wPPmuVrQCAoJoS1zskgDA4"
|
||||
],
|
||||
"pubkey_publisher":"ED58ED4AA543B524F16771F6E1367BAA220D99DCF22CD8CF7A11309E9EAB1B647B",
|
||||
"seq":1,
|
||||
"version":1
|
||||
}
|
||||
],
|
||||
"signing_keys":{},
|
||||
"status":"success",
|
||||
"trusted_validator_keys":[
|
||||
"nHBe4vqSAzjpPRLKwSFzRFtmvzXaf5wPPmuVrQCAoJoS1zskgDA4",
|
||||
"nHBtBkHGfL4NpB54H1AwBaaSJkSJLUSPvnUNAcuNpuffYB51VjH6"
|
||||
],
|
||||
"validation_quorum":2,
|
||||
"validator_list_expires":"2017-Oct-13 14:56:00"
|
||||
},
|
||||
"status":"success"
|
||||
}
|
||||
```
|
||||
{% /tab %}
|
||||
|
||||
{% tab label="コマンドライン" %}
|
||||
```json
|
||||
Loading: "/etc/rippled.cfg"
|
||||
Connecting to 127.0.0.1:5005
|
||||
|
||||
{
|
||||
"result":{
|
||||
"local_static_keys": [],
|
||||
"publisher_lists":[
|
||||
{
|
||||
"available":true,
|
||||
"expiration":"2017-Oct-13 14:56:00",
|
||||
"list":[
|
||||
"nHBtBkHGfL4NpB54H1AwBaaSJkSJLUSPvnUNAcuNpuffYB51VjH6",
|
||||
"nHBe4vqSAzjpPRLKwSFzRFtmvzXaf5wPPmuVrQCAoJoS1zskgDA4"
|
||||
],
|
||||
"pubkey_publisher":"ED58ED4AA543B524F16771F6E1367BAA220D99DCF22CD8CF7A11309E9EAB1B647B",
|
||||
"seq":1,
|
||||
"version":1
|
||||
}
|
||||
],
|
||||
"signing_keys":{},
|
||||
"status":"success",
|
||||
"trusted_validator_keys":[
|
||||
"nHBe4vqSAzjpPRLKwSFzRFtmvzXaf5wPPmuVrQCAoJoS1zskgDA4",
|
||||
"nHBtBkHGfL4NpB54H1AwBaaSJkSJLUSPvnUNAcuNpuffYB51VjH6"
|
||||
],
|
||||
"validation_quorum":2,
|
||||
"validator_list_expires":"2017-Oct-13 14:56:00"
|
||||
},
|
||||
"status":"success"
|
||||
}
|
||||
```
|
||||
{% /tab %}
|
||||
|
||||
{% /tabs %}
|
||||
|
||||
レスポンスは[標準フォーマット][]に従っており、正常に完了した場合は結果に次のフィールドが含まれています。
|
||||
|
||||
| `Field` | 型 | 説明 |
|
||||
|:-------------------------|:-------|:-----------------------------------------|
|
||||
| `listed_static_keys` | 配列 | 信頼リストに常に追加可能なバリデータの公開鍵の配列。 |
|
||||
| `publisher_lists` | 配列 | パブリッシャーリストオブジェクトの配列。 |
|
||||
| `signing_keys` | オブジェクト | バリデータマニフェストを使用している登録済みバリデータのマスター公開鍵から、現在の署名キーへのマッピング。 |
|
||||
| `trusted_validator_keys` | 配列 | 現在信頼されているバリデータの公開鍵の配列。 |
|
||||
| `validation_quorum` | 数値 | 1つのレジャーバージョンの検証に最低限必要となる信頼できる検証の数。状況によっては、サーバーがさらに検証をリクエストする場合があります。 |
|
||||
| `validator_list_expires` | 文字列 | 人間が読み取れる形式での現在のバリデータリストの有効期限、文字列`unknown`（サーバーが公開済みバリデータリストを読み込む必要がある場合）、または文字列`never`（サーバーが静的なバリデータリストを使用している場合）のいずれか。 |
|
||||
|
||||
`publisher_lists`配列の各メンバーは、以下のフィールドを有するオブジェクトです。
|
||||
|
||||
| `Field` | 型 | 説明 |
|
||||
|:-------------------|:-----------------|:-------------------------------------|
|
||||
| `available` | ブール値 | `false`の場合、`list`内のバリデータキーはこのパブリッシャーによりサポートされていない可能性があります。 |
|
||||
| `expiration` | 文字列 | この公開済みリストの有効期限を人間が読み取れる形式で示します。 |
|
||||
| `list` | 配列 | 公開済みバリデータキーからなる配列。 |
|
||||
| `pubkey_publisher` | 文字列 | リストパブリッシャーのEd25519またはECDSA公開鍵（16進数）。 |
|
||||
| `seq` | 符号なし整数 | 公開済みリストのシーケンス番号。 |
|
||||
| `version` | 符号なし整数 | リストフォーマットのバージョン。 |
|
||||
|
||||
### 考えられるエラー
|
||||
|
||||
* [汎用エラータイプ][]のすべて。
|
||||
|
||||
{% raw-partial file="/docs/_snippets/common-links.md" /%}
|
||||
Reference in New Issue
Block a user