peer_reservations_list
peer_reservations_list
メソッドは、ピアリザベーションを一覧表示します。
peer_reservations_list
メソッドは、権限のないユーザは実行できない管理メソッドです。
リクエストのフォーマット
リクエストのフォーマットの例:
{ "id": "peer_reservations_list_example_1", "command": "peer_reservations_list" }
このリクエストにはパラメーターは含まれません。
レスポンスのフォーマット
処理が成功したレスポンスの例:
{ "id": "peer_reservations_list_example_1", "result": { "reservations": [ { "description": "Ripple s1 server 'WOOL'", "node": "n9Jt8awsPzWLjBCNKVEEDQnw4bQEPjezfcQ4gttD1UzbLT1FoG99" }, { "node": "n9MZRo92mzYjjsa5XcqnPC7GFYAnENo9VfJzKmpcS9EFZvw5fgwz" } ] }, "status": "success", "type": "response" }
このレスポンスは標準フォーマットに従っており、正常に完了した場合は結果に次のフィールドが含まれます。
Field | 型 | 説明 |
---|---|---|
reservations | 配列 | 既存のピアリザベーションのリスト。各メンバーはピアリザベーションオブジェクトです。詳細は以下のとおりです。 |
ピアリザベーションオブジェクト
reservations
配列の各メンバーは、1つのピアリザベーションを表すJSONオブジェクトです。このオブジェクトのフィールドを次に示します。
Field | 型 | 説明 |
---|---|---|
node | 文字列 | この予約の対象となるピアサーバの[ノード公開鍵][]([base58][])。 |
description | 文字列 | (省略される場合があります) このピアリザベーションの説明(ある場合)。 |
考えられるエラー
- いずれかの汎用エラータイプ。