XRP Ledger Apex is back in Amsterdam

Register Now
Last updated
Edit

peer_reservations_add

[ソース]

このpeer_reservations_addメソッドは、XRP Ledgerピアツーピアネットワーク内の特定のピアサーバの予約済みスロットを追加または更新します。新規: rippled 1.4.0

peer_reservations_addメソッドは、権限のないユーザは実行できない管理メソッドです。

リクエストのフォーマット

リクエストのフォーマットの例:

  1. WebSocket
  2. JSON-RPC
  3. コマンドライン
{
    "id": "peer_reservations_add_example_1",
    "command": "peer_reservations_add",
    "public_key": "n9Jt8awsPzWLjBCNKVEEDQnw4bQEPjezfcQ4gttD1UzbLT1FoG99",
    "description": "Ripple s1 server 'WOOL'"
}

リクエストには以下のパラメーターが含まれます。

Field説明
public_key文字列base58での予約を追加するピアリザベーションのノード公開鍵
description文字列(省略可) ピアリザベーションに関するカスタムの説明。64文字を超える部分は、再起動時にサーバによって切り捨てられます。

レスポンスのフォーマット

処理が成功したレスポンスの例:

  1. WebSocket
  2. JSON-RPC
  3. コマンドライン
{
  "id": "peer_reservations_add_example_1",
  "result": {
    "previous": {
      "description": "Maecenas atavis edite regibus, O et praesidium et dulce decus meum, Sunt quos curriculo pulverem Olympicum Collegisse iuvat metaque fervidis Evitata rotis palmaque nobilis Terrarum dominos evehit ad deos; Hunc, si mobilium turba Quiritium Certat tergeminis tollere honoribus; Illum, si proprio condidit horreo, Quidquid de Libycis verritur areis.",
      "node": "n9Jt8awsPzWLjBCNKVEEDQnw4bQEPjezfcQ4gttD1UzbLT1FoG99"
    }
  },
  "status": "success",
  "type": "response"
}

このレスポンスは標準フォーマットに従っており、正常に完了した場合は結果に次のフィールドが含まれます。

Field説明
previousオブジェクト(省略される場合があります) 同じノード公開鍵の以前のエントリ(同じノード公開鍵を使用した予約がすでに存在する場合)。以下で説明するように、このオブジェクトは、ピアリザベーションオブジェクトというフォーマットになります。

同じノード公開鍵に以前のエントリがなかった場合、resultオブジェクトは空です。

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

previousフィールドが指定されている場合は、このピアリザベーションの以前のステータスが次のフィールドとともに表示されます。

Field説明
node文字列この予約の対象となるピアサーバの[ノード公開鍵][]([base58][])。
description文字列(省略される場合があります) このピアリザベーションの説明(ある場合)。

考えられるエラー

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