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