Files
xrpl-dev-portal/content/references/http-websocket-apis/admin-api-methods/peer-management-methods/peer_reservations_add.ja.md
2022-06-28 04:09:37 -07:00

5.5 KiB

html, parent, blurb, labels
html parent blurb labels
peer_reservations_add.html peer-management-methods.html 特定のピアサーバー用の予約済みスロットを追加します。
コアサーバー

peer_reservations_add

[ソース]

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

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

要求フォーマット

要求フォーマットの例:

WebSocket

{
    "id": "peer_reservations_add_example_1",
    "command": "{{currentpage.name}}",
    "public_key": "n9Jt8awsPzWLjBCNKVEEDQnw4bQEPjezfcQ4gttD1UzbLT1FoG99",
    "description": "Ripple s1 server 'WOOL'"
}

JSON-RPC

{
    "method": "{{currentpage.name}}",
    "params": [{
      "public_key": "n9Jt8awsPzWLjBCNKVEEDQnw4bQEPjezfcQ4gttD1UzbLT1FoG99",
      "description": "Ripple s1 server 'WOOL'"
    }]
}

コマンドライン

#Syntax: {{currentpage.name}} <public_key> [<description>]
rippled {{currentpage.name}} n9Jt8awsPzWLjBCNKVEEDQnw4bQEPjezfcQ4gttD1UzbLT1FoG99 "Ripple s1 server 'WOOL'"

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

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

応答フォーマット

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

WebSocket

{
  "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"
}

JSON-RPC

{
  "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"
  }
}

コマンドライン

Loading: "/etc/rippled.cfg"
Connecting to 127.0.0.1:5005

{
  "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"
  }
}

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

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

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

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

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

{% include '_snippets/peer_reservation_object.ja.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' %}