[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

@@ -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` | 型 | 説明 |
|:---------|:-------|:--------------------------|