[JA] fix request, response

This commit is contained in:
tequ
2024-01-05 19:07:53 +09:00
parent c385c08542
commit 15e0519260
151 changed files with 918 additions and 918 deletions

View File

@@ -18,8 +18,8 @@ _`validation_create`メソッドは、権限のないユーザーは実行でき
**ヒント:** 堅牢なバリデータを設定するには、`validator-keys`ツール(`rippled` RPMに付属を使用してバリデータトークンローテーション可能とオフラインマスターキーを生成してください。詳細は、[rippledサーバーで検証を有効化](run-rippled-as-a-validator.html#3-rippledサーバーで検証を有効化)を参照してください。
### 要求フォーマット
要求フォーマットの例:
### リクエストのフォーマット
リクエストのフォーマットの例:
<!-- MULTICODE_BLOCK_START -->
@@ -55,7 +55,7 @@ rippled validation_create "BAWL MAN JADE MOON DOVE GEM SON NOW HAD ADEN GLOW TIR
<!-- MULTICODE_BLOCK_END -->
要求には以下のパラメーターが含まれます。
リクエストには以下のパラメーターが含まれます。
| `Field` | 型 | 説明 |
|:---------|:-------|:---------------------------------------------------------|
@@ -63,9 +63,9 @@ rippled validation_create "BAWL MAN JADE MOON DOVE GEM SON NOW HAD ADEN GLOW TIR
**注記:** バリデータのセキュリティは、シードのエントロピーに応じて異なります。シークレット値が強力なランダム性のソースを使用して生成されている場合を除き、実際の事業目的のためにシークレット値を使用しないでください。新しいクレデンシャルを初めて生成するときには`secret`を省略することが推奨されます。
### 応答フォーマット
### レスポンスのフォーマット
処理が成功した応答の例:
処理が成功したレスポンスの例:
<!-- MULTICODE_BLOCK_START -->
@@ -100,7 +100,7 @@ Connecting to 127.0.0.1:5005
<!-- MULTICODE_BLOCK_END -->
この応答は[標準フォーマット][]に従っており、正常に完了した場合は結果に次のフィールドが含まれています。
このレスポンスは[標準フォーマット][]に従っており、正常に完了した場合は結果に次のフィールドが含まれています。
| `Field` | 型 | 説明 |
|:------------------------|:-------|:------------------------------------------|
@@ -111,7 +111,7 @@ Connecting to 127.0.0.1:5005
### 考えられるエラー
* [汎用エラータイプ][]のすべて。
* `badSeed` - 要求に無効なシード値が指定されていました。この場合は通常、シード値が異なるフォーマットの有効文字列(アカウントアドレス、検証の公開鍵など)である可能性があります。
* `badSeed` - リクエストに無効なシード値が指定されていました。この場合は通常、シード値が異なるフォーマットの有効文字列(アカウントアドレス、検証の公開鍵など)である可能性があります。
<!--{# common link defs #}-->
{% include '_snippets/rippled-api-links.md' %}

View File

@@ -15,9 +15,9 @@ labels:
[更新: rippled 0.31.0][]
### 要求フォーマット
### リクエストのフォーマット
要求フォーマットの例:
リクエストのフォーマットの例:
<!-- MULTICODE_BLOCK_START -->
@@ -76,7 +76,7 @@ rippled wallet_propose masterpassphrase
<!-- MULTICODE_BLOCK_END -->
要求には以下のパラメーターを含めることができます。
リクエストには以下のパラメーターを含めることができます。
| `Field` | 型 | 説明 |
|:-------------|:-------|:-----------------------------------------------------|
@@ -108,9 +108,9 @@ rippled wallet_propose masterpassphrase
[RFC-1751]: https://tools.ietf.org/html/rfc1751 ""
[16進数]: https://en.wikipedia.org/wiki/Hexadecimal ""
### 応答フォーマット
### レスポンスのフォーマット
処理が成功した応答の例:
処理が成功したレスポンスの例:
<!-- MULTICODE_BLOCK_START -->
@@ -172,7 +172,7 @@ Connecting to 127.0.0.1:5005
<!-- MULTICODE_BLOCK_END -->
応答は[標準フォーマット][]に従い、正常に終了した場合、新しい(可能性がある)アカウントについての重要な各種情報を含みます。以下のフィールドを含みます。
レスポンスは[標準フォーマット][]に従い、正常に終了した場合、新しい(可能性がある)アカウントについての重要な各種情報を含みます。以下のフィールドを含みます。
| `Field` | 型 | 説明 |
|:------------------|:-------|:------------------------------------------------|
@@ -183,7 +183,7 @@ Connecting to 127.0.0.1:5005
| `account_id` | 文字列 | XRP Ledgerの[base58][]フォーマットで作成されたアカウントの[アドレス][]。これは公開鍵ではありませんが、公開鍵を2回ハッシュ化したものです。チェックサムも持っているため、タイプミスした場合はほぼ間違いなく無効なアドレスとみなされ、有効だが異なるアドレスとはみなされません。これはXRP LedgerのアカウントのプライマリIDです。支払いを受けるときにこれを人に伝えたり、トランザクションにおいて、自身や、支払先、委託先識別するのに使用します。[マルチシグリスト](multi-signing.html)でもこれを使用して、他の署名者を識別します。 |
| `public_key` | 文字列 | XRP Ledgerの[base58][]エンコード文字列フォーマットで作成された、キーペアの公開鍵。`master_seed`から生成されます。 |
| `public_key_hex` | 文字列 | これは16進数で作成されたキーペアの公開鍵です。`master_seed`から生成されます。トランザクションの署名を検証する場合、`rippled`にはこの公開鍵が必要です。そのため、署名されたトランザクションのフォーマットの`SigningPubKey`フィールドには公開鍵が入力されています。 |
| `warning` | 文字列 | (削除される可能性あり)要求にシード値を指定した場合、このフィールドに安全でない可能性があるという警告が表示されます。[新規: rippled 0.32.0][] |
| `warning` | 文字列 | (削除される可能性あり)リクエストにシード値を指定した場合、このフィールドに安全でない可能性があるという警告が表示されます。[新規: rippled 0.32.0][] |
このメソッドを使用してキーペアを生成し、アカウントのレギュラーキーペアとして使用することもできます。アカウントにレギュラーキーペアを割り当てて、それを使用してほとんどのトランザクションに署名し、マスターキーペアをできるだけオフラインにしておくことも可能です。
@@ -198,7 +198,7 @@ Connecting to 127.0.0.1:5005
* いずれかの[汎用エラータイプ][]。
* `invalidParams` - 1つ以上のフィールドが不正に指定されています。
* `badSeed` - 要求には、空の文字列やXRP Ledgerアドレスに似た文字列などの許可されないシード値が`passphrase``seed`、または`seed_hex`フィールド内に)指定されています。
* `badSeed` - リクエストには、空の文字列やXRP Ledgerアドレスに似た文字列などの許可されないシード値が`passphrase``seed`、または`seed_hex`フィールド内に)指定されています。
<!--{# common link defs #}-->
{% include '_snippets/rippled-api-links.md' %}

View File

@@ -12,9 +12,9 @@ labels:
_`can_delete`メソッドは、権限のないユーザーは実行できない[管理メソッド](admin-api-methods.html)です。_
### 要求フォーマット
### リクエストのフォーマット
要求フォーマットの例:
リクエストのフォーマットの例:
<!-- MULTICODE_BLOCK_START -->
@@ -50,15 +50,15 @@ rippled can_delete 11320417
<!-- MULTICODE_BLOCK_END -->
要求には以下のパラメーターを指定できます。
リクエストには以下のパラメーターを指定できます。
| `Field` | 型 | 説明 |
|:-------------|:------------------|:------------------------------------------|
| `can_delete` | 文字列 または整数 | _省略可_ 削除可能な最大レジャーバージョンの[レジャーインデックス][]。特殊ケース`never`を指定すると、オンライン削除が無効になります。特殊ケース`always`を指定すると、指示による削除が無効な場合と同様に、自動オンライン削除が有効になります。特殊ケース`now`を指定すると、設定されている`online_delete`値に一致するかまたはこの値を超える次の検証済みレジャーで、オンライン削除が1回実行されます。省略すると、サーバーは変更を行いませんただし現在の`can_delete`の値で応答します)。 |
| `can_delete` | 文字列 または整数 | _省略可_ 削除可能な最大レジャーバージョンの[レジャーインデックス][]。特殊ケース`never`を指定すると、オンライン削除が無効になります。特殊ケース`always`を指定すると、指示による削除が無効な場合と同様に、自動オンライン削除が有効になります。特殊ケース`now`を指定すると、設定されている`online_delete`値に一致するかまたはこの値を超える次の検証済みレジャーで、オンライン削除が1回実行されます。省略すると、サーバーは変更を行いませんただし現在の`can_delete`の値でレスポンスします)。 |
### 応答フォーマット
### レスポンスのフォーマット
応答は[標準フォーマット][]に従っており、正常に完了した場合は結果に次のフィールドが含まれています。
レスポンスは[標準フォーマット][]に従っており、正常に完了した場合は結果に次のフィールドが含まれています。
| `Field` | 型 | 説明 |
|:-------------|:--------|:----------------------------------------------------|
@@ -70,7 +70,7 @@ rippled can_delete 11320417
- [汎用エラータイプ][]のすべて。
- `invalidParams` - 1つ以上のフィールドの指定が正しくないか、1つ以上の必須フィールドが指定されていません。
- `lgrNotFound` 要求`can_delete`フィールドに指定されているレジャーが存在しないか、存在しているがサーバーにはありません。
- `lgrNotFound` リクエスト`can_delete`フィールドに指定されているレジャーが存在しないか、存在しているがサーバーにはありません。
- `notEnabled` - オンライン削除または指示による削除のいずれかがサーバーの設定で有効になっていない場合。
- `notReady` - サーバーは現在オンライン削除を実行する準備ができていません。これは通常、サーバーが起動したが、検証済みレジャーをまだ取得していないことを意味します。

View File

@@ -1,7 +1,7 @@
---
html: crawl_shards.html
parent: logging-and-data-management-methods.html
blurb: ピアが持つ履歴シャードについての情報を要求します。
blurb: ピアが持つ履歴シャードについての情報をリクエストします。
labels:
- データ保持
---
@@ -9,13 +9,13 @@ labels:
[[ソース]](https://github.com/XRPLF/rippled/blob/master/src/ripple/rpc/handlers/CrawlShards.cpp "Source")
使用可能な[履歴レジャーデータのシャード](history-sharding.html)に関するピアサーバーからの情報を要求します。[新規: rippled 1.2.0][]
使用可能な[履歴レジャーデータのシャード](history-sharding.html)に関するピアサーバーからの情報をリクエストします。[新規: rippled 1.2.0][]
_`crawl_shards`メソッドは、権限のないユーザーは実行できない[管理メソッド](admin-api-methods.html)です。_
### 要求フォーマット
### リクエストのフォーマット
要求フォーマットの例:
リクエストのフォーマットの例:
<!-- MULTICODE_BLOCK_START -->
@@ -47,19 +47,19 @@ _`crawl_shards`メソッドは、権限のないユーザーは実行できな
**注記:** このメソッドのコマンドライン構文はありません。コマンドラインからアクセスするには[jsonメソッド][]を使用してください。
要求には以下のフィールドが含まれます。
リクエストには以下のフィールドが含まれます。
| `Field` | 型 | 説明 |
|:---------|:--------|:--------------------------------------------------------|
| `pubkey` | ブール値 | _省略可_ `true`の場合、応答には、クロールされたサーバーのノード公開鍵(ピアツーピア通信用)が含まれます。デフォルトは`false`です。 |
| `pubkey` | ブール値 | _省略可_ `true`の場合、レスポンスには、クロールされたサーバーのノード公開鍵(ピアツーピア通信用)が含まれます。デフォルトは`false`です。 |
| `limit` | 数値 | _省略可_ 検索の深さを示すホップ数。デフォルトは0で、ダイレクトピアのみを検索します。`1`を制限値にすると、ピアのピアも検索します。最大値は`3`です。 |
**注意:** `limit`が増加すると、検索される可能性のあるピアの数は、指数関数的に増加します。2または3を制限値にすると、サーバーがAPI要求に応答するのに数秒かかる場合があります。
**注意:** `limit`が増加すると、検索される可能性のあるピアの数は、指数関数的に増加します。2または3を制限値にすると、サーバーがAPIリクエストにレスポンスするのに数秒かかる場合があります。
### 応答フォーマット
### レスポンスのフォーマット
処理が成功した応答の例:
処理が成功したレスポンスの例:
<!-- MULTICODE_BLOCK_START -->
@@ -114,7 +114,7 @@ _`crawl_shards`メソッドは、権限のないユーザーは実行できな
<!-- MULTICODE_BLOCK_END -->
この応答は[標準フォーマット][]に従っており、正常に完了した場合は結果に次のフィールドが含まれます。
このレスポンスは[標準フォーマット][]に従っており、正常に完了した場合は結果に次のフィールドが含まれます。
| `Field` | 型 | 説明 |
|:------------------|:-------|:------------------------------------------------|
@@ -123,7 +123,7 @@ _`crawl_shards`メソッドは、権限のないユーザーは実行できな
#### ピアシャードオブジェクト
応答`peers`配列のメンバーはそれぞれ、ピアツーピアネットワーク内の1つのサーバーを表すオブジェクトです。リストには、少なくとも1つの完全な[履歴シャード](history-sharding.html)が使用可能なピアのみが含まれます。配列の各オブジェクトには以下のフィールドが含まれます。
レスポンス`peers`配列のメンバーはそれぞれ、ピアツーピアネットワーク内の1つのサーバーを表すオブジェクトです。リストには、少なくとも1つの完全な[履歴シャード](history-sharding.html)が使用可能なピアのみが含まれます。配列の各オブジェクトには以下のフィールドが含まれます。
| `Field` | 型 | 説明 |
@@ -136,7 +136,7 @@ _`crawl_shards`メソッドは、権限のないユーザーは実行できな
### 考えられるエラー
- いずれかの[汎用エラータイプ][]。
- `invalidParams` - 要求で1つ以上の必須フィールドが省略されていたか、または指定されたフィールドのデータタイプが誤っています。
- `invalidParams` - リクエストで1つ以上の必須フィールドが省略されていたか、または指定されたフィールドのデータタイプが誤っています。
<!--{# common link defs #}-->

View File

@@ -16,9 +16,9 @@ _`download_shard`メソッドは、権限のないユーザーは実行できな
通常、このメソッドを使用してシャードをダウンロードしてインポートすれば、ピアツーピアネットワークからシャードを個別に取得するよりも短い時間で取得できます。また、サーバーから提供される特定範囲のシャードまたはシャードのセットを選択する場合にもこのメソッドを使用できます。
### 要求フォーマット
### リクエストのフォーマット
要求フォーマットの例:
リクエストのフォーマットの例:
<!-- MULTICODE_BLOCK_START -->
@@ -55,7 +55,7 @@ _`download_shard`メソッドは、権限のないユーザーは実行できな
<!-- MULTICODE_BLOCK_END -->
要求には以下のフィールドが含まれます。
リクエストには以下のフィールドが含まれます。
| `Field` | 型 | 説明 |
|:-----------|:--------|:------------------------------------------------------|
@@ -70,9 +70,9 @@ _`download_shard`メソッドは、権限のないユーザーは実行できな
| `index` | 数値 | 取得するシャードのインデックス。本番環境のXRP Ledgerでは、最も古いシャードのインデックスは1であり、このシャードにはレジャー3275032768が含まれています。次のシャードのインデックスは2であり、このシャードにはレジャー3276949152が含まれています。 |
| `url` | 文字列 | このシャードをダウンロードできるURL。このURLは`https://``http://`かで始まり`.tar.lz4`大文字小文字の区別なしで終わる必要があります。このダウンロードを提供するWebサーバーは、信頼できる認証局CAによって署名された有効なTLS証明書を使用する必要があります。`rippled`はオペレーティングシステムのCAストアーを使用します。 [更新: rippled 1.7.0][] |
### 応答フォーマット
### レスポンスのフォーマット
処理が成功した応答の例:
処理が成功したレスポンスの例:
<!-- MULTICODE_BLOCK_START -->
@@ -105,11 +105,11 @@ _`download_shard`メソッドは、権限のないユーザーは実行できな
<!-- MULTICODE_BLOCK_END -->
この応答は[標準フォーマット][]に従っており、正常に完了した場合は結果に次のフィールドが含まれます。
このレスポンスは[標準フォーマット][]に従っており、正常に完了した場合は結果に次のフィールドが含まれます。
| `Field` | 型 | 説明 |
|:----------|:-------|:--------------------------------------------------------|
| `message` | 文字列 | この要求に対応して実行されたアクションを説明するメッセージ。 |
| `message` | 文字列 | このリクエストに対応して実行されたアクションを説明するメッセージ。 |
**ヒント:** サーバーで使用可能なシャードを確認するには、[crawl_shardsメソッド[]を使用します。または、シャードストアーとして設定されたロケーションのサブフォルダー(`rippled.cfg``[shard_db]``path`パラメーターを調べます。フォルダーには、シャードの番号に対応する名前が付いています。これらのフォルダーの1つに、シャードが未完了であることを示す`control.txt`ファイルが含まれていることがあります。
@@ -117,8 +117,8 @@ _`download_shard`メソッドは、権限のないユーザーは実行できな
- いずれかの[汎用エラータイプ][]。
- `notEnabled` - サーバーでシャードストアーを使用するように設定されていません。
- `tooBusy` - サーバーはすでに、ピアツーピアネットワークから、または以前の`download_shard`要求の結果として、シャードをダウンロード中です。
- `invalidParams` - 要求で1つ以上の必須フィールドが省略されていたか、または指定されたフィールドのデータタイプが誤っています。
- `tooBusy` - サーバーはすでに、ピアツーピアネットワークから、または以前の`download_shard`リクエストの結果として、シャードをダウンロード中です。
- `invalidParams` - リクエストで1つ以上の必須フィールドが省略されていたか、または指定されたフィールドのデータタイプが誤っています。
<!--{# common link defs #}-->
{% include '_snippets/rippled-api-links.md' %}

View File

@@ -12,8 +12,8 @@ labels:
_`ledger_cleaner`メソッドは、権限のないユーザーは実行できない[管理メソッド](admin-api-methods.html)です。_
### 要求フォーマット
要求フォーマットの例:
### リクエストのフォーマット
リクエストのフォーマットの例:
<!-- MULTICODE_BLOCK_START -->
@@ -30,7 +30,7 @@ _`ledger_cleaner`メソッドは、権限のないユーザーは実行できな
<!-- MULTICODE_BLOCK_END -->
要求には以下のパラメーターが含まれます。
リクエストには以下のパラメーターが含まれます。
| `Field` | 型 | 説明 |
|:--------------|:--------------------------|:---------------------------------|
@@ -42,9 +42,9 @@ _`ledger_cleaner`メソッドは、権限のないユーザーは実行できな
| `check_nodes` | ブール値 | _省略可_ trueの場合は、指定されているレジャーのレジャー状態オブジェクトを修正します。指定されている場合は`full`をオーバーライドします。 |
| `stop` | ブール値 | _省略可_ trueの場合は、レジャークリーナーを無効にします。 |
### 応答フォーマット
### レスポンスのフォーマット
処理が成功した応答の例:
処理が成功したレスポンスの例:
<!-- MULTICODE_BLOCK_START -->
@@ -64,7 +64,7 @@ _`ledger_cleaner`メソッドは、権限のないユーザーは実行できな
<!-- MULTICODE_BLOCK_END -->
この応答は[標準フォーマット][]に従っており、正常に完了した場合は結果に次のフィールドが含まれます。
このレスポンスは[標準フォーマット][]に従っており、正常に完了した場合は結果に次のフィールドが含まれます。
| `Field` | 型 | 説明 |
|:----------|:-------|:---------------------------------|

View File

@@ -10,10 +10,10 @@ labels:
`ledger_request`コマンドは、サーバーに対し接続しているピアから特定のレジャーバージョンを取得するように指示します。これは、サーバーが直接接続しているピアの1つにそのレジャーが存在している場合にのみ機能します。場合によっては、レジャーを完全に取得するにはこのコマンドを繰り返し実行する必要があります。
*`ledger_request`要求は、権限のないユーザーは実行できない[管理メソッド](admin-api-methods.html)です。*
*`ledger_request`リクエストは、権限のないユーザーは実行できない[管理メソッド](admin-api-methods.html)です。*
### 要求フォーマット
要求フォーマットの例:
### リクエストのフォーマット
リクエストのフォーマットの例:
<!-- MULTICODE_BLOCK_START -->
@@ -35,7 +35,7 @@ rippled ledger_request 13800000
<!-- MULTICODE_BLOCK_END -->
要求には以下のパラメーターが含まれます。
リクエストには以下のパラメーターが含まれます。
| `Field` | 型 | 説明 |
|:---------------|:-------|:---------------------------------------------------|
@@ -44,13 +44,13 @@ rippled ledger_request 13800000
`ledger_index`または`ledger_hash`のいずれかを指定する必要がありますが、両方は指定しないでください。
### 応答フォーマット
### レスポンスのフォーマット
応答は[標準フォーマット][]に従っています。ただし、_`rippled`サーバーに対してレジャーの取得開始を正常に指示できた場合でも_、指定されたレジャーがない場合には失敗を示す応答が要求から返されます。
レスポンスは[標準フォーマット][]に従っています。ただし、_`rippled`サーバーに対してレジャーの取得開始を正常に指示できた場合でも_、指定されたレジャーがない場合には失敗を示すレスポンスがリクエストから返されます。
**注記:** レジャーを取得するには、rippledサーバーのダイレクトピアの履歴にそのレジャーが含まれている必要があります。どのピアにも要求されたレジャーがない場合は、[connectメソッド][]または構成ファイルの`fixed_ips`セクションを使用して、`s2.ripple.com`にあるRippleのすべての履歴が記録されるサーバーを追加すれば、`ledger_request`要求を再度実行できます。
**注記:** レジャーを取得するには、rippledサーバーのダイレクトピアの履歴にそのレジャーが含まれている必要があります。どのピアにもリクエストされたレジャーがない場合は、[connectメソッド][]または構成ファイルの`fixed_ips`セクションを使用して、`s2.ripple.com`にあるRippleのすべての履歴が記録されるサーバーを追加すれば、`ledger_request`リクエストを再度実行できます。
失敗した場合の応答には、レジャーの取得状況が示されます。成功した場合の応答には、[ledgerメソッド][]に類似したフォーマットでレジャーの情報が含まれます。
失敗した場合のレスポンスには、レジャーの取得状況が示されます。成功した場合のレスポンスには、[ledgerメソッド][]に類似したフォーマットでレジャーの情報が含まれます。
<!-- MULTICODE_BLOCK_START -->
@@ -160,22 +160,22 @@ Connecting to 127.0.0.1:5005
<!-- MULTICODE_BLOCK_END -->
3つの応答フォーマットは次のとおりです。
3つのレスポンスのフォーマットは次のとおりです。
1. `lgrNotFound`エラーが返された場合、応答`acquiring`フィールドには、ピアツーピアネットワークからのレジャー取得状況を示す[レジャー要求オブジェクト](#レジャー要求オブジェクト)が指定されています。
2. サーバーが現在データを取得中であると応答に示される場合、その結果の本文として、ピアツーピアネットワークからのレジャー取得状況を示す[レジャー要求オブジェクト](#レジャー要求オブジェクト)が表示されます。
3. レジャーが完全に利用可能な場合、応答には[レジャーヘッダー](ledger-header.html)が表示されます。
1. `lgrNotFound`エラーが返された場合、レスポンス`acquiring`フィールドには、ピアツーピアネットワークからのレジャー取得状況を示す[レジャーリクエストオブジェクト](#レジャーリクエストオブジェクト)が指定されています。
2. サーバーが現在データを取得中であるとレスポンスに示される場合、その結果の本文として、ピアツーピアネットワークからのレジャー取得状況を示す[レジャーリクエストオブジェクト](#レジャーリクエストオブジェクト)が表示されます。
3. レジャーが完全に利用可能な場合、レスポンスには[レジャーヘッダー](ledger-header.html)が表示されます。
### レジャー要求オブジェクト
### レジャーリクエストオブジェクト
サーバーでレジャーの取得操作が進行中であり、まだ完了していない場合は、`rippled`サーバーはレジャー取得状況を示すレジャー要求オブジェクトを返します。このオブジェクトのフィールドを次に示します。
サーバーでレジャーの取得操作が進行中であり、まだ完了していない場合は、`rippled`サーバーはレジャー取得状況を示すレジャーリクエストオブジェクトを返します。このオブジェクトのフィールドを次に示します。
| `Field` | 型 | 説明 |
|:----------------------------|:-----------------|:----------------------------|
| `hash` | 文字列 | (省略される場合があります)要求されるレジャーの[ハッシュ][](サーバーがこのハッシュを認識している場合)。 |
| `have_header` | ブール値 | 要求されたレジャーのヘッダーセクションがサーバーにあるかどうか。 |
| `have_state` | ブール値 | (省略される場合があります)要求されたレジャーの完全な状態データがサーバーにあるかどうか。 |
| `have_transactions` | ブール値 | (省略される場合があります)要求されたレジャーの完全なトランザクションセットがサーバーにあるかどうか。 |
| `hash` | 文字列 | (省略される場合があります)リクエストされるレジャーの[ハッシュ][](サーバーがこのハッシュを認識している場合)。 |
| `have_header` | ブール値 | リクエストされたレジャーのヘッダーセクションがサーバーにあるかどうか。 |
| `have_state` | ブール値 | (省略される場合があります)リクエストされたレジャーの完全な状態データがサーバーにあるかどうか。 |
| `have_transactions` | ブール値 | (省略される場合があります)リクエストされたレジャーの完全なトランザクションセットがサーバーにあるかどうか。 |
| `needed_state_hashes` | 文字列の配列 | 省略される場合がありますサーバーが取得する必要がある完全な状態データ内のオブジェクトのハッシュ最大16個。 |
| `needed_transaction_hashes` | 文字列の配列 | 省略される場合がありますサーバーが取得する必要があるトランザクションセットのオブジェクトのハッシュ最大16個。 |
| `peers` | 数値 | このレジャーを見つけるためにサーバーが照会するピアの数。 |
@@ -185,7 +185,7 @@ Connecting to 127.0.0.1:5005
* [汎用エラータイプ][]のすべて。
* `invalidParams` - 1つ以上のフィールドの指定が正しくないか、1つ以上の必須フィールドが指定されていません。このエラーは、指定したレジャーインデックスが現在進行中のレジャーのインデックス以上である場合にも発生します。
* `lgrNotFound` - レジャーがまだ利用可能ではない場合。これは、サーバーがレジャーの取得を開始していますが、要求されたレジャーが接続されたどのピアにもない場合には失敗する可能性があることを意味します。(以前はこのエラーにはコード`ledgerNotFound`が使用されていました。)[更新: rippled 0.30.1][新規: rippled 0.30.1]
* `lgrNotFound` - レジャーがまだ利用可能ではない場合。これは、サーバーがレジャーの取得を開始していますが、リクエストされたレジャーが接続されたどのピアにもない場合には失敗する可能性があることを意味します。(以前はこのエラーにはコード`ledgerNotFound`が使用されていました。)[更新: rippled 0.30.1][新規: rippled 0.30.1]
<!--{# common link defs #}-->
{% include '_snippets/rippled-api-links.md' %}

View File

@@ -12,8 +12,8 @@ labels:
_`log_level`メソッドは、権限のないユーザーは実行できない[管理メソッド](admin-api-methods.html)です。_
### 要求フォーマット
要求フォーマットの例:
### リクエストのフォーマット
リクエストのフォーマットの例:
<!-- MULTICODE_BLOCK_START -->
@@ -37,16 +37,16 @@ rippled log_level PathRequest debug
<!-- MULTICODE_BLOCK_END -->
要求には以下のパラメーターが含まれます。
リクエストには以下のパラメーターが含まれます。
| `Field` | 型 | 説明 |
|:------------|:-------|:------------------------------------------------------|
| `severity` | 文字列 | _省略可_ 設定するログの詳細レベル。以下に、有効な値を詳細レベルの低いものから順に示します。`fatal``error``warn``info``debug`、および`trace`。省略すると、すべてのカテゴリーの現在のログ詳細レベルが返されます。 |
| `partition` | 文字列 | _省略可_`severity`が指定されていない場合は無視されます。変更するログカテゴリー。省略されている場合、または`base`の値が指定されている場合は、すべてのカテゴリーのログレベルを設定します。 |
### 応答フォーマット
### レスポンスのフォーマット
成功した場合の応答例:
成功した場合のレスポンス例:
<!-- MULTICODE_BLOCK_START -->
@@ -130,13 +130,13 @@ Connecting to 127.0.0.1:5005
<!-- MULTICODE_BLOCK_END -->
応答は[標準フォーマット][]に従っています。応答フォーマットは、要求`severity`が指定されているかどうかに応じて異なります。指定されていた場合はログレベルが変更され、成功した場合の結果には追加フィールドが含まれません。
レスポンスは[標準フォーマット][]に従っています。レスポンスのフォーマットは、リクエスト`severity`が指定されているかどうかに応じて異なります。指定されていた場合はログレベルが変更され、成功した場合の結果には追加フィールドが含まれません。
それ以外の場合、要求には以下のフィールドが含まれます。
それ以外の場合、リクエストには以下のフィールドが含まれます。
| `Field` | 型 | 説明 |
|:--------|:-------|:----------------------------------------------------------|
| `level` | オブジェクト | 各カテゴリーの現在のログレベル。このカテゴリーリストは、今後のリリースで予告なく変更される場合があります。このコマンドに対する要求で、フィールド名を`partition`の値として使用できます。 |
| `level` | オブジェクト | 各カテゴリーの現在のログレベル。このカテゴリーリストは、今後のリリースで予告なく変更される場合があります。このコマンドに対するリクエストで、フィールド名を`partition`の値として使用できます。 |
### 考えられるエラー

View File

@@ -40,8 +40,8 @@ labels:
_`logrotate`メソッドは、権限のないユーザーは実行できない[管理メソッド](admin-api-methods.html)です。_
### 要求フォーマット
要求フォーマットの例:
### リクエストのフォーマット
リクエストのフォーマットの例:
<!-- MULTICODE_BLOCK_START -->
@@ -63,11 +63,11 @@ rippled logrotate
<!-- MULTICODE_BLOCK_END -->
要求にはパラメーターが含まれていません。
リクエストにはパラメーターが含まれていません。
### 応答フォーマット
### レスポンスのフォーマット
処理が成功した応答の例:
処理が成功したレスポンスの例:
<!-- MULTICODE_BLOCK_START -->
@@ -102,7 +102,7 @@ Connecting to 127.0.0.1:5005
<!-- MULTICODE_BLOCK_END -->
この応答は[標準フォーマット][]に従っており、正常に完了した場合は結果に次のフィールドが含まれます。
このレスポンスは[標準フォーマット][]に従っており、正常に完了した場合は結果に次のフィールドが含まれます。
| `Field` | 型 | 説明 |
|:----------|:-------|:--------------------------------------------------------|

View File

@@ -13,9 +13,9 @@ labels:
_`{{currentpage.name}}`メソッドは、権限のないユーザーには実行できない[管理メソッド](admin-api-methods.html)です。_
### リクエストフォーマット
### リクエストフォーマット
リクエストフォーマット例:
リクエストフォーマット例:
<!-- MULTICODE_BLOCK_START -->
@@ -55,7 +55,7 @@ rippled {{currentpage.name}} start
| `action` | String | どのような動作をさせるかによって、 `start``stop` または `status` のいずれかを指定します。 |
### レスポンスフォーマット
### レスポンスフォーマット
正常レスポンス例:
@@ -106,7 +106,7 @@ Connecting to 127.0.0.1:5005
| `項目` | 型 | 説明 |
|:----------|:-------|:--------------------------------------------------------|
| `message` | 文字列 | コマンドに応答して実行されたアクションを示す、可読性の高いメッセージ。 |
| `message` | 文字列 | コマンドにレスポンスして実行されたアクションを示す、可読性の高いメッセージ。 |
### 起こり得るエラー

View File

@@ -10,10 +10,10 @@ labels:
`connect`コマンドは、`rippled`サーバーを特定のピア`rippled`サーバーに強制的に接続します。
*`connect`要求は、権限のないユーザーは実行できない[管理メソッド](admin-api-methods.html)です。*
*`connect`リクエストは、権限のないユーザーは実行できない[管理メソッド](admin-api-methods.html)です。*
### 要求フォーマット
要求フォーマットの例:
### リクエストのフォーマット
リクエストのフォーマットの例:
<!-- MULTICODE_BLOCK_START -->
@@ -51,16 +51,16 @@ rippled connect 192.170.145.88 51235
<!-- MULTICODE_BLOCK_END -->
要求には以下のパラメーターが含まれます。
リクエストには以下のパラメーターが含まれます。
| `Field` | 型 | 説明 |
|:--------|:-------|:----------------------------------------------------------|
| `ip` | 文字列 | 接続するサーバーのIPアドレス。 |
| `port` | 数値 | _省略可_ 接続時に使用するポート番号。デフォルトでは**2459**です。 [新規: rippled 1.6.0][] |
### 応答フォーマット
### レスポンスのフォーマット
処理が成功した応答の例:
処理が成功したレスポンスの例:
<!-- MULTICODE_BLOCK_START -->
@@ -91,7 +91,7 @@ Connecting to 127.0.0.1:5005
<!-- MULTICODE_BLOCK_END -->
この応答は[標準フォーマット][]に従っており、正常に完了した場合は結果に次のフィールドが含まれています。
このレスポンスは[標準フォーマット][]に従っており、正常に完了した場合は結果に次のフィールドが含まれています。
| `Field` | 型 | 説明 |
|:----------|:-------|:-------------------------------------------------------|

View File

@@ -13,9 +13,9 @@ labels:
_`{{currentpage.name}}`メソッドは、権限のないユーザーは実行できない[管理メソッド](admin-api-methods.html)です。_
### 要求フォーマット
### リクエストのフォーマット
要求フォーマットの例:
リクエストのフォーマットの例:
<!-- MULTICODE_BLOCK_START -->
@@ -51,7 +51,7 @@ rippled {{currentpage.name}} n9Jt8awsPzWLjBCNKVEEDQnw4bQEPjezfcQ4gttD1UzbLT1FoG9
<!-- MULTICODE_BLOCK_END -->
要求には以下のパラメーターが含まれます。
リクエストには以下のパラメーターが含まれます。
| `Field` | 型 | 説明 |
|:--------------|:-------|:----------------------------------------------------|
@@ -60,9 +60,9 @@ rippled {{currentpage.name}} n9Jt8awsPzWLjBCNKVEEDQnw4bQEPjezfcQ4gttD1UzbLT1FoG9
### 応答フォーマット
### レスポンスのフォーマット
処理が成功した応答の例:
処理が成功したレスポンスの例:
<!-- MULTICODE_BLOCK_START -->
@@ -115,7 +115,7 @@ Connecting to 127.0.0.1:5005
<!-- MULTICODE_BLOCK_END -->
この応答は[標準フォーマット][]に従っており、正常に完了した場合は結果に次のフィールドが含まれます。
このレスポンスは[標準フォーマット][]に従っており、正常に完了した場合は結果に次のフィールドが含まれます。
| `Field` | 型 | 説明 |
|:-----------|:-------|:-------------------------------------------------------|
@@ -135,7 +135,7 @@ Connecting to 127.0.0.1:5005
- いずれかの[汎用エラータイプ][]。
- `invalidParams` - 1つ以上のフィールドの指定が正しくないか、1つ以上の必須フィールドが指定されていません。
- `publicMalformed` - 要求`public_key`フィールドが無効です。[base58][]フォーマットの有効なノード公開鍵である必要があります。
- `publicMalformed` - リクエスト`public_key`フィールドが無効です。[base58][]フォーマットの有効なノード公開鍵である必要があります。
<!--{# common link defs #}-->
{% include '_snippets/rippled-api-links.md' %}

View File

@@ -15,9 +15,9 @@ _`{{currentpage.name}}`メソッドは、権限のないユーザーは実行で
**注記:** ピアリザベーションを削除しても、対応するピアが接続されている場合、そのピアは自動的に切断されません。
### 要求フォーマット
### リクエストのフォーマット
要求フォーマットの例:
リクエストのフォーマットの例:
<!-- MULTICODE_BLOCK_START -->
@@ -51,16 +51,16 @@ rippled {{currentpage.name}} n9Jt8awsPzWLjBCNKVEEDQnw4bQEPjezfcQ4gttD1UzbLT1FoG9
<!-- MULTICODE_BLOCK_END -->
要求には以下のパラメーターが含まれます。
リクエストには以下のパラメーターが含まれます。
| `Field` | 型 | 説明 |
|:------------|:--------------------------|:-----------------------------------|
| `public_key` | 文字列 | 削除する[ピアリザベーション][]の[ノード公開鍵][][base58][]フォーマット) |
### 応答フォーマット
### レスポンスのフォーマット
処理が成功した応答の例:
処理が成功したレスポンスの例:
<!-- MULTICODE_BLOCK_START -->
@@ -113,7 +113,7 @@ Connecting to 127.0.0.1:5005
<!-- MULTICODE_BLOCK_END -->
この応答は[標準フォーマット][]に従っており、正常に完了した場合は結果に次のフィールドが含まれます。
このレスポンスは[標準フォーマット][]に従っており、正常に完了した場合は結果に次のフィールドが含まれます。
| `Field` | 型 | 説明 |
|:--------|:-------|:----------------------------------------------------------|
@@ -132,7 +132,7 @@ Connecting to 127.0.0.1:5005
- いずれかの[汎用エラータイプ][]。
- `invalidParams` - 1つ以上のフィールドの指定が正しくないか、1つ以上の必須フィールドが指定されていません。
- `publicMalformed` - 要求`public_key`フィールドが無効です。[base58][]フォーマットの有効なノード公開鍵である必要があります。
- `publicMalformed` - リクエスト`public_key`フィールドが無効です。[base58][]フォーマットの有効なノード公開鍵である必要があります。
<!--{# common link defs #}-->
{% include '_snippets/rippled-api-links.md' %}

View File

@@ -13,9 +13,9 @@ labels:
_`{{currentpage.name}}`メソッドは、権限のないユーザーは実行できない[管理メソッド](admin-api-methods.html)です。_
### 要求フォーマット
### リクエストのフォーマット
要求フォーマットの例:
リクエストのフォーマットの例:
<!-- MULTICODE_BLOCK_START -->
@@ -45,12 +45,12 @@ rippled {{currentpage.name}}
<!-- MULTICODE_BLOCK_END -->
この要求にはパラメーターは含まれません。
このリクエストにはパラメーターは含まれません。
### 応答フォーマット
### レスポンスのフォーマット
処理が成功した応答の例:
処理が成功したレスポンスの例:
<!-- MULTICODE_BLOCK_START -->
@@ -118,7 +118,7 @@ Loading: "/etc/rippled.cfg"
<!-- MULTICODE_BLOCK_END -->
この応答は[標準フォーマット][]に従っており、正常に完了した場合は結果に次のフィールドが含まれます。
このレスポンスは[標準フォーマット][]に従っており、正常に完了した場合は結果に次のフィールドが含まれます。
| `Field` | 型 | 説明 |
|:---------------|:------|:----------------------------------------------------|

View File

@@ -10,10 +10,10 @@ labels:
`peers`コマンドは、[ピアプロトコル](peer-protocol.html)でこのサーバーに現在接続されているその他のすべての`rippled`サーバーのリスト(各サーバーの接続状況と同期状況を含む)を返します。
*`peers`要求は、権限のないユーザーは実行できない[管理メソッド](admin-api-methods.html)です。*
*`peers`リクエストは、権限のないユーザーは実行できない[管理メソッド](admin-api-methods.html)です。*
### 要求フォーマット
要求フォーマットの例:
### リクエストのフォーマット
リクエストのフォーマットの例:
<!-- MULTICODE_BLOCK_START -->
@@ -34,11 +34,11 @@ rippled peers
<!-- MULTICODE_BLOCK_END -->
この要求には追加パラメーターはありません。
このリクエストには追加パラメーターはありません。
### 応答フォーマット
### レスポンスのフォーマット
処理が成功した応答の例:
処理が成功したレスポンスの例:
<!-- MULTICODE_BLOCK_START -->
@@ -378,7 +378,7 @@ Connecting to 127.0.0.1:5005
<!-- MULTICODE_BLOCK_END -->
応答は[標準フォーマット][]に従っており、正常に完了した場合は結果に次のフィールドからなるJSONオブジェクトが含まれます。
レスポンスは[標準フォーマット][]に従っており、正常に完了した場合は結果に次のフィールドからなるJSONオブジェクトが含まれます。
| `Field` | 型 | 説明 |
|:----------|:-------|:--------------------------------------------------------|

View File

@@ -12,9 +12,9 @@ labels:
*`ledger_accept`メソッドは、権限のないユーザーは実行できない[管理メソッド](admin-api-methods.html)です。*
### 要求フォーマット
### リクエストのフォーマット
要求フォーマットの例:
リクエストのフォーマットの例:
<!-- MULTICODE_BLOCK_START -->
@@ -36,11 +36,11 @@ rippled ledger_accept
<!-- MULTICODE_BLOCK_END -->
この要求はパラメーターを受け入れません。
このリクエストはパラメーターを受け入れません。
### 応答フォーマット
### レスポンスのフォーマット
処理が成功した応答の例:
処理が成功したレスポンスの例:
```js
{
"id": "Accept my ledger!",
@@ -52,7 +52,7 @@ rippled ledger_accept
}
```
応答は[標準フォーマット][]に従っており、正常に完了した場合は結果に次のフィールドが含まれます。
レスポンスは[標準フォーマット][]に従っており、正常に完了した場合は結果に次のフィールドが含まれます。
| `Field` | 型 | 説明 |
|:-----------------------|:-----------------|:---------------------------------|

View File

@@ -10,10 +10,10 @@ labels:
サーバーのグレースフルシャットダウンを行います。
_`stop`要求は、権限のないユーザーは実行できない*[管理メソッド](admin-api-methods.html)です。_
_`stop`リクエストは、権限のないユーザーは実行できない*[管理メソッド](admin-api-methods.html)です。_
### 要求フォーマット
要求フォーマットの例:
### リクエストのフォーマット
リクエストのフォーマットの例:
<!-- MULTICODE_BLOCK_START -->
@@ -45,11 +45,11 @@ rippled stop
<!-- MULTICODE_BLOCK_END -->
要求にはパラメーターが含まれていません。
リクエストにはパラメーターが含まれていません。
### 応答フォーマット
### レスポンスのフォーマット
処理が成功した応答の例:
処理が成功したレスポンスの例:
<!-- MULTICODE_BLOCK_START -->
@@ -80,7 +80,7 @@ Connecting to 127.0.0.1:5005
<!-- MULTICODE_BLOCK_END -->
応答は[標準フォーマット][]に従っており、正常に完了した場合は結果に次のフィールドが含まれています。
レスポンスは[標準フォーマット][]に従っており、正常に完了した場合は結果に次のフィールドが含まれています。
| `Field` | 型 | 説明 |
|:----------|:-------|:-------------------------------------|

View File

@@ -11,10 +11,10 @@ labels:
`validation_seed`コマンドは、rippledが検証の署名に使用するシークレット値を一時的に設定します。サーバーを再起動すると、この値は構成ファイルに基づいてリセットされます。[rippled 0.29.1 以降では無効](https://github.com/XRPLF/rippled/releases/tag/0.29.1-rc1 "BADGE_RED")
*`validation_seed`要求は、権限のないユーザーは実行できない[管理メソッド](admin-api-methods.html)です。*
*`validation_seed`リクエストは、権限のないユーザーは実行できない[管理メソッド](admin-api-methods.html)です。*
### 要求フォーマット
要求フォーマットの例:
### リクエストのフォーマット
リクエストのフォーマットの例:
<!-- MULTICODE_BLOCK_START -->
@@ -37,15 +37,15 @@ rippled validation_seed 'BAWL MAN JADE MOON DOVE GEM SON NOW HAD ADEN GLOW TIRE'
<!-- MULTICODE_BLOCK_END -->
要求には以下のパラメーターが含まれます。
リクエストには以下のパラメーターが含まれます。
| `Field` | 型 | 説明 |
|:---------|:-------|:---------------------------------------------------------|
| `secret` | 文字列 | _省略可_ 指定されている場合は、この値はキーペアの検証のためのシークレット値として使用されます。有効なフォーマットには、XRP Ledgerの[base58][]フォーマット、[RFC-1751](https://tools.ietf.org/html/rfc1751)、またはパスフレーズがあります。省略されている場合は、ネットワークへの検証の提案が無効になります。 |
### 応答フォーマット
### レスポンスのフォーマット
処理が成功した応答の例:
処理が成功したレスポンスの例:
<!-- MULTICODE_BLOCK_START -->
@@ -82,7 +82,7 @@ Connecting to 127.0.0.1:5005
<!-- MULTICODE_BLOCK_END -->
この応答は[標準フォーマット][]に従っており、正常に完了した場合は結果に次のフィールドが含まれています。
このレスポンスは[標準フォーマット][]に従っており、正常に完了した場合は結果に次のフィールドが含まれています。
| `Field` | 型 | 説明 |
|:------------------------|:-------|:------------------------------------------|
@@ -93,7 +93,7 @@ Connecting to 127.0.0.1:5005
### 考えられるエラー
* [汎用エラータイプ][]のすべて。
* `badSeed` - 要求に無効なシークレット値が指定されていました。この場合は通常、シークレット値が異なるフォーマットの有効文字列(アカウントアドレス、検証の公開鍵など)である可能性があります。
* `badSeed` - リクエストに無効なシークレット値が指定されていました。この場合は通常、シークレット値が異なるフォーマットの有効文字列(アカウントアドレス、検証の公開鍵など)である可能性があります。
<!--{# common link defs #}-->
{% include '_snippets/rippled-api-links.md' %}

View File

@@ -15,8 +15,8 @@ labels:
**注意:** 独自の`rippled`サーバーを運用している場合を除き、このコマンドを使用するのではなく、[クライアントライブラリ](client-libraries.html)を実行してください。詳細については[安全な署名の設定](secure-signing.html)を参照してください。
## 要求フォーマット
要求フォーマットの例:
## リクエストのフォーマット
リクエストのフォーマットの例:
<!-- MULTICODE_BLOCK_START -->
@@ -81,7 +81,7 @@ rippled sign s██████████████████████
* `secret`フィールドにシードを指定し、`key_type`フィールドを省略します。この値は、XRP Ledgerの[base58][]シード、RFC-1751、16進値のフォーマットで記述するか、文字列パスフレーズとして記述しますsecp256k1キーのみ
* `key_type`値と、`seed``seed_hex`、または`passphrase`のいずれか1つを提供します。`secret`フィールドは省略します。(コマンドライン構文ではサポートされません)。
要求には以下のパラメーターが含まれます。
リクエストには以下のパラメーターが含まれます。
| `Field` | 型 | 説明 |
|:---------------|:--------|:--------------------------------------------------|
@@ -98,19 +98,19 @@ rippled sign s██████████████████████
### 自動入力可能なフィールド
`tx_json`[トランザクションオブジェクト](transaction-formats.html))の特定のフィールドを省略すると、サーバーは自動的に入力しようとします。要求`offline``true`と指定しない限り、サーバーは署名前に以下のフィールドを提供します。
`tx_json`[トランザクションオブジェクト](transaction-formats.html))の特定のフィールドを省略すると、サーバーは自動的に入力しようとします。リクエスト`offline``true`と指定しない限り、サーバーは署名前に以下のフィールドを提供します。
* `Sequence` - サーバーは、送信者のアカウント情報にある次のシーケンス番号を自動的に使用します。
* **注意:** アカウントの次のシーケンス番号は、このトランザクションが適用されるまで増分されません。トランザクションの送信および個々のトランザクションへの応答を待たずに複数のトランザクションに署名する場合は、最初のトランザクション以降の各トランザクションについて、正しいシーケンス番号を手動で提供する必要があります。
* **注意:** アカウントの次のシーケンス番号は、このトランザクションが適用されるまで増分されません。トランザクションの送信および個々のトランザクションへのレスポンスを待たずに複数のトランザクションに署名する場合は、最初のトランザクション以降の各トランザクションについて、正しいシーケンス番号を手動で提供する必要があります。
* `Fee` - `Fee`パラメーターを省略した場合、サーバーは適切なトランザクションコストを自動的に入力しようとします。本番環境のXRP Ledgerでは、適切な`fee_mult_max`値を提供しない限り、この処理は`rpcHIGH_FEE`エラーで失敗します。
* `fee_mult_max`パラメーターと`fee_div_max`パラメーターは、[リファレンストランザクションコスト](transaction-cost.html#referenceトランザクションコスト)に適用される負荷スケーリング乗数によって、自動的に提供されるトランザクションコストの上限値を設定します。デフォルト設定では、自動的に提供される値が10×の乗数より大きい場合、エラーが返されます。ただし、本番環境のXRP Ledgerでは、[1000×の負荷乗数を使用することが一般的](transaction-cost.html#現在のトランザクションコスト)です。
* コマンドライン構文では、`fee_mult_max`および`fee_div_max`はサポートされません。本番環境のXRP Ledgerの場合は、`Fee`値を提供する必要があります。
* **注意:** 悪意のあるサーバーは、`fee_mult_max``fee_div_max`の値を無視して、きわめて大きなトランザクションコストを指定するおそれがあります。
* `Paths` - Payment型のトランザクションの場合XRP間の移動を除く、Pathsフィールドは、[ripple_path_findメソッド][]を使用した場合と同様に自動的に入力できます。`build_path`を指定した場合のみ入力されます。
## 応答フォーマット
## レスポンスのフォーマット
処理が成功した応答の例:
処理が成功したレスポンスの例:
<!-- MULTICODE_BLOCK_START -->
@@ -204,14 +204,14 @@ Connecting to 127.0.0.1:5005
<!-- MULTICODE_BLOCK_END -->
この応答は[標準フォーマット][]に従っており、正常に完了した場合は結果に次のフィールドが含まれます。
このレスポンスは[標準フォーマット][]に従っており、正常に完了した場合は結果に次のフィールドが含まれます。
| `Field` | 型 | 説明 |
|:----------|:-------|:--------------------------------------------------------|
| `tx_blob` | 文字列 | 正しく作成された署名済みトランザクションの16進バイナリー表現 |
| `tx_json` | オブジェクト | 自動的に入力されたフィールドを含む、署名済み[トランザクション全体](transaction-formats.html)のJSON仕様 |
**注意:** このコマンドの結果としてエラーメッセージが表示された場合は、要求で指定されたシークレット値がメッセージの中に含まれている可能性があります。これらのエラーが他者から見えない状態であることを確認してください。
**注意:** このコマンドの結果としてエラーメッセージが表示された場合は、リクエストで指定されたシークレット値がメッセージの中に含まれている可能性があります。これらのエラーが他者から見えない状態であることを確認してください。
* このエラーは、複数の人物が参照できるログファイルに書き込まないでください。
* デバッグを目的として、誰でも参照できる場所にこのエラーを貼り付けないでください。
@@ -221,7 +221,7 @@ Connecting to 127.0.0.1:5005
* いずれかの[汎用エラータイプ][]。
* `invalidParams` - 1つ以上のフィールドの指定が正しくないか、1つ以上の必須フィールドが指定されていません。
* `highFee` - トランザクションコストに適用される現在の負荷乗数が、自動的に提供されるトランザクションコストの上限を超えています。要求で指定する`fee_mult_max`を大きくするか1000以上`tx_json``Fee`フィールドに値を手動で指定します。
* `highFee` - トランザクションコストに適用される現在の負荷乗数が、自動的に提供されるトランザクションコストの上限を超えています。リクエストで指定する`fee_mult_max`を大きくするか1000以上`tx_json``Fee`フィールドに値を手動で指定します。
* `tooBusy` - トランザクションにパスが含まれていませんが、サーバーがビジーであるため、パス検出処理をすぐに実行できません。管理者として接続している場合は発生しません。
* `noPath` - トランザクションにパスが含まれておらず、サーバーは、このペイメントの発生経路となるパスを検出できませんでした。

View File

@@ -15,8 +15,8 @@ labels:
このコマンドを使用するには、[MultiSign Amendment][]が有効になっている必要があります。[新規: rippled 0.31.0][]
## 要求フォーマット
要求フォーマットの例:
## リクエストのフォーマット
リクエストのフォーマットの例:
<!-- MULTICODE_BLOCK_START -->
@@ -92,7 +92,7 @@ rippled sign_for rsA2LpzuawewSBQXkiju3YQTMzW13pAAdW s█████████
<!-- MULTICODE_BLOCK_END -->
要求には以下のパラメーターが含まれます。
リクエストには以下のパラメーターが含まれます。
| `Field` | 型 | 説明 |
|:-------------|:---------------------|:---------------------------------------|
@@ -102,16 +102,16 @@ rippled sign_for rsA2LpzuawewSBQXkiju3YQTMzW13pAAdW s█████████
| `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のサポートは実験的な機能です。 |
| `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`フィールドは省略します。(コマンドライン構文ではサポートされません。)
## 応答フォーマット
## レスポンスのフォーマット
処理が成功した応答の例:
処理が成功したレスポンスの例:
<!-- MULTICODE_BLOCK_START -->
@@ -225,7 +225,7 @@ Connecting to 127.0.0.1:5005
<!-- MULTICODE_BLOCK_END -->
この応答は[標準フォーマット][]に従っており、正常に完了した場合は結果に次のフィールドが含まれます。
このレスポンスは[標準フォーマット][]に従っており、正常に完了した場合は結果に次のフィールドが含まれます。
| `Field` | 型 | 説明 |
|:----------|:-------|:--------------------------------------------------------|
@@ -237,7 +237,7 @@ Connecting to 127.0.0.1:5005
* [汎用エラータイプ][]のすべて。
* `invalidParams` - 1つ以上のフィールドの指定が正しくないか、1つ以上の必須フィールドが指定されていません。
* `srcActNotFound` - トランザクションの`Account`が、レジャーの資金供給のあるアドレスではない場合。
* `srcActMalformed` - 要求の署名アドレス(`account`フィールド)の形式が無効である場合。
* `srcActMalformed` - リクエストの署名アドレス(`account`フィールド)の形式が無効である場合。
* `badSeed` - 指定されたシード値のフォーマットが正しくありません。
* `badSecret` - 指定されたシークレット値のフォーマットが正しくありません。

View File

@@ -13,8 +13,8 @@ labels:
_`consensus_info`メソッドは、権限のないユーザーは実行できない[管理メソッド](admin-api-methods.html)です。_
### 要求フォーマット
要求フォーマットの例:
### リクエストのフォーマット
リクエストのフォーマットの例:
<!-- MULTICODE_BLOCK_START -->
@@ -47,11 +47,11 @@ rippled consensus_info
<!-- MULTICODE_BLOCK_END -->
この要求にはパラメーターはありません。
このリクエストにはパラメーターはありません。
### 応答フォーマット
### レスポンスのフォーマット
処理が成功した応答の例:
処理が成功したレスポンスの例:
<!-- MULTICODE_BLOCK_START -->
@@ -210,7 +210,7 @@ Connecting to 127.0.0.1:5005
<!-- MULTICODE_BLOCK_END -->
この応答は[標準フォーマット][]に従っており、正常に完了した場合は結果に次のフィールドが含まれています。
このレスポンスは[標準フォーマット][]に従っており、正常に完了した場合は結果に次のフィールドが含まれています。
| `Field` | 型 | 説明 |
|:--------|:-------|:----------------------------------------------------------|

View File

@@ -15,8 +15,8 @@ labels:
_`feature`メソッドは、権限のないユーザーは実行できない[管理メソッド](admin-api-methods.html)です。_
### 要求フォーマット
要求フォーマットの例:
### リクエストのフォーマット
リクエストのフォーマットの例:
<!-- MULTICODE_BLOCK_START -->
@@ -63,18 +63,18 @@ rippled feature 4C97EBA926031A7CF7D7B36FDE3ED66DDA5421192D63DE53FFB46E43B9DC8373
<!-- MULTICODE_BLOCK_END -->
要求には以下のパラメーターが含まれます。
リクエストには以下のパラメーターが含まれます。
| `Field` | 型 | 説明 |
|:----------|:--------|:-------------------------------------------------------|
| `feature` | 文字列 | _省略可_ Amendmentの一意のID16進数またはAmendmentの短い名前。指定されている場合は、応答が1つのAmendmentに限定されます。それ以外の場合は応答にすべてのAmendmentのリストが表示されます。 |
| `feature` | 文字列 | _省略可_ Amendmentの一意のID16進数またはAmendmentの短い名前。指定されている場合は、レスポンスが1つのAmendmentに限定されます。それ以外の場合はレスポンスにすべてのAmendmentのリストが表示されます。 |
| `vetoed` | ブール値 | (省略可、`feature`が指定されていない場合は無視されますtrueの場合、サーバに対し`feature`で指定されたAmendmentに反対票を投じるように指示します。falseの場合、サーバに対しAmendmentに賛成票を投じるように指示します。 |
**注記:** サーバが新しいAmendmentの適用方法を現在認識していない場合でも、`feature`フィールドにAmendment IDを指定すれば、新しいAmendmentに賛成票を投じるようにサーバを設定できます。たとえば、Amendmentをサポートする新しい`rippled`バージョンに _確実に_ アップグレードする予定がある場合などにこのように設定できます。
### 応答フォーマット
### レスポンスのフォーマット
処理が成功した応答の例:
処理が成功したレスポンスの例:
<!-- MULTICODE_BLOCK_START -->
@@ -181,7 +181,7 @@ Connecting to 127.0.0.1:5005
<!-- MULTICODE_BLOCK_END -->
応答は[標準フォーマット][]に従っており、正常に完了した場合は結果に**Amendmentのマップ**がJSONプロジェクトとして含まれています。オブジェクトのキーはAmendment IDです。各キーの値は、そのIDのAmendmentのステータスを記述した _Amendmentオブジェクト_ です。要求`feature`が指定されいる場合、要求による変更の適用後には、要求されたAmendmentオブジェクトだけがマップに含まれます。各Amendmentオブジェクトのフィールドを次に示します。
レスポンスは[標準フォーマット][]に従っており、正常に完了した場合は結果に**Amendmentのマップ**がJSONプロジェクトとして含まれています。オブジェクトのキーはAmendment IDです。各キーの値は、そのIDのAmendmentのステータスを記述した _Amendmentオブジェクト_ です。リクエスト`feature`が指定されいる場合、リクエストによる変更の適用後には、リクエストされたAmendmentオブジェクトだけがマップに含まれます。各Amendmentオブジェクトのフィールドを次に示します。
| `Field` | 型 | 説明 |
|:------------|:--------|:-----------------------------------------------------|

View File

@@ -12,8 +12,8 @@ labels:
_`fetch_info`メソッドは、権限のないユーザーは実行できない[管理メソッド](admin-api-methods.html)です。_
### 要求フォーマット
要求フォーマットの例:
### リクエストのフォーマット
リクエストのフォーマットの例:
<!-- MULTICODE_BLOCK_START -->
@@ -49,15 +49,15 @@ rippled fetch_info
<!-- MULTICODE_BLOCK_END -->
要求には以下のパラメーターが含まれます。
リクエストには以下のパラメーターが含まれます。
| `Field` | 型 | 説明 |
|:--------|:--------|:---------------------------------------------------------|
| `clear` | ブール値 | `true`の場合、現在のフェッチ操作がリセットされます。それ以外の場合、進行中のフェッチ操作のステータスのみが取得されます。 |
### 応答フォーマット
### レスポンスのフォーマット
処理が成功した応答の例:
処理が成功したレスポンスの例:
<!-- MULTICODE_BLOCK_START -->
@@ -142,7 +142,7 @@ Connecting to 127.0.0.1:5005
<!-- MULTICODE_BLOCK_END -->
この応答は[標準フォーマット][]に従っており、正常に完了した場合は結果に次のフィールドが含まれています。
このレスポンスは[標準フォーマット][]に従っており、正常に完了した場合は結果に次のフィールドが含まれています。
| `Field` | 型 | 説明 |
|:--------|:-------|:----------------------------------------------------------|
@@ -155,7 +155,7 @@ Connecting to 127.0.0.1:5005
| `hash` | 文字列 | フェッチ対象アイテムのハッシュ。 |
| `have_header` | ブール値 | レジャーの場合、このサーバーがすでにレジャーのヘッダーセクションを取得しているかどうか。 |
| `have_transactions` | ブール値 | レジャーの場合、このサーバーがすでにレジャーのトランザクションセクションを取得しているかどうか。 |
| `needed_state_hashes` | (ハッシュ)文字列の配列 | まだ必要とされる、このアイテムの状態オブジェクトのハッシュ値。必要なハッシュの数が16を超えている場合、応答には最初の16個のハッシュのみが含まれます。 |
| `needed_state_hashes` | (ハッシュ)文字列の配列 | まだ必要とされる、このアイテムの状態オブジェクトのハッシュ値。必要なハッシュの数が16を超えている場合、レスポンスには最初の16個のハッシュのみが含まれます。 |
| `peers` | 数値 | このアイテムが利用可能であるピアの数。 |
| `timeouts` | 数値 | このアイテムをフェッチしようとしてタイムアウトになった2.5秒)回数。 |

View File

@@ -12,8 +12,8 @@ labels:
_`get_counts`メソッドは、権限のないユーザーは実行できない[管理メソッド](admin-api-methods.html)です。_
### 要求フォーマット
要求フォーマットの例:
### リクエストのフォーマット
リクエストのフォーマットの例:
<!-- MULTICODE_BLOCK_START -->
@@ -49,15 +49,15 @@ rippled get_counts 100
<!-- MULTICODE_BLOCK_END -->
要求には以下のパラメーターが含まれます。
リクエストには以下のパラメーターが含まれます。
| `Field` | 型 | 説明 |
|:------------|:--------------------------|:-----------------------------------|
| `min_count` | 数値(符号なし整数) | この値以上の値を含むフィールドのみを返します。 |
### 応答フォーマット
### レスポンスのフォーマット
処理が成功した応答の例:
処理が成功したレスポンスの例:
<!-- MULTICODE_BLOCK_START -->
@@ -140,7 +140,7 @@ Connecting to 127.0.0.1:5005
<!-- MULTICODE_BLOCK_END -->
応答は[標準フォーマット][]に従っています。結果に含まれるフィールドのリストは、予告なく変更される可能性がありますが、(特に)以下のいずれかが含まれます。
レスポンスは[標準フォーマット][]に従っています。結果に含まれるフィールドのリストは、予告なく変更される可能性がありますが、(特に)以下のいずれかが含まれます。
| `Field` | 型 | 説明 |
|:--------------|:-------|:----------------------------------------------------|

View File

@@ -10,10 +10,10 @@ labels:
`print`コマンドは、さまざまな内部サブシステム(ピア、レジャークリーナー、リソースマネージャーなど)の現在の状況を返します。
*`print`要求は、権限のないユーザーは実行できない[管理メソッド](admin-api-methods.html)です。*
*`print`リクエストは、権限のないユーザーは実行できない[管理メソッド](admin-api-methods.html)です。*
### 要求フォーマット
要求フォーマットの例:
### リクエストのフォーマット
リクエストのフォーマットの例:
<!-- MULTICODE_BLOCK_START -->
@@ -34,11 +34,11 @@ rippled print
<!-- MULTICODE_BLOCK_END -->
要求にはパラメーターが含まれていません。
リクエストにはパラメーターが含まれていません。
### 応答フォーマット
### レスポンスのフォーマット
処理が成功した応答の例:
処理が成功したレスポンスの例:
<!-- MULTICODE_BLOCK_START -->
@@ -232,7 +232,7 @@ Connecting to 127.0.0.1:5005
<!-- MULTICODE_BLOCK_END -->
応答は[標準フォーマット][]に従っています。結果に含まれる追加フィールドは、`rippled`サーバーの内部状態に応じて異なります。このコマンドの実行結果は、予告なく変更されることがあります。
レスポンスは[標準フォーマット][]に従っています。結果に含まれる追加フィールドは、`rippled`サーバーの内部状態に応じて異なります。このコマンドの実行結果は、予告なく変更されることがあります。
### 考えられるエラー

View File

@@ -11,10 +11,10 @@ labels:
`validator_list_sites`コマンドは、バリデータリストを処理するサイトのステータス情報を返します。[新規: rippled 0.80.1][]
*`validator_list_sites`要求は、権限のないユーザーは実行できない[管理メソッド](admin-api-methods.html)です。*
*`validator_list_sites`リクエストは、権限のないユーザーは実行できない[管理メソッド](admin-api-methods.html)です。*
### 要求フォーマット
要求フォーマットの例:
### リクエストのフォーマット
リクエストのフォーマットの例:
<!-- MULTICODE_BLOCK_START -->
@@ -47,11 +47,11 @@ rippled validator_list_sites
<!-- MULTICODE_BLOCK_END -->
要求にはパラメーターが含まれていません。
リクエストにはパラメーターが含まれていません。
### 応答フォーマット
### レスポンスのフォーマット
処理が成功した応答の例:
処理が成功したレスポンスの例:
<!-- MULTICODE_BLOCK_START -->
@@ -119,7 +119,7 @@ Connecting to 127.0.0.1:5005
<!-- MULTICODE_BLOCK_END -->
応答は[標準フォーマット][]に従っており、正常に完了した場合は結果に次のフィールドが含まれています。
レスポンスは[標準フォーマット][]に従っており、正常に完了した場合は結果に次のフィールドが含まれています。
| `Field` | 型 | 説明 |
|:------------------|:------|----------------------------------|

View File

@@ -11,10 +11,10 @@ labels:
`validators`コマンドは、サーバーが使用する公開済みの信頼できるバリデータの最新リストに関する情報を、人間が読み取れる形式で返します。[新規: rippled 0.80.1][]
*`validators`要求は、権限のないユーザーは実行できない[管理メソッド](admin-api-methods.html)です。*
*`validators`リクエストは、権限のないユーザーは実行できない[管理メソッド](admin-api-methods.html)です。*
### 要求フォーマット
要求フォーマットの例:
### リクエストのフォーマット
リクエストのフォーマットの例:
<!-- MULTICODE_BLOCK_START -->
@@ -47,11 +47,11 @@ rippled validators
<!-- MULTICODE_BLOCK_END -->
要求にはパラメーターが含まれていません。
リクエストにはパラメーターが含まれていません。
### 応答フォーマット
### レスポンスのフォーマット
処理が成功した応答の例:
処理が成功したレスポンスの例:
<!-- MULTICODE_BLOCK_START -->
@@ -160,7 +160,7 @@ Connecting to 127.0.0.1:5005
<!-- MULTICODE_BLOCK_END -->
応答は[標準フォーマット][]に従っており、正常に完了した場合は結果に次のフィールドが含まれています。
レスポンスは[標準フォーマット][]に従っており、正常に完了した場合は結果に次のフィールドが含まれています。
| `Field` | 型 | 説明 |
|:-------------------------|:-------|:-----------------------------------------|
@@ -168,7 +168,7 @@ Connecting to 127.0.0.1:5005
| `publisher_lists` | 配列 | パブリッシャーリストオブジェクトの配列。 |
| `signing_keys` | オブジェクト | バリデータマニフェストを使用している登録済みバリデータのマスター公開鍵から、現在の署名キーへのマッピング。 |
| `trusted_validator_keys` | 配列 | 現在信頼されているバリデータの公開鍵の配列。 |
| `validation_quorum` | 数値 | 1つのレジャーバージョンの検証に最低限必要となる信頼できる検証の数。状況によっては、サーバーがさらに検証を要求する場合があります。 |
| `validation_quorum` | 数値 | 1つのレジャーバージョンの検証に最低限必要となる信頼できる検証の数。状況によっては、サーバーがさらに検証をリクエストする場合があります。 |
| `validator_list_expires` | 文字列 | 人間が読み取れる形式での現在のバリデータリストの有効期限、文字列`unknown`(サーバーが公開済みバリデータリストを読み込む必要がある場合)、または文字列`never`(サーバーが静的なバリデータリストを使用している場合)のいずれか。 |
`publisher_lists`配列の各メンバーは、以下のフィールドを有するオブジェクトです。