mirror of
https://github.com/XRPLF/xrpl-dev-portal.git
synced 2025-11-25 22:25:52 +00:00
[JA] fix request, response
This commit is contained in:
@@ -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`で指定したレジャーが存在しないか、存在してはいるもののサーバーが保有していません。
|
||||
|
||||
|
||||
|
||||
@@ -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`で指定したレジャーが存在しないか、存在してはいるもののサーバーが保有していません。
|
||||
|
||||
|
||||
|
||||
@@ -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#手数料レベル
|
||||
|
||||
@@ -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`フィールドが受け入れられない場合。
|
||||
|
||||
|
||||
@@ -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`で指定したレジャーが存在しないか、存在してはいるもののサーバーが保有していません。
|
||||
|
||||
|
||||
|
||||
@@ -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`で指定したレジャーが存在しないか、存在してはいるもののサーバーが保有していません。
|
||||
|
||||
|
||||
|
||||
@@ -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` | 整数 | いいえ | 取得するオファーの数を制限します。サーバはこの数より少ない結果を返すことがあります。10~400の範囲内でなければなりません。この範囲外の正の値は、最も近い有効なオプションに置き換えられます。デフォルトは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`フィールドが受け入れられない場合。
|
||||
|
||||
|
||||
@@ -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' %}
|
||||
|
||||
@@ -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`で指定したレジャーが存在しないか、存在してはいるもののサーバーが保有していません。
|
||||
|
||||
|
||||
|
||||
@@ -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`に指定されているレジャーが存在しないか、存在しているがサーバーにはありません。
|
||||
|
||||
|
||||
|
||||
Reference in New Issue
Block a user