[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`配列の各メンバーは、以下のフィールドを有するオブジェクトです。

View File

@@ -5,9 +5,9 @@ blurb: WebSocket、JSON-RPC、コマンドラインインターフェイスの
---
# エラーのフォーマット
エラーが発生する可能性のある状況をすべて挙げることは不可能です。トランスポートレイヤーで発生する場合(ネットワーク接続が失われる場合など)には、使用しているクライアントとトランスポートに応じてその結果は異なります。ただし、`rippled`サーバーが要求を正常に受信した場合、サーバーは標準のエラー形式での応答を試みます。
エラーが発生する可能性のある状況をすべて挙げることは不可能です。トランスポートレイヤーで発生する場合(ネットワーク接続が失われる場合など)には、使用しているクライアントとトランスポートに応じてその結果は異なります。ただし、`rippled`サーバーがリクエストを正常に受信した場合、サーバーは標準のエラー形式でのレスポンスを試みます。
**注意:** 要求の結果がエラーになった場合、応答の一部として要求全体がコピーされます。このため、エラーのデバッグに取り組むことができます。ただし、これには要求で渡した機密情報がすべて含まれます。エラーメッセージを共有するときには、アカウントの重要な機密情報を他のユーザーに誤って公開することがないように、十分に注意してください。
**注意:** リクエストの結果がエラーになった場合、レスポンスの一部としてリクエスト全体がコピーされます。このため、エラーのデバッグに取り組むことができます。ただし、これにはリクエストで渡した機密情報がすべて含まれます。エラーメッセージを共有するときには、アカウントの重要な機密情報を他のユーザーに誤って公開することがないように、十分に注意してください。
エラーの例:
@@ -74,44 +74,44 @@ HTTP Status: 200 OK
| `Field` | 型 | 説明 |
|:----------|:---------|:------------------------------------------------------|
| `id` | (場合により異なる) | この応答の要求元となったWeb Socket要求に指定されていたID |
| `status` | 文字列 | `"error"`: 要求が原因でエラーが発生した場合 |
| `type` | 文字列 | 通常は`"response"`。これは、コマンドに対し正常に応答したことを示します。 |
| `id` | (場合により異なる) | このレスポンスのリクエスト元となったWeb Socketリクエストに指定されていたID |
| `status` | 文字列 | `"error"`: リクエストが原因でエラーが発生した場合 |
| `type` | 文字列 | 通常は`"response"`。これは、コマンドに対し正常にレスポンスしたことを示します。 |
| `error` | 文字列 | 発生したエラータイプの一意のコード。 |
| `request` | オブジェクト | このエラーが発生した要求のコピーJSONフォーマット。**注意:** 要求にアカウントの機密情報が含まれている場合、ここにコピーされます。 |
| `request` | オブジェクト | このエラーが発生したリクエストのコピーJSONフォーマット。**注意:** リクエストにアカウントの機密情報が含まれている場合、ここにコピーされます。 |
## JSON-RPCフォーマット
一部のJSON-RPC要求は、HTTPレイヤーでエラーコードで応答します。この場合、応答は応答本文にプレーンテキストで記述されます。たとえば`method`パラメーターでコマンドを指定し忘れた場合、応答は次のようになります。
一部のJSON-RPCリクエストは、HTTPレイヤーでエラーコードでレスポンスします。この場合、レスポンスはレスポンス本文にプレーンテキストで記述されます。たとえば`method`パラメーターでコマンドを指定し忘れた場合、レスポンスは次のようになります。
```
HTTP Status: 400 Bad Request
Null method
```
HTTPステータスコード200 OKが返されるその他のエラーの場合、応答はJSONフォーマットで、以下のフィールドが使用されます。
HTTPステータスコード200 OKが返されるその他のエラーの場合、レスポンスはJSONフォーマットで、以下のフィールドが使用されます。
| `Field` | 型 | 説明 |
|:-----------------|:-------|:-------------------------------------------------|
| `result` | オブジェクト | クエリーに対する応答が含まれているオブジェクト |
| `result` | オブジェクト | クエリーに対するレスポンスが含まれているオブジェクト |
| `result.error` | 文字列 | 発生したエラータイプの一意のコード。 |
| `result.status` | 文字列 | `"error"`: 要求が原因でエラーが発生した場合 |
| `result.request` | オブジェクト | このエラーが発生した要求のコピーJSONフォーマット。**注意:** 要求にアカウントの機密情報が含まれている場合、ここにコピーされます。**注記:** 発行される要求にかかわらず、要求はWebSocketフォーマットに再設定されます。 |
| `result.status` | 文字列 | `"error"`: リクエストが原因でエラーが発生した場合 |
| `result.request` | オブジェクト | このエラーが発生したリクエストのコピーJSONフォーマット。**注意:** リクエストにアカウントの機密情報が含まれている場合、ここにコピーされます。**注記:** 発行されるリクエストにかかわらず、リクエストはWebSocketフォーマットに再設定されます。 |
## 汎用エラー
すべてのメソッドは、以下のいずれかの値の`error`コードを返す可能性があります。
* `unknownCmd` - 要求に、`rippled`サーバーが認識する[コマンド](http-websocket-apis.html)が含まれていません。
* `jsonInvalid` -WebSocketのみ要求は適切なJSONオブジェクトではありません。
* `unknownCmd` - リクエストに、`rippled`サーバーが認識する[コマンド](http-websocket-apis.html)が含まれていません。
* `jsonInvalid` -WebSocketのみリクエストは適切なJSONオブジェクトではありません。
* この場合JSON-RPCは、代わりに400 Bad Request HTTPエラーを返します。
* `missingCommand` -WebSocketのみ要求`command`フィールドが指定されていませんでした。
* `missingCommand` -WebSocketのみリクエスト`command`フィールドが指定されていませんでした。
* この場合JSON-RPCは、代わりに400 Bad Request HTTPエラーを返します。
* `tooBusy` - サーバーの負荷が高すぎるため、現在このコマンドを実行できません。管理者として接続している場合は、通常このエラーが返されることはありません。
* `noNetwork` - サーバーとXRP Ledgerピアツーピアネットワークのその他の部分との接続で問題が発生していますサーバーがスタンドアロンモードで実行されていません
* `noCurrent` - 高い負荷、ネットワークの問題、バリデータ障害、誤った構成、またはその他の問題が原因で、サーバーが現行のレジャーを認識できません。
* `noClosed` - サーバーに決済済みレジャーがありません。通常、このエラーは起動が完了していないことが原因で発生します。
* `wsTextRequired` -WebSocketのみ要求の[opcode](https://tools.ietf.org/html/rfc6455#section-5.2)がテキストではありません。
* `wsTextRequired` -WebSocketのみリクエストの[opcode](https://tools.ietf.org/html/rfc6455#section-5.2)がテキストではありません。
* `amendmentBlocked` - サーバーの状態が[Amendment blocked](amendments.html#amendment-blocked)であるため、XRP Ledgerネットワークとの同期を維持するために最新バージョンに更新する必要があります。

View File

@@ -1,10 +1,10 @@
---
html: markers-and-pagination.html
parent: api-conventions.html
blurb: 大きなクエリを複数の応答にページネーションする際の慣例です。
blurb: 大きなクエリを複数のレスポンスにページネーションする際の慣例です。
---
# マーカーとページネーション
一部のメソッドから返されるデータは、1つの応答に実質的に収まらないことがあります。結果全体が収まらない場合、応答には`marker`フィールドが含まれます。このフィールドを使用することで、複数回の呼出しを通じてデータのページをさらに取得できます。各要求で直前の応答`marker`値を渡して、終わったところから再開します。応答`marker`が含まれていなければ、データセットの終わりに達しています。
一部のメソッドから返されるデータは、1つのレスポンスに実質的に収まらないことがあります。結果全体が収まらない場合、レスポンスには`marker`フィールドが含まれます。このフィールドを使用することで、複数回の呼出しを通じてデータのページをさらに取得できます。各リクエストで直前のレスポンス`marker`値を渡して、終わったところから再開します。レスポンス`marker`が含まれていなければ、データセットの終わりに達しています。
`marker`フィールドのフォーマットは意図的に未定義になっています。各サーバーで`marker`をそれぞれに合わせて定義できるので、このフィールドの形式は文字列、ネストオブジェクトなどさまざまです。異なるサーバー、または同じサーバーの異なるメソッドでは、異なる`marker`定義を使用できます。各`marker`は一時的であり、10分以上経過すると予期されているとおりに機能しなくなることがあります。

View File

@@ -13,7 +13,7 @@ labels:
クライアントがレート制限に近づいている場合、サーバーは[APIレスポンス](response-formatting.html)のトップレベルにフィールド`"warning" "load"`というフィールドを[APIレスポンス](response-formatting.html)のトップレベルに追加します。この警告はすべてのレスポンスに追加されるわけではありませんが、サーバはクライアントを切断する前に何度かこのような警告を送ることがあります。
クライアントがレート制限を超えると、サーバーはそのクライアントを切断し、しばらくの間、クライアントのAPIアドレスからの要求を受け付けません。WebSocket APIとJSON-RPC APIでは、異なる切断メッセージを使用します。
クライアントがレート制限を超えると、サーバーはそのクライアントを切断し、しばらくの間、クライアントのAPIアドレスからのリクエストを受け付けません。WebSocket APIとJSON-RPC APIでは、異なる切断メッセージを使用します。
## WebSocket APIの切断メッセージ
@@ -47,7 +47,7 @@ Server is overloaded
## リクエストあたりのレート
[[ソース]](https://github.com/XRPLF/rippled/blob/master/src/ripple/resource/Fees.h "ソース")
サーバは時間の経過とともに行われるリクエストの数に基づいてクライアントの使用率を計算し、サーバがリクエストに応答するためにどれだけの作業をしなければならないかに基づいて、異なるタイプのリクエストに重みをつけます。[subscribeメソッド][]と[path_findメソッド][]に対するサーバからの後続メッセージもクライアントの使用率にカウントされます。
サーバは時間の経過とともに行われるリクエストの数に基づいてクライアントの使用率を計算し、サーバがリクエストにレスポンスするためにどれだけの作業をしなければならないかに基づいて、異なるタイプのリクエストに重みをつけます。[subscribeメソッド][]と[path_findメソッド][]に対するサーバからの後続メッセージもクライアントの使用率にカウントされます。
使用率は時間とともに指数関数的に低下するため、リクエストを自動的に行わないクライアントは、数秒から数分後にアクセスが回復します。

View File

@@ -1,9 +1,9 @@
---
html: request-formatting.html
parent: api-conventions.html
blurb: WebSocket、JSON-RPC、コマンドラインインターフェイスの標準の要求フォーマットと例です。
blurb: WebSocket、JSON-RPC、コマンドラインインターフェイスの標準のリクエストのフォーマットと例です。
---
# 要求フォーマット
# リクエストのフォーマット
## WebSocketフォーマット
@@ -11,30 +11,30 @@ blurb: WebSocket、JSON-RPC、コマンドラインインターフェイスの
* コマンド名を最上位の`"command"`フィールドに指定します。
* このコマンドのすべての関連パラメーターも最上位に指定します。
* オプションで、任意の値を指定した`"id"`フィールドを指定します。この要求への応答では、同一の`"id"`フィールドを使用します。そうすることで、応答が順不同で到達した場合も、どの要求によってどの応答を得られたのかがわかります。
* オプションで、任意の値を指定した`"id"`フィールドを指定します。このリクエストへのレスポンスでは、同一の`"id"`フィールドを使用します。そうすることで、レスポンスが順不同で到達した場合も、どのリクエストによってどのレスポンスを得られたのかがわかります。
応答はJSONオブジェクトとして返されます。
レスポンスはJSONオブジェクトとして返されます。
## JSON-RPCフォーマット
JSON-RPC要求を実行するには、`rippled`サーバーがJSON-RPC接続をリッスンしているポートおよびIPで、HTTP **POST**要求をルートパス(`/`に送信します。HTTP/1.0またはHTTP/1.1を使用できます。HTTPSを使用する場合は、TLS v1.2を使用してください。セキュリティ上の理由から、`rippled`ではSSL v3以前を _サポートしていません_
JSON-RPCリクエストを実行するには、`rippled`サーバーがJSON-RPC接続をリッスンしているポートおよびIPで、HTTP **POST**リクエストをルートパス(`/`に送信します。HTTP/1.0またはHTTP/1.1を使用できます。HTTPSを使用する場合は、TLS v1.2を使用してください。セキュリティ上の理由から、`rippled`ではSSL v3以前を _サポートしていません_
常に`Content-Type`ヘッダー(値`application/json`)を指定してください。
複数の要求を実行する予定の場合は、要求間で接続を閉じてから開く操作を行わずに済むように、[Keep-Alives](http://tools.ietf.org/html/rfc7230#section-6.3)を使用してください。
複数のリクエストを実行する予定の場合は、リクエスト間で接続を閉じてから開く操作を行わずに済むように、[Keep-Alives](http://tools.ietf.org/html/rfc7230#section-6.3)を使用してください。
以下の属性を指定した要求本文を[JSON](https://en.wikipedia.org/wiki/JSON)オブジェクトとして送信します。
以下の属性を指定したリクエスト本文を[JSON](https://en.wikipedia.org/wiki/JSON)オブジェクトとして送信します。
* コマンドを最上位の`"method"` フィールドに指定します。
* 最上位の`"params"`フィールドを指定します。このフィールドの内容は、コマンドのすべてのパラメーターが指定された1つの入れ子JSONオブジェクトのみを保持している**1要素配列**です。
応答もJSONオブジェクトです。
レスポンスもJSONオブジェクトです。
## コマンドライン形式
コマンドラインでは、通常の(ダッシュが先頭に付いた)コマンドラインオプションの後にコマンドを指定し、その後に一連の限定的なパラメーターをスペースで区切って指定します。スペースやその他の特殊文字が含まれている可能性のあるパラメーター値は、一重引用符で囲みます。
### 要求の例
### リクエストの例
<!-- MULTICODE_BLOCK_START -->

View File

@@ -1,24 +1,24 @@
---
html: response-formatting.html
parent: api-conventions.html
blurb: WebSocket、JSON-RPC、コマンドラインインターフェイスの応答のフォーマットとその応答に含まれるフィールド。
blurb: WebSocket、JSON-RPC、コマンドラインインターフェイスのレスポンスのフォーマットとそのレスポンスに含まれるフィールド。
---
# 応答フォーマット
# レスポンスのフォーマット
`rippled` APIからの応答のフォーマットは、メソッドが呼び出されたインターフェイスWebSocket、JSON-RPC、コマンドラインに応じて多少異なります。コマンドラインインターフェイスがJSON-RPCを呼び出すため、コマンドラインインターフェイスとJSON-RPCインターフェイスは同じフォーマットを使用します。
`rippled` APIからのレスポンスのフォーマットは、メソッドが呼び出されたインターフェイスWebSocket、JSON-RPC、コマンドラインに応じて多少異なります。コマンドラインインターフェイスがJSON-RPCを呼び出すため、コマンドラインインターフェイスとJSON-RPCインターフェイスは同じフォーマットを使用します。
成功した場合の応答に含まれるフィールドは、以下の通りです。
成功した場合のレスポンスに含まれるフィールドは、以下の通りです。
| `Field` | 型 | 説明 |
|:----------------|:---------|:------------------------------------------------|
| `id` | (場合により異なる) | WebSocketのみこの応答の要求元となった要求で指定されているID。 |
| `status` | 文字列 | WebSocketのみ値が`success`である場合、要求がサーバーによって正常に受信され、理解されたことを示します。 |
| `result.status` | 文字列 | JSON-RPCおよびコマンドライン値が`success`である場合、要求がサーバーによって正常に受信され、理解されたことを示します。 |
| `type` | 文字列 | WebSocketのみ値が`response`の場合、コマンドに対する正常な応答であることを示します。[非同期の通知](subscribe.html)では、`ledgerClosed``transaction`など異なる値が使用されます。 |
| `id` | (場合により異なる) | WebSocketのみこのレスポンスのリクエスト元となったリクエストで指定されているID。 |
| `status` | 文字列 | WebSocketのみ値が`success`である場合、リクエストがサーバーによって正常に受信され、理解されたことを示します。 |
| `result.status` | 文字列 | JSON-RPCおよびコマンドライン値が`success`である場合、リクエストがサーバーによって正常に受信され、理解されたことを示します。 |
| `type` | 文字列 | WebSocketのみ値が`response`の場合、コマンドに対する正常なレスポンスであることを示します。[非同期の通知](subscribe.html)では、`ledgerClosed``transaction`など異なる値が使用されます。 |
| `result` | オブジェクト | クエリーの結果。内容はコマンドによって異なります。 |
## 成功した場合の応答の例
## 成功した場合のレスポンスの例
<!-- MULTICODE_BLOCK_START -->

View File

@@ -7,7 +7,7 @@ labels:
---
# rippledサーバーの状態
`rippled`サーバーの設定、稼働時間、その他の要素により、サーバーがグローバルなXRP Ledgerピアツーピアネットワークに参加する度合いは異なります。これは、[server_infoメソッド][]と[server_stateメソッド][]への応答内の`server_state`フィールドに示されます。応答は昇順のやり取りに従い、後の値は前の値より優先されます。これらの応答の定義を以下に示します(優先順位の高い順)。
`rippled`サーバーの設定、稼働時間、その他の要素により、サーバーがグローバルなXRP Ledgerピアツーピアネットワークに参加する度合いは異なります。これは、[server_infoメソッド][]と[server_stateメソッド][]へのレスポンス内の`server_state`フィールドに示されます。レスポンスは昇順のやり取りに従い、後の値は前の値より優先されます。これらのレスポンスの定義を以下に示します(優先順位の高い順)。
| `Value` | 説明 |
|:---------------|:------------------------------------------------------------|

View File

@@ -26,7 +26,7 @@ labels:
- **ホスト:** (任意の`rippled`サーバ(ホスト名またはIPアドレスによる))
- **ポート:** (`rippled`サーバがピアプロトコルを使用するポート番号、通常は51235です。)
- **パス:** `/health`
- **セキュリティ:** ほとんどの`rippled`サーバはリクエストに応答するために自己署名証明書を使います。デフォルトでは、(Webブラウザを含む)ほとんどのツールは、そのようなレスポンスは信頼できないとしてフラグを立てたりブロックしたりします。これらのサーバからの応答を表示するには、証明書のチェックを無視しなければなりません (たとえば、cURLを使用している場合は`--insecure`フラグを追加します)。
- **セキュリティ:** ほとんどの`rippled`サーバはリクエストにレスポンスするために自己署名証明書を使います。デフォルトでは、(Webブラウザを含む)ほとんどのツールは、そのようなレスポンスは信頼できないとしてフラグを立てたりブロックしたりします。これらのサーバからのレスポンスを表示するには、証明書のチェックを無視しなければなりません (たとえば、cURLを使用している場合は`--insecure`フラグを追加します)。
<!-- TODO: link a tutorial for how to run rippled with a non-self-signed TLS cert -->

View File

@@ -21,7 +21,7 @@ labels:
- **ホスト:** (任意の`rippled`サーバ(ホスト名またはIPアドレス))
- **ポート:** (`rippled`サーバがピアプロトコルを使用するポート番号、通常は51235です。)
- **パス:** `/crawl`
- **セキュリティ:** ほとんどの`rippled`サーバはリクエストに応答するために自己署名証明書を使います。デフォルトでは、(ウェブブラウザを含む)ほとんどのツールは、そのようなレスポンスは信頼できないとしてフラグを立てたりブロックしたりします。これらのサーバからの応答を表示するには、証明書のチェックを無視しなければなりません(たとえば、cURLを使用している場合は`--insecure`フラグを追加します)。
- **セキュリティ:** ほとんどの`rippled`サーバはリクエストにレスポンスするために自己署名証明書を使います。デフォルトでは、(ウェブブラウザを含む)ほとんどのツールは、そのようなレスポンスは信頼できないとしてフラグを立てたりブロックしたりします。これらのサーバからのレスポンスを表示するには、証明書のチェックを無視しなければなりません(たとえば、cURLを使用している場合は`--insecure`フラグを追加します)。
## レスポンスのフォーマット
@@ -36,7 +36,7 @@ JSONオブジェクトは次のフィールドを含んでいます。
| `overlay` | オブジェクト | _(省略可)_ [peersメソッド][]のレスポンスに似ています。`active`というフィールドがあり、これはオブジェクトの配列です(下記参照)。 |
| `server` | オブジェクト | _(省略可)_ このサーバに関する情報。[server_stateメソッド][]の公開フィールドを含みます。どの`rippled`バージョン(`build_version`)か、どの[レジャーバージョン](ledger-history.html)が利用可能か(`complete_ledgers`)、サーバーの負荷量などです。[更新: rippled 1.2.1][]. |
| `unl` | オブジェクト | _(省略可)_ [validatorsメソッド][]や[validator_list_sitesメソッド][]のレスポンスと同様です。[更新: rippled 1.2.1][]. |
| `version` | 数値 | このピアクローラのレスポンスフォーマットのバージョンを示します。現在のピアクローラのバージョン番号は`2`です。[更新: rippled 1.2.1][]. |
| `version` | 数値 | このピアクローラのレスポンスフォーマットのバージョンを示します。現在のピアクローラのバージョン番号は`2`です。[更新: rippled 1.2.1][]. |
`overlay.active`配列の各メンバーは、次のフィールドを持つオブジェクトです。

View File

@@ -12,7 +12,7 @@ labels:
[ピアクローラ](peer-crawler.html)と同様に、バリデータリストメソッドはデフォルトで非root権限で[ピアプロトコル](peer-protocol.html)ポートから利用できます。
## リクエストフォーマット
## リクエストフォーマット
バリデータリストの情報をリクエストするには、以下のHTTPリクエストを実行します。
@@ -24,7 +24,7 @@ labels:
`{public_key}`はリスト発行者の公開鍵で、16進数です。この鍵は発行者を識別し、リストの内容が真正で完全であることを確認するためにも使われます。
- **セキュリティ:** ほとんどの`rippled`サーバはリクエストに応答するために自己署名したTLS証明書を使います。デフォルトでは、(Webブラウザを含む)ほとんどのツールはそのようなレスポンスが信頼できないものであるとしてフラグを立てたりブロックしたりします。これらのサーバからの応答を表示するには、証明書のチェックを無視しなければなりません(たとえばcURLを使う場合は`--insecure`フラグを追加します)。
- **セキュリティ:** ほとんどの`rippled`サーバはリクエストにレスポンスするために自己署名したTLS証明書を使います。デフォルトでは、(Webブラウザを含む)ほとんどのツールはそのようなレスポンスが信頼できないものであるとしてフラグを立てたりブロックしたりします。これらのサーバからのレスポンスを表示するには、証明書のチェックを無視しなければなりません(たとえばcURLを使う場合は`--insecure`フラグを追加します)。
バリデータリストの内容は別の暗号鍵で署名されているので、使用するTLS証明書にかかわらずその完全性を検証できます。

View File

@@ -12,8 +12,8 @@ _[PayChan Amendment][]が有効になっている必要があります。[新
`account_channels`メソッドは、アカウントのPayment Channelに関する情報を返します。指定されたアカウントがChannelの送金元であり、送金先ではないChannelのみが含まれます。Channelの「送金元」と「所有者」は同一です。取得された情報はすべて、特定バージョンのレジャーに関連付けられています。
## 要求フォーマット
要求フォーマットの例:
## リクエストのフォーマット
リクエストのフォーマットの例:
<!-- MULTICODE_BLOCK_START -->
@@ -54,20 +54,20 @@ rippled account_channels rf1BiGeXwwQoi8Z2ueFYTEXSwuJYfV2Jpn ra5nK24KXen9AHvsdFTK
[試してみる>](websocket-api-tool.html#account_channels)
要求には以下のパラメーターが含まれます。
リクエストには以下のパラメーターが含まれます。
| フィールド | 型 | 説明 |
|:----------------------|:-------------------------------------------|:--------|
| `account` | 文字列 | アカウントの一意のID。通常はアカウントの[アドレス][]です。要求は、このアカウントがChannelの所有者/送金元であるChannelを返します。 |
| `account` | 文字列 | アカウントの一意のID。通常はアカウントの[アドレス][]です。リクエストは、このアカウントがChannelの所有者/送金元であるChannelを返します。 |
| `destination_account` | 文字列 | _省略可_ アカウントの一意のID。通常はアカウントの[アドレス][]です。指定されている場合、フィルタリングによりこのアカウントを送金先とするPayment Channelに絞り込まれます。 |
| `ledger_hash` | 文字列 | _省略可_ 使用するレジャーバージョンの20バイトの16進文字列。[レジャーの指定][]を参照してください) |
| `ledger_index` | 文字列または符号なし整数 | _省略可_ 使用する[レジャーインデックス][]、またはレジャーを自動的に選択するためのショートカット文字列。([レジャーの指定][]を参照してください) |
| `limit` | 整数 | _省略可_ 取得するトランザクション数を制限します。サーバーはこの値に従う必要はありません。10以上400以下の範囲で値を指定する必要があります。デフォルトでは200です。 |
| `marker` | [マーカー][] | _省略可_ 以前にページネーションされた応答の値。その応答を停止した箇所からデータの取得を再開します。 |
| `marker` | [マーカー][] | _省略可_ 以前にページネーションされたレスポンスの値。そのレスポンスを停止した箇所からデータの取得を再開します。 |
## 応答フォーマット
## レスポンスのフォーマット
処理が成功した応答の例:
処理が成功したレスポンスの例:
<!-- MULTICODE_BLOCK_START -->
@@ -157,16 +157,16 @@ rippled account_channels rf1BiGeXwwQoi8Z2ueFYTEXSwuJYfV2Jpn ra5nK24KXen9AHvsdFTK
<!-- MULTICODE_BLOCK_END -->
この応答は[標準フォーマット][]に従っており、正常に完了した場合は結果に次のフィールドが含まれています。
このレスポンスは[標準フォーマット][]に従っており、正常に完了した場合は結果に次のフィールドが含まれています。
| フィールド | 型 | 説明 |
|:-----------|:-------------------------------------------|:-------------------|
| `account` | 文字列 | Payment Channelの送金元/所有者のアドレス。これは要求`account`フィールドに対応しています。 |
| `account` | 文字列 | Payment Channelの送金元/所有者のアドレス。これはリクエスト`account`フィールドに対応しています。 |
| `channels` | channelオブジェクトの配列 | この`account`が所有するPayment Channel。 |
| `ledger_hash` | 文字列 | この応答の生成に使用されたレジャーバージョンの識別用[ハッシュ][]。[新規: rippled 0.90.0][] |
| `ledger_index` | 数値 | この応答の生成に使用されたレジャーバージョンの[レジャーインデックス][]。[新規: rippled 0.90.0][] |
| `validated` | ブール値 | _省略される場合があります_`true`の場合、この応答の情報は検証済みレジャーバージョンから取り込まれます。trueでない場合、情報は変更されることがあります。[新規: rippled 0.90.0][] |
| `limit` | 数値 | _省略される場合があります_ この要求から実際に返されるchannelオブジェクトの数の制限。 |
| `ledger_hash` | 文字列 | このレスポンスの生成に使用されたレジャーバージョンの識別用[ハッシュ][]。[新規: rippled 0.90.0][] |
| `ledger_index` | 数値 | このレスポンスの生成に使用されたレジャーバージョンの[レジャーインデックス][]。[新規: rippled 0.90.0][] |
| `validated` | ブール値 | _省略される場合があります_`true`の場合、このレスポンスの情報は検証済みレジャーバージョンから取り込まれます。trueでない場合、情報は変更されることがあります。[新規: rippled 0.90.0][] |
| `limit` | 数値 | _省略される場合があります_ このリクエストから実際に返されるchannelオブジェクトの数の制限。 |
| `marker` | [マーカー][] | _省略される場合があります_ ページネーションのサーバー定義の値。この値を次のコールに渡して、このコールで終わった箇所から結果の取得を再開します。この後に追加のページがない場合は省略されます。 |
各Channelオブジェクトのフィールドは次のとおりです。
@@ -190,7 +190,7 @@ rippled account_channels rf1BiGeXwwQoi8Z2ueFYTEXSwuJYfV2Jpn ra5nK24KXen9AHvsdFTK
* [汎用エラータイプ][]のすべて。
* `invalidParams` - 1つ以上のフィールドの指定が正しくないか、1つ以上の必須フィールドが指定されていません。
* `actNotFound` - 要求`account`フィールドに指定されているアドレスが、レジャーのアカウントに対応していません。
* `actNotFound` - リクエスト`account`フィールドに指定されているアドレスが、レジャーのアカウントに対応していません。
* `lgrNotFound` - `ledger_hash`または`ledger_index`で指定したレジャーが存在しないか、存在してはいるもののサーバーが保有していません。

View File

@@ -10,8 +10,8 @@ labels:
`account_currencies`コマンドは、アカウントのトラストラインに基づいてそのアカウントが送金または受領できる通貨のリストを返します。(このリストは完全に確認されたリストではありませんが、ユーザーインターフェイスへの入力に使用できます。)
## 要求フォーマット
要求フォーマットの例:
## リクエストのフォーマット
リクエストのフォーマットの例:
<!-- MULTICODE_BLOCK_START -->
@@ -46,7 +46,7 @@ labels:
[試してみる>](websocket-api-tool.html#account_currencies)
要求には以下のパラメーターが含まれます。
リクエストには以下のパラメーターが含まれます。
| `Field` | 型 | 説明 |
|:---------------|:---------------------------|:-------------------------------|
@@ -57,9 +57,9 @@ labels:
次のフィールドは廃止予定であるため、指定しないでください。`account_index`.
## 応答フォーマット
## レスポンスのフォーマット
処理が成功した応答の例:
処理が成功したレスポンスの例:
<!-- MULTICODE_BLOCK_START -->
@@ -135,7 +135,7 @@ labels:
<!-- MULTICODE_BLOCK_END -->
この応答は[標準フォーマット][]に従っており、正常に完了した場合は結果に次のフィールドが含まれています。
このレスポンスは[標準フォーマット][]に従っており、正常に完了した場合は結果に次のフィールドが含まれています。
| `Field` | 型 | 説明 |
|:---------------------|:---------------------------|:-------------------------|
@@ -151,7 +151,7 @@ labels:
* [汎用エラータイプ][]のすべて。
* `invalidParams` - 1つ以上のフィールドの指定が正しくないか、1つ以上の必須フィールドが指定されていません。
* `actNotFound` - 要求`account`フィールドに指定されているアドレスが、レジャーのアカウントに対応していません。
* `actNotFound` - リクエスト`account`フィールドに指定されているアドレスが、レジャーのアカウントに対応していません。
* `lgrNotFound` - `ledger_hash`または`ledger_index`で指定したレジャーが存在しないか、存在してはいるもののサーバーが保有していません。

View File

@@ -11,9 +11,9 @@ labels:
`account_info`コマンドは、アカウントとそのアクティビティおよびXRP残高についての情報を取得します。取得されたすべての情報は、特定バージョンのレジャーに関連付けられています。
## 要求フォーマット
## リクエストのフォーマット
account_info要求の例:
account_infoリクエストの例:
<!-- MULTICODE_BLOCK_START -->
@@ -55,7 +55,7 @@ rippled account_info rG1QQv2nh2gr7RCZ1P8YYcBUKCCN633jCn validated
[試してみる>](websocket-api-tool.html#account_info)
要求には以下のパラメーターが含まれます。
リクエストには以下のパラメーターが含まれます。
| `Field` | 型 | 必須? | 説明 |
|:---------------|:---------------------------|:------|:-------------------------------|
@@ -67,9 +67,9 @@ rippled account_info rG1QQv2nh2gr7RCZ1P8YYcBUKCCN633jCn validated
次のフィールドは廃止予定のため、指定しないでください。`ident``ledger`,`strict`
## 応答フォーマット
## レスポンスのフォーマット
処理が成功した応答の例:
処理が成功したレスポンスの例:
<!-- MULTICODE_BLOCK_START -->
@@ -198,13 +198,13 @@ rippled account_info rG1QQv2nh2gr7RCZ1P8YYcBUKCCN633jCn validated
<!-- MULTICODE_BLOCK_END -->
応答は[標準フォーマット][]に従い、要求されたアカウントとそのデータ、アカウントの適用先レジャーが結果として表示されます。以下のフィールドが含まれます。
レスポンスは[標準フォーマット][]に従い、リクエストされたアカウントとそのデータ、アカウントの適用先レジャーが結果として表示されます。以下のフィールドが含まれます。
| `Field` | 型 | 説明 |
|:-----------------------|:-----------|:------------------------------------------|
| `account_data` | オブジェクト | このアカウントの情報を含む[AccountRootレジャーオブジェクト](accountroot.html)がレジャーに保管されているとおりに表示されます。 |
| `account_flags` | オブジェクト | アカウントの`Flags`フィールドに基づく、アカウントのフラグ情報(下記参照)。 [新規: rippled 1.11.0][] |
| `signer_lists` | 配列 | (要求`signer_lists`が指定されていて、少なくとも1つのSignerListがアカウントに関連する場合を除いて省略)[マルチシグ](multi-signing.html)用にアカウントに関連付けられた[SignerListレジャーオブジェクト](signerlist.html)の配列。アカウントが所有できるSignerListは最大1つであるため、この配列のメンバーは存在するとすれば、1メンバーのみです。 |
| `signer_lists` | 配列 | (リクエスト`signer_lists`が指定されていて、少なくとも1つのSignerListがアカウントに関連する場合を除いて省略)[マルチシグ](multi-signing.html)用にアカウントに関連付けられた[SignerListレジャーオブジェクト](signerlist.html)の配列。アカウントが所有できるSignerListは最大1つであるため、この配列のメンバーは存在するとすれば、1メンバーのみです。 |
| `ledger_current_index` | 整数 | (`ledger_index`が代わりに指定されている場合は省略) この情報を取得したときに使用されていた最新のレジャーのシーケンス番号。この情報には、これより新しいレジャーの変更は一切含まれません。 |
| `ledger_index` | 整数 | (`ledger_current_index`が代わりに指定されている場合は省略) この情報を取得したときに使用されていたレジャーのシーケンス番号。この情報には、これより新しいレジャーの変更は一切含まれません。 |
| `queue_data` | オブジェクト | (`queue``true`と指定され、現在開いているレジャーを問い合わせている場合を除いて省略) このアカウントによって送信された[キューに入れられたトランザクション](transaction-cost.html#キューに入れられたトランザクション)についての情報。この情報にはローカル`rippled`サーバの状態が示されますが、コンセンサスネットワーク内の他のサーバとは異なる場合があります。示される値はキューメカニズムによって「大まかに」計算されるため、一部のフィールドは省略される場合があります。 |
@@ -226,7 +226,7 @@ rippled account_info rG1QQv2nh2gr7RCZ1P8YYcBUKCCN633jCn validated
| `noFreeze` | 真偽値 | `true`の場合、このアカウントは個々のトラストラインを凍結したり、グローバル凍結を行う機能を永久に放棄しています。詳細は[No Freeze](freezes.html#no-freeze)をご覧ください。 |
| `passwordSpent` | 真偽値 | `false`の場合、このアカウントはトランザクションコスト0の特別な[キーリセットトランザクション](transaction-cost.html#key-resetトランザクション)を送信できます。プロトコルはこのフラグを自動的にオン/オフします。 |
| `requireAuthorization` | 真偽値 | `true`の場合、このアカウントは[認可トラストライン](authorized-trust-lines.html)を使って、発行するトークンを保持できる人を制限しています。 |
| `requireDestinationTag` | 真偽値 | `true`の場合、このアカウントは受け取るすべての支払いに[宛先タグ](require-destination-tags.html)を要求しています。 |
| `requireDestinationTag` | 真偽値 | `true`の場合、このアカウントは受け取るすべての支払いに[宛先タグ](require-destination-tags.html)をリクエストしています。 |
`queue_data`パラメーターが存在する場合、以下のフィールドが含まれます。
@@ -252,8 +252,8 @@ rippled account_info rG1QQv2nh2gr7RCZ1P8YYcBUKCCN633jCn validated
## 考えられるエラー
* いずれかの[汎用エラータイプ][]。
* `invalidParams` - 1つ以上のフィールドの指定が正しくないか、1つ以上の必須フィールドが指定されていません。例えば、要求`queue``true`と指定したが、現在開いているレジャーではない`ledger_index`を指定した場合です。
* `actNotFound` - 要求`account`フィールドに指定したアドレスが、レジャー内のアカウントに対応していません。
* `invalidParams` - 1つ以上のフィールドの指定が正しくないか、1つ以上の必須フィールドが指定されていません。例えば、リクエスト`queue``true`と指定したが、現在開いているレジャーではない`ledger_index`を指定した場合です。
* `actNotFound` - リクエスト`account`フィールドに指定したアドレスが、レジャー内のアカウントに対応していません。
* `lgrNotFound` - `ledger_hash`または`ledger_index`で指定したレジャーが存在しないか、存在してはいるもののサーバーが保有していません。
[手数料レベル]: transaction-cost.html#手数料レベル

View File

@@ -10,9 +10,9 @@ labels:
`account_lines`メソッドは、アカウントのトラストラインに関する情報XRP以外のあらゆる通貨の残高と資産などを返します。取得された情報はすべて、特定バージョンのレジャーに関連付けられています。
## 要求フォーマット
## リクエストのフォーマット
要求フォーマットの例:
リクエストのフォーマットの例:
<!-- MULTICODE_BLOCK_START -->
@@ -50,7 +50,7 @@ rippled account_lines r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59
[試してみる >](websocket-api-tool.html#account_lines)
要求には以下のパラメーターを指定できます。
リクエストには以下のパラメーターを指定できます。
| `Field` | 型 | 説明 |
|:--------------|:---------------|:---------------|
@@ -59,13 +59,13 @@ rippled account_lines r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59
| `ledger_index` | 文字列または整数 | _省略可_ 使用するレジャーの[レジャーインデックス][]、またはレジャーを自動的に選択するためのショートカット文字列。([レジャーの指定][]をご覧ください) |
| `peer` | 文字列 | _省略可_ 2番目のアカウントの[アドレス][]。指定されている場合は、2つのアカウントを結ぶトラストラインだけが出力されます。 |
| `limit` | 整数 | 省略可、デフォルト値は可変取得するトラストラインの数を制限します。サーバはこの値を受け入れる必要はありません。10以上400以下の範囲で値を指定する必要があります。 |
| `marker` | [マーカー][] | _省略可_ 以前にページネーションされた応答の値。その応答を停止した箇所からデータの取得を再開します。 |
| `marker` | [マーカー][] | _省略可_ 以前にページネーションされたレスポンスの値。そのレスポンスを停止した箇所からデータの取得を再開します。 |
以下のパラメーターは廃止予定であり、今後予告なしに削除される可能性があります。`ledger`および`peer_index`
## 応答フォーマット
## レスポンスのフォーマット
処理が成功した応答の例:
処理が成功したレスポンスの例:
<!-- MULTICODE_BLOCK_START -->
@@ -407,16 +407,16 @@ rippled account_lines r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59
<!-- MULTICODE_BLOCK_END -->
この応答は[標準フォーマット][]に従っており、正常に完了した場合には、アカウントのアドレスとトラストラインオブジェクトの配列が含まれています。具体的には、結果オブジェクトには以下のフィールドが含まれます。
このレスポンスは[標準フォーマット][]に従っており、正常に完了した場合には、アカウントのアドレスとトラストラインオブジェクトの配列が含まれています。具体的には、結果オブジェクトには以下のフィールドが含まれます。
| `Field` | 型 | 説明 |
|:-----------------------|:----------------------------|:-----------------------|
| `account` | 文字列 | この要求に対応するアカウントの一意の[アドレス][]。トラストラインのための「パースペクティブアカウント」です。 |
| `account` | 文字列 | このリクエストに対応するアカウントの一意の[アドレス][]。トラストラインのための「パースペクティブアカウント」です。 |
| `lines` | 配列 | トラストラインオブジェクトからなる配列。以下で説明します。トラストラインの数が多い場合は、一度に`limit`の数までのトラストラインが返されます。 |
| `ledger_current_index` | 整数 - [レジャーインデックス][] | _`ledger_hash`または`ledger_index`が指定されている場合は省略_ この情報の取得時に使用した、現行のオープンレジャーのレジャーインデックス。 |
| `ledger_index` | 整数 - [レジャーインデックス][] | _`ledger_current_index`が指定されている場合は省略_ このデータの取得時に使用されたレジャーバージョンのレジャーインデックス。 |
| `ledger_hash` | 文字列 - [ハッシュ][] | _省略される場合があります_ このデータの取得時に使用されたレジャーバージョンの識別用ハッシュ。 |
| `marker` | [マーカー][] | 応答がページネーションされていることを示す、サーバが定義した値。この値を次のコールに渡して、このコールで終わった箇所から再開します。この後に追加のページがない場合は省略されます |
| `marker` | [マーカー][] | レスポンスがページネーションされていることを示す、サーバが定義した値。この値を次のコールに渡して、このコールで終わった箇所から再開します。この後に追加のページがない場合は省略されます |
各トラストラインオブジェクトには以下のフィールドの組み合わせが含まれています。
@@ -440,7 +440,7 @@ rippled account_lines r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59
* いずれかの[汎用エラータイプ][]。
* `invalidParams` - 1つ以上のフィールドの指定が正しくないか、1つ以上の必須フィールドが指定されていません。
* `actNotFound` - 要求`account`フィールドに指定されている[アドレス][]が、レジャーのアカウントに対応していません。
* `actNotFound` - リクエスト`account`フィールドに指定されている[アドレス][]が、レジャーのアカウントに対応していません。
* `lgrNotFound` - `ledger_hash`または`ledger_index`で指定したレジャーが存在しないか、存在してはいるもののサーバーが保有していません。
* `actMalformed` - 指定されている`marker`フィールドが受け入れられない場合。

View File

@@ -12,8 +12,8 @@ labels:
_([NonFungibleTokensV1_1 amendment][]により追加されました。)_
## 要求フォーマット
要求フォーマットの例
## リクエストのフォーマット
リクエストのフォーマットの例
{% include '_snippets/no-cli-syntax.ja.md' %}
@@ -45,7 +45,7 @@ _([NonFungibleTokensV1_1 amendment][]により追加されました。)_
[試してみる >](websocket-api-tool.html#account_nfts)
要求には以下のパラメーターが含まれます。
リクエストには以下のパラメーターが含まれます。
| フィールド | 型 | 説明 |
|:---------------|:-----------------|:-----------------------------------------|
@@ -56,8 +56,8 @@ _([NonFungibleTokensV1_1 amendment][]により追加されました。)_
| `marker` | [マーカー][] | _(省略可)_ 以前のページ分割されたレスポンスの値。そのレスポンスが終了したところからデータの取得を再開します。 |
## 応答フォーマット
処理が成功した応答の例:
## レスポンスのフォーマット
処理が成功したレスポンスの例:
<!-- MULTICODE_BLOCK_START -->
@@ -128,7 +128,7 @@ _([NonFungibleTokensV1_1 amendment][]により追加されました。)_
<!-- MULTICODE_BLOCK_END -->
この応答は[標準フォーマット][]に従っており、正常に完了した場合は結果に次のフィールドが含まれます。
このレスポンスは[標準フォーマット][]に従っており、正常に完了した場合は結果に次のフィールドが含まれます。
| `Field` | 型 | 説明 |
|:-----------------------|:----------------------------|:----------------------------------------|
@@ -156,7 +156,7 @@ _([NonFungibleTokensV1_1 amendment][]により追加されました。)_
* いずれかの[汎用エラータイプ][]。
* `invalidParams` - 1つ以上のフィールドの指定が正しくないか、1つ以上の必須フィールドが指定されていません。
* `actNotFound` - 要求`account`フィールドに指定されている[アドレス][]が、レジャーのアカウントに対応していません。
* `actNotFound` - リクエスト`account`フィールドに指定されている[アドレス][]が、レジャーのアカウントに対応していません。
* `lgrNotFound` - `ledger_hash`または`ledger_index`で指定したレジャーが存在しないか、存在してはいるもののサーバーが保有していません。

View File

@@ -11,7 +11,7 @@ labels:
`account_objects`コマンドは、アカウントが所有するすべてのレジャーエントリの生[レジャーフォーマット][]を返します。アカウントのトラストラインと残高の概要については、[account_linesメソッド][]をご覧ください。
アカウントの`account_objects`応答に含まれる可能性のあるオブジェクトのタイプには以下のものがあります。
アカウントの`account_objects`レスポンスに含まれる可能性のあるオブジェクトのタイプには以下のものがあります。
- [Offerエントリ](offer.html): 現在処理中であり、資金化されていない、または有効期限切れで削除されていない注文情報。(詳細は、[オファーのライフサイクル](offers.html#オファーのライフサイクル)をご覧ください。)
- [RippleStateエントリ](ripplestate.html): このアカウント側がデフォルト状態にないトラストライン。
@@ -25,8 +25,8 @@ labels:
- [NFTokenPageエントリ](nftokenpage.html): NFTの集合。 [新規: rippled 1.11.0][]
## 要求フォーマット
要求フォーマットの例:
## リクエストのフォーマット
リクエストのフォーマットの例:
<!-- MULTICODE_BLOCK_START -->
@@ -71,7 +71,7 @@ rippled account_objects r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59 validated
<!-- MULTICODE_BLOCK_END -->
要求には以下のパラメーターが含まれます。
リクエストには以下のパラメーターが含まれます。
| `Field` | 型 | 必須? | 説明 |
|:-------------------------|:----------------------|:-----|:---------------|
@@ -80,14 +80,14 @@ rippled account_objects r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59 validated
| `ledger_hash` | [ハッシュ][] | いいえ | 使用するレジャーバージョンの20バイトの16進文字列。[レジャーの指定][]をご覧ください) |
| `ledger_index` | [レジャーインデックス][] | いいえ | 使用するレジャーの[レジャーインデックス][]、またはレジャーを自動的に選択するためのショートカット文字列。([レジャーの指定][]ををご覧ください) |
| `limit` | 符号なし整数 | いいえ | 結果に含めることができるオブジェクトの最大数。非管理者接続では10以上400以下の範囲で値を指定する必要があります。デフォルトでは200です。 |
| `marker` | [マーカー][] | いいえ | 以前にページネーションされた応答の値。その応答を停止した箇所からデータの取得を再開します。 |
| `marker` | [マーカー][] | いいえ | 以前にページネーションされたレスポンスの値。そのレスポンスを停止した箇所からデータの取得を再開します。 |
| `type` | 文字列 | いいえ | 指定されている場合、結果をフィルタリングしてこのタイプのレジャーオブジェクトのみが含まれるようにします。有効なタイプは`check``deposit_preauth``escrow``offer``payment_channel``signer_list``state`(トラストライン)そして`ticket`です。 |
**注記:** `account_objects`コマンドのコマンドラインインタフェースは`type`フィールドを受け付けません。代わりにコマンドラインでJSON-RPC形式のリクエストを送信するには[jsonメソッド][]を使用してください。
## 応答フォーマット
## レスポンスのフォーマット
処理が成功した応答の例:
処理が成功したレスポンスの例:
<!-- MULTICODE_BLOCK_START -->
@@ -1204,24 +1204,24 @@ rippled account_objects r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59 validated
<!-- MULTICODE_BLOCK_END -->
この応答は[標準フォーマット][]に従っており、正常に完了した場合は結果に次のフィールドが含まれます。
このレスポンスは[標準フォーマット][]に従っており、正常に完了した場合は結果に次のフィールドが含まれます。
| `Field` | 型 | 説明 |
|:-----------------------|:----------------------------|:------------------------|
| `account` | 文字列 | この要求に対応するアカウントの一意の[アドレス][]。 |
| `account` | 文字列 | このリクエストに対応するアカウントの一意の[アドレス][]。 |
| `account_objects` | 配列 | このアカウントが所有するオブジェクトの配列。各オブジェクトは、生[レジャーフォーマット][]です。 |
| `ledger_hash` | 文字列 | (省略される場合があります)この応答の生成に使用されたレジャーの識別用ハッシュ。 |
| `ledger_index` | 数値 - [レジャーインデックス][] | _省略される場合があります_ この応答の生成に使用されたレジャーバージョンのレジャーインデックス。 |
| `ledger_current_index` | 数値 - [レジャーインデックス][] | _省略される場合があります_ この応答の生成に使用された現在処理中のレジャーバージョンのレジャーインデックス。 |
| `limit` | 数値 | _省略される場合があります_ この要求で使用されていた制限(制限の使用がある場合)。 |
| `marker` | [マーカー][] | 応答がページネーションされていることを示す、サーバーが定義した値。この値を次のコールに渡して、このコールで終わった箇所から再開します。この後に追加のページがない場合は省略されます。 |
| `validated` | 真偽値 | このフィールドが含まれていて`true`に設定されている場合、この応答内の情報は検証済みのレジャーバージョンから取得されています。そうでない場合、情報は変更されることがあります。 |
| `ledger_hash` | 文字列 | (省略される場合があります)このレスポンスの生成に使用されたレジャーの識別用ハッシュ。 |
| `ledger_index` | 数値 - [レジャーインデックス][] | _省略される場合があります_ このレスポンスの生成に使用されたレジャーバージョンのレジャーインデックス。 |
| `ledger_current_index` | 数値 - [レジャーインデックス][] | _省略される場合があります_ このレスポンスの生成に使用された現在処理中のレジャーバージョンのレジャーインデックス。 |
| `limit` | 数値 | _省略される場合があります_ このリクエストで使用されていた制限(制限の使用がある場合)。 |
| `marker` | [マーカー][] | レスポンスがページネーションされていることを示す、サーバーが定義した値。この値を次のコールに渡して、このコールで終わった箇所から再開します。この後に追加のページがない場合は省略されます。 |
| `validated` | 真偽値 | このフィールドが含まれていて`true`に設定されている場合、このレスポンス内の情報は検証済みのレジャーバージョンから取得されています。そうでない場合、情報は変更されることがあります。 |
## 考えられるエラー
* いずれかの[汎用エラータイプ][]。
* `invalidParams` - 1つ以上のフィールドの指定が正しくないか、1つ以上の必須フィールドが指定されていません。
* `actNotFound` - 要求`account`フィールドに指定されている[アドレス][]が、レジャーのアカウントに対応していません。
* `actNotFound` - リクエスト`account`フィールドに指定されている[アドレス][]が、レジャーのアカウントに対応していません。
* `lgrNotFound` - `ledger_hash`または`ledger_index`で指定したレジャーが存在しないか、存在してはいるもののサーバーが保有していません。

View File

@@ -10,9 +10,9 @@ labels:
`account_offers`メソッドは、特定の[アカウント](accounts.html)から出された[オファー](offers.html)のうち、特定の[レジャーバージョン](ledgers.html)で未処理であったオファーのリストを取得します。
## 要求フォーマット
## リクエストのフォーマット
要求フォーマットの例:
リクエストのフォーマットの例:
<!-- MULTICODE_BLOCK_START -->
@@ -50,7 +50,7 @@ rippled account_offers r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59 current
[試してみる >](websocket-api-tool.html#account_offers)
要求には以下のパラメーターを指定できます。
リクエストには以下のパラメーターを指定できます。
| `Field` | 型 | 必須? | 説明 |
|:---------------|:----------------------|:-----|:------------------------------|
@@ -58,13 +58,13 @@ rippled account_offers r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59 current
| `ledger_hash` | [ハッシュ][] | いいえ | 使用するレジャーバージョンを識別する20バイトの16進文字列。 |
| `ledger_index` | [レジャーインデックス][] | いいえ | 使用するレジャーの[レジャーインデックス][]、レジャーを自動的に選択するためのショートカット文字列。([レジャーの指定][]をご覧ください |
| `limit` | 整数 | いいえ | 取得するオファーの数を制限します。サーバはこの数より少ない結果を返すことがあります。10400の範囲内でなければなりません。この範囲外の正の値は、最も近い有効なオプションに置き換えられます。デフォルトは200です。 |
| `marker` | [マーカー][] | いいえ | 以前にページネーションされた応答の値。その応答を停止した箇所からデータの取得を再開します。 |
| `marker` | [マーカー][] | いいえ | 以前にページネーションされたレスポンスの値。そのレスポンスを停止した箇所からデータの取得を再開します。 |
以下のパラメーターは廃止予定であり、今後予告なしに削除される可能性があります。`ledger`,`strict`
## 応答フォーマット
## レスポンスのフォーマット
処理が成功した応答の例:
処理が成功したレスポンスの例:
<!-- MULTICODE_BLOCK_START -->
@@ -186,16 +186,16 @@ rippled account_offers r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59 current
<!-- MULTICODE_BLOCK_END -->
この応答は[標準フォーマット][]に従っており、正常に完了した場合は結果に次のフィールドが含まれます。
このレスポンスは[標準フォーマット][]に従っており、正常に完了した場合は結果に次のフィールドが含まれます。
| `Field` | 型 | 説明 |
|:-----------------------|:----------------------------|:------------------------|
| `account` | 文字列 | オファーを出したアカウントを識別する一意の[アドレス][] |
| `offers` | 配列 | オブジェクトの配列。各オブジェクトは、このアカウントが出したオファーの中で、レジャーバージョンが要求された時点で未処理のオファーを表します。オファーの数が多い場合は、一度に`limit`の数までのオファーが返されます。 |
| `offers` | 配列 | オブジェクトの配列。各オブジェクトは、このアカウントが出したオファーの中で、レジャーバージョンがリクエストされた時点で未処理のオファーを表します。オファーの数が多い場合は、一度に`limit`の数までのオファーが返されます。 |
| `ledger_current_index` | 数値 - [レジャーインデックス][] | _`ledger_hash`または`ledger_index`が指定されている場合は省略可_ このデータの取得時に使用した、現在処理中のレジャーバージョンのレジャーインデックス。 |
| `ledger_index` | 数値 - [レジャーインデックス][] | _`ledger_current_index`が指定されている場合は省略可_ 要求に従って、このデータの取得時に使用されたレジャーバージョンのレジャーインデックス。 |
| `ledger_index` | 数値 - [レジャーインデックス][] | _`ledger_current_index`が指定されている場合は省略可_ リクエストに従って、このデータの取得時に使用されたレジャーバージョンのレジャーインデックス。 |
| `ledger_hash` | 文字列 - [ハッシュ][] | _省略される場合があります_ このデータの取得時に使用されたレジャーバージョンの識別用ハッシュ。 |
| `marker` | [マーカー][] | _省略される場合があります_ 応答がページネーションされていることを示す、サーバが定義した値。この値を次のコールに渡して、このコールで終わった箇所から再開します。この後に情報ページがない場合は省略されます。 |
| `marker` | [マーカー][] | _省略される場合があります_ レスポンスがページネーションされていることを示す、サーバが定義した値。この値を次のコールに渡して、このコールで終わった箇所から再開します。この後に情報ページがない場合は省略されます。 |
各Offerオブジェクトのフィールドを次に示します。
@@ -213,7 +213,7 @@ rippled account_offers r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59 current
* いずれかの[汎用エラータイプ][]。
* `invalidParams` - 1つ以上のフィールドの指定が正しくないか、1つ以上の必須フィールドが指定されていません。
* `actNotFound` - 要求`account`フィールドに指定されている[アドレス][]が、レジャーのアカウントに対応していません。
* `actNotFound` - リクエスト`account`フィールドに指定されている[アドレス][]が、レジャーのアカウントに対応していません。
* `lgrNotFound` - `ledger_hash`または`ledger_index`で指定したレジャーが存在しないか、存在してはいるもののサーバーが保有していません。
* `actMalformed` - 指定されている`marker`フィールドが受け入れられない場合。

View File

@@ -11,9 +11,9 @@ labels:
`account_tx`メソッドは、指定したアカウントに関連するトランザクションのリストを取得します。
## 要求フォーマット
## リクエストのフォーマット
要求フォーマットの例:
リクエストのフォーマットの例:
<!-- MULTICODE_BLOCK_START -->
@@ -61,7 +61,7 @@ rippled -- account_tx r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59 -1 -1 2 5 1 0 1
[試してみる >](websocket-api-tool.html#account_tx)
要求には以下のパラメーターが含まれます。
リクエストには以下のパラメーターが含まれます。
| `Field` | 型 | 説明 |
|:-------------------|:-------------------------------------------|:-----------|
@@ -73,9 +73,9 @@ rippled -- account_tx r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59 -1 -1 2 5 1 0 1
| `binary` | ブール値 | _省略可能_ デフォルトは`false`です。`true`に設定すると、JSONの代わりに16進文字列でトランザクションが返されます。 |
| `forward` | ブール値 | _省略可能_ デフォルトは`false`です。`true`に設定すると、最も古いレジャーを先頭としてインデックスが付けられた値が返されます。そうしない場合、最新のレジャーを先頭として結果にインデックスが付けられます。(結果を示した各ページの中身は順序よく整理されていない場合がありますが、ページ全体としては順序付けされています。) |
| `limit` | 整数 | _省略可能_ デフォルトは変化します。取得するトランザクションの数を制限します。サーバーはこの値を受け入れる必要はありません。 |
| `marker` | [マーカー][] | 以前にページネーションされた応答の値。その応答を停止した箇所からデータの取得を再開します。サーバーが使用できるレジャーの範囲に変更があっても、この値は変わりません。 |
| `marker` | [マーカー][] | 以前にページネーションされたレスポンスの値。そのレスポンスを停止した箇所からデータの取得を再開します。サーバーが使用できるレジャーの範囲に変更があっても、この値は変わりません。 |
次の各フィールドは省略可能とされていますが、要求内で**1つ以上は使用する必要があります**: `ledger_index``ledger_hash``ledger_index_min`、または`ledger_index_max`
次の各フィールドは省略可能とされていますが、リクエスト内で**1つ以上は使用する必要があります**: `ledger_index``ledger_hash``ledger_index_min`、または`ledger_index_max`
次のフィールドは廃止されました: `offset``count``descending``ledger_max``ledger_min`。 [削除: rippled 1.7.0][]
@@ -83,11 +83,11 @@ rippled -- account_tx r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59 -1 -1 2 5 1 0 1
他のページネーションメソッドと同様に、`marker`フィールドを使用すると複数ページのデータが返されます。
複数の要求の合間に、`"ledger_index_min": -1``"ledger_index_max": -1`が変更されて、以前とは異なるレジャーバージョンを参照する場合があります。`marker`フィールドを使用すると、要求からのレジャー範囲に変更がある場合でも、マーカーが示すポイントが要求で指定されたレジャーの範囲外でない限り、安全にページネーションできます。
複数のリクエストの合間に、`"ledger_index_min": -1``"ledger_index_max": -1`が変更されて、以前とは異なるレジャーバージョンを参照する場合があります。`marker`フィールドを使用すると、リクエストからのレジャー範囲に変更がある場合でも、マーカーが示すポイントがリクエストで指定されたレジャーの範囲外でない限り、安全にページネーションできます。
## 応答フォーマット
## レスポンスのフォーマット
処理が成功した応答の例:
処理が成功したレスポンスの例:
<!-- MULTICODE_BLOCK_START -->
@@ -564,21 +564,21 @@ rippled -- account_tx r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59 -1 -1 2 5 1 0 1
<!-- MULTICODE_BLOCK_END -->
この応答は[標準フォーマット][]に従っており、正常に完了した場合は結果に次のフィールドが含まれます。
このレスポンスは[標準フォーマット][]に従っており、正常に完了した場合は結果に次のフィールドが含まれます。
| `Field` | 型 | 説明 |
|:-------------------|:---------------------------|:---------------------------|
| `account` | 文字列 | 関連するアカウントを識別する一意の[アドレス][]。 |
| `ledger_index_min` | 整数 - [レジャーインデックス][] | トランザクションで実際に検索された最古のレジャーのレジャーインデックス。 |
| `ledger_index_max` | 整数 - [レジャーインデックス][] | トランザクションで実際に検索された最新のレジャーのレジャーインデックス。 |
| `limit` | 整数 | 要求で使用される`limit`値。(サーバーによって強制される実際の制限値とは異なる場合があります。) |
| `marker` | [マーカー][] | 応答がページネーションされていることを示す、サーバーが定義した値。この値を次のコールに渡して、このコールで終わった箇所から再開します。 |
| `transactions` | 配列 | 以降で説明する、要求の基準を満たすトランザクションの配列。 |
| `validated` | ブール値 | このフィールドが含まれていて`true`に設定されている場合、この応答内の情報は検証済みのレジャーバージョンから取得されています。そうでない場合、情報は変更されることがあります。 |
| `limit` | 整数 | リクエストで使用される`limit`値。(サーバーによって強制される実際の制限値とは異なる場合があります。) |
| `marker` | [マーカー][] | レスポンスがページネーションされていることを示す、サーバーが定義した値。この値を次のコールに渡して、このコールで終わった箇所から再開します。 |
| `transactions` | 配列 | 以降で説明する、リクエストの基準を満たすトランザクションの配列。 |
| `validated` | ブール値 | このフィールドが含まれていて`true`に設定されている場合、このレスポンス内の情報は検証済みのレジャーバージョンから取得されています。そうでない場合、情報は変更されることがあります。 |
**注記:** サーバーから返される`ledger_index_min`および`ledger_index_max`の値が要求で指定したものとは異なる場合があります。例えば、サーバーに手元の指定したバージョンがない場合など。
**注記:** サーバーから返される`ledger_index_min`および`ledger_index_max`の値がリクエストで指定したものとは異なる場合があります。例えば、サーバーに手元の指定したバージョンがない場合など。
各トランザクションのオブジェクトには以下のフィールドが含まれます。含まれるフィールドは、JSONまたは16進文字列`"binary":true`)フォーマットのどちらで要求されたかによって異なります。
各トランザクションのオブジェクトには以下のフィールドが含まれます。含まれるフィールドは、JSONまたは16進文字列`"binary":true`)フォーマットのどちらでリクエストされたかによって異なります。
| `Field` | 型 | 説明 |
|:---------------|:---------------------------------|:-------------------------|
@@ -592,9 +592,9 @@ rippled -- account_tx r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59 -1 -1 2 5 1 0 1
* いずれかの[汎用エラータイプ][]。
* `invalidParams` - 1つ以上のフィールドの指定が正しくないか、1つ以上の必須フィールドが指定されていません。
* `actMalformed` - 要求`account`フィールドに指定した[アドレス][]が、正しいフォーマットではありません。
* `actMalformed` - リクエスト`account`フィールドに指定した[アドレス][]が、正しいフォーマットではありません。
* `lgrIdxMalformed` - `ledger_index_min`または`ledger_index_max`で指定したレジャーが存在しないか、存在してはいるもののサーバーが保有していません。
* `lgrIdxsInvalid` - 要求`ledger_index_min`の前にある`ledger_index_max`を指定したか、[ネットワークと同期](troubleshoot-the-rippled-server.html)されていないためにサーバーに検証済みレジャーの範囲が存在しません。
* `lgrIdxsInvalid` - リクエスト`ledger_index_min`の前にある`ledger_index_max`を指定したか、[ネットワークと同期](troubleshoot-the-rippled-server.html)されていないためにサーバーに検証済みレジャーの範囲が存在しません。
{% include '_snippets/rippled_versions.md' %}

View File

@@ -11,8 +11,8 @@ labels:
`gateway_balances`コマンドは、特定のアカウントから発行された残高の合計を計算します。オプションで、[運用アドレス](account-types.html)が保有する額を除外できます。[新規: rippled 0.28.2][]
## 要求フォーマット
要求フォーマットの例:
## リクエストのフォーマット
リクエストのフォーマットの例:
<!-- MULTICODE_BLOCK_START -->
@@ -50,7 +50,7 @@ labels:
<!-- MULTICODE_BLOCK_END -->
要求には以下のパラメーターが含まれます。
リクエストには以下のパラメーターが含まれます。
| `Field` | 型 | 説明 |
|:---------------|:---------------------------|:-------------------------------|
@@ -60,9 +60,9 @@ labels:
| `ledger_hash` | 文字列 | _省略可_ 使用するレジャーバージョンの20バイトの16進文字列。[レジャーの指定][]を参照してください) |
| `ledger_index` | 文字列または符号なし整数 | _省略可_ 使用するレジャーバージョンの[レジャーインデックス][]、またはレジャーを自動的に選択するためのショートカット文字列。([レジャーの指定][]を参照してください) |
## 応答フォーマット
## レスポンスのフォーマット
処理が成功した応答の例:
処理が成功したレスポンスの例:
<!-- MULTICODE_BLOCK_START -->
@@ -205,24 +205,24 @@ labels:
**注記:** このメソッドのコマンドライン構文はありません。コマンドラインからアクセスするには[jsonメソッド][]を使用してください。
この応答は[標準フォーマット][]に従っており、正常に完了した場合は結果に次のフィールドが含まれます。
このレスポンスは[標準フォーマット][]に従っており、正常に完了した場合は結果に次のフィールドが含まれます。
| `Field` | 型 | 説明 |
|:-----------------------|:--------------------------|:------------------------|
| `account` | 文字列 - [アドレス][] | 残高を発行したアカウントのアドレス。 |
| `obligations` | オブジェクト | (空の場合は省略)除外されていないアドレスに発行された額の合計。発行された価値の合計に対する通貨のマップとして示されます。 |
| `balances` | オブジェク | _空の場合は省略_ 要求から`hotwallet`アドレスに発行された額。キーはアドレスであり、値はアドレスが保有する通貨額の配列です。 |
| `balances` | オブジェク | _空の場合は省略_ リクエストから`hotwallet`アドレスに発行された額。キーはアドレスであり、値はアドレスが保有する通貨額の配列です。 |
| `assets` | オブジェクト | _空の場合は省略_ 他から発行された保有額の合計。推奨される構成では、[発行アドレス](account-types.html)の保有額はありません。 |
| `ledger_hash` | 文字列 - [ハッシュ][] | _省略される場合があります_ この応答の生成に使用されたレジャーバージョンの識別用ハッシュ。 |
| `ledger_index` | 数値 - [レジャーインデックス][] | _省略される場合があります_ この応答の生成に使用されたレジャーバージョンのレジャーインデックス。 | |
| `ledger_hash` | 文字列 - [ハッシュ][] | _省略される場合があります_ このレスポンスの生成に使用されたレジャーバージョンの識別用ハッシュ。 |
| `ledger_index` | 数値 - [レジャーインデックス][] | _省略される場合があります_ このレスポンスの生成に使用されたレジャーバージョンのレジャーインデックス。 | |
| `ledger_current_index` | 数値 - [レジャーインデックス][] | _`ledger_current_index`が指定されている場合は省略_ この情報の取得時に使用した、現在処理中のレジャーバージョンの[レジャーインデックス][]。 |
## 考えられるエラー
* いずれかの[汎用エラータイプ][]。
* `invalidParams` - 1つ以上のフィールドの指定が正しくないか、1つ以上の必須フィールドが指定されていません。
* `invalidHotWallet` - `hotwallet`フィールドに指定されている1つ以上のアドレスが、要求に指定されているアカウントが発行した通貨を保有しているアカウントの[アドレス][]ではありません。
* `actNotFound` - 要求`account`フィールドに指定されている[アドレス][]が、レジャーのアカウントに対応していません。
* `invalidHotWallet` - `hotwallet`フィールドに指定されている1つ以上のアドレスが、リクエストに指定されているアカウントが発行した通貨を保有しているアカウントの[アドレス][]ではありません。
* `actNotFound` - リクエスト`account`フィールドに指定されている[アドレス][]が、レジャーのアカウントに対応していません。
* `lgrNotFound` - `ledger_hash`または`ledger_index`で指定したレジャーが存在しないか、存在してはいるもののサーバーが保有していません。

View File

@@ -10,8 +10,8 @@ labels:
`noripple_check`コマンドを使用すると、[アカウントのDefaultRippleフィールドとそのトラストラインのNoRippleフラグ](rippling.html)の状態を、推奨される設定と比較して迅速にチェックできます。
## 要求フォーマット
要求フォーマットの例:
## リクエストのフォーマット
リクエストのフォーマットの例:
<!-- MULTICODE_BLOCK_START -->
@@ -50,7 +50,7 @@ labels:
**注記:** このメソッドのコマンドライン構文はありません。コマンドラインからアクセスするには[jsonメソッド][]を使用してください。
要求には以下のパラメーターが含まれます。
リクエストには以下のパラメーターが含まれます。
| `Field` | 型 | 説明 |
|:---------------|:---------------------------|:-------------------------------|
@@ -61,9 +61,9 @@ labels:
| `ledger_hash` | 文字列 | _省略可_ 使用するレジャーバージョンの20バイトの16進数文字列。[レジャーの指定][]を参照してください。) |
| `ledger_index` | 文字列または符号なし整数 | _省略可_ 使用するレジャーのシーケンス番号、またはレジャーを自動的に選択するためのショートカット文字列。([レジャーの指定][]を参照してください。) |
## 応答フォーマット
## レスポンスのフォーマット
処理が成功した応答の例:
処理が成功したレスポンスの例:
<!-- MULTICODE_BLOCK_START -->
@@ -172,19 +172,19 @@ labels:
<!-- MULTICODE_BLOCK_END -->
応答は[標準フォーマット][]に従っており、正常に完了した場合は結果に次のフィールドが含まれています。
レスポンスは[標準フォーマット][]に従っており、正常に完了した場合は結果に次のフィールドが含まれています。
| `Field` | 型 | 説明 |
|:-----------------------|:-------|:-------------------------------------------|
| `ledger_current_index` | 数値 | これらの結果の計算に使用するレジャーのシーケンス番号。 |
| `problems` | 配列 | 人間が読み取ることができる形式の問題の記述が含まれている文字列の配列。アカウントのDefaultRipple設定が推奨に従っていない場合は、最大1つのエントリーが含まれます。加えて、NoRipple設定が推奨に従っていないトラストラインのエントリー最大で`limit`に指定されている数)も含まれます。 |
| `transactions` | 配列 | (省略される場合があります)要求`transactions``true`に指定されている場合、これはJSONオブジェクトの配列です。各JSONオブジェクトは、JSON形式の[トランザクション](transaction-formats.html)で、記述されている問題の1つを修正します。この配列の長さは`problems`配列と同じであり、各エントリーは、その配列の同じインデックスで記述されている問題の修正を目的としています。 |
| `transactions` | 配列 | (省略される場合があります)リクエスト`transactions``true`に指定されている場合、これはJSONオブジェクトの配列です。各JSONオブジェクトは、JSON形式の[トランザクション](transaction-formats.html)で、記述されている問題の1つを修正します。この配列の長さは`problems`配列と同じであり、各エントリーは、その配列の同じインデックスで記述されている問題の修正を目的としています。 |
## 考えられるエラー
* [汎用エラータイプ][]のすべて。
* `invalidParams` - 1つ以上のフィールドの指定が正しくないか、1つ以上の必須フィールドが指定されていません。
* `actNotFound` - 要求`account`フィールドに指定されている[アドレス][]が、レジャーのアカウントに対応していません。
* `actNotFound` - リクエスト`account`フィールドに指定されている[アドレス][]が、レジャーのアカウントに対応していません。
* `lgrNotFound` - `ledger_hash`または`ledger_index`に指定されているレジャーが存在しないか、存在しているがサーバーにはありません。

View File

@@ -13,7 +13,7 @@ labels:
Clioサーバはデフォルトで検証済みのレジャーデータを返すことに注意してください。
## リクエストのフォーマット
リクエストフォーマットの例:
リクエストフォーマットの例:
<!-- MULTICODE_BLOCK_START -->
@@ -41,7 +41,7 @@ Clioサーバはデフォルトで検証済みのレジャーデータを返す
| `ledger_index` | [レジャーインデックス][] | _(省略可)_ 使用するレジャーの[レジャーインデックス][]、またはレジャーを自動的に選択するためのショートカット文字列。([レジャーの指定][]をご覧ください) |
| `transactions` | 真偽値 | _(省略可)_ `true`の場合、指定されたレジャーバージョンのトランザクションに関する情報が返されます。デフォルトでは`false`です。レジャーバージョンを指定しない場合は無視されます。 |
| `expand` | 真偽値 | _(省略可)_ ハッシュのみではなく、トランザクション/アカウントの完全な情報がJSONフォーマットで提供されます。デフォルトでは`false`です。トランザクション、アカウント、またはその両方をリクエストしない場合は無視されます。 |
| `owner_funds` | 真偽値 | _(省略可)_ `true`の場合、応答のOfferCreateトランザクションのメタデータに`owner_funds`フィールドが含まれます。デフォルトでは`false`です。トランザクションが含まれておらず、`expand`がtrueではない場合には無視されます。 |
| `owner_funds` | 真偽値 | _(省略可)_ `true`の場合、レスポンスのOfferCreateトランザクションのメタデータに`owner_funds`フィールドが含まれます。デフォルトでは`false`です。トランザクションが含まれておらず、`expand`がtrueではない場合には無視されます。 |
| `binary` | 真偽値 | _(省略可)_ `true`で、かつ`transactions``expand`が両方とも`true`の場合、JSONフォーマットではなくバイナリフォーマット16進文字列でトランザクション情報が返されます。 |
| `diff` | 真偽値 | _(省略可)_ `true`の場合、指定したレジャーのトランザクションの一部として追加、変更、または削除されたすべてのオブジェクトを返します。 |
@@ -101,7 +101,7 @@ Clioサーバはデフォルトで検証済みのレジャーデータを返す
| `validated` | 真偽値 | _(省略される場合があります)_ `true`の場合、このレジャーは最終バージョンです。省略または `false` の場合、このレジャーのデータは最終版ではありません。 |
| `diff` | オブジェクト | _(リクエストで`diff`パラメータの指定がない場合省略)_ レジャーのトランザクションの一部として追加、変更、または削除されたハッシュの配列を含むオブジェクト。 |
リクエストに`"owner_funds": true`が指定されておりトランザクションが展開されている場合、応答には、各[OfferCreateトランザクション][]の`metaData`オブジェクトの`owner_funds`フィールドが含まれています。このフィールドの目的は、新しい検証済みレジャーごとに[オファーの資金化ステータス](offers.html#オファーのライフサイクル)を容易に追跡できるようにすることです。このフィールドの定義は、[オーダーブックサブスクリプションストリーム](subscribe.html#オーダーブックストリーム)でのこのフィールドのバージョンとはわずかに異なります。
リクエストに`"owner_funds": true`が指定されておりトランザクションが展開されている場合、レスポンスには、各[OfferCreateトランザクション][]の`metaData`オブジェクトの`owner_funds`フィールドが含まれています。このフィールドの目的は、新しい検証済みレジャーごとに[オファーの資金化ステータス](offers.html#オファーのライフサイクル)を容易に追跡できるようにすることです。このフィールドの定義は、[オーダーブックサブスクリプションストリーム](subscribe.html#オーダーブックストリーム)でのこのフィールドのバージョンとはわずかに異なります。
| `Field` | 値 | 説明 |
|:--------------|:------|:----------------------------------------------------|

View File

@@ -14,7 +14,7 @@ labels:
**注記** `nft_history`はNFTに関連する成功したトランザクションのみを返します。
## リクエストのフォーマット
リクエストフォーマットの例:
リクエストフォーマットの例:
<!-- MULTICODE_BLOCK_START -->

View File

@@ -11,7 +11,7 @@ labels:
`nft_info`コマンドはクエリ対象の[NFT](non-fungible-tokens.html)に関する情報をClioサーバに問い合わせます。[新規: Clio v1.1.0](https://github.com/XRPLF/clio/releases/tag/1.1.0 "BADGE_BLUE")
## リクエストのフォーマット
リクエストフォーマットの例:
リクエストフォーマットの例:
<!-- MULTICODE_BLOCK_START -->

View File

@@ -589,7 +589,7 @@ labels:
| `load_factor` | 数値 | サーバが現在実行中の、負荷スケーリングされたオープンレジャートランザクションコストを、基本トランザクションコストに適用される乗数として示したもの。例えば、負荷係数`1000`でリファレンストランザクションコストが10 dropである場合、負荷スケーリングされたトランザクションコストは10,000 drop0.01 XRPです。負荷係数は、[個々のサーバの負荷係数](transaction-cost.html#ローカル負荷コスト)の最高値、クラスターの負荷係数、[オープンレジャーコスト](transaction-cost.html#オープンレジャーコスト)、ネットワーク全体の負荷係数によって決まります。 |
| `clio_version` | 文字列 | 実行中のClioサーバのバージョン番号。 |
| `libxrpl_version` | 文字列 | このClioサーバがビルドされた`libxrpl`ライブラリのバージョン番号。[新規: Clio v2.0](https://github.com/XRPLF/clio/releases/tag/2.0.0 "BADGE_BLUE") |
| `validation_quorum` | 数値 | _(省略される場合があります)_ レジャーバージョンを検証するために必要な、信頼できる検証の最小数。状況によっては、サーバがより多くの検証を要求することもあります。この値は`rippled`から取得します。何らかの理由でClioサーバが`rippled`に接続できない場合、このフィールドはレスポンスから省略されることがあります。 |
| `validation_quorum` | 数値 | _(省略される場合があります)_ レジャーバージョンを検証するために必要な、信頼できる検証の最小数。状況によっては、サーバがより多くの検証をリクエストすることもあります。この値は`rippled`から取得します。何らかの理由でClioサーバが`rippled`に接続できない場合、このフィールドはレスポンスから省略されることがあります。 |
| `rippled_version` | 文字列 | _(省略される場合があります)_ Clioサーバが接続している`rippled`サーバのバージョン番号。何らかの理由でClioサーバが`rippled`に接続できない場合、このフィールドはレスポンスから省略されることがあります。 |
| `network_id` | 文字列 | _(省略される場合があります)_ このClioサーバが接続している`rippled`が動作しているネットワークのネットワークID。何らかの理由でClioサーバが`rippled`に接続できない場合、このフィールドはレスポンスから省略されることがあります。[新規: Clio v2.0](https://github.com/XRPLF/clio/releases/tag/2.0.0 "BADGE_BLUE") |
| `validated_ledger` | オブジェクト | _(省略される場合があります)_ 完全に検証された最新のレジャーに関する情報。検証済みの最新のレジャーがない場合、レスポンスではこのフィールドは省略され、代わりに`closed_ledger`が含まれます。 |
@@ -600,7 +600,7 @@ labels:
| `validated_ledger.reserve_base_xrp` | 数値 | すべてのアカウントで準備金として保有しておく必要があるXRPの最少額drop数ではありません |
| `validated_ledger.reserve_inc_xrp` | 数値 | アカウントがレジャー内に保有するオブジェクトごとのアカウント準備金に追加するXRP額drop数ではありません |
| `validated_ledger.seq` | 数値 | 最新の検証済みレジャーのレジャーインデックス |
| `validation_quorum` | 数値 | レジャーバージョンの検証に、最低限必要となる信頼できる検証の数。場合によっては、サーバがさらに検証を要求する場合があります。 |
| `validation_quorum` | 数値 | レジャーバージョンの検証に、最低限必要となる信頼できる検証の数。場合によっては、サーバがさらに検証をリクエストする場合があります。 |
| `validator_list_expires` | 文字列 | _管理者のみ_ 現在のバリデータリストの有効期限が切れるタイミングを人間が読み取れる時間でを表示、または、サーバが発行済みのバリデータリストをロードしていない場合は文字列`unknown`、サーバが静的なバリデータリストを使用する場合は文字列`never`のいずれかを表示します。 |
| `cache` | オブジェクト | Clioの状態データのキャッシュに関する情報。 |
| `cache.size` | 数値 | 現在キャッシュ内にある状態データオブジェクトの数。 |

View File

@@ -10,8 +10,8 @@ label:
公開レジャーに関する情報を取得します。
## 要求フォーマット
要求フォーマットの例:
## リクエストのフォーマット
リクエストのフォーマットの例:
<!-- MULTICODE_BLOCK_START -->
@@ -57,24 +57,24 @@ rippled ledger current
[試してみる >](websocket-api-tool.html#ledger)
要求には以下のパラメーターを含めることができます。
リクエストには以下のパラメーターを含めることができます。
| `Field` | 型 | 必須? | 説明 |
|:---------------|:---------------------|:------|:-------------------------------|
| `ledger_hash` | [ハッシュ][] | いいえ | 使用するレジャーバージョンの20バイトの16進文字列。([レジャーの指定][]ご覧ください。) |
| `ledger_index` | [レジャーインデックス][] | いいえ | 使用するレジャーの[レジャーインデックス][]、またはレジャーを自動的に選択するためのショートカット文字列。([レジャーの指定][]をご覧ください) |
| `transactions` | 真偽値 | いいえ | `true`の場合、指定されたレジャーバージョンのトランザクションに関する情報が返されます。デフォルトでは`false`です。レジャーバージョンを指定しない場合は無視されます。 |
| `expand` | 真偽値 | いいえ | ハッシュのみではなく、トランザクション/アカウントの完全な情報がJSONフォーマットで提供されます。デフォルトでは`false`です。トランザクション、アカウント、またはその両方を要求しない場合は無視されます。 |
| `owner_funds` | 真偽値 | いいえ | `true`の場合、応答のOfferCreateトランザクションのメタデータに`owner_funds`フィールドが含まれます。デフォルトでは`false`です。トランザクションが含まれておらず、`expand`がtrueではない場合には無視されます。 |
| `expand` | 真偽値 | いいえ | ハッシュのみではなく、トランザクション/アカウントの完全な情報がJSONフォーマットで提供されます。デフォルトでは`false`です。トランザクション、アカウント、またはその両方をリクエストしない場合は無視されます。 |
| `owner_funds` | 真偽値 | いいえ | `true`の場合、レスポンスのOfferCreateトランザクションのメタデータに`owner_funds`フィールドが含まれます。デフォルトでは`false`です。トランザクションが含まれておらず、`expand`がtrueではない場合には無視されます。 |
| `binary` | 真偽値 | いいえ | `true`で、かつ`transactions``expand`が両方とも`true`の場合、JSONフォーマットではなくバイナリフォーマット16進文字列でトランザクション情報が返されます。 |
| `queue` | 真偽値 | いいえ | `true`で、かつコマンドが`current`レジャーを要求している場合、[キューに入れらているトランザクション](transaction-cost.html#キューに入れられたトランザクション)の配列が結果に含まれます。
| `queue` | 真偽値 | いいえ | `true`で、かつコマンドが`current`レジャーをリクエストしている場合、[キューに入れらているトランザクション](transaction-cost.html#キューに入れられたトランザクション)の配列が結果に含まれます。
`ledger`フィールドは廃止予定であり、今後予告なしに削除される可能性があります。`full``accounts``type`フィールド(管理者専用)も非推奨です。
## 応答フォーマット
## レスポンスのフォーマット
処理が成功した応答の例:
処理が成功したレスポンスの例:
<!-- MULTICODE_BLOCK_START -->
@@ -103,7 +103,7 @@ Loading: "/etc/opt/ripple/rippled.cfg"
<!-- MULTICODE_BLOCK_END -->
応答は[標準フォーマット][]に従っており、正常に完了した場合は結果にレジャーに関する情報を表す次のフィールドが含まれています。
レスポンスは[標準フォーマット][]に従っており、正常に完了した場合は結果にレジャーに関する情報を表す次のフィールドが含まれています。
| `Field` | 型 | 説明 |
|:-------------------------------|:------------|:--------------------------|
@@ -121,12 +121,12 @@ Loading: "/etc/opt/ripple/rippled.cfg"
| `ledger.parent_hash` | 文字列 | このレジャーの直前のレジャーの一意の識別用ハッシュ。 |
| `ledger.total_coins` | 文字列 | ネットワークのXRPの合計drop数。整数を引用符で囲んだ形式で示されます。トランザクションコストによりXRPが焼却されると、この値は減少します。 |
| `ledger.transaction_hash` | 文字列 | このレジャーに記録されているトランザクション情報のハッシュ16進数 |
| `ledger.transactions` | 配列 | 要求されていない場合は省略)このレジャーバージョンで適用されたトランザクション。デフォルトでは、メンバーはトランザクションの識別用[ハッシュ][]文字列です。要求`expand`がtrueとして指定されている場合は、メンバーはJSONフォーマットまたはバイナリフォーマットでのトランザクションの完全な表現です。フォーマットは、要求`binary`がtrueとして指定されていたかどうかに応じて決まります。 |
| `ledger.transactions` | 配列 | リクエストされていない場合は省略)このレジャーバージョンで適用されたトランザクション。デフォルトでは、メンバーはトランザクションの識別用[ハッシュ][]文字列です。リクエスト`expand`がtrueとして指定されている場合は、メンバーはJSONフォーマットまたはバイナリフォーマットでのトランザクションの完全な表現です。フォーマットは、リクエスト`binary`がtrueとして指定されていたかどうかに応じて決まります。 |
| `ledger_hash` | 文字列 | レジャー全体の一意の識別用ハッシュ。 |
| `ledger_index` | 数値 | このレジャーの[レジャーインデックス][]。 |
| `queue_data` | 配列 | `queue`パラメーターで要求されている場合を除いて省略)キューに入れられたトランザクションをキューと同じ順序で記述するオブジェクトの配列。要求`expand`がtrueに指定されている場合は、メンバーにはJSONフォーマットまたはバイナリフォーマットでのトランザクションの完全な表現が含まれています。フォーマットは、要求`binary`がtrueとして指定されていたかどうかによって決まります。 |
| `queue_data` | 配列 | `queue`パラメーターでリクエストされている場合を除いて省略)キューに入れられたトランザクションをキューと同じ順序で記述するオブジェクトの配列。リクエスト`expand`がtrueに指定されている場合は、メンバーにはJSONフォーマットまたはバイナリフォーマットでのトランザクションの完全な表現が含まれています。フォーマットは、リクエスト`binary`がtrueとして指定されていたかどうかによって決まります。 |
`ledger.accountState`フィールド(`"full": true`または`"accounts": true`要求されない限り省略)は廃止予定です。
`ledger.accountState`フィールド(`"full": true`または`"accounts": true`リクエストされない限り省略)は廃止予定です。
次のフィールドは廃止予定であり、今後予告なしに削除される可能性があります。`accepted``hash`(代わりに`ledger_hash`を使用)、`seqNum`(代わりに`ledger_index`を使用)、`totalCoins`(代わりに`total_coins`を使用)。[更新: rippled 1.12.0][]
@@ -144,7 +144,7 @@ Loading: "/etc/opt/ripple/rippled.cfg"
| `fee_level` | 文字列 | _省略される場合があります_ このタイプのトランザクションの最少コストと比較した、このトランザクションのトランザクションコスト([手数料レベル][])。 |
| `max_spend_drops` | 文字列 | _省略される場合があります_ このトランザクションで送信または消却できる[XRP、drop単位][]の最高額。 |
要求`"owner_funds": true`が指定されておりトランザクションが展開されている場合、応答には、各[OfferCreateトランザクション][]の`metaData`オブジェクトの`owner_funds`フィールドが含まれています。このフィールドの目的は、新しい検証済みレジャーごとに[オファーの資金化ステータス](offers.html#オファーのライフサイクル)を容易に追跡できるようにすることです。このフィールドの定義は、[オーダーブックサブスクリプションストリーム](subscribe.html#オーダーブックストリーム)でのこのフィールドのバージョンとはわずかに異なります。
リクエスト`"owner_funds": true`が指定されておりトランザクションが展開されている場合、レスポンスには、各[OfferCreateトランザクション][]の`metaData`オブジェクトの`owner_funds`フィールドが含まれています。このフィールドの目的は、新しい検証済みレジャーごとに[オファーの資金化ステータス](offers.html#オファーのライフサイクル)を容易に追跡できるようにすることです。このフィールドの定義は、[オーダーブックサブスクリプションストリーム](subscribe.html#オーダーブックストリーム)でのこのフィールドのバージョンとはわずかに異なります。
| `Field` | 値 | 説明 |
|:--------------|:-------|:----------------------------------------------------|

View File

@@ -10,8 +10,8 @@ label:
`ledger_closed`メソッドは、最新の決済済みレジャーの一意のIDを返します。このレジャーは必ずしも検証済みで変更不可能ではありません。
## 要求フォーマット
要求フォーマットの例:
## リクエストのフォーマット
リクエストのフォーマットの例:
<!-- MULTICODE_BLOCK_START -->
@@ -48,8 +48,8 @@ rippled ledger_closed
このメソッドはパラメーターを受け入れません。
## 応答フォーマット
処理が成功した応答の例:
## レスポンスのフォーマット
処理が成功したレスポンスの例:
<!-- MULTICODE_BLOCK_START -->
@@ -83,7 +83,7 @@ rippled ledger_closed
<!-- MULTICODE_BLOCK_END -->
この応答は[標準フォーマット][]に従っており、正常に完了した場合は結果に次のフィールドが含まれます。
このレスポンスは[標準フォーマット][]に従っており、正常に完了した場合は結果に次のフィールドが含まれます。
| `Field` | 型 | 説明 |
|:---------------|:-----------------|:-----------------------------------------|

View File

@@ -10,9 +10,9 @@ label:
`ledger_current`メソッドは、現在進行中のレジャーの一意のIDを返します。このコマンドで返されるレジャーは確定されたものではないため、このコマンドは主にテストに有用です。
## 要求フォーマット
## リクエストのフォーマット
要求フォーマットの例:
リクエストのフォーマットの例:
<!-- MULTICODE_BLOCK_START -->
@@ -47,11 +47,11 @@ rippled ledger_current
[試してみる >](websocket-api-tool.html#ledger_current)
この要求にはパラメーターは含まれていません。
このリクエストにはパラメーターは含まれていません。
## 応答フォーマット
処理が成功した応答の例:
## レスポンスのフォーマット
処理が成功したレスポンスの例:
<!-- MULTICODE_BLOCK_START -->
@@ -83,7 +83,7 @@ rippled ledger_current
<!-- MULTICODE_BLOCK_END -->
応答は[標準フォーマット][]に従っており、正常に完了した場合は結果に次のフィールドが含まれています。
レスポンスは[標準フォーマット][]に従っており、正常に完了した場合は結果に次のフィールドが含まれています。
| `Field` | 型 | 説明 |
|:-----------------------|:-----------------|:-------------------------------|

View File

@@ -11,8 +11,8 @@ label:
`ledger_data`メソッドは指定されたレジャーの内容を取得します。1つのレジャーバージョンの内容全体を取得するため、複数のコールを繰り返し実行できます。
## 要求フォーマット
要求フォーマットの例:
## リクエストのフォーマット
リクエストのフォーマットの例:
<!-- MULTICODE_BLOCK_START -->
@@ -47,22 +47,22 @@ label:
**注記:**`ledger_data`のコマンドライン構文はありません。代わりに[jsonメソッド][]を使用してコマンドラインからこのメソッドにアクセスできます。
要求には以下のフィールドが含まれます。
リクエストには以下のフィールドが含まれます。
| `Field` | 型 | 説明 |
|:---------------|:-------------------------------------------|:---------------|
| `id` | (任意) | WebSocketのみ応答が遅延して順不同になる場合にこの要求を他の要求と区別するためのID。 |
| `id` | (任意) | WebSocketのみレスポンスが遅延して順不同になる場合にこのリクエストを他のリクエストと区別するためのID。 |
| `ledger_hash` | 文字列 | _省略可_ 使用するレジャーバージョンの20バイトの16進文字列。[レジャーの指定][]を参照してください) |
| `ledger_index` | 文字列または符号なし整数 | _省略可_ 使用するレジャーのシーケンス番号、またはレジャーを自動的に選択するためのショートカット文字列。([レジャーの指定][]を参照してください) |
| `binary` | ブール値 | 省略可、デフォルトではfalseですtrueに設定すると、レジャーオブジェクトがJSONではなくハッシュされた16進文字列として返されます。 |
| `limit` | 整数 | (省略可、デフォルト値は可変)取得するレジャーオブジェクトの数を制限します。サーバーはこの値に従う必要はありません。 |
| `marker` | [マーカー][] | 以前にページネーションされた応答の値。その応答を停止した箇所からデータの取得を再開します。 |
| `marker` | [マーカー][] | 以前にページネーションされたレスポンスの値。そのレスポンスを停止した箇所からデータの取得を再開します。 |
`ledger`フィールドは廃止予定であり、今後予告なしに削除される可能性があります。
## 応答フォーマット
## レスポンスのフォーマット
処理が成功した応答の例:
処理が成功したレスポンスの例:
<!-- MULTICODE_BLOCK_START -->
@@ -241,20 +241,20 @@ label:
<!-- MULTICODE_BLOCK_END -->
この応答は[標準フォーマット][]に従っており、正常に完了した場合は結果に次のフィールドが含まれます。
このレスポンスは[標準フォーマット][]に従っており、正常に完了した場合は結果に次のフィールドが含まれます。
| `Field` | 型 | 説明 |
|:---------------|:-------------------------------------------|:---------------|
| `ledger_index` | 符号なし整数 | このレジャーのシーケンス番号 |
| `ledger_hash` | 文字列 | レジャー全体の一意の識別用ハッシュ。 |
| `state` | 配列 | ツリーのデータが含まれているJSONオブジェクトの配列。以下のように定義されています。 |
| `marker` | [マーカー][] | 応答がページネーションされていることを示す、サーバーが定義した値。この値を次のコールに渡して、このコールで終わった箇所から再開します。 |
| `marker` | [マーカー][] | レスポンスがページネーションされていることを示す、サーバーが定義した値。この値を次のコールに渡して、このコールで終わった箇所から再開します。 |
`state`配列の各オブジェクトのフォーマットは、要求`binary`がtrueに設定されているかどうかによって異なります。各`state`オブジェクトには以下のフィールドが含まれます。
`state`配列の各オブジェクトのフォーマットは、リクエスト`binary`がtrueに設定されているかどうかによって異なります。各`state`オブジェクトには以下のフィールドが含まれます。
| `Field` | 型 | 説明 |
|:--------------------|:----------|:-------------------------------------------|
| `data` | 文字列 | `"binary":true`の場合にのみ含まれる)要求されたデータの16進表現。 |
| `data` | 文字列 | `"binary":true`の場合にのみ含まれる)リクエストされたデータの16進表現。 |
| `LedgerEntryType` | 文字列 | `"binary":false`の場合にのみ含まれる)このオブジェクトが表すレジャーオブジェクトの型を示す文字列。詳細なリストについては[レジャーデータフォーマット](ledger-data-formats.html)を参照してください。 |
| (追加のフィールド) | (各種) | `"binary":false`の場合にのみ含まれるこのオブジェクトを記述する追加フィールド。オブジェクトのLedgerEntryTypeに応じて異なります。 |
| `index` | 文字列 | このレジャーエントリの一意のID16進数 |

View File

@@ -11,9 +11,9 @@ label:
`ledger_entry`メソッドは、XRP Ledgerの1つのレジャーオブジェクトを生フォーマットで返します。取得可能な各種オブジェクトについては、[レジャーフォーマット][]をご覧ください。
## 要求フォーマット
## リクエストのフォーマット
このメソッドは複数の異なる種類のデータを取得することができます。以下に記載されている一般的なフィールドと特定のタイプのフィールドで構成される適切なパラメータを渡し、標準の[リクエストフォーマット](request-formatting.html)に従うことで、取得するアイテムの種類を選択できます。(例えば、WebSocketリクエストは常に`command`フィールドとオプションで`id`フィールドを持ち、JSON-RPCリクエストは`method`フィールドと`params`フィールドを使います)。
このメソッドは複数の異なる種類のデータを取得することができます。以下に記載されている一般的なフィールドと特定のタイプのフィールドで構成される適切なパラメータを渡し、標準の[リクエストフォーマット](request-formatting.html)に従うことで、取得するアイテムの種類を選択できます。(例えば、WebSocketリクエストは常に`command`フィールドとオプションで`id`フィールドを持ち、JSON-RPCリクエストは`method`フィールドと`params`フィールドを使います)。
{% include '_snippets/no-cli-syntax.ja.md' %}
@@ -21,7 +21,7 @@ label:
| フィールド | 型 | 説明 |
|:------------------------|:-----------------------|:----------------------|
| `binary` | ブール値 | _省略可_ `true`の場合、要求したレジャーオブジェクトの内容がXRP Ledgerの[バイナリ形式](serialization.html)の16進数の文字列として返されます。それ以外の場合はデータがJSONフォーマットで返されます。デフォルトは`false`です。[更新: rippled 1.2.0][] |
| `binary` | ブール値 | _省略可_ `true`の場合、リクエストしたレジャーオブジェクトの内容がXRP Ledgerの[バイナリ形式](serialization.html)の16進数の文字列として返されます。それ以外の場合はデータがJSONフォーマットで返されます。デフォルトは`false`です。[更新: rippled 1.2.0][] |
| `ledger_hash` | 文字列 | _省略可_ 使用するレジャーバージョンの20バイトの16進数の文字列。[レジャーの指定][]をご覧ください。 |
| `ledger_index` | 文字列 または 符号なし整数 | _省略可_ 使用するレジャーの[レジャーインデックス][]、またはレジャーを自動的に選択するためのショートカット文字列("validated"や"closed"、"current"など)。([レジャーの指定][]をご覧ください。 |
@@ -671,7 +671,7 @@ rippled json ledger_entry '{ "nft_page": "255DD86DDF59D778081A06D02701E9B2C9F4F0
[試してみる >](websocket-api-tool.html#ledger_entry-nft-page)
## 応答フォーマット
## レスポンスのフォーマット
レスポンスは[標準フォーマット][]に従って、成功結果には以下のフィールドが含まれます。
@@ -789,15 +789,15 @@ rippled json ledger_entry '{ "nft_page": "255DD86DDF59D778081A06D02701E9B2C9F4F0
## 考えられるエラー
* いずれかの[汎用エラータイプ][]。
* `deprecatedFeature` - 削除されたフィールド(`generator`など)が要求に指定されていました。
* `entryNotFound` - 要求されたレジャーオブジェクトはレジャーに存在しません。
* `deprecatedFeature` - 削除されたフィールド(`generator`など)がリクエストに指定されていました。
* `entryNotFound` - リクエストされたレジャーオブジェクトはレジャーに存在しません。
* `invalidParams` - 1つ以上のフィールドの指定が正しくないか、1つ以上の必須フィールドが指定されていません。
* `lgrNotFound` - `ledger_hash`または`ledger_index`で指定したレジャーが存在しないか、存在してはいるもののサーバーが保有していません。
* `malformedAddress` - 要求の[アドレス][]フィールドが誤って指定されています。
* `malformedCurrency` - 要求の[通貨コード][]フィールドが誤って指定されています。
* `malformedOwner` - 要求`escrow.owner`サブフィールドが誤って指定されています。
* `malformedRequest` - 要求にフィールドが無効な組み合わせで指定されているか、1つ以上のフィールドの型が誤っています。
* `unknownOption` - 要求に指定されたフィールドが、予期される要求フォーマットのいずれにも一致していません。
* `malformedAddress` - リクエストの[アドレス][]フィールドが誤って指定されています。
* `malformedCurrency` - リクエストの[通貨コード][]フィールドが誤って指定されています。
* `malformedOwner` - リクエスト`escrow.owner`サブフィールドが誤って指定されています。
* `malformedRequest` - リクエストにフィールドが無効な組み合わせで指定されているか、1つ以上のフィールドの型が誤っています。
* `unknownOption` - リクエストに指定されたフィールドが、予期されるリクエストのフォーマットのいずれにも一致していません。

View File

@@ -9,10 +9,10 @@ labels:
# book_offers
[[ソース]](https://github.com/XRPLF/rippled/blob/master/src/ripple/rpc/handlers/BookOffers.cpp "Source")
`book_offers`メソッドは、[オーダーブック](http://www.investopedia.com/terms/o/order-book.asp)と呼ばれる、2つの通貨間のオファーのリストを取得します。結果が非常に大きい場合、結果の一部がマーカー付きで返されます。これにより、その後の要求は前回の要求で終わった箇所から再開できます。
`book_offers`メソッドは、[オーダーブック](http://www.investopedia.com/terms/o/order-book.asp)と呼ばれる、2つの通貨間のオファーのリストを取得します。結果が非常に大きい場合、結果の一部がマーカー付きで返されます。これにより、その後のリクエストは前回のリクエストで終わった箇所から再開できます。
## 要求フォーマット
要求フォーマットの例:
## リクエストのフォーマット
リクエストのフォーマットの例:
<!-- MULTICODE_BLOCK_START -->
@@ -66,21 +66,21 @@ rippled book_offers 'USD/rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B' 'EUR/rvYAfWj5gh67oV6
[試してみる >](websocket-api-tool.html#book_offers)
要求には以下のパラメーターが含まれます。
リクエストには以下のパラメーターが含まれます。
| `Field` | 型 | 説明 |
|:---------------|:-------------------------------------------|:-------------------------------|
| `ledger_hash` | 文字列 | _省略可_ 使用するレジャーバージョンの20バイトの16進文字列。[レジャーの指定][]を参照してください) |
| `ledger_index` | 文字列または符号なし整数 | _省略可_ 使用するレジャーの[レジャーインデックス][]、またはレジャーを自動的に選択するためのショートカット文字列。([レジャーの指定][]を参照してください) |
| `limit` | 符号なし整数 | _省略可_ 指定されている場合、サーバーはこの制限を超える数のオファーを結果に含めません。資金供給のないオファーはサーバーにより省略されるため、返される結果の総数はこの制限よりも少ないことがあります。 |
| `marker` | [マーカー][] | _省略可_ 以前にページネーションされた応答の値。その応答を停止した箇所からデータの取得を再開します。 |
| `taker` | 文字列 | _省略可_ パースペクティブとして使用するアカウントの[アドレス][]。このアカウントが発行した[資金供給のないオファー](offers.html#オファーのライフサイクル)は常に応答に含まれます。(これを使用して、キャンセルしたい各自のオーダーを検索できます。) |
| `marker` | [マーカー][] | _省略可_ 以前にページネーションされたレスポンスの値。そのレスポンスを停止した箇所からデータの取得を再開します。 |
| `taker` | 文字列 | _省略可_ パースペクティブとして使用するアカウントの[アドレス][]。このアカウントが発行した[資金供給のないオファー](offers.html#オファーのライフサイクル)は常にレスポンスに含まれます。(これを使用して、キャンセルしたい各自のオーダーを検索できます。) |
| `taker_gets` | オブジェクト | オファーを受諾するアカウントが受け取る通貨を、[通貨額][通貨額]と同様に、`currency`フィールドと`issuer`フィールドを持つオブジェクトとして指定しますXRPの場合はissuerを省略。 |
| `taker_pays` | オブジェクト | オファーを受諾するアカウントが支払う通貨を、[通貨額][通貨額]と同様に、`currency`フィールドと`issuer`フィールドを持つオブジェクトとして指定しますXRPの場合はissuerを省略。 |
## 応答フォーマット
## レスポンスのフォーマット
処理が成功した応答の例:
処理が成功したレスポンスの例:
<!-- MULTICODE_BLOCK_START -->
@@ -162,14 +162,14 @@ rippled book_offers 'USD/rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B' 'EUR/rvYAfWj5gh67oV6
<!-- MULTICODE_BLOCK_END -->
この応答は[標準フォーマット][]に従っており、正常に完了した場合は結果に次のフィールドが含まれます。
このレスポンスは[標準フォーマット][]に従っており、正常に完了した場合は結果に次のフィールドが含まれます。
| `Field` | 型 | 説明 |
|:-----------------------|:--------------------------|:------------------------|
| `ledger_current_index` | 数値 - [レジャーインデックス][] | _`ledger_current_index`が指定されている場合は省略_ この情報の取得時に使用した、現在処理中のレジャーバージョンの[レジャーインデックス][]。 |
| `ledger_index` | 数値 - [レジャーインデックス][] | _`ledger_current_index`が指定されている場合は省略可_ 要求に従って、このデータの取得時に使用されたレジャーバージョンのレジャーインデックス。 |
| `ledger_hash` | 文字列 - [ハッシュ][] | _省略される場合があります_ 要求に従って、このデータの取得時に使用されたレジャーバージョンの識別用ハッシュ。 |
| `marker` | [マーカー][] | _省略される場合があります_ 応答がページネーションされていることを示す、サーバーが定義した値。この値を次のコールに渡して、このコールで終わった箇所から再開します。この後に情報ページがない場合は省略されます。 |
| `ledger_index` | 数値 - [レジャーインデックス][] | _`ledger_current_index`が指定されている場合は省略可_ リクエストに従って、このデータの取得時に使用されたレジャーバージョンのレジャーインデックス。 |
| `ledger_hash` | 文字列 - [ハッシュ][] | _省略される場合があります_ リクエストに従って、このデータの取得時に使用されたレジャーバージョンの識別用ハッシュ。 |
| `marker` | [マーカー][] | _省略される場合があります_ レスポンスがページネーションされていることを示す、サーバーが定義した値。この値を次のコールに渡して、このコールで終わった箇所から再開します。この後に情報ページがない場合は省略されます。 |
| `offers` | 配列 | Offerオブジェクトの配列。各オブジェクトには[Offer オブジェクト](offer.html)のフィールドが含まれています。 |
`offers`配列の要素には、Offerの標準フィールドの他に以下のフィールドが含まれます。
@@ -186,10 +186,10 @@ rippled book_offers 'USD/rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B' 'EUR/rvYAfWj5gh67oV6
* いずれかの[汎用エラータイプ][]。
* `invalidParams` - 1つ以上のフィールドの指定が正しくないか、1つ以上の必須フィールドが指定されていません。
* `lgrNotFound` - `ledger_hash`または`ledger_index`で指定したレジャーが存在しないか、存在してはいるもののサーバーが保有していません。
* `srcCurMalformed` - 要求`taker_pays`フィールドのフォーマットが適切ではありません。
* `dstAmtMalformed` - 要求`taker_gets`フィールドのフォーマットが適切ではありません。
* `srcIsrMalformed` - 要求`taker_pays`フィールドの`issuer`フィールドが無効です。
* `dstIsrMalformed` - 要求`taker_gets`フィールドの`issuer`フィールドが無効です。
* `srcCurMalformed` - リクエスト`taker_pays`フィールドのフォーマットが適切ではありません。
* `dstAmtMalformed` - リクエスト`taker_gets`フィールドのフォーマットが適切ではありません。
* `srcIsrMalformed` - リクエスト`taker_pays`フィールドの`issuer`フィールドが無効です。
* `dstIsrMalformed` - リクエスト`taker_gets`フィールドの`issuer`フィールドが無効です。
* `badMarket` - 必要なオーダーブックが存在していません(ある通貨をその通貨自体と交換するオファーなど)。

View File

@@ -11,8 +11,8 @@ labels:
`deposit_authorized`コマンドは、あるアカウントに別のアカウントへ支払を直接送金する権限があるかどうかを示します。アカウントへの送金に承認を義務付ける方法については、[Deposit Authorization](depositauth.html)を参照してください。
## 要求フォーマット
要求フォーマットの例:
## リクエストのフォーマット
リクエストのフォーマットの例:
<!-- MULTICODE_BLOCK_START -->
@@ -52,7 +52,7 @@ rippled deposit_authorized rEhxGqkqPPSxQ3P25J66ft5TwpzV14k2de rsUiUMpnrgxQp24dJY
<!-- MULTICODE_BLOCK_END -->
要求には以下のパラメーターが含まれます。
リクエストには以下のパラメーターが含まれます。
| `Field` | 型 | 説明 |
|:----------------------|:---------------------------|:------------------------|
@@ -62,9 +62,9 @@ rippled deposit_authorized rEhxGqkqPPSxQ3P25J66ft5TwpzV14k2de rsUiUMpnrgxQp24dJY
| `ledger_index` | 文字列または符号なし整数 | _省略可_ 使用するレジャーの[レジャーインデックス][]、またはレジャーを自動的に選択するためのショートカット文字列。([レジャーの指定][]を参照してください) |
## 応答フォーマット
## レスポンスのフォーマット
処理が成功した応答の例:
処理が成功したレスポンスの例:
<!-- MULTICODE_BLOCK_START -->
@@ -123,16 +123,16 @@ Loading: "/etc/rippled.cfg"
<!-- MULTICODE_BLOCK_END -->
この応答は[標準フォーマット][]に従っており、正常に完了した場合は結果に次のフィールドが含まれます。
このレスポンスは[標準フォーマット][]に従っており、正常に完了した場合は結果に次のフィールドが含まれます。
| `Field` | 型 | 説明 |
|:-----------------------|:--------------------------|:------------------------|
| `deposit_authorized` | ブール値 | 指定の支払元アカウントから支払先アカウントへの直接送金が承認されているかどうか。`true`の場合、支払先アカウントで[Deposit Authorization](depositauth.html)を必要としていないか、または支払元アカウントが事前承認されています。 |
| `destination_account` | 文字列 - [アドレス][] | 要求に指定されている宛先アカウント。 |
| `ledger_hash` | 文字列 | _省略される場合があります_ この応答の生成に使用されたレジャーの識別用ハッシュ。 |
| `ledger_index` | 数値 - [レジャーインデックス][] | _省略される場合があります_ この応答の生成に使用されたレジャーバージョンのレジャーインデックス。 |
| `ledger_current_index` | 数値 - [レジャーインデックス][] | _省略される場合があります_ この応答の生成に使用された現在処理中のレジャーバージョンのレジャーインデックス。 |
| `source_account` | 文字列 - [アドレス][] | 要求に指定されている支払元アカウント。 |
| `destination_account` | 文字列 - [アドレス][] | リクエストに指定されている宛先アカウント。 |
| `ledger_hash` | 文字列 | _省略される場合があります_ このレスポンスの生成に使用されたレジャーの識別用ハッシュ。 |
| `ledger_index` | 数値 - [レジャーインデックス][] | _省略される場合があります_ このレスポンスの生成に使用されたレジャーバージョンのレジャーインデックス。 |
| `ledger_current_index` | 数値 - [レジャーインデックス][] | _省略される場合があります_ このレスポンスの生成に使用された現在処理中のレジャーバージョンのレジャーインデックス。 |
| `source_account` | 文字列 - [アドレス][] | リクエストに指定されている支払元アカウント。 |
| `validated` | ブール値 | _省略される場合があります_`true`の場合、検証済みレジャーバージョンからの情報が取り込まれます。 |
**注記:** `deposit_authorized`ステータスが`true`でも、指定の支払元から指定の支払先への送金が可能であるとは保証されません。たとえば、支払先アカウントに指定通貨の[トラストライン](trust-lines-and-issuing.html)がない場合や、送金に十分な流動性がない場合があります。
@@ -141,10 +141,10 @@ Loading: "/etc/rippled.cfg"
* いずれかの[汎用エラータイプ][]。
* `invalidParams` - 1つ以上のフィールドの指定が正しくないか、1つ以上の必須フィールドが指定されていません。
* `actMalformed` - 要求`source_account`フィールドまたは`destination_account`フィールドに指定されている[アドレス][]のフォーマットが適切ではありません。(入力ミスが含まれていたり、長さが正しくない場合は、チェックサムは失敗します。)
* `dstActNotFound` - 要求`destination_account`フィールドがレジャーのアカウントに対応していません。
* `actMalformed` - リクエスト`source_account`フィールドまたは`destination_account`フィールドに指定されている[アドレス][]のフォーマットが適切ではありません。(入力ミスが含まれていたり、長さが正しくない場合は、チェックサムは失敗します。)
* `dstActNotFound` - リクエスト`destination_account`フィールドがレジャーのアカウントに対応していません。
* `lgrNotFound` - `ledger_hash`または`ledger_index`で指定したレジャーが存在しないか、存在してはいるもののサーバーが保有していません。
* `srcActNotFound` - 要求`source_account`フィールドがレジャーのアカウントに対応していません。
* `srcActNotFound` - リクエスト`source_account`フィールドがレジャーのアカウントに対応していません。
{% include '_snippets/rippled_versions.md' %}

View File

@@ -13,7 +13,7 @@ labels:
_([NonFungibleTokensV1_1 amendment][]により追加されました。)_
## リクエストのフォーマット
リクエストフォーマットの例:
リクエストフォーマットの例:
{% include '_snippets/no-cli-syntax.ja.md' %}

View File

@@ -13,7 +13,7 @@ labels:
_([NonFungibleTokensV1_1 amendment][]により追加されました。)_
## リクエストのフォーマット
リクエストフォーマットの例:
リクエストフォーマットの例:
{% include '_snippets/no-cli-syntax.ja.md' %}

View File

@@ -15,19 +15,19 @@ path_findコマンドには3種類のモードサブコマンドがあり
* `create` - Pathfinding情報の送信を開始します
* `close` - Pathfinding情報の送信を停止します
* `status` - 現在処理中のPathfinding要求に関する情報を取得します
* `status` - 現在処理中のPathfindingリクエストに関する情報を取得します
`rippled`サーバーは支払いを行うにあたり最も安価なパスまたはパスの組み合わせを探索しますが、このメソッドで返されるパスが最良のパスであることは保証されません。サーバーの負荷が原因で、Pathfindingで最良のパスを検出できないことがあります。また、信頼できないサーバーからのPathfindingの結果には注意する必要があります。オペレーターの収益となるように、最良ではないパスを返すようにサーバーが改ざんされる可能性があります。Pathfindingについて信頼できる独自サーバーがない場合は、1つのサーバーから不適切な結果が返されるリスクを最小限に抑えるため、異なる当事者が実行する複数のサーバーからのPathfindingの結果を比較してください。**注記:** サーバーから最良ではない結果が返されても、必ずしも悪意のある振る舞いの証拠とはなりません。サーバーの負荷が高い場合の症状である可能性もあります。)
## path_find create
[[ソース]](https://github.com/XRPLF/rippled/blob/master/src/ripple/rpc/handlers/PathFind.cpp#L50-L56 "Source")
`path_find``create`サブコマンドは、指定された特定アカウントから支払トランザクションを実行できるパスを探索する継続的な要求を作成し、別のアカウントが何らかの通貨で希望する額を受領できるようにします。初期応答には2つのアドレス間で提案されるパスが含まれています。このパスにより、希望する額を受領できます。その後サーバーは、`"type": "path_find"`で有効なパスの更新を含む追加メッセージを送信します。更新の頻度はサーバーにより決定されますが、新しいレジャーバージョンがある場合には通常、数秒間に1回です。
`path_find``create`サブコマンドは、指定された特定アカウントから支払トランザクションを実行できるパスを探索する継続的なリクエストを作成し、別のアカウントが何らかの通貨で希望する額を受領できるようにします。初期レスポンスには2つのアドレス間で提案されるパスが含まれています。このパスにより、希望する額を受領できます。その後サーバーは、`"type": "path_find"`で有効なパスの更新を含む追加メッセージを送信します。更新の頻度はサーバーにより決定されますが、新しいレジャーバージョンがある場合には通常、数秒間に1回です。
クライアントは一度に1つのPathfinding要求のみ実行できます。同じ接続ですでに他のPathfinding要求が実行されている場合、古い要求が自動的にクローズされ、新しい要求に置き換えられます。
クライアントは一度に1つのPathfindingリクエストのみ実行できます。同じ接続ですでに他のPathfindingリクエストが実行されている場合、古いリクエストが自動的にクローズされ、新しいリクエストに置き換えられます。
### 要求フォーマット
要求フォーマットの例:
### リクエストのフォーマット
リクエストのフォーマットの例:
<!-- MULTICODE_BLOCK_START -->
@@ -52,22 +52,22 @@ path_findコマンドには3種類のモードサブコマンドがあり
[試してみる >](websocket-api-tool.html#path_find)
要求には以下のパラメーターが含まれます。
リクエストには以下のパラメーターが含まれます。
| `Field` | 型 | 説明 |
|:----------------------|:-----------------|:----------------------------------|
| `subcommand` | 文字列 | `"create"`を使用してcreateサブコマンドを送信します。 |
| `source_account` | 文字列 | 探索するパスの送金元アカウントの一意のアドレス。(つまり、支払いを送金するアカウントです。) |
| `destination_account` | 文字列 | 探索するパスの送金先アカウントの一意のアドレス。(つまり、支払いを受領するアカウントです。) |
| `destination_amount` | 文字列またはオブジェクト | 送金先アカウントがトランザクションで受領する[通貨額][]。**特殊なケース:**[新規: rippled 0.30.0][]`value`フィールドには`"-1"`XRPの場合または-1XRP以外の通貨の場合を指定できます。これにより、最大限の額を送金できるパスが要求されます。ただし`send_max`が指定されている場合は、指定額を上回る額が支払われることはありません。 |
| `destination_amount` | 文字列またはオブジェクト | 送金先アカウントがトランザクションで受領する[通貨額][]。**特殊なケース:**[新規: rippled 0.30.0][]`value`フィールドには`"-1"`XRPの場合または-1XRP以外の通貨の場合を指定できます。これにより、最大限の額を送金できるパスがリクエストされます。ただし`send_max`が指定されている場合は、指定額を上回る額が支払われることはありません。 |
| `send_max` | 文字列またはオブジェクト | _省略可_ トランザクションに使用する[通貨額][]。`source_currencies`と同時に指定することはできません。[新規: rippled 0.30.0][] |
| `paths` | 配列 | _省略可_ チェックする[ペイメントパス](paths.html)を表すオブジェクトの配列。すでに判明している特定パスの変更内容を常に把握する場合や、特定パスに沿った支払いにかかる総コストを確認する場合にこのフィールドを使用できます。 |
サーバーは`source_currencies`および`bridges`フィールドも認識しますが、これらのフィールドを使用した場合の結果は保証されません。これらのフィールドは将来のために予約されているものと考えてください。
### 応答フォーマット
### レスポンスのフォーマット
処理が成功した応答の例:
処理が成功したレスポンスの例:
<!-- MULTICODE_BLOCK_START -->
@@ -441,16 +441,16 @@ path_findコマンドには3種類のモードサブコマンドがあり
<!-- MULTICODE_BLOCK_END -->
この初期応答は[標準フォーマット](response-formatting.html)に従っており、正常に完了した場合は次のフィールドが含まれています。
この初期レスポンスは[標準フォーマット](response-formatting.html)に従っており、正常に完了した場合は次のフィールドが含まれています。
| `Field` | 型 | 説明 |
|:----------------------|:-----------------|:----------------------------------|
| `alternatives` | 配列 | 以下に説明する、提案される[パス](paths.html)のオブジェクトの配列。空の場合、送金元アカウントと送金先アカウントを結ぶパスが見つかりませんでした。 |
| `destination_account` | 文字列 | トランザクションを受信するアカウントの一意のアドレス。 |
| `destination_amount` | 文字列またはオブジェクト | 送金先がトランザクションで受領する[通貨額][]。 |
| `id` | (各種) | WebSocketのみWebSocket要求に指定されているIDが再びこのレベルで含まれます。 |
| `id` | (各種) | WebSocketのみWebSocketリクエストに指定されているIDが再びこのレベルで含まれます。 |
| `source_account` | 文字列 | トランザクションを送信するアカウントの一意のアドレス。 |
| `full_reply` | ブール値 | `false`の場合、これは不完全な検索の結果です。これ以降の応答に、より適切なパスが含まれている可能性があります。`true`の場合、これは検出された最良のパスです。(理論上、これよりも優れたパスが存在している可能性がありますが`rippled`では検出されません。Pathfinding要求をクローズするまで、`rippled`は引き続き、新しいレジャーが閉鎖されるたびに更新を送信します。[新規: rippled 0.29.0][] |
| `full_reply` | ブール値 | `false`の場合、これは不完全な検索の結果です。これ以降のレスポンスに、より適切なパスが含まれている可能性があります。`true`の場合、これは検出された最良のパスです。(理論上、これよりも優れたパスが存在している可能性がありますが`rippled`では検出されません。Pathfindingリクエストをクローズするまで、`rippled`は引き続き、新しいレジャーが閉鎖されるたびに更新を送信します。[新規: rippled 0.29.0][] |
`alternatives`配列の各要素は、1つの送金元通貨開始アカウントが保有から送金先アカウントへのパスと通貨を表すオブジェクトです。このオブジェクトのフィールドを次に示します。
@@ -467,11 +467,11 @@ path_findコマンドには3種類のモードサブコマンドがあり
### 非同期フォローアップ
サーバーからは初期応答の他に、時間の経過にともなう[ペイメントパス](paths.html)のステータスを更新するため類似したフォーマットでさらにメッセージが送信されます。これらのメッセージには、元のWebSocket要求`id`が含まれているので、どの要求からメッセージが送信されたかを確認できます。また、最上位レベルの`"type": "path_find"`フィールドは、追加応答であることを示します。その他のフィールドは、初期応答と同じ方法で定義されます。
サーバーからは初期レスポンスの他に、時間の経過にともなう[ペイメントパス](paths.html)のステータスを更新するため類似したフォーマットでさらにメッセージが送信されます。これらのメッセージには、元のWebSocketリクエスト`id`が含まれているので、どのリクエストからメッセージが送信されたかを確認できます。また、最上位レベルの`"type": "path_find"`フィールドは、追加レスポンスであることを示します。その他のフィールドは、初期レスポンスと同じ方法で定義されます。
フォローアップに`"full_reply": true`が含まれている場合、これは現行レジャーの時点でrippledが検出できる最良のパスです。
path_find create要求からの非同期フォローアップの例を次に示します。
path_find createリクエストからの非同期フォローアップの例を次に示します。
<!-- MULTICODE_BLOCK_START -->
@@ -499,10 +499,10 @@ path_find create要求からの非同期フォローアップの例を次に示
## path_find close
[[ソース]](https://github.com/XRPLF/rippled/blob/master/src/ripple/rpc/handlers/PathFind.cpp#L58-L67 "Source")
`path_find``close`サブコマンドは、サーバーに対して現在実行中のPathfinding要求に関する情報の送信を停止するように指示します。
`path_find``close`サブコマンドは、サーバーに対して現在実行中のPathfindingリクエストに関する情報の送信を停止するように指示します。
### 要求フォーマット
要求フォーマットの例:
### リクエストのフォーマット
リクエストのフォーマットの例:
<!-- MULTICODE_BLOCK_START -->
@@ -518,36 +518,36 @@ path_find create要求からの非同期フォローアップの例を次に示
<!-- MULTICODE_BLOCK_END -->
要求には以下のパラメーターが含まれます。
リクエストには以下のパラメーターが含まれます。
| `Field` | 型 | 説明 |
|:-------------|:-------|:-------------------------------------------|
| `subcommand` | 文字列 | closeサブコマンドを送信するため`"close"`を使用します。 |
### 応答フォーマット
### レスポンスのフォーマット
Pathfinding要求が正常にクローズされた場合、応答は[`path_find create`](#path_find-create)に対する初期応答と同じフォーマットであり、されに以下のフィールドが含まれます。
Pathfindingリクエストが正常にクローズされた場合、レスポンスは[`path_find create`](#path_find-create)に対する初期レスポンスと同じフォーマットであり、されに以下のフィールドが含まれます。
| `Field` | 型 | 説明 |
|:---------|:--------|:--------------------------------------------------------|
| `closed` | ブール値 | 値が`true`の場合、これは`path_find close`コマンドに対する応答です。 |
| `closed` | ブール値 | 値が`true`の場合、これは`path_find close`コマンドに対するレスポンスです。 |
未処理のPathfinding要求がない場合はエラーが返されます。
未処理のPathfindingリクエストがない場合はエラーが返されます。
### 考えられるエラー
* [汎用エラータイプ][]のすべて。
* `invalidParams` - フィールドの指定が正しくないか、必須フィールドが指定されていません。
* `noEvents` - 非同期コールバックをサポートしていないプロトコルJSON-RPCなどでこのメソッドを使用しようとしました。JSON-RPCと互換性が_ある_Pathfindingメソッドについては、[ripple_path_findメソッド][]を参照してください。)
* `noPathRequest` - Pathfinding要求をクローズしようとしましたが、実行中の要求がありませんでした。
* `noPathRequest` - Pathfindingリクエストをクローズしようとしましたが、実行中のリクエストがありませんでした。
## path_find status
[[ソース]](https://github.com/XRPLF/rippled/blob/master/src/ripple/rpc/handlers/PathFind.cpp#L69-L77 "Source")
`path_find``status`サブコマンドは、現在実行中のクライアントのPathfinding要求の即時更新を要求します。
`path_find``status`サブコマンドは、現在実行中のクライアントのPathfindingリクエストの即時更新をリクエストします。
### 要求フォーマット
要求フォーマットの例:
### リクエストのフォーマット
リクエストのフォーマットの例:
<!-- MULTICODE_BLOCK_START -->
@@ -563,28 +563,28 @@ Pathfinding要求が正常にクローズされた場合、応答は[`path_find
<!-- MULTICODE_BLOCK_END -->
要求には以下のパラメーターが含まれます。
リクエストには以下のパラメーターが含まれます。
| `Field` | 型 | 説明 |
|:-------------|:-------|:---------------------------------------------|
| `subcommand` | 文字列 | `"status"`を使用して、statusサブコマンドを送信します。 |
### 応答フォーマット
### レスポンスのフォーマット
Pathfinding要求が実行中の場合、応答は[`path_find create`](#path_find-create)に対する初期応答と同じフォーマットであるのに加えて、以下のフィールドがあります。
Pathfindingリクエストが実行中の場合、レスポンスは[`path_find create`](#path_find-create)に対する初期レスポンスと同じフォーマットであるのに加えて、以下のフィールドがあります。
| `Field` | 型 | 説明 |
|:---------|:--------|:--------------------------------------------------------|
| `status` | ブール値 | 値が`true`の場合、これは`path_find status`コマンドに対する応答です。 |
| `status` | ブール値 | 値が`true`の場合、これは`path_find status`コマンドに対するレスポンスです。 |
未処理のPathfinding要求がない場合はエラーが返されます。
未処理のPathfindingリクエストがない場合はエラーが返されます。
### 考えられるエラー
* [汎用エラータイプ][]のすべて。
* `invalidParams` - 1つ以上のフィールドの指定が正しくないか、1つ以上の必須フィールドが指定されていません。
* `noEvents` - 非同期コールバックをサポートしていないプロトコルJSON-RPCなどを使用しています。JSON-RPCと互換性が_ある_Pathfindingメソッドについては、[ripple_path_findメソッド][]を参照してください。)
* `noPathRequest` - Pathfinding要求のステータスを確認しようとしましたが、処理中の要求がありませんでした。
* `noPathRequest` - Pathfindingリクエストのステータスを確認しようとしましたが、処理中のリクエストがありませんでした。
{% include '_snippets/rippled_versions.md' %}

View File

@@ -1,7 +1,7 @@
---
html: ripple_path_find.html
parent: path-and-order-book-methods.html
blurb: すぐに利用できるペイメントパスを含む1つの応答を返します。
blurb: すぐに利用できるペイメントパスを含む1つのレスポンスを返します。
labels:
- 複数通貨間
- トークン
@@ -9,14 +9,14 @@ labels:
# ripple_path_find
[[ソース]](https://github.com/XRPLF/rippled/blob/master/src/ripple/rpc/handlers/RipplePathFind.cpp "Source")
`ripple_path_find`メソッドは、[path_findメソッド][]のシンプルなバージョンであり、すぐに利用できる[ペイメントパス](paths.html)を含む1つの応答を返します。WebSocket APIとJSON-RPC APIの両方で使用できます。ただし、結果は時間の経過とともに古くなる傾向にあります。最新の状態を維持するために複数のコールを実行する代わりに、可能な場合には[path_findメソッド][]を使用して、継続的な更新をサブスクライブします。
`ripple_path_find`メソッドは、[path_findメソッド][]のシンプルなバージョンであり、すぐに利用できる[ペイメントパス](paths.html)を含む1つのレスポンスを返します。WebSocket APIとJSON-RPC APIの両方で使用できます。ただし、結果は時間の経過とともに古くなる傾向にあります。最新の状態を維持するために複数のコールを実行する代わりに、可能な場合には[path_findメソッド][]を使用して、継続的な更新をサブスクライブします。
`rippled`サーバーは支払いを行うため最も安価なパスまたはパスの組み合わせを探索しますが、このメソッドで返されるパスが最良のパスであることは保証されません。
**注意:** 信頼できないサーバーからのPathfindingの結果には注意してください。オペレーターの収益となるように、最良ではないパスを返すようにサーバーが改ざんされる可能性があります。サーバーの負荷が非常に高い場合にも不適切な結果が返される可能性があります。Pathfindingについて信頼できる独自サーバーがない場合は、1つのサーバーから不適切な結果が返されるリスクを最小限に抑えるため、異なる当事者が実行する複数のサーバーからのPathfindingの結果を比較してください。
## 要求フォーマット
要求フォーマットの例:
## リクエストのフォーマット
リクエストのフォーマットの例:
<!-- MULTICODE_BLOCK_START -->
@@ -82,21 +82,21 @@ rippled ripple_path_find '{"source_account":"r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59"
[試してみる >](websocket-api-tool.html#ripple_path_find)
要求には以下のパラメーターが含まれます。
リクエストには以下のパラメーターが含まれます。
| `Field` | 型 | 説明 |
|:----------------------|:---------------------------|:------------------------|
| `source_account` | 文字列 | トランザクションで資金を送金するアカウントの一意のアドレス。 |
| `destination_account` | 文字列 | トランザクションで資金を受領するアカウントの一意のアドレス。 |
| `destination_amount` | 文字列またはオブジェクト | 送金先アカウントがトランザクションで受領する[通貨額][]。**特殊なケース:** [新規: rippled 0.30.0][]`value`フィールドには`"-1"`XRPの場合または-1XRP以外の通貨の場合を指定できます。これにより、最大限の額を送金できるパスが要求されます。ただし`send_max`が指定されている場合は、指定されている額を上回る額が支払われることはありません。 |
| `destination_amount` | 文字列またはオブジェクト | 送金先アカウントがトランザクションで受領する[通貨額][]。**特殊なケース:** [新規: rippled 0.30.0][]`value`フィールドには`"-1"`XRPの場合または-1XRP以外の通貨の場合を指定できます。これにより、最大限の額を送金できるパスがリクエストされます。ただし`send_max`が指定されている場合は、指定されている額を上回る額が支払われることはありません。 |
| `send_max` | 文字列またはオブジェクト | _省略可_ トランザクションで使用する[通貨額][]。`source_currencies`と同時に使用することはできません。[新規: rippled 0.30.0][] |
| `source_currencies` | 配列 | _省略可_ 送信元アカウントが使用する通貨の配列。この配列の各エントリーは、必須の`currency`フィールドとオプションの`issuer`フィールドを有するJSONオブジェクトです[通貨額][]の指定方法と同様)。指定できる送金元通貨は**18**種類以下です。デフォルトでは、あらゆる送金元通貨を使用し、最大で**88**の異なる通貨/イシュアーペアに使用できます。 |
| `ledger_hash` | 文字列 | _省略可_ 使用するレジャーバージョンの20バイトの16進文字列。[レジャーの指定][]を参照してください) |
| `ledger_index` | 文字列または符号なし整数 | _省略可_ 使用するレジャーのシーケンス番号、またはレジャーを自動的に選択するためのショートカット文字列。([レジャーの指定][]を参照してください) |
## 応答フォーマット
## レスポンスのフォーマット
処理が成功した応答の例:
処理が成功したレスポンスの例:
<!-- MULTICODE_BLOCK_START -->
@@ -320,7 +320,7 @@ rippled ripple_path_find '{"source_account":"r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59"
<!-- MULTICODE_BLOCK_END -->
この応答は[標準フォーマット][]に従っており、正常に完了した場合は結果に次のフィールドが含まれます。
このレスポンスは[標準フォーマット][]に従っており、正常に完了した場合は結果に次のフィールドが含まれます。
| `Field` | 型 | 説明 |
|:-------------------------|:-------|:-----------------------------------------|
@@ -342,12 +342,12 @@ rippled ripple_path_find '{"source_account":"r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59"
* [汎用エラータイプ][]のすべて。
* `tooBusy` - サーバーの負荷が高すぎるため、パスを計算できません。管理者として接続している場合は、このエラーが返されることはありません。
* `invalidParams` - 1つ以上のフィールドの指定が正しくないか、1つ以上の必須フィールドが指定されていません。
* `srcActMissing` - `source_account`フィールドが要求で省略されています。
* `srcActMalformed` - 要求`source_account`フィールドのフォーマットが適切ではありません。
* `dstActMissing` - `destination_account`フィールドが要求で省略されています。
* `dstActMalformed` - 要求`destination_account`フィールドのフォーマットが適切ではありません。
* `srcActMissing` - `source_account`フィールドがリクエストで省略されています。
* `srcActMalformed` - リクエスト`source_account`フィールドのフォーマットが適切ではありません。
* `dstActMissing` - `destination_account`フィールドがリクエストで省略されています。
* `dstActMalformed` - リクエスト`destination_account`フィールドのフォーマットが適切ではありません。
* `srcCurMalformed` - `source_currencies`フィールドのフォーマットが適切ではありません。
* `srcIsrMalformed` - 要求の1つ以上の通貨オブジェクトの`issuer`フィールドが有効ではありません。
* `srcIsrMalformed` - リクエストの1つ以上の通貨オブジェクトの`issuer`フィールドが有効ではありません。
{% include '_snippets/rippled_versions.md' %}

View File

@@ -12,8 +12,8 @@ _[PayChan Amendment][]が有効になっている必要があります。[新
`channel_authorize`メソッドは、特定額のXRPをPayment Channelから清算するときに使用できる署名を作成します。
## 要求フォーマット
要求フォーマットの例:
## リクエストのフォーマット
リクエストのフォーマットの例:
<!-- MULTICODE_BLOCK_START -->
@@ -56,7 +56,7 @@ rippled channel_authorize s█████████████████
<!-- MULTICODE_BLOCK_END -->
要求には以下のパラメーターが含まれます。
リクエストには以下のパラメーターが含まれます。
| フィールド | 型 | 説明 |
|-------|------|-------------|
@@ -68,13 +68,13 @@ rippled channel_authorize s█████████████████
| `key_type` | 文字列 | _省略可_ 指定された暗号化キーペアの[署名アルゴリズム](cryptographic-keys.html#署名アルゴリズム)。有効な種類は、`secp256k1`または`ed25519`です。デフォルトは`secp256k1`です。[新規: rippled 1.4.0][] |
| `amount` | 文字列 | 承認するXRPの累積額drop数送金先がこのChannelからすでに受領しているXRPの額がこのフィールドの額よりも少ない場合、このメソッドで作成される署名を使用して差額を清算できます。 |
要求では、`secret``seed``seed_hex``passphrase`のうち1つだけを指定する**必要があります**。
リクエストでは、`secret``seed``seed_hex``passphrase`のうち1つだけを指定する**必要があります**。
**警告:** 信頼できないサーバーに対して、またはセキュリティが確保されていないネットワーク接続を通じて秘密鍵を送信しないでください。(これには、この要求`secret``seed``seed_hex`、または`passphrase`フィールドも含まれますこのメソッドは、自身が実行するサーバー、または資金を預けている十分に信頼できるサーバーへの、安全で暗号化されたネットワーク接続でのみ使用してください。そうでない場合、盗聴者があなたの秘密鍵を使用してクレームに署名し、同じキーペアを使用してこのPayment Channelなどから資金をすべて持ち出す可能性があります。手順については、[安全な署名の設定](secure-signing.html)を参照してください。
**警告:** 信頼できないサーバーに対して、またはセキュリティが確保されていないネットワーク接続を通じて秘密鍵を送信しないでください。(これには、このリクエスト`secret``seed``seed_hex`、または`passphrase`フィールドも含まれますこのメソッドは、自身が実行するサーバー、または資金を預けている十分に信頼できるサーバーへの、安全で暗号化されたネットワーク接続でのみ使用してください。そうでない場合、盗聴者があなたの秘密鍵を使用してクレームに署名し、同じキーペアを使用してこのPayment Channelなどから資金をすべて持ち出す可能性があります。手順については、[安全な署名の設定](secure-signing.html)を参照してください。
## 応答フォーマット
## レスポンスのフォーマット
処理が成功した応答の例:
処理が成功したレスポンスの例:
<!-- MULTICODE_BLOCK_START -->
@@ -116,7 +116,7 @@ rippled channel_authorize s█████████████████
<!-- MULTICODE_BLOCK_END -->
この応答は[標準フォーマット][]に従っており、正常に完了した場合は結果に次のフィールドが含まれます。
このレスポンスは[標準フォーマット][]に従っており、正常に完了した場合は結果に次のフィールドが含まれます。
| フィールド | 型 | 説明 |
|-------|------|-------------|
@@ -125,10 +125,10 @@ rippled channel_authorize s█████████████████
## 考えられるエラー
* いずれかの[汎用エラータイプ][]。
* `badKeyType` - 要求`key_type`パラメーターは、有効なキータイプではありません。(有効なタイプは、`secp256k1`または`ed25519`です。)[新規: rippled 1.4.0][]
* `badSeed` - 要求`secret`が有効なシークレットキーではありません。
* `channelAmtMalformed` - 要求`amount`が有効な[XRPの額][XRP、drop単位]ではありません。
* `channelMalformed` - 要求`channel_id`が有効なChannel IDではありません。Channel IDは256ビット64文字の16進文字列です。
* `badKeyType` - リクエスト`key_type`パラメーターは、有効なキータイプではありません。(有効なタイプは、`secp256k1`または`ed25519`です。)[新規: rippled 1.4.0][]
* `badSeed` - リクエスト`secret`が有効なシークレットキーではありません。
* `channelAmtMalformed` - リクエスト`amount`が有効な[XRPの額][XRP、drop単位]ではありません。
* `channelMalformed` - リクエスト`channel_id`が有効なChannel IDではありません。Channel IDは256ビット64文字の16進文字列です。
{% include '_snippets/rippled_versions.md' %}

View File

@@ -12,8 +12,8 @@ _[PayChan Amendment][]が有効になっている必要があります。[新
`channel_verify`メソッドは、特定額のXRPをPayment Channelから清算するときに使用できる署名の有効性を検証します。
## 要求フォーマット
要求フォーマットの例:
## リクエストのフォーマット
リクエストのフォーマットの例:
<!-- MULTICODE_BLOCK_START -->
@@ -53,7 +53,7 @@ rippled channel_verify aB44YfzW24VDEJQ2UuLPV2PvqcPCSoLnL7y5M1EzhdW4LnK5xMS3 5DB0
<!-- MULTICODE_BLOCK_END -->
要求には以下のパラメーターが含まれます。
リクエストには以下のパラメーターが含まれます。
| フィールド | 型 | 説明 |
|-------|------|-------------|
@@ -62,9 +62,9 @@ rippled channel_verify aB44YfzW24VDEJQ2UuLPV2PvqcPCSoLnL7y5M1EzhdW4LnK5xMS3 5DB0
| `public_key` | 文字列 | Channelの公開鍵と、署名の作成に使用されたキーペア16進数またはXRP Ledgerの[base58][]形式)。[更新: rippled 0.90.0][新規: rippled 0.90.0] |
| `signature` | 文字列 | 検証する署名16進数。 |
## 応答フォーマット
## レスポンスのフォーマット
処理が成功した応答の例:
処理が成功したレスポンスの例:
<!-- MULTICODE_BLOCK_START -->
@@ -107,7 +107,7 @@ rippled channel_verify aB44YfzW24VDEJQ2UuLPV2PvqcPCSoLnL7y5M1EzhdW4LnK5xMS3 5DB0
<!-- MULTICODE_BLOCK_END -->
この応答は[標準フォーマット][]に従っており、正常に完了した場合は結果に次のフィールドが含まれます。
このレスポンスは[標準フォーマット][]に従っており、正常に完了した場合は結果に次のフィールドが含まれます。
| フィールド | 型 | 説明 |
|-------|------|-------------|
@@ -119,9 +119,9 @@ rippled channel_verify aB44YfzW24VDEJQ2UuLPV2PvqcPCSoLnL7y5M1EzhdW4LnK5xMS3 5DB0
* [汎用エラータイプ][]のすべて。
* `invalidParams` - 1つ以上のフィールドの指定が正しくないか、1つ以上の必須フィールドが指定されていません。
* `publicMalformed` - 要求`public_key`フィールドが、正しいフォーマットの有効な公開鍵ではありません。公開鍵は33バイトであり、base58または16進数で表記されている必要があります。[アカウントの公開鍵のbase58表現は文字`a`から始まります](base58-encodings.html)。16進表現は66文字です。
* `channelMalformed` - 要求`channel_id`フィールドが有効なChannel IDではありません。Channel IDは256ビット64文字の16進文字列である必要があります。
* `channelAmtMalformed` - 要求`amount`に指定された値が、有効な[XRPの額][XRP、drop単位]ではありませんでした。
* `publicMalformed` - リクエスト`public_key`フィールドが、正しいフォーマットの有効な公開鍵ではありません。公開鍵は33バイトであり、base58または16進数で表記されている必要があります。[アカウントの公開鍵のbase58表現は文字`a`から始まります](base58-encodings.html)。16進表現は66文字です。
* `channelMalformed` - リクエスト`channel_id`フィールドが有効なChannel IDではありません。Channel IDは256ビット64文字の16進文字列である必要があります。
* `channelAmtMalformed` - リクエスト`amount`に指定された値が、有効な[XRPの額][XRP、drop単位]ではありませんでした。
{% include '_snippets/rippled_versions.md' %}

View File

@@ -12,8 +12,8 @@ labels:
これは権限のないユーザーが使用できるパブリックコマンドです。[更新: rippled 0.32.0][新規: rippled 0.32.0]
## 要求フォーマット
要求フォーマットの例:
## リクエストのフォーマット
リクエストのフォーマットの例:
<!-- MULTICODE_BLOCK_START -->
@@ -44,11 +44,11 @@ rippled fee
<!-- MULTICODE_BLOCK_END -->
要求にはパラメーターは含まれていません。
リクエストにはパラメーターは含まれていません。
## 応答フォーマット
## レスポンスのフォーマット
処理が成功した応答の例:
処理が成功したレスポンスの例:
<!-- MULTICODE_BLOCK_START -->
@@ -142,7 +142,7 @@ Connecting to 127.0.0.1:5005
<!-- MULTICODE_BLOCK_END -->
この応答は[標準フォーマット][]に従っており、正常に完了した場合は結果に次のフィールドが含まれます。
このレスポンスは[標準フォーマット][]に従っており、正常に完了した場合は結果に次のフィールドが含まれます。
| `Field` | 型 | 説明 |
|:---------------------------|:-----------------|:-----------------------------|

View File

@@ -1,17 +1,17 @@
---
html: server_info.html
parent: server-info-methods.html
blurb: サーバについての各種情報を、人間が読めるフォーマットでサーバに要求します。
blurb: サーバについての各種情報を、人間が読めるフォーマットでサーバにリクエストします。
labels:
- コアサーバー
---
# server_info (rippled)
[[ソース]](https://github.com/XRPLF/rippled/blob/master/src/ripple/rpc/handlers/ServerInfo.cpp "Source")
`server_info`コマンドは、問い合わせ中の`rippled`サーバについての各種情報を、人間が読めるフォーマットでサーバに要求します。[Clioサーバ](the-clio-server.html)については、[`server_info` (Clio)](server_info-clio.html)をご覧ください。
`server_info`コマンドは、問い合わせ中の`rippled`サーバについての各種情報を、人間が読めるフォーマットでサーバにリクエストします。[Clioサーバ](the-clio-server.html)については、[`server_info` (Clio)](server_info-clio.html)をご覧ください。
## 要求フォーマット
要求フォーマットの例:
## リクエストのフォーマット
リクエストのフォーマットの例:
<!-- MULTICODE_BLOCK_START -->
@@ -46,11 +46,11 @@ rippled server_info
[試してみる>](websocket-api-tool.html#server_info)
要求にパラメーターは何も含まれません。
リクエストにパラメーターは何も含まれません。
## 応答フォーマット
## レスポンスのフォーマット
処理が成功した応答の例:
処理が成功したレスポンスの例:
<!-- MULTICODE_BLOCK_START -->
@@ -79,17 +79,17 @@ Loading: "/etc/opt/ripple/rippled.cfg"
<!-- MULTICODE_BLOCK_END -->
応答は[標準フォーマット][]に従い、結果が正常な場合`info`オブジェクトが唯一のフィールドとして含まれます。
レスポンスは[標準フォーマット][]に従い、結果が正常な場合`info`オブジェクトが唯一のフィールドとして含まれます。
`info`オブジェクトは以下のフィールドを含むことがあります。
| `Field` | 型 | 説明 |
|:------------------------------------|:-----------|:-----------|
| `amendment_blocked` | 真偽値 | _省略される場合があります_`true`の場合、このサーバは[Amendmentブロック](amendments.html#amendment-blocked)の状態です。サーバがAmendmentブロックの状態でない場合、このフィールドは応答から省略されます。 |
| `amendment_blocked` | 真偽値 | _省略される場合があります_`true`の場合、このサーバは[Amendmentブロック](amendments.html#amendment-blocked)の状態です。サーバがAmendmentブロックの状態でない場合、このフィールドはレスポンスから省略されます。 |
| `build_version` | 文字列 | 実行中の`rippled`のバージョン番号。 |
| `closed_ledger` | オブジェクト | (省略される場合があります)コンセンサスによってまだ検証されていない、最も最近更新を閉鎖したレジャーについての情報。最新の検証済みレジャーが使用可能な場合、このフィールドは応答で省略され、代わりに`validated_ledger`が含まれます。メンバーフィールドは`validated_ledger`フィールドと同じです。 |
| `closed_ledger` | オブジェクト | (省略される場合があります)コンセンサスによってまだ検証されていない、最も最近更新を閉鎖したレジャーについての情報。最新の検証済みレジャーが使用可能な場合、このフィールドはレスポンスで省略され、代わりに`validated_ledger`が含まれます。メンバーフィールドは`validated_ledger`フィールドと同じです。 |
| `complete_ledgers` | 文字列 | ローカル`rippled`がデータベース内に有するレジャーのバージョンのシーケンス番号の範囲を示す表現。例えば、`24900901-24900984,24901116-24901158`のように、互いに素なシーケンスの場合があります。サーバに完全なレジャーがない場合(例えば、ネットワークとの同期を始めたばかりの場合)、文字列`empty`になります。 |
| `hostid` | 文字列 | admin要求の場合、`rippled`インスタンスを実行するサーバのホスト名が返されます。それ以外の要求の場合、一意の4文字の単語が返されます。 |
| `hostid` | 文字列 | adminリクエストの場合、`rippled`インスタンスを実行するサーバのホスト名が返されます。それ以外のリクエストの場合、一意の4文字の単語が返されます。 |
| `io_latency_ms` | 数値 | I/O処理の待ち時間ミリ秒単位。この数値がそれほど低くない場合、`rippled`サーバは深刻な負荷の問題を抱えている可能性があります。 |
| `jq_trans_overflow` | 文字列-数値 | このサーバが一度に処理待ちのトランザクションが250回を超えた回数起動以来。この数値が大きい場合、サーバがXRP Ledgerネットワークのトランザクション負荷に対応できていない可能性があります。将来を見据えたサーバの詳細な推奨仕様については、[容量の計画](capacity-planning.html)をご覧ください。 |
| `last_close` | オブジェクト | サーバが最後にレジャーを閉鎖したときの情報。これには、コンセンサスの取得に要した時間や、参加した信頼できるバリデータ(検証者)の数が含まれます。 |
@@ -120,14 +120,14 @@ Loading: "/etc/opt/ripple/rippled.cfg"
| `state_accounting.*.transitions` | 文字列 | サーバがこの状態に移行した回数。 |
| `time` | 文字列 | サーバの時計によるUTCでの現在時刻。 |
| `uptime` | 数値 | サーバが連続して稼働している秒数。 |
| `validated_ledger` | オブジェクト | (省略される場合があります)完全に検証された最新のレジャーについての情報。最新の検証済みレジャーが使用できない場合、このフィールドは応答にて省略され、代わりに`closed_ledger`が含まれます。 |
| `validated_ledger` | オブジェクト | (省略される場合があります)完全に検証された最新のレジャーについての情報。最新の検証済みレジャーが使用できない場合、このフィールドはレスポンスにて省略され、代わりに`closed_ledger`が含まれます。 |
| `validated_ledger.age` | 数値 | レジャーの閉鎖以降の秒数。 |
| `validated_ledger.base_fee_xrp` | 数値 | XRP単位の基本手数料。0.00005の場合は、`1e-05`などの科学的記数法で表すことができます。 |
| `validated_ledger.hash` | 文字列 | 16進数で表された、レジャーの一意のハッシュ |
| `validated_ledger.reserve_base_xrp` | 符号なし整数 | すべてのアカウントで準備金として保有しておく必要があるXRPの最少額drop数ではありません |
| `validated_ledger.reserve_inc_xrp` | 符号なし整数 | アカウントがレジャー内に保有するオブジェクトごとのアカウント準備金に追加するXRP額drop数ではありません |
| `validated_ledger.seq` | 数値 | 最新の検証済みレジャーのレジャーインデックス |
| `validation_quorum` | 数値 | レジャーバージョンの検証に、最低限必要となる信頼できる検証の数。場合によっては、サーバがさらに検証を要求する場合があります。 |
| `validation_quorum` | 数値 | レジャーバージョンの検証に、最低限必要となる信頼できる検証の数。場合によっては、サーバがさらに検証をリクエストする場合があります。 |
| `validator_list_expires` | 文字列 | _管理者のみ_ 現在のバリデータリストの有効期限が切れるタイミングを人間が読み取れる時間でを表示、または、サーバが発行済みのバリデータリストをロードしていない場合は文字列`unknown`、サーバが静的なバリデータリストを使用する場合は文字列`never`のいずれかを表示します。 |
**注記:** `closed_ledger`フィールドがあり、`seq`の値が小さい8桁未満場合、`rippled`には現在、ピアツーピアネットワークから取得した検証済みレジャーのコピーがないことを表しています。これは、サーバが現在も同期中である可能性を示しています。接続速度とハードウェア仕様にもよりますが、通常はネットワークとの同期に約5分かかります。

View File

@@ -9,10 +9,10 @@ labels:
[[ソース]](https://github.com/XRPLF/rippled/blob/master/src/ripple/rpc/handlers/ServerState.cpp "Source")
`server_state`コマンドは、サーバーに対し`rippled`サーバーの現在の状態に関するさまざまな機械可読の情報を問い合わせます。応答は[server_infoメソッド][]の場合とほぼ同じですが、読み取りやすい単位ではなく処理しやすい単位を使用します。たとえば、XRP値は科学的記数法や10進数値の代わりに整数のdrop数で示され、時刻は秒単位ではなくミリ秒単位で示されます。
`server_state`コマンドは、サーバーに対し`rippled`サーバーの現在の状態に関するさまざまな機械可読の情報を問い合わせます。レスポンスは[server_infoメソッド][]の場合とほぼ同じですが、読み取りやすい単位ではなく処理しやすい単位を使用します。たとえば、XRP値は科学的記数法や10進数値の代わりに整数のdrop数で示され、時刻は秒単位ではなくミリ秒単位で示されます。
## 要求フォーマット
要求フォーマットの例:
## リクエストのフォーマット
リクエストのフォーマットの例:
<!-- MULTICODE_BLOCK_START -->
@@ -47,11 +47,11 @@ rippled server_state
[試してみる>](websocket-api-tool.html#server_state)
要求はパラメーターをとりません。
リクエストはパラメーターをとりません。
## 応答フォーマット
## レスポンスのフォーマット
処理が成功した応答の例:
処理が成功したレスポンスの例:
<!-- MULTICODE_BLOCK_START -->
@@ -263,16 +263,16 @@ Headers
<!-- MULTICODE_BLOCK_END -->
応答は[標準フォーマット][]に従っており、正常に完了した場合は、結果に唯一のフィールドとして`state`オブジェクトが含まれています。
レスポンスは[標準フォーマット][]に従っており、正常に完了した場合は、結果に唯一のフィールドとして`state`オブジェクトが含まれています。
`state`オブジェクトには、以下のフィールドが含まれています。
| `Field` | 型 | 説明 |
|:---------------------------------|:-----------|:-----------------------|
| `amendment_blocked` | 真偽値 | _省略される場合があります_`true`の場合、このサーバは[Amendmentブロック](amendments.html#amendment-blocked)の状態です。サーバーがAmendmentブロックではない場合、応答ではこのフィールドが省略されます。 |
| `amendment_blocked` | 真偽値 | _省略される場合があります_`true`の場合、このサーバは[Amendmentブロック](amendments.html#amendment-blocked)の状態です。サーバーがAmendmentブロックではない場合、レスポンスではこのフィールドが省略されます。 |
| `build_version` | 文字列 | 実行中の`rippled`バージョンのバージョン番号。 |
| `complete_ledgers` | 文字列 | ローカルの`rippled`がデータベース内に有するレジャーバージョンのシーケンス番号の範囲を示す表現。例えば、「2500-5000,32570-7695432」のように互いに素なシーケンスの場合があります。サーバーに完全なレジャーがない場合例えば、ネットワークとの同期を始めたばかりの場合、文字列`empty`になります。 |
| `closed_ledger` | オブジェクト | (省略される場合があります)コンセンサスによって検証されていない、最新の閉鎖済みレジャーに関する情報。最新の検証済みレジャーが使用可能な場合、応答ではこのフィールドは省略され、代わりに`validated_ledger`が含まれます。メンバーフィールドは`validated_ledger`フィールドと同じです。 |
| `closed_ledger` | オブジェクト | (省略される場合があります)コンセンサスによって検証されていない、最新の閉鎖済みレジャーに関する情報。最新の検証済みレジャーが使用可能な場合、レスポンスではこのフィールドは省略され、代わりに`validated_ledger`が含まれます。メンバーフィールドは`validated_ledger`フィールドと同じです。 |
| `io_latency_ms` | 数値 | I/O処理の待機に費やされた時間数ミリ秒単位。この数値が極端に低くない場合、`rippled`サーバーでは深刻な負荷の問題が発生している可能性があります。 |
| `jq_trans_overflow` | 文字列-数値 | Tこのサーバが一度に処理待ちのトランザクションが250回を超えた回数起動以来。この数値が大きい場合、サーバがXRP Ledgerネットワークのトランザクション負荷に対応できていない可能性があります。将来を見据えたサーバの詳細な推奨仕様については、[容量の計画](capacity-planning.html)をご覧ください |
| `last_close` | オブジェクト | サーバが最後にレジャーを閉鎖したときの情報。これには、コンセンサスの取得に要した時間や、参加した信頼できるバリデータ(検証者)の数が含まれます。 |
@@ -302,14 +302,14 @@ Headers
| `state_accounting.*.transitions` | 数値 | サーバがこの状態に移行した回数。 |
| `time` | 文字列 | サーバの時計によるUTCでの現在時刻。 |
| `uptime` | 数値 | サーバが連続稼働している秒数。 |
| `validated_ledger` | オブジェクト | (省略される場合があります)完全に検証された最新のレジャーについての情報。最新の検証済みレジャーが使用できない場合、このフィールドは応答で省略され、代わりに`closed_ledger`が含まれます。 |
| `validated_ledger` | オブジェクト | (省略される場合があります)完全に検証された最新のレジャーについての情報。最新の検証済みレジャーが使用できない場合、このフィールドはレスポンスで省略され、代わりに`closed_ledger`が含まれます。 |
| `validated_ledger.base_fee` | 符号なし整数 | ネットワークへのトランザクション伝達にかかる基本手数料XRPのdrop数。 |
| `validated_ledger.close_time` | 数値 | レジャーが閉鎖された時刻([Rippleエポック以降の経過秒数][] |
| `validated_ledger.hash` | 文字列 | 当該レジャーバージョンの一意のハッシュ16進数 |
| `validated_ledger.reserve_base` | 符号なし整数 | すべてのアカウントで準備金として保有する必要がある最小額XRPのdrop数 |
| `validated_ledger.reserve_inc` | 符号なし整数 | アカウントがレジャー内に保有する各アイテムのアカウント準備金に追加する額XRPのdrop数。 |
| `validated_ledger.seq` | 符号なし整数 | このレジャーの一意のシーケンス番号 |
| `validation_quorum` | 数値 | 1つのレジャーバージョンの検証に最低限必要となる信頼できる検証の数。状況によっては、サーバーがさらに検証を要求する場合があります。 |
| `validation_quorum` | 数値 | 1つのレジャーバージョンの検証に最低限必要となる信頼できる検証の数。状況によっては、サーバーがさらに検証をリクエストする場合があります。 |
| `validator_list_expires` | 数値 | _管理者専用_ 現在のバリデータリストが期限切れになる時点([Rippleエポック以降の経過秒数][]。サーバーが発行済みのバリデータリストをロードしていない場合は0。 |
{% include '_snippets/etl-source-object.ja.md' %}

View File

@@ -1,7 +1,7 @@
---
html: subscribe.html
parent: subscription-methods.html
blurb: 特定のイベントが発生した場合に、定期的に通知するようサーバーに要求します。
blurb: 特定のイベントが発生した場合に、定期的に通知するようサーバーにリクエストします。
labels:
- 支払い
- アカウント
@@ -11,10 +11,10 @@ labels:
# subscribe
[[ソース]](https://github.com/XRPLF/rippled/blob/master/src/ripple/rpc/handlers/Subscribe.cpp "Source")
`subscribe`メソッドは、特定のイベントが発生した場合に、定期的に通知するようサーバーに要求します。
`subscribe`メソッドは、特定のイベントが発生した場合に、定期的に通知するようサーバーにリクエストします。
## 要求フォーマット
要求フォーマットの例:
## リクエストのフォーマット
リクエストのフォーマットの例:
<!-- MULTICODE_BLOCK_START -->
@@ -63,7 +63,7 @@ labels:
[試してみる >](websocket-api-tool.html#subscribe)
要求には以下のパラメーターが含まれます。
リクエストには以下のパラメーターが含まれます。
| `Field` | 型 | 説明 |
|:--------------------|:-------|:----------------------------------------------|
@@ -97,9 +97,9 @@ labels:
| `snapshot` | ブール値 | 省略可、デフォルトではfalsetrueの場合は、更新の送信前にサブスクライブした時点でオーダーブックの現在の状態を一度返します。 |
| `both` | ブール値 | 省略可、デフォルトではfalsetrueの場合は、オーダーブックの両サイドを返します。 |
## 応答フォーマット
## レスポンスのフォーマット
処理が成功した応答の例:
処理が成功したレスポンスの例:
<!-- MULTICODE_BLOCK_START -->
@@ -116,29 +116,29 @@ labels:
<!-- MULTICODE_BLOCK_END -->
応答は[標準フォーマット][]に従っています。応答に含まれるフィールドは、要求に指定されたサブスクリプションに応じて異なります。
レスポンスは[標準フォーマット][]に従っています。レスポンスに含まれるフィールドは、リクエストに指定されたサブスクリプションに応じて異なります。
* `accounts`および`accounts_proposed` - フィールドが返されません。
* *Stream: server* - `load_base`(サーバーの現在の読み込みレベル)、`random`(ランダムに生成された値)などのサーバーのステータスに関する情報。これらの情報は変更される可能性があります。
* *Stream: transactions*、*Stream: transactions_proposed*、*Stream: validations*、および*Stream: consensus* - フィールドは返されません。
* *Stream: ledger* - 手元にあるレジャーと現在の手数料体系に関する情報。`fee_base`XRP単位のトランザクションの現行基本手数料`fee_ref`(手数料単位のトランザクションの現行基本手数料)、`ledger_hash`(最新の検証済みレジャーのハッシュ)、`reserve_base`(アカウントの最低必要準備金)などがあります。
* `books` - フィールドはデフォルトで返されません。要求`"snapshot": true`に設定されている場合、`offers`(オーダーブックを定義するオファー定義オブジェクトの配列)を返します。
* `books` - フィールドはデフォルトで返されません。リクエスト`"snapshot": true`に設定されている場合、`offers`(オーダーブックを定義するオファー定義オブジェクトの配列)を返します。
## 考えられるエラー
* いずれかの[汎用エラータイプ][]。
* `invalidParams` - 1つ以上のフィールドの指定が正しくないか、1つ以上の必須フィールドが指定されていません。
* `noPermission` - 要求`url`フィールドが指定されていますが、管理者として接続していません。
* `unknownStream` - 要求`streams`フィールドの1つ以上の要素が有効なストリーム名ではありません。
* `malformedStream` - 要求`streams`フィールドのフォーマットが適切ではありません。
* `malformedAccount` - 要求`accounts`または`accounts_proposed`フィールドのアドレスのいずれか1つが、適切なフォーマットのXRP Ledgerアドレスではありません。**注記:** グローバルレジャーにまだエントリーのないアドレスのストリームをサブスクライブして、そのアドレスに資金が供給されたらメッセージを受け取るように _できます_ 。)
* `srcCurMalformed` - 要求`books`フィールドの1つ以上の`taker_pays`サブフィールドのフォーマットが適切ではありません。
* `dstAmtMalformed` - 要求`books`フィールドの1つ以上の`taker_gets`サブフィールドのフォーマットが適切ではありません。
* `srcIsrMalformed` - 要求`books`フィールドの1つ以上の`taker_pays`サブフィールドの`issuer`フィールドが無効です。
* `dstIsrMalformed` - 要求`books`フィールドの1つ以上の`taker_gets`サブフィールドの`issuer`フィールドが無効です。
* `noPermission` - リクエスト`url`フィールドが指定されていますが、管理者として接続していません。
* `unknownStream` - リクエスト`streams`フィールドの1つ以上の要素が有効なストリーム名ではありません。
* `malformedStream` - リクエスト`streams`フィールドのフォーマットが適切ではありません。
* `malformedAccount` - リクエスト`accounts`または`accounts_proposed`フィールドのアドレスのいずれか1つが、適切なフォーマットのXRP Ledgerアドレスではありません。**注記:** グローバルレジャーにまだエントリーのないアドレスのストリームをサブスクライブして、そのアドレスに資金が供給されたらメッセージを受け取るように _できます_ 。)
* `srcCurMalformed` - リクエスト`books`フィールドの1つ以上の`taker_pays`サブフィールドのフォーマットが適切ではありません。
* `dstAmtMalformed` - リクエスト`books`フィールドの1つ以上の`taker_gets`サブフィールドのフォーマットが適切ではありません。
* `srcIsrMalformed` - リクエスト`books`フィールドの1つ以上の`taker_pays`サブフィールドの`issuer`フィールドが無効です。
* `dstIsrMalformed` - リクエスト`books`フィールドの1つ以上の`taker_gets`サブフィールドの`issuer`フィールドが無効です。
* `badMarket` - `books`フィールドに指定されている1つ以上のオーダーブックが存在していませんある通貨とその通貨自体の交換オファーなど
特定のストリームをサブスクライブすると、サブスクライブを解除するか、WebSocket接続を閉じるまで、そのストリームに関する応答を定期的に受信します。これらの応答の内容は、サブスクライブしている内容に応じて異なります。以下に、いくつかの例を紹介します。
特定のストリームをサブスクライブすると、サブスクライブを解除するか、WebSocket接続を閉じるまで、そのストリームに関するレスポンスを定期的に受信します。これらのレスポンスの内容は、サブスクライブしている内容に応じて異なります。以下に、いくつかの例を紹介します。
## レジャーストリーム
@@ -354,14 +354,14 @@ labels:
|:------------------------|:--------------------------|:-----------------------|
| `type` | 文字列 | `transaction`は、トランザクションの通知であることを示します。この通知はさまざまなストリームから送信される可能性があります。 |
| `engine_result` | 文字列 | 文字列の[トランザクション結果コード](transaction-results.html) |
| `engine_result_code` | 数値 | 数値の[トランザクション応答コード](transaction-results.html)(該当する場合) |
| `engine_result_message` | 文字列 | 人間が読み取れる形式のトランザクション応答の説明 |
| `engine_result_code` | 数値 | 数値の[トランザクションレスポンスコード](transaction-results.html)(該当する場合) |
| `engine_result_message` | 文字列 | 人間が読み取れる形式のトランザクションレスポンスの説明 |
| `ledger_current_index` | 数値 - [レジャーインデックス][] | _未検証のトランザクションのみ_ このトランザクションが現在提案されている現在進行中の[レジャーバージョン](ledgers.html)のレジャーインデックス。 |
| `ledger_hash` | 文字列 - [ハッシュ][] | _検証済みのトランザクションのみ_ このトランザクションを含む レジャーバージョンの識別用ハッシュ。 |
| `ledger_index` | 数値 - [レジャーインデックス][] | _検証済みのトランザクションのみ_ このトランザクションを含むレジャーバージョンのレジャーインデックス。 |
| `meta` | オブジェクト | _検証済みのトランザクションのみ_ [トランザクションのメタデータ](transaction-metadata.html)。トランザクションの正確な結果を詳細に表示します。 |
| `transaction` | オブジェクト | JSONフォーマットの[トランザクションの定義](transaction-formats.html)。 |
| `validated` | ブール値 | `true`の場合、このトランザクションは検証済みのレジャーに含まれており、最終的な結果であることを意味します。`transaction`ストリームからの応答は常に検証される必要があります。 |
| `validated` | ブール値 | `true`の場合、このトランザクションは検証済みのレジャーに含まれており、最終的な結果であることを意味します。`transaction`ストリームからのレスポンスは常に検証される必要があります。 |
## ピアステータスストリーム

View File

@@ -13,8 +13,8 @@ labels:
`unsubscribe`コマンドはサーバーに対して、特定のサブスクリプションまたは一連のサブスクリプションへのメッセージ送信の停止を指示します。
## 要求フォーマット
要求フォーマットの例:
## リクエストのフォーマット
リクエストのフォーマットの例:
<!-- MULTICODE_BLOCK_START -->
@@ -46,7 +46,7 @@ labels:
[試してみる >](websocket-api-tool.html#unsubscribe)
この要求のパラメーターは、[subscribeメソッド][]のパラメーターとほぼ同様の方法で指定されますが、終了するサブスクリプションを定義するために使用される点が異なります。これらのパラメーターを以下に示します。
このリクエストのパラメーターは、[subscribeメソッド][]のパラメーターとほぼ同様の方法で指定されますが、終了するサブスクリプションを定義するために使用される点が異なります。これらのパラメーターを以下に示します。
| `Field` | 型 | 説明 |
|:--------------------|:------|:-----------------------------------------------|
@@ -65,9 +65,9 @@ labels:
| `taker_pays` | オブジェクト | オファーを受諾するアカウントが支払う通貨を、[通貨額][]と同様、`currency`フィールドと`issuer`フィールドを持つオブジェクトとして指定しますXRPの場合はissuerを省略。 |
| `both` | ブール値 | 省略可、デフォルトではfalsetrueの場合は、オーダーブックの両サイドからサブスクリプションを削除します。 |
## 応答フォーマット
## レスポンスのフォーマット
処理が成功した応答の例:
処理が成功したレスポンスの例:
<!-- MULTICODE_BLOCK_START -->
@@ -84,20 +84,20 @@ labels:
<!-- MULTICODE_BLOCK_END -->
この応答は[標準フォーマット][]に従っており、正常に完了した場合は結果にフィールドが含まれません。
このレスポンスは[標準フォーマット][]に従っており、正常に完了した場合は結果にフィールドが含まれません。
## 考えられるエラー
* [汎用エラータイプ][]のすべて。
* `invalidParams` - 1つ以上のフィールドの指定が正しくないか、1つ以上の必須フィールドが指定されていません。
* `noPermission` - 要求`url`フィールドが指定されていますが、管理者として接続していません。
* `malformedStream` - 要求`streams`フィールドのフォーマットが適切ではありません。
* `malformedAccount` - 要求`accounts`または`accounts_proposed`フィールドのアドレスの1つが、適切なフォーマットのXRP Ledgerアドレスではありません。
* `noPermission` - リクエスト`url`フィールドが指定されていますが、管理者として接続していません。
* `malformedStream` - リクエスト`streams`フィールドのフォーマットが適切ではありません。
* `malformedAccount` - リクエスト`accounts`または`accounts_proposed`フィールドのアドレスの1つが、適切なフォーマットのXRP Ledgerアドレスではありません。
* **注記:** グローバルレジャーにエントリーがまだ作成されていないアドレスのストリームをサブスクライブ _できます_ 。このようにサブスクライブして、そのアドレスに資金が供給されたらメッセージを受け取ることができます。
* `srcCurMalformed` - 要求`books`フィールドの1つ以上の`taker_pays`サブフィールドのフォーマットが適切ではありません。
* `dstAmtMalformed` - 要求`books`フィールドの1つ以上の`taker_gets`サブフィールドのフォーマットが適切ではありません。
* `srcIsrMalformed` - 要求`books`フィールドの1つ以上の`taker_pays`サブフィールドの`issuer`フィールドが無効です。
* `dstIsrMalformed` - 要求`books`フィールドの1つ以上の`taker_gets`サブフィールドの`issuer`フィールドが無効です。
* `srcCurMalformed` - リクエスト`books`フィールドの1つ以上の`taker_pays`サブフィールドのフォーマットが適切ではありません。
* `dstAmtMalformed` - リクエスト`books`フィールドの1つ以上の`taker_gets`サブフィールドのフォーマットが適切ではありません。
* `srcIsrMalformed` - リクエスト`books`フィールドの1つ以上の`taker_pays`サブフィールドの`issuer`フィールドが無効です。
* `dstIsrMalformed` - リクエスト`books`フィールドの1つ以上の`taker_gets`サブフィールドの`issuer`フィールドが無効です。
* `badMarket` - `books` フィールドに指定されている1つ以上のオーダーブックが存在していませんある通貨をその通貨自体と交換するオファーなど

View File

@@ -20,14 +20,14 @@ labels:
## 送信専用モード
送信専用の要求では、以下のパラメーターを指定します。
送信専用のリクエストでは、以下のパラメーターを指定します。
| `Field` | 型 | 説明 |
|:------------|:--------|:-----------------------------------------------------|
| `tx_blob` | 文字列 | 送信する署名済みトランザクションの16進表現。[マルチシグトランザクション](multi-signing.html)を送信することもできます。 |
| `fail_hard` | ブール値 | 省略可。デフォルトはfalsetrueにした場合は、トランザクションがローカルで失敗したときに再試行されず、他のサーバーにも中継されません。 |
### 要求フォーマット
### リクエストのフォーマット
<!-- MULTICODE_BLOCK_START -->
@@ -77,7 +77,7 @@ submit 1200002280000000240000000361D4838D7EA4C6800000000000000000000000000055534
* `secret`値を指定し、`key_type`フィールドを省略します。この値は、XRP Ledgerの[base58][]シード、RFC-1751、16進値のフォーマットで記述するか、文字列パスフレーズとして記述しますsecp256k1キーのみ
* `key_type`値と、`seed``seed_hex`、または`passphrase`のいずれか1つを提供します。`secret`フィールドは省略します(コマンドライン構文ではサポートされません)。
要求には以下のパラメーターが含まれます。
リクエストには以下のパラメーターが含まれます。
| `Field` | 型 | 説明 |
|:---------------|:--------|:--------------------------------------------------|
@@ -86,7 +86,7 @@ submit 1200002280000000240000000361D4838D7EA4C6800000000000000000000000000055534
| `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のサポートは実験的な機能です。 |
| `fail_hard` | ブール値 | 省略可。デフォルトはfalsetrueにした場合は、トランザクションがローカルで失敗したときに再試行されず、他のサーバーにも中継されません。 |
| `offline` | ブール値 | 省略可。デフォルトはfalsetrueにする場合は、トランザクションの生成時に、値を自動で入力または検証しようとしないでください。 |
| `build_path` | ブール値 | _省略可_ Payment型のトランザクションに対して指定した場合、署名前に`Paths`フィールドが自動で入力されます。トランザクションがXRP間の直接移動である場合は、このフィールドを省略してください。**注意:** サーバーは、このフィールドの値ではなく、このフィールドが存在するかどうかを調べます。この動作は変更される可能性があります。 |
@@ -95,8 +95,8 @@ submit 1200002280000000240000000361D4838D7EA4C6800000000000000000000000000055534
サーバーによって特定のフィールドにどのように値が自動入力されるかについては、[signメソッド][]を参照してください。
### 要求フォーマット
要求フォーマットの例:
### リクエストのフォーマット
リクエストのフォーマットの例:
<!-- MULTICODE_BLOCK_START -->
@@ -158,9 +158,9 @@ rippled submit s█████████████████████
[試してみる>](websocket-api-tool.html#submit)
## 応答フォーマット
## レスポンスのフォーマット
処理が成功した応答の例:
処理が成功したレスポンスの例:
<!-- MULTICODE_BLOCK_START -->
@@ -261,7 +261,7 @@ Connecting to 127.0.0.1:5005
<!-- MULTICODE_BLOCK_END -->
この応答は[標準フォーマット][]に従っており、結果が正しい場合、以下のフィールドが含まれます。
このレスポンスは[標準フォーマット][]に従っており、結果が正しい場合、以下のフィールドが含まれます。
| `Field` | 型 | 説明 |
|:------------------------|:--------|:-----------------------------------------|
@@ -271,9 +271,9 @@ Connecting to 127.0.0.1:5005
| `tx_blob` | 文字列 | トランザクション全体の16進文字列表現 |
| `tx_json` | オブジェクト | トランザクション全体のJSON表現 |
**注意:** WebSocketの応答`"status":"success"`が含まれていても、これはコマンドが正常に受け付けられたことを示すものであり、トランザクションが正常に実行されたことを示しているわけでは _ありません_ 。トランザクションは、さまざまな状況で正常に処理されない可能性があります。例えば、ペイメントの2つのアカウントを接続するトラストラインの欠落や、トランザクション生成後のレジャーの状態の変化などです。問題が特にない場合も、トランザクションが含まれているバージョンのレジャーを閉鎖し検証するまでに数秒かかることがあります。詳細は、[トランザクションの応答の完全なリスト](transaction-results.html)を参照してください。トランザクションの結果は、検証済みバージョンのレジャーにトランザクションが表示されるまで、最終的なものと考えないでください。
**注意:** WebSocketのレスポンス`"status":"success"`が含まれていても、これはコマンドが正常に受け付けられたことを示すものであり、トランザクションが正常に実行されたことを示しているわけでは _ありません_ 。トランザクションは、さまざまな状況で正常に処理されない可能性があります。例えば、ペイメントの2つのアカウントを接続するトラストラインの欠落や、トランザクション生成後のレジャーの状態の変化などです。問題が特にない場合も、トランザクションが含まれているバージョンのレジャーを閉鎖し検証するまでに数秒かかることがあります。詳細は、[トランザクションのレスポンスの完全なリスト](transaction-results.html)を参照してください。トランザクションの結果は、検証済みバージョンのレジャーにトランザクションが表示されるまで、最終的なものと考えないでください。
**注意:** このコマンドの結果としてエラーメッセージが表示された場合、要求から取得されたシークレットキーがメッセージの中に記述されている可能性があります。(要求に含まれているものが署名済みのtx_blobである場合は問題ありません。これらのエラーが他者から見えない状態であることを確認してください。
**注意:** このコマンドの結果としてエラーメッセージが表示された場合、リクエストから取得されたシークレットキーがメッセージの中に記述されている可能性があります。(リクエストに含まれているものが署名済みのtx_blobである場合は問題ありません。これらのエラーが他者から見えない状態であることを確認してください。
* シークレットキーが記述されているエラーは、複数の人物が参照できるログファイルに書き込まないでください。
* シークレットキーが記述されているエラーは、誰でも参照できる場所にデバッグを目的として貼り付けないでください。

View File

@@ -12,8 +12,8 @@ labels:
このコマンドを使用するには、[MultiSign Amendment][]が有効になっている必要があります。[新規: rippled 0.31.0][]
## 要求フォーマット
要求フォーマットの例:
## リクエストのフォーマット
リクエストのフォーマットの例:
<!-- MULTICODE_BLOCK_START -->
@@ -133,16 +133,16 @@ rippled submit_multisigned '{
<!-- MULTICODE_BLOCK_END -->
要求には以下のパラメーターが含まれます。
リクエストには以下のパラメーターが含まれます。
| `Field` | 型 | 説明 |
|:------------|:--------|:-----------------------------------------------------|
| `tx_json` | オブジェクト | `Signers`からなる配列が指定された[JSONフォーマットのトランザクション](transaction-formats.html)。成功させるには、署名の重みが[SignerList](signerlist.html)の定数以上でなければなりません。 |
| `fail_hard` | ブール値 | 省略可、デフォルトではfalseですtrueで、かつトランザクションがローカルで失敗する場合は、このトランザクションの再試行や、他のサーバーへのリレーは行わないでください。 |
## 応答フォーマット
## レスポンスのフォーマット
処理が成功した応答の例:
処理が成功したレスポンスの例:
<!-- MULTICODE_BLOCK_START -->
@@ -240,7 +240,7 @@ rippled submit_multisigned '{
<!-- MULTICODE_BLOCK_END -->
応答は[標準フォーマット][]に従っており、正常に完了した場合は結果に次のフィールドが含まれています。
レスポンスは[標準フォーマット][]に従っており、正常に完了した場合は結果に次のフィールドが含まれています。
| `Field` | 型 | 説明 |
|:------------------------|:--------|:-----------------------------------------|

View File

@@ -10,9 +10,9 @@ labels:
`transaction_entry`メソッドは、特定のレジャーバージョンから1つのトランザクションに関する情報を取得します。これに対して、[txメソッド][]はすべてのレジャーから指定のトランザクションを検索します。txメソッドの使用をお勧めします。
## 要求フォーマット
## リクエストのフォーマット
要求フォーマットの例:
リクエストのフォーマットの例:
<!-- MULTICODE_BLOCK_START -->
@@ -52,7 +52,7 @@ rippled transaction_entry E08D6E9754025BA2534A78707605E0601F03ACE063687A0CA1BDDA
[試してみる >](websocket-api-tool.html#transaction_entry)
要求には以下のパラメーターが含まれます。
リクエストには以下のパラメーターが含まれます。
| `Field` | 型 | 説明 |
|:---------------|:---------------------------|:-------------------------------|
@@ -62,9 +62,9 @@ rippled transaction_entry E08D6E9754025BA2534A78707605E0601F03ACE063687A0CA1BDDA
**注記:** このメソッドでは、現在進行中のレジャーから情報を取得する操作はサポートされていません。`ledger_index`または`ledger_hash`でレジャーバージョンを指定する必要があります。
## 応答フォーマット
## レスポンスのフォーマット
処理が成功した応答の例:
処理が成功したレスポンスの例:
<!-- MULTICODE_BLOCK_START -->
@@ -200,12 +200,12 @@ rippled transaction_entry E08D6E9754025BA2534A78707605E0601F03ACE063687A0CA1BDDA
<!-- MULTICODE_BLOCK_END -->
この応答は[標準フォーマット][]に従っており、正常に完了した場合は結果に次のフィールドが含まれます。
このレスポンスは[標準フォーマット][]に従っており、正常に完了した場合は結果に次のフィールドが含まれます。
| `Field` | 型 | 説明 |
|:---------------|:--------------------------|:--------------------------------|
| `ledger_index` | 数値 - [レジャーインデックス][] | トランザクションが検出されたレジャーバージョンのレジャーインデックス。これは要求のレジャーインデックスと同じです。 |
| `ledger_hash` | 文字列 - [ハッシュ][] | _省略される場合があります_ トランザクションが検出されたレジャーバージョンの識別用ハッシュ。これは要求のハッシュと同じです。 |
| `ledger_index` | 数値 - [レジャーインデックス][] | トランザクションが検出されたレジャーバージョンのレジャーインデックス。これはリクエストのレジャーインデックスと同じです。 |
| `ledger_hash` | 文字列 - [ハッシュ][] | _省略される場合があります_ トランザクションが検出されたレジャーバージョンの識別用ハッシュ。これはリクエストのハッシュと同じです。 |
| `metadata` | オブジェクト | [トランザクションのメタデータ](transaction-metadata.html)。トランザクションの正確な結果を詳細に表示します。 |
| `tx_json` | オブジェクト | [Transactionオブジェクト](transaction-formats.html)のJSON表現。 |
@@ -213,15 +213,15 @@ rippled transaction_entry E08D6E9754025BA2534A78707605E0601F03ACE063687A0CA1BDDA
* トランザクションが存在しません。
* トランザクションが存在しますが、指定のレジャーバージョンに含まれていません。
* サーバーには、使用可能な指定のレジャーバージョンがありません。正しいバージョンを保管する別のサーバーからの応答は、異なる可能性があります。
* サーバーには、使用可能な指定のレジャーバージョンがありません。正しいバージョンを保管する別のサーバーからのレスポンスは、異なる可能性があります。
## 考えられるエラー
* いずれかの[汎用エラータイプ][]。
* `fieldNotFoundTransaction` - `tx_hash`フィールドが要求で省略されています。
* `notYetImplemented` - レジャーバージョンが要求に指定されていません。
* `fieldNotFoundTransaction` - `tx_hash`フィールドがリクエストで省略されています。
* `notYetImplemented` - レジャーバージョンがリクエストに指定されていません。
* `lgrNotFound` - `ledger_hash`または`ledger_index`で指定したレジャーが存在しないか、存在してはいるもののサーバーが保有していません。
* `transactionNotFound` - 要求に指定されているトランザクションが指定のレジャーで見つかりませんでした。(トランザクションが異なるレジャーバージョンにあるか、またはトランザクションがまったく使用できない可能性があります。)
* `transactionNotFound` - リクエストに指定されているトランザクションが指定のレジャーで見つかりませんでした。(トランザクションが異なるレジャーバージョンにあるか、またはトランザクションがまったく使用できない可能性があります。)
{% include '_snippets/rippled_versions.md' %}

View File

@@ -11,9 +11,9 @@ labels:
`tx`メソッドは1つのトランザクションに関する情報を取得します。
## 要求フォーマット
## リクエストのフォーマット
要求フォーマットの例:
リクエストのフォーマットの例:
<!-- MULTICODE_BLOCK_START -->
@@ -51,16 +51,16 @@ rippled tx E08D6E9754025BA2534A78707605E0601F03ACE063687A0CA1BDDACFCD1698C7 fals
[試してみる>](websocket-api-tool.html#tx)
要求には以下のパラメーターが含まれます。
リクエストには以下のパラメーターが含まれます。
| `Field` | 型 | 説明 |
|:--------------|:--------|:---------------------------------------------------|
| `transaction` | 文字列 | トランザクションの256ビットハッシュ16進数。 |
| `binary` | ブール値 | 省略可、デフォルトではfalseですtrueの場合、トランザクションデータとメタデータがJSONではなく16進文字列として返されます。 |
## 応答フォーマット
## レスポンスのフォーマット
処理が成功した応答の例:
処理が成功したレスポンスの例:
<!-- MULTICODE_BLOCK_START -->
@@ -194,7 +194,7 @@ rippled tx E08D6E9754025BA2534A78707605E0601F03ACE063687A0CA1BDDACFCD1698C7 fals
<!-- MULTICODE_BLOCK_END -->
この応答は[標準フォーマット][]に従っており、正常に完了した場合は結果に[Transactionオブジェクト](transaction-formats.html)フィールドと以下の追加のフィールドが含まれています。
このレスポンスは[標準フォーマット][]に従っており、正常に完了した場合は結果に[Transactionオブジェクト](transaction-formats.html)フィールドと以下の追加のフィールドが含まれています。
| `Field` | 型 | 説明 |
|:---------------|:-----------------|:-----------------------------------------|

View File

@@ -10,8 +10,8 @@ blurb: 直近に作成されたトランザクションの一部を取得しま
**注意:** このメソッドは廃止予定であり、今後予告なしに削除される可能性があります。
## 要求フォーマット
要求フォーマットの例:
## リクエストのフォーマット
リクエストのフォーマットの例:
<!-- MULTICODE_BLOCK_START -->
@@ -49,15 +49,15 @@ rippled tx_history 0
[試してみる>](websocket-api-tool.html#tx_history)
要求には以下のパラメーターが含まれます。
リクエストには以下のパラメーターが含まれます。
| `Field` | 型 | 説明 |
|:--------|:-----------------|:-------------------------------------|
| `start` | 符号なし整数 | スキップするトランザクションの数。 |
## 応答フォーマット
## レスポンスのフォーマット
処理が成功した応答の例:
処理が成功したレスポンスの例:
<!-- MULTICODE_BLOCK_START -->
@@ -884,11 +884,11 @@ rippled tx_history 0
<!-- MULTICODE_BLOCK_END -->
応答は[標準フォーマット][]に従っており、正常に完了した場合は結果に次のフィールドが含まれています。
レスポンスは[標準フォーマット][]に従っており、正常に完了した場合は結果に次のフィールドが含まれています。
| `Field` | 型 | 説明 |
|:--------|:-----------------|:------------------------------------------|
| `index` | 符号なし整数 | 要求に使用されている`start`の値。 |
| `index` | 符号なし整数 | リクエストに使用されている`start`の値。 |
| `txs` | 配列 | トランザクションオブジェクトの配列。 |
各トランザクションオブジェクトに含まれているフィールドは、トランザクションのタイプに応じて多少異なります。詳細は、[トランザクションのフォーマット](transaction-formats.html)を参照してください。

View File

@@ -9,8 +9,8 @@ labels:
`json`メソッドは、プロキシとして他のコマンドを実行し、コマンドのパラメーターをJSON値として受け入れます。これは*コマンドラインクライアント専用*であり、パラメーターを指定するコマンドライン構文が不十分であるかまたは望ましくない場合に使用されるものです。
## 要求フォーマット
要求フォーマットの例:
## リクエストのフォーマット
リクエストのフォーマットの例:
<!-- MULTICODE_BLOCK_START -->
@@ -23,9 +23,9 @@ rippled -q json ledger_closed '{}'
<!-- MULTICODE_BLOCK_END -->
## 応答フォーマット
## レスポンスのフォーマット
処理が成功した応答の例:
処理が成功したレスポンスの例:
<!-- MULTICODE_BLOCK_START -->
@@ -43,7 +43,7 @@ rippled -q json ledger_closed '{}'
<!-- MULTICODE_BLOCK_END -->
応答は[標準フォーマット][]に従っており、実行されたコマンドのタイプに対して適切なフィールドが含まれています。
レスポンスは[標準フォーマット][]に従っており、実行されたコマンドのタイプに対して適切なフィールドが含まれています。
{% include '_snippets/rippled_versions.md' %}

View File

@@ -1,17 +1,17 @@
---
html: ping.html
parent: utility-methods.html
blurb: 確認応答を返します。これにより、接続のステータスと遅延をテストできます。
blurb: 確認レスポンスを返します。これにより、接続のステータスと遅延をテストできます。
labels:
- コアサーバー
---
# ping
[[ソース]](https://github.com/XRPLF/rippled/blob/master/src/ripple/rpc/handlers/Ping.cpp "Source")
`ping`コマンドは確認応答を返します。これにより、クライアントは接続のステータスと遅延をテストできます。
`ping`コマンドは確認レスポンスを返します。これにより、クライアントは接続のステータスと遅延をテストできます。
## 要求フォーマット
要求フォーマットの例:
## リクエストのフォーマット
リクエストのフォーマットの例:
<!-- MULTICODE_BLOCK_START -->
@@ -46,11 +46,11 @@ rippled ping
[試してみる >](websocket-api-tool.html#ping)
要求にはパラメーターが含まれていません。
リクエストにはパラメーターが含まれていません。
## 応答フォーマット
## レスポンスのフォーマット
処理が成功した応答の例:
処理が成功したレスポンスの例:
<!-- MULTICODE_BLOCK_START -->
@@ -79,7 +79,7 @@ rippled ping
<!-- MULTICODE_BLOCK_END -->
この応答は[標準フォーマット][]に従っており、正常に完了した場合は結果にフィールドが含まれません。クライアントは要求から応答までのラウンドトリップ時間を遅延として測定できます。
このレスポンスは[標準フォーマット][]に従っており、正常に完了した場合は結果にフィールドが含まれません。クライアントはリクエストからレスポンスまでのラウンドトリップ時間を遅延として測定できます。
## 考えられるエラー

View File

@@ -10,8 +10,8 @@ labels:
`random`コマンドは、クライアントが乱数生成のエントロピー生成源として使用する乱数を提供します。
## 要求フォーマット
要求フォーマットの例:
## リクエストのフォーマット
リクエストのフォーマットの例:
<!-- MULTICODE_BLOCK_START -->
@@ -44,11 +44,11 @@ rippled random
<!-- MULTICODE_BLOCK_END -->
要求にはパラメーターが含まれていません。
リクエストにはパラメーターが含まれていません。
## 応答フォーマット
## レスポンスのフォーマット
処理が成功した応答の例:
処理が成功したレスポンスの例:
<!-- MULTICODE_BLOCK_START -->
@@ -80,7 +80,7 @@ rippled random
<!-- MULTICODE_BLOCK_END -->
応答は[標準フォーマット][]に従っており、正常に完了した場合は結果に次のフィールドが含まれています。
レスポンスは[標準フォーマット][]に従っており、正常に完了した場合は結果に次のフィールドが含まれています。
| `Field` | 型 | 説明 |
|:---------|:-------|:--------------------------|

View File

@@ -31,7 +31,7 @@ blurb: アドレス、レジャーインデックス、通貨コードなどの
多くの場合、XRP Ledgerではオブジェクトのバイナリデータに4バイトのプレフィクスを付けてからハッシュを計算するため、異なるタイプのオブジェクトが同じバイナリフォーマットである場合でも、異なるハッシュが設定されます。既存の4バイトコードは、ASCIIでエンコードされた英字3文字の後に0バイトが続く構成となっています。
ある種のハッシュは、APIの要求と応答に使用されます。またある種のデータに署名するときの最初のステップで計算されるだけのものや、より高度なハッシュを計算するためのものもあります。XRP Ledgerで使用されるすべての4バイトのハッシュプレフィクスは以下の表の通りです。
ある種のハッシュは、APIのリクエストとレスポンスに使用されます。またある種のデータに署名するときの最初のステップで計算されるだけのものや、より高度なハッシュを計算するためのものもあります。XRP Ledgerで使用されるすべての4バイトのハッシュプレフィクスは以下の表の通りです。
| オブジェクトタイプ | APIフィールド | ハッシュプレフィクス16進数 | ハッシュプレフィクス(テキスト) |
|:--------------------------------------------|:---------------------------------------|:--------------------------|:--|
@@ -96,7 +96,7 @@ APIメソッドの多くは、レジャーのインスタンスを指定する
**注記:** レジャーを指定する際に上記のデフォルトの動作に頼らないでください。変更される場合があります。可能であれば、常にリクエストでレジャーバージョンを指定してください。
レポートモードでは、検証済みとなるまでレジャーデータは記録されません。レポートモードサーバに`current`または`closed`のレジャーをリクエストすると、サーバはそのリクエストを P2Pモードサーバに転送します。検証されていないレジャー番号またはハッシュを要求した場合、レポートモードのサーバは`lgrNotFound`エラーを返します。
レポートモードでは、検証済みとなるまでレジャーデータは記録されません。レポートモードサーバに`current`または`closed`のレジャーをリクエストすると、サーバはそのリクエストを P2Pモードサーバに転送します。検証されていないレジャー番号またはハッシュをリクエストした場合、レポートモードのサーバは`lgrNotFound`エラーを返します。
### 通貨額の指定

View File

@@ -121,7 +121,7 @@ TXTレコードのフォーマットは以下の通りです。
xrpl-nft-data-token-info-v1 IN TXT "https://host.example.com/api/token-info/{tokenid}"
```
情報を問い合わせようとしたときに、文字列`{tokenid}`要求されたトークンの`NFTokenID`(64バイトの16進文字列)に置き換えてください。
情報を問い合わせようとしたときに、文字列`{tokenid}`リクエストされたトークンの`NFTokenID`(64バイトの16進文字列)に置き換えてください。
実装では、`TXT`レコードの存在を確認し、存在すればそれらのクエリ文字列を使用する必要があります。文字列が存在しない場合、実装はデフォルトのURLを使用するように試みるべきです。ドメインが _example.com_ であると仮定すると、デフォルトのURLは次のようになります。

View File

@@ -71,7 +71,7 @@ _([NonFungibleTokensV1_1 amendment][]により追加されました)_
### `NFTokenOffer`の準備金
`NFTokenOffer`オブジェクトは、オファーを出すアカウントに1つ分の準備金の増額を要求します。執筆時点では、準備金の増分は2XRPです。この準備金は、オファーをキャンセルすることで取り戻すことができます。
`NFTokenOffer`オブジェクトは、オファーを出すアカウントに1つ分の準備金の増額をリクエストします。執筆時点では、準備金の増分は2XRPです。この準備金は、オファーをキャンセルすることで取り戻すことができます。
### `NFTokenOfferID`のフォーマット

View File

@@ -53,7 +53,7 @@ labels:
| `PreviousTxnID` | 文字列 | Hash256 | はい | 最後にこのオブジェクトを変更したトランザクションの識別用ハッシュ。 |
| `Sequence` | 数値 | UInt32 | はい | `Offer`オブジェクトを作成した[OfferCreate][]トランザクションの`Sequence`値。`Account`とこのフィールドの組み合わせによってこのオファーが識別されます。 |
| `PreviousTxnLgrSeq` | 数値 | UInt32 | はい | 最後にこのオブジェクトを変更したトランザクションが記録された[レジャーインデックス][]。 |
| `TakerPays` | 文字列またはオブジェクト | Amount | はい | オファー作成者が要求する残額と通貨の種類。 |
| `TakerPays` | 文字列またはオブジェクト | Amount | はい | オファー作成者がリクエストする残額と通貨の種類。 |
| `TakerGets` | 文字列またはオブジェクト | Amount | はい | オファー作成者が提供する残額と通貨の種類。 |
## Offerのフラグ

View File

@@ -53,7 +53,7 @@ Payment Channelの使用例については、[Payment Channelのチュートリ
| `Amount` | 文字列 | Amount | このChannelに割り当てられている [XRP、drop単位][]の合計です。これには宛先アドレスに支払われたXRPも含まれます。最初にChannelを作成したトランザクションにより設定され、支払元アドレスがPaymentChannelFundトランザクションを送信する場合に増加できます。 |
| `Balance` | 文字列 | Amount | このChannelがすでに支払った[XRP、drop単位][]の合計。この値と`Amount`フィールドの差異は、PaymentChannelClaimトランザクションの宛先アドレスに対して支払うことができるXRPの量を示します。Channelが閉鎖すると、残りの差額は支払元アドレスに返されます。 |
| `PublicKey` | 文字列 | PubKey | このChannelに対するクレームの署名に使用できるキーペアの公開鍵16進数。有効なsecp256k1公開鍵またはEd25519公開鍵を指定できます。Channelを作成したトランザクションによって設定されます。Channelに対するクレームに使用される公開鍵と一致している必要があります。Channelの支払元アドレスは、署名付きクレームなしでこのChannelから宛先にXRPを送金することもできます。 |
| `SettleDelay` | 数値 | UInt32 | ChannelにXRPがまだある場合に、支払元アドレスがそのChannelを閉鎖するまでに待機する秒数。値が小さい場合、支払元アドレスがChannelの閉鎖を要求した後で、宛先アドレスが未処理のクレームを精算できる時間が短くなります。32ビットの符号なし整数に収まる値02^32-1であれば任意の値を指定できます。これは、Channelを作成するトランザクションにより設定されます。 |
| `SettleDelay` | 数値 | UInt32 | ChannelにXRPがまだある場合に、支払元アドレスがそのChannelを閉鎖するまでに待機する秒数。値が小さい場合、支払元アドレスがChannelの閉鎖をリクエストした後で、宛先アドレスが未処理のクレームを精算できる時間が短くなります。32ビットの符号なし整数に収まる値02^32-1であれば任意の値を指定できます。これは、Channelを作成するトランザクションにより設定されます。 |
| `OwnerNode` | 文字列 | UInt64 | 支払元アドレスの所有者のディレクトリが複数ページで構成されている場合に、このオブジェクトにリンクしているページを示すヒントです。 |
| `PreviousTxnID` | 文字列 | Hash256 | 最後にこのオブジェクトを変更したトランザクションの識別用ハッシュ。 |
| `PreviousTxnLgrSeq` | 数値 | UInt32 | 最後にこのオブジェクトを変更したトランザクションが記録された[レジャーインデックス][]。 |

View File

@@ -74,7 +74,7 @@ AccountTxnIDを使用するには、アカウントの1つ前のトランザク
| フラグの名前 | 16進値 | 10進値 | 説明 |
|:--------------------|:-----------|:--------------|:--------------------------|
| tfFullyCanonicalSig | 0x80000000 | 2147483648 | _使用を強く推奨_ 完全に正規である署名を要求します。 |
| tfFullyCanonicalSig | 0x80000000 | 2147483648 | _使用を強く推奨_ 完全に正規である署名をリクエストします。 |
[signメソッド][](または「署名と送信」モードの[submitメソッド][])を使用すると、`rippled`は、`Flags`フィールドがすでに存在している場合を除き、`tfFullyCanonicalSig`フラグを有効にした状態で`Flags`フィールドを追加します。`tfFullyCanonicalSig`フラグは、`Flags`が明示的に指定されている場合、自動的には有効に***なりません***。また、[sign_forメソッド][]を使用してマルチシグトランザクションに署名を追加する場合も、自動的には有効に***なりません***。

View File

@@ -18,7 +18,7 @@ labels:
| `temBAD_CURRENCY` | トランザクションの通貨フィールドが誤って指定されています。正しいフォーマットについては、[通貨額の指定][通貨額]を参照してください。 |
| `temBAD_EXPIRATION` | トランザクションの有効期限の値が誤って指定されています([OfferCreateトランザクション][]など)。あるいは、トランザクションに必須の有効期限値が指定されていません(例えば、[EscrowCreateトランザクション][]の作成過程などで)。 |
| `temBAD_FEE` | トランザクションで`Fee`の値が誤って指定されています例えば、XRP以外の通貨やマイナスの額のXRPを指定するなど。 |
| `temBAD_ISSUER` | 要求に指定されている通貨の`issuer`フィールドが、トランザクションにて誤って指定されています。 |
| `temBAD_ISSUER` | リクエストに指定されている通貨の`issuer`フィールドが、トランザクションにて誤って指定されています。 |
| `temBAD_LIMIT` | [TrustSetトランザクション][]でトラストラインの`LimitAmount`値が誤って指定されています。 |
| `temBAD_OFFER` | [OfferCreateトランザクション][]で無効なオファーが指定されていますXRPをXRP自身と取引するオファー、マイナスの額のオファーなど。 |
| `temBAD_PATH` | [Paymentトランザクション][]の1つ以上の[パス](paths.html)が誤って指定されています。例えば、XRPのイシュアーが含まれていたり、アカウントが異なる方法で指定されたりするなど。 |

View File

@@ -15,7 +15,7 @@ labels:
|:----------------------|:------------------------|:---------------------------|
| コストの請求のみ | [tec](tec-codes.html) | トランザクションは意図された目的を果さず、[トランザクションコスト](transaction-cost.html)は消却されました。この結果が最終的なものになるのは、検証済みレジャーに記録された場合のみです。 |
| 失敗 | [tef](tef-codes.html) | サーバーの現在の(進行中の)レジャーまたはその後のレジャーに対して、トランザクションを適用できません。すでに適用されているか、レジャーの状態が原因となって、将来の適用が不可能になっています。 |
| ローカルエラー | [tel](tel-codes.html) | 負荷が高いなど、ローカルの状態が原因となって、`rippled`サーバーでエラーが発生しました。サーバーまたは時間を変えて再送信すると、別の応答を得られる可能性があります。 |
| ローカルエラー | [tel](tel-codes.html) | 負荷が高いなど、ローカルの状態が原因となって、`rippled`サーバーでエラーが発生しました。サーバーまたは時間を変えて再送信すると、別のレスポンスを得られる可能性があります。 |
| 形式が正しくないトランザクション | [tem](tem-codes.html) | 構文が誤っている、オプションが互いに矛盾している、署名が不正であるなどの原因で、トランザクションが無効になっています。 |
| 再試行 | [ter](ter-codes.html) | トランザクションを適用できませんでしたが、後ほど適用できる可能性があります。 |
| 成功 | [tes](tes-success.html) | (エラーではありません)トランザクションは成功しました。この結果が最終的なものになるのは、検証済みレジャーに記録された場合のみです。 |
@@ -27,11 +27,11 @@ labels:
これに対して、`tem`エラーは、設定にかかわらずトランザクションを適用できるサーバーが存在しないことを示唆しています。トランザクションがプロトコルのルールに違反しているか、許容限度を超えてあいまいであるか、完全に無意味なものになっています。形式が正しくないトランザクションが有効なものになる可能性があるのは、プロトコルに変更が生じた場合のみです。例えば、新しい機能が採用された場合、当該の機能を使用するトランザクションは、当該の機能がまだ採用されていない古いソフトウェアを実行しているサーバーによって、形式が正しくないと見なされる可能性があります。
## 即時の応答
## 即時のレスポンス
[submitメソッド][]から返される応答には、トランザクションのローカル処理中に発生した事項を示す、`rippled`サーバーからの暫定的な結果が含まれています。
[submitメソッド][]から返されるレスポンスには、トランザクションのローカル処理中に発生した事項を示す、`rippled`サーバーからの暫定的な結果が含まれています。
`submit`からの応答に含まれているのは、以下のフィールドです。
`submit`からのレスポンスに含まれているのは、以下のフィールドです。
| フィールド | 値 | 説明 |
|:------------------------|:---------------|:----------------------------------|
@@ -39,7 +39,7 @@ labels:
| `engine_result_code` | 符号付き整数 | `engine_result`に対応する数値。値そのものは変更される可能性があります。 |
| `engine_result_message` | 文字列 | 発生した事項を説明する、人間が読める形式のメッセージ。このメッセージは、問題を診断する目的で開発者に利用されることを想定したものであり、通知なく変更される可能性があります。 |
トランザクションをローカルで送信して適用した時点で問題がない場合、応答は以下のような内容になります。
トランザクションをローカルで送信して適用した時点で問題がない場合、レスポンスは以下のような内容になります。
```js
"engine_result": "tesSUCCESS",

View File

@@ -83,8 +83,8 @@ AccountSetトランザクションは、[XRP Ledgerのアカウント](accountro
| `asfDisallowXRP` | 3 | `lsfDisallowXRP` | XRPがこのアカウントに送信されないようにします勧告的なもので、XRP Ledgerのプロトコルでは強制されません。 |
| `asfGlobalFreeze` | 7 | `lsfGlobalFreeze` | このアカウントによって発行されたすべての資産を[凍結](freezes.html)します。 |
| `asfNoFreeze` | 6 | `lsfNoFreeze` | [個々のトラストラインの凍結またはGlobal Freezeの無効化](freezes.html)の機能を永続的に放棄します。このフラグは、有効にした後は無効にできません。 |
| `asfRequireAuth` | 2 | `lsfRequireAuth` | このアドレスによって発行された残高をユーザーが保持することについて、承認を要求します。アドレスにトラストラインが接続されていない場合のみ有効にできます。 |
| `asfRequireDest` | 1 | `lsfRequireDestTag` | トランザクションをこのアカウントに送信するための宛先タグを要求します。 |
| `asfRequireAuth` | 2 | `lsfRequireAuth` | このアドレスによって発行された残高をユーザーが保持することについて、承認をリクエストします。アドレスにトラストラインが接続されていない場合のみ有効にできます。 |
| `asfRequireDest` | 1 | `lsfRequireDestTag` | トランザクションをこのアカウントに送信するための宛先タグをリクエストします。 |
`asfDisableMaster`フラグまたは`asfNoFreeze`フラグを有効にするには、マスターキーペアで署名することによって[トランザクションを承認](transactions.html#トランザクションの承認)する必要があります。レギュラーキーペアやマルチ署名を使用することはできません。レギュラーキーペアまたはマルチ署名を使用すると、`asfDisableMaster`を無効にする(つまり、マスターキーペアを再び有効にする)ことができます。[新規: rippled 0.28.0][]

View File

@@ -42,7 +42,7 @@ _([NonFungibleTokensV1_1 amendment][]により追加されました)_
`NFTokenOffers`フィールドのIDの1つ以上が、レジャーに現在存在するオブジェクトを参照していない場合でも、トランザクションは成功しますたとえば、それらのオファーはすでに削除されている可能性があります。IDの1つが存在するオブジェクトを指していても、[NFTokenOffer](nftokenoffer.html)オブジェクトでない場合は、エラーでトランザクションが失敗します。
注意すべき点は、誤って`nft_offer_index`ではなく`nft_id`を指定してしまった場合、`tesSUCCESS`応答を受け取る可能性があることです。適切にフォーマットされたID値が見つからない場合、システムは`NFTokenOffer`が既に削除されたと判断するからです。
注意すべき点は、誤って`nft_offer_index`ではなく`nft_id`を指定してしまった場合、`tesSUCCESS`レスポンスを受け取る可能性があることです。適切にフォーマットされたID値が見つからない場合、システムは`NFTokenOffer`が既に削除されたと判断するからです。
IDが[NFTokenOffer](nftokenoffer.html)オブジェクトでないオブジェクトを指している場合、トランザクションはエラーで失敗します。

View File

@@ -39,7 +39,7 @@ OfferCreateトランザクションは[分散型取引所](decentralized-exchang
| [Expiration](offers.html#オファーの有効期限) | 数字 | UInt32 | _省略可_ オファーがアクティブでなくなるまでの時間([Rippleエポック以降の経過秒数][])。 |
| `OfferSequence` | 数字 | UInt32 | _省略可_ 最初に削除されるオファー([OfferCancel][]と同様に指定されます)。 |
| `TakerGets` | [通貨額][] | Amount | オファーの作成者によって作成される金額および通貨の種類。 |
| `TakerPays` | [通貨額][] | Amount | オファーの作成者によって要求される金額および通貨の種類。 |
| `TakerPays` | [通貨額][] | Amount | オファーの作成者によってリクエストされる金額および通貨の種類。 |
## OfferCreateフラグ

View File

@@ -64,7 +64,7 @@ PaymentChannelClaimタイプのトランザクションについては、[`Flags
| フラグ名 | 16進数値 | 10進数値 | 説明 |
|:----------|:-----------|:--------------|:------------------------------------|
| `tfRenew` | 0x00010000 | 65536 | Channelの`Expiration`時刻をクリアします。(`Expiration`は、Channelの変更できない`CancelAfter`時刻とは異なります。このフラグは、Payment Channelの支払元アドレスだけが使用できます。 |
| `tfClose` | 0x00020000 | 131072 | Channelの閉鎖を要求します。このフラグは、Channelの支払元アドレスと宛先アドレスだけが使用できます。このフラグにより、現在のクレームの処理後にChannelにこれ以上のXRPが割り当てられない場合、または宛先アドレスが使用している場合に、Channelが即時に閉鎖されます。XRPがまだChannelに保有されているときに、支払元アドレスがこのフラグを使用した場合、`SettleDelay`秒の経過後にChannelが閉鎖するようにスケジュールされます。具体的には、Channelの`Expiration`は、前のレジャーの閉鎖時刻にChannelの`SettleDelay`の時間を加算した時刻に設定されます。ただし、Channelにこの時刻よりも早い`Expiration`時刻がすでに設定されている場合を除きます。XRPがまだChannelに保有されているときに、宛先アドレスがこのフラグを使用した場合、クレーム処理後に残っているXRPはすべて支払元アドレスに返金されます。 |
| `tfClose` | 0x00020000 | 131072 | Channelの閉鎖をリクエストします。このフラグは、Channelの支払元アドレスと宛先アドレスだけが使用できます。このフラグにより、現在のクレームの処理後にChannelにこれ以上のXRPが割り当てられない場合、または宛先アドレスが使用している場合に、Channelが即時に閉鎖されます。XRPがまだChannelに保有されているときに、支払元アドレスがこのフラグを使用した場合、`SettleDelay`秒の経過後にChannelが閉鎖するようにスケジュールされます。具体的には、Channelの`Expiration`は、前のレジャーの閉鎖時刻にChannelの`SettleDelay`の時間を加算した時刻に設定されます。ただし、Channelにこの時刻よりも早い`Expiration`時刻がすでに設定されている場合を除きます。XRPがまだChannelに保有されているときに、宛先アドレスがこのフラグを使用した場合、クレーム処理後に残っているXRPはすべて支払元アドレスに返金されます。 |
<!--{# common link defs #}-->
{% include '_snippets/rippled-api-links.md' %}

View File

@@ -32,7 +32,7 @@ TicketCreateトランザクションは、1つまたは複数の[シーケンス
|:-----------------|:-----------------|:------------------|:-------------------|
| `TicketCount` | 数値 | UInt32 | 作成するチケットの枚数。これは正の数でなければならず、このトランザクションの実行の結果、アカウントが250枚以上のチケットを所有することはできません。 |
トランザクションが要求されたチケット_全て_を作成できない場合(250チケットの制限または[所有者準備金](reserves.html)のいずれかが原因)、失敗してチケットは作成されません。アカウントが現在所有しているチケットの数を調べるには、[account_info メソッド][]を使用して、`account_data.TicketCount`フィールドを確認してください。
トランザクションがリクエストされたチケット_全て_を作成できない場合(250チケットの制限または[所有者準備金](reserves.html)のいずれかが原因)、失敗してチケットは作成されません。アカウントが現在所有しているチケットの数を調べるには、[account_info メソッド][]を使用して、`account_data.TicketCount`フィールドを確認してください。
**ヒント:** このトランザクションは、送信アカウントの[シーケンス番号][Sequence Number]を1 _+_ 作成するチケットの数(`TicketCount`)だけ増加させます。この取引は、アカウントのシーケンス番号を1より多く増加させる唯一の取引です。
@@ -44,7 +44,7 @@ TicketCreateトランザクションは、1つまたは複数の[シーケンス
|:--------------------------|:-------------------------------------------------|
| `temINVALID_COUNT` | TicketCount`フィールドが無効です。1から250までの整数でなければなりません。|
| `tecDIR_FULL` | この取引により、アカウントが一度に所有するチケットの上限である250枚を超えたり、一般的なレジャーオブジェクトの上限数を超えたりすることになります。 |
| `tecINSUFFICIENT_RESERVE` | 送信側のアカウントには、要求されたすべてのチケットの[所有者準備金](reserves.html)を満たすだけのXRPがありません。 |
| `tecINSUFFICIENT_RESERVE` | 送信側のアカウントには、リクエストされたすべてのチケットの[所有者準備金](reserves.html)を満たすだけのXRPがありません。 |
<!--{# common link defs #}-->
{% include '_snippets/rippled-api-links.md' %}

View File

@@ -188,7 +188,7 @@ _各_`[[VALIDATORS]]`エントリごとに、以下から任意のフィール
| フィールド | 型 | 説明 |
|:----------|:-------|:--------------------------------------------------------|
| `address` | 文字列 | XRP Ledgerのbase58フォーマットでエンコードされた、アカウントの公開アドレス通常、先頭は`r`)。 |
| `network` | 文字列 | このアカウントが主に使用されるネットワークチェーン。省略された場合、クライアントはアカウントが本番環境のXRP Ledger _と_ 、場合によっては他のネットワークチェーンでも要求されていると想定する必要があります。本番環境のXRP Ledgerでは`main`を使用します。RippleのXRP Ledger Test Netには`testnet`を使用します。他の値を指定して、他のTest Netまたは非標準のネットワークチェーンを表すことができます。 |
| `network` | 文字列 | このアカウントが主に使用されるネットワークチェーン。省略された場合、クライアントはアカウントが本番環境のXRP Ledger _と_ 、場合によっては他のネットワークチェーンでもリクエストされていると想定する必要があります。本番環境のXRP Ledgerでは`main`を使用します。RippleのXRP Ledger Test Netには`testnet`を使用します。他の値を指定して、他のTest Netまたは非標準のネットワークチェーンを表すことができます。 |
| `desc` | 文字列 | 人間が読める形式での、このアカウントの目的または使用方法に関する説明。 |
**注意:** `xrp-ledger.toml`ファイルをホストすることで、誰でもアカウントの所有権を主張できるため、ここでのアカウントの存在が正式であると見なすべきではありません。ただし、[XRP Ledgerの当該アカウントの`Domain`フィールド](accountset.html#domain)が、この`xrp-ledger.toml`ファイルの提供元のドメインとも一致している場合は除きます。詳細は、[アカウントの検証](#アカウント検証)を確認してください。
@@ -212,7 +212,7 @@ _各_`[[VALIDATORS]]`エントリごとに、以下から任意のフィール
|:--------|:-------|:-----------------------------------------------------|
| `json_rpc` | 文字列URL | 公開JSON-RPC APIを提供するURL。先頭は`http://`または`https://`である必要があります。公開APIに対してはHTTPSが推奨されます。 |
| `ws` | 文字列URL | 公開WebSocket APIを提供するURL。先頭は`ws://`または`wss://`である必要があります。公開APIに対してはWSSが推奨されます。 |
| `peer` | 文字列URL | サーバーがXRP LedgerのピアプロトコルをリッスンしているURL。他のXRP Ledgerサーバーは、このURLで接続できます。サーバーよりピアクローラー応答が提供される場合は、このURLに`crawl`が付加されて提供されます。 |
| `peer` | 文字列URL | サーバーがXRP LedgerのピアプロトコルをリッスンしているURL。他のXRP Ledgerサーバーは、このURLで接続できます。サーバーよりピアクローラーレスポンスが提供される場合は、このURLに`crawl`が付加されて提供されます。 |
| `network` | 文字列 | このサーバーがフォローするネットワークチェーン。省略された場合、クライアントはサーバーが本番環境のXRP Ledgerをフォローすると想定する必要があります。本番環境のXRP Ledgerを明示的に指定するには`main`を使用します。RippleのXRP Ledger Test Netには`testnet`を使用します。他の値を指定して、他のTest Netまたは非標準のネットワークチェーンを表すことができます。 |
このセクションのすべてのURLの末尾にスラッシュを付けることが推奨されます。省略された場合、クライアントアプリケーションでは、末尾にスラッシュが含まれていると想定します。

View File

@@ -255,7 +255,7 @@ ripple-lib 1.xでは、全てのメソッドとプロパティは、`RippleAPI`
| RippleAPIインスタンスメソッド/プロパティ | xrpl.jsメソッド/プロパティ | 注記 |
|-------------------|----------------|---|
| `new ripple.RippleAPI({server: url})` | [`new xrpl.Client(url)`](https://js.xrpl.org/classes/Client.html#constructor) | 複数のサーバに接続するには`xrpl.BroadcastClient([url1, url2, ..])` を使用してください。 |
| `request(command, options)` | [`Client.request(options)`](https://js.xrpl.org/classes/Client.html#request) | <ul><li>WebSocket API との一貫性を保つために `command` フィールドを `options` オブジェクトに移動しました。</li><li>1.x では、このメソッドの戻り値 (Promise がリゾルブしたとき) は `result` オブジェクトのみでした。現在は、[WebSocket 応答フォーマット](response-formatting.html) 全体が返されます。同様の値を得るには、戻り値の `result` フィールドを読み取ってください。 |
| `request(command, options)` | [`Client.request(options)`](https://js.xrpl.org/classes/Client.html#request) | <ul><li>WebSocket API との一貫性を保つために `command` フィールドを `options` オブジェクトに移動しました。</li><li>1.x では、このメソッドの戻り値 (Promise がリゾルブしたとき) は `result` オブジェクトのみでした。現在は、[WebSocket レスポンスのフォーマット](response-formatting.html) 全体が返されます。同様の値を得るには、戻り値の `result` フィールドを読み取ってください。 |
| `hasNextPage()` | [`xrpl.hasNextPage(response)`](https://js.xrpl.org/modules.html#hasNextPage) | こちらもご覧ください。 [`Client.requestNextPage()`](https://js.xrpl.org/classes/Client.html#requestNextPage) および [`Client.requestAll()`](https://js.xrpl.org/classes/Client.html#requestAll) |
| `requestNextPage()` | [`Client.requestNextPage()`](https://js.xrpl.org/classes/Client.html#requestNextPage) | |
| `computeBinaryTransactionHash()` | [`xrpl.hashes.hashTx()`](https://js.xrpl.org/modules.html#hashes) | |