XRP Ledger Apex is back in Amsterdam

Register Now
Last updated
Edit

crawl_shards

[ソース]

使用可能な履歴レジャーデータのシャードに関するピアサーバからの情報をリクエストします。新規: rippled 1.2.0

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

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

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

  1. WebSocket
  2. JSON-RPC
{
  "command": "crawl_shards",
  "pubkey": true,
  "limit": 0
}

注記: このメソッドのコマンドライン構文はありません。コマンドラインからアクセスするにはjsonメソッドを使用してください。

リクエストには以下のフィールドが含まれます。

Field説明
pubkeyブール値(省略可) trueの場合、レスポンスには、クロールされたサーバのノード公開鍵(ピアツーピア通信用)が含まれます。デフォルトはfalseです。
limit数値(省略可) 検索の深さを示すホップ数。デフォルトは0で、ダイレクトピアのみを検索します。1を制限値にすると、ピアのピアも検索します。最大値は3です。

注意: limitが増加すると、検索される可能性のあるピアの数は、指数関数的に増加します。2または3を制限値にすると、サーバがAPIリクエストにレスポンスするのに数秒かかる場合があります。

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

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

  1. WebSocket
  2. JSON-RPC
{
  "result": {
    "complete_shards": "1-2,5,8-9,584,1973,2358",
    "peers": [
      {
        "complete_shards": "1-2,8,47,371,464,554,653,857,1076,1402,1555,1708,1813,1867",
        "public_key": "n9LxFZiySnfDSvfh23N94UxsFkCjWyrchTeKHcYE6tJJQL5iejb2"
      },
      {
        "complete_shards": "8-9,584",
        "ip": "192.168.1.132",
        "public_key": "n9MN5xwYqbrj64rtfZAXQy7Y3sNxXZJeLt7Lj61a9DYEZ4SE2tQQ"
      }
    ]
  },
  "status": "success",
  "type": "response"
}

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

Field説明
complete_shards文字列(省略可) ローカルサーバで利用可能な履歴シャードの範囲。これは、空の文字列か、または連続していない範囲である場合があります。たとえば、1-2,5,7-9は、シャード1、2、5、7、8、9が利用可能であることを示します。このサーバで履歴シャーディングが有効になっていない場合は省略されます。
peers配列各ピアが使用可能な履歴シャードを表すピアシャードオブジェクトのリスト(以下を参照)。

ピアシャードオブジェクト

レスポンスのpeers配列のメンバーはそれぞれ、ピアツーピアネットワーク内の1つのサーバを表すオブジェクトです。リストには、少なくとも1つの完全な履歴シャードが使用可能なピアのみが含まれます。配列の各オブジェクトには以下のフィールドが含まれます。

Field説明
complete_shards文字列このピアが使用可能な履歴シャードの範囲。連続していない場合があります。たとえば、1-2,5,7-9は、シャード1、2、5、7、8、9が利用可能であることを示します。
ip文字列(省略される場合があります) このオブジェクトが表すピアのIPアドレス。IPv4アドレスまたはIPv6アドレスを指定できます。プライベートピアの場合は省略されます。
public_key文字列(リクエストで"pubkey": trueが指定されている場合を除き省略) XRP Ledgerのbase58フォーマットで、このピアでピアツーピア通信に使用される公開鍵。

考えられるエラー

  • いずれかの汎用エラータイプ
  • invalidParams - リクエストで1つ以上の必須フィールドが省略されていたか、または指定されたフィールドのデータタイプが誤っています。