mirror of https://github.com/XRPLF/xrpl-dev-portal.git synced 2025-11-27 23:25:51 +00:00

Files

mDuo13 7645140477 Re-levelization: move non-docs content, rename content→docs

For better URLs, the content folder has been renamed 'docs' and all
other files have been moved up a level. Also, non-docs images have been
moved to the static folder at the top level where they belong.

Many relative paths had to be fixed to make this work.

2024-01-31 17:53:52 -08:00

7.3 KiB

Raw Blame History

html, parent, seo, labels

html

parent

seo

labels

peer-crawler.html

peer-port-methods.html

description
ネットワークの情報とステータスの統計を共有するための特別なAPIメソッドです。

コアサーバ

ブロックチェーン

ピアクローラ

ピアクローラは、ピアツーピアネットワークの健全性と統計情報を報告するための特別なpeer portメソッドです。このAPIメソッドは、デフォルトではピアプロトコルのポートを通して非rootベースで利用可能で、コンセンサスやレジャーの履歴、その他の必要な情報についてのrippledサーバのピアツーピア通信にも使用されます。

ピアクローラによって報告された情報は事実上公開され、XRP Ledgerのネットワーク全体やその健全性、統計情報について報告するために使用することができます。

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

ピアクローラ情報をリクエストするには、以下のHTTPリクエストを送信します。

プロトコル: https
HTTPメソッド: GET
ホスト: (任意のrippledサーバ(ホスト名またはIPアドレス))
ポート: (rippledサーバがピアプロトコルを使用するポート番号、通常は51235です。)
パス: /crawl
セキュリティ: ほとんどのrippledサーバはリクエストにレスポンスするために自己署名証明書を使います。デフォルトでは、(ウェブブラウザを含む)ほとんどのツールは、そのようなレスポンスは信頼できないとしてフラグを立てたりブロックしたりします。これらのサーバからのレスポンスを表示するには、証明書のチェックを無視しなければなりません(たとえば、cURLを使用している場合は--insecureフラグを追加します)。

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

レスポンスにはステータスコード200 OKとメッセージ本文にJSONオブジェクトがあります。

JSONオブジェクトは次のフィールドを含んでいます。

`フィールド`	値	説明
`counts`	オブジェクト	(省略可) [get_countsメソッド][]のレスポンスと同じように、このサーバの状態に関する統計情報を返します。デフォルトの設定では、このフィールドは報告されません。報告される情報には、レジャーデータベースとトランザクションデータベースのサイズ、アプリケーション内キャッシュのキャッシュヒット率、さまざまな種類のオブジェクトがメモリにキャッシュされている数などがあります。メモリに保存されるオブジェクトの種類には、レジャー(`Ledger`)、トランザクション(`STTx`)、検証メッセージ (`STValidation`)などがあります。
`overlay`	オブジェクト	(省略可) [peersメソッド][]のレスポンスに似ています。`active`というフィールドがあり、これはオブジェクトの配列です(下記参照)。
`server`	オブジェクト	(省略可) このサーバに関する情報。[server_stateメソッド][]の公開フィールドを含みます。どの`rippled`バージョン(`build_version`)か、どのレジャーバージョンが利用可能か(`complete_ledgers`)、サーバーの負荷量などです。{% badge href="https://github.com/XRPLF/rippled/releases/tag/1.2.1" %}更新: rippled 1.2.1{% /badge %}.
`unl`	オブジェクト	(省略可) [validatorsメソッド][]や[validator_list_sitesメソッド][]のレスポンスと同様です。{% badge href="https://github.com/XRPLF/rippled/releases/tag/1.2.1" %}更新: rippled 1.2.1{% /badge %}.
`version`	数値	このピアクローラのレスポンスのフォーマットのバージョンを示します。現在のピアクローラのバージョン番号は`2`です。{% badge href="https://github.com/XRPLF/rippled/releases/tag/1.2.1" %}更新: rippled 1.2.1{% /badge %}.

overlay.active配列の各メンバーは、次のフィールドを持つオブジェクトです。

`Field`	値	説明
`complete_ledgers`	文字列	このピアで利用可能なレジャーバージョンの範囲。
`complete_shards`	文字列	(省略可) このピアが利用可能なレジャー履歴シャードの範囲。
`ip`	文字列 (IPv4アドレス)	_(省略可)_この接続ピアの IPアドレス。ピアがバリデータまたはプライベートピアとして設定されている場合は省略されます。{% badge href="https://github.com/XRPLF/rippled/releases/tag/1.2.1" %}更新: rippled 1.2.1{% /badge %}.
`port`	文字列 (数値)	(省略可) RTXPを提供するピアサーバのポート番号。通常は`51235`。ピアがバリデータまたはプライベートピアとして設定されている場合は省略されます。{% badge href="https://github.com/XRPLF/rippled/releases/tag/1.2.1" %}更新: rippled 1.2.1{% /badge %}.
`public_key`	文字列 (Base64エンコード)	このピアがRTXPメッセージに署名するために使用するECDSA鍵ペアの公開鍵。(これはピアサーバの[server_infoメソッド][]で報告される`pubkey_node`と同じデータです)。
`type`	文字列	`in`または`out`の値で、ピアへのTCP接続が着信か発信かを示します。
`uptime`	数値	サーバがこのピアに接続している秒数。
`version`	文字列	相手が使用していると報告した`rippled`バージョン番号。

例

リクエスト:

{% tabs %}

{% tab label="HTTP" %}

GET https://localhost:51235/crawl

{% /tab %}

{% tab label="cURL" %}

curl --insecure https://localhost:51235/crawl

{% /tab %}

{% /tabs %}

レスポンス:

{% code-snippet file="/_api-examples/peer-crawler/crawl.json" language="json" prefix="200 OK\n\n" /%}

7.3 KiB Raw Blame History

ピアクローラ

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

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

例

関連項目

7.3 KiB

Raw Blame History