crawl_shards: add to config, see also, etc.

This commit is contained in:
mDuo13
2019-01-24 14:55:29 -08:00
parent 8e64cd4219
commit 5275cd2b1f
4 changed files with 18 additions and 4 deletions

View File

@@ -46,7 +46,9 @@
"channel_verify",
"connect",
"consensus_info",
"crawl_shards",
"deposit_authorized",
"download_shard",
"feature",
"fee",
"fetch_info",

View File

@@ -27,7 +27,8 @@ The history of all ledgers is shared by servers agreeing to keep particular rang
## See Also
- [Configure History Sharding](configure-history-sharding.html)
<!--{# - [download_shard method][] #}-->
- [download_shard method][]
- [crawl_shards method][]
<!--{# common link defs #}-->
{% include '_snippets/rippled-api-links.md' %}

View File

@@ -108,17 +108,17 @@ The response follows the [standard format][], with a successful result containin
| `Field` | Type | Description |
|:------------------|:-------|:------------------------------------------------|
| `complete_shards` | String | The range of history shards that are available across all servers that were searched. This may be disjointed. For example, `1-2,5,7-9` indicates that shards 1, 2, 5, 7, 8, and 9 are available. |
| `peers` | Array | List of **Peer Shard Objects** (see below) describing which history shards each peer has available. Only includes servers that have [history sharding](history-sharding.html) enabled. |
| `peers` | Array | List of **Peer Shard Objects** (see below) describing which history shards each peer has available. |
#### Peer Shard Objects
Each member of the `peers` array of the response is an object that describes one server in the peer-to-peer network. These objects contain the following fields:
Each member of the `peers` array of the response is an object that describes one server in the peer-to-peer network. The list only includes peers that have at least one complete [history shard](history-sharding.html) available. Each object in the array contain the following fields:
| `Field` | Type | Description |
|:----------|:-------|:--------------------------------------------------------|
| `complete_shards` | String | The range of history shards this peer has available. This may be disjointed. For example, `1-2,5,7-9` indicates that shards 1, 2, 5, 7, 8, and 9 are available. |
| `ip` | String | _(May be omitted)_ The IP address of the peer this object describes. This may be an IPv4 or IPv6 address. Omitted if the server is a private peer. |
| `ip` | String | _(May be omitted)_ The IP address of the peer this object describes. This may be an IPv4 or IPv6 address. Omitted if this is a [private peer](peer-protocol.html#private-peers). |
| `public_key` | String | _(Omitted unless the request specified `"pubkey": true`)_ The public key this peer uses for peer-to-peer communications, in the XRP Ledger's [base58 format](base58-encodings.html). |

View File

@@ -1905,6 +1905,17 @@ pages:
targets:
- local
- md: references/rippled-api/admin-rippled-methods/logging-and-data-management-methods/crawl_shards.md
html: crawl_shards.html
blurb: Request information about which history shards peers have.
funnel: Docs
doc_type: References
supercategory: rippled API
category: Admin rippled Methods
subcategory: Logging and Data Management Methods
targets:
- local
- md: references/rippled-api/admin-rippled-methods/logging-and-data-management-methods/download_shard.md
html: download_shard.html
blurb: Download a specific shard of ledger history.