peer_reservations_del
peer_reservations_del
メソッドは、特定のピアリザベーションを削除します(存在する場合)。
peer_reservations_del
メソッドは、権限のないユーザは実行できない管理メソッドです。
注記: ピアリザベーションを削除しても、対応するピアが接続されている場合、そのピアは自動的に切断されません。
リクエストのフォーマット
リクエストのフォーマットの例:
{ "id": "peer_reservations_del_example_1", "command": "peer_reservations_del", "public_key": "n9Jt8awsPzWLjBCNKVEEDQnw4bQEPjezfcQ4gttD1UzbLT1FoG99" }
リクエストには以下のパラメーターが含まれます。
レスポンスのフォーマット
処理が成功したレスポンスの例:
{ "id": "peer_reservations_del_example_1", "result": { "previous": { "description": "Ripple s1 server 'WOOL'", "node": "n9Jt8awsPzWLjBCNKVEEDQnw4bQEPjezfcQ4gttD1UzbLT1FoG99" } }, "status": "success", "type": "response" }
このレスポンスは標準フォーマットに従っており、正常に完了した場合は結果に次のフィールドが含まれます。
Field | 型 | 説明 |
---|---|---|
previous | オブジェクト | (省略される場合があります) 削除する前のピアリザベーションの最後のステータスを伴った、ピアリザベーションオブジェクト。このフィールドは、ピアリザベーションが正常に削除された場合、必ず表示されます。 |
注記: 指定された予約が存在しなかった場合は、このコマンドによって、成功を示す空の結果オブジェクトが返されます。この場合、previous
フィールドは省略されます。
ピアリザベーションオブジェクト
previous
フィールドが指定されている場合は、このピアリザベーションの以前のステータスが次のフィールドとともに表示されます。
Field | 型 | 説明 |
---|---|---|
node | 文字列 | この予約の対象となるピアサーバの[ノード公開鍵][]([base58][])。 |
description | 文字列 | (省略される場合があります) このピアリザベーションの説明(ある場合)。 |