peer_reservations_del

[ソース]

{{currentpage.name}}メソッドは、特定の[ピアリザベーション][]を削除します（存在する場合）。[新規: rippled 1.4.0][]

{{currentpage.name}}メソッドは、権限のないユーザーは実行できない管理メソッドです。

注記: ピアリザベーションを削除しても、対応するピアが接続されている場合、そのピアは自動的に切断されません。

要求フォーマット

要求フォーマットの例:

WebSocket

{
    "id": "peer_reservations_del_example_1",
    "command": "{{currentpage.name}}",
    "public_key": "n9Jt8awsPzWLjBCNKVEEDQnw4bQEPjezfcQ4gttD1UzbLT1FoG99"
}

JSON-RPC

{
    "method": "{{currentpage.name}}",
    "params": [{
      "public_key": "n9Jt8awsPzWLjBCNKVEEDQnw4bQEPjezfcQ4gttD1UzbLT1FoG99"
    }]
}

コマンドライン

#Syntax: {{currentpage.name}} <public_key>
rippled {{currentpage.name}} n9Jt8awsPzWLjBCNKVEEDQnw4bQEPjezfcQ4gttD1UzbLT1FoG99

要求には以下のパラメーターが含まれます。

`Field`	型	説明
`public_key`	文字列	削除する[ピアリザベーション][]の[ノード公開鍵][]（[base58][]フォーマット）

応答フォーマット

処理が成功した応答の例:

WebSocket

{
  "id": "peer_reservations_del_example_1",
  "result": {
    "previous": {
      "description": "Ripple s1 server 'WOOL'",
      "node": "n9Jt8awsPzWLjBCNKVEEDQnw4bQEPjezfcQ4gttD1UzbLT1FoG99"
    }
  },
  "status": "success",
  "type": "response"
}

JSON-RPC

{
   "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フィールドが指定されている場合は、このピアリザベーションの以前のステータスが次のフィールドとともに表示されます。

{% include '_snippets/peer_reservation_object.md' %}

考えられるエラー

いずれかの[一般的なエラータイプ][]。
invalidParams - 1つ以上のフィールドの指定が正しくないか、1つ以上の必須フィールドが指定されていません。
publicMalformed - 要求のpublic_keyフィールドが無効です。[base58][]フォーマットの有効なノード公開鍵である必要があります。

{% include '_snippets/rippled-api-links.md' %} {% include '_snippets/tx-type-links.md' %} {% include '_snippets/rippled_versions.md' %}

4.2 KiB Raw Blame History Unescape Escape

peer_reservations_del

要求フォーマット

応答フォーマット

ピアリザベーションオブジェクト

考えられるエラー

4.2 KiB

Raw Blame History