mirror of
https://github.com/XRPLF/xrpl-dev-portal.git
synced 2025-11-20 11:45:50 +00:00
added blurbs, demoted headers
This commit is contained in:
@@ -1,11 +1,11 @@
|
||||
## can_delete
|
||||
# can_delete
|
||||
[[Source]<br>](https://github.com/ripple/rippled/blob/develop/src/ripple/rpc/handlers/CanDelete.cpp "Source")
|
||||
|
||||
With `online_delete` and `advisory_delete` configuration options enabled, the `can_delete` method informs the rippled server of the latest ledger which may be deleted.
|
||||
|
||||
_The `can_delete` method is an [admin command](#connecting-to-rippled) that cannot be run by unprivileged users._
|
||||
|
||||
#### Request Format
|
||||
### Request Format
|
||||
|
||||
An example of the request format:
|
||||
|
||||
@@ -60,7 +60,7 @@ a successful result containing the following fields:
|
||||
|
||||
Use this command with no parameter to query the existing `can_delete` setting.
|
||||
|
||||
#### Possible Errors
|
||||
### Possible Errors
|
||||
|
||||
* Any of the [universal error types](#universal-errors).
|
||||
* `notEnabled` - Not enabled in configuration.
|
||||
|
||||
@@ -1,11 +1,11 @@
|
||||
## ledger_cleaner
|
||||
# ledger_cleaner
|
||||
[[Source]<br>](https://github.com/ripple/rippled/blob/df54b47cd0957a31837493cd69e4d9aade0b5055/src/ripple/rpc/handlers/LedgerCleaner.cpp "Source")
|
||||
|
||||
The `ledger_cleaner` command controls the [Ledger Cleaner](https://github.com/ripple/rippled/blob/f313caaa73b0ac89e793195dcc2a5001786f916f/src/ripple/app/ledger/README.md#the-ledger-cleaner), an asynchronous maintenance process that can find and repair corruption in `rippled`'s database of ledgers.
|
||||
|
||||
_The `ledger_cleaner` method is an [admin command](#connecting-to-rippled) that cannot be run by unprivileged users._
|
||||
|
||||
#### Request Format
|
||||
### Request Format
|
||||
An example of the request format:
|
||||
|
||||
<!-- MULTICODE_BLOCK_START -->
|
||||
@@ -35,7 +35,7 @@ The request includes the following parameters:
|
||||
| `check_nodes` | Boolean | _(Optional)_ If true, correct ledger state objects in the specified ledger(s). Overrides `full` if provided. |
|
||||
| `stop` | Boolean | _(Optional)_ If true, disable the ledger cleaner. |
|
||||
|
||||
#### Response Format
|
||||
### Response Format
|
||||
|
||||
An example of a successful response:
|
||||
|
||||
@@ -62,7 +62,7 @@ The response follows the [standard format](#response-formatting), with a success
|
||||
|:----------|:-------|:---------------------------------|
|
||||
| `message` | String | `Cleaner configured` on success. |
|
||||
|
||||
#### Possible Errors
|
||||
### Possible Errors
|
||||
|
||||
* Any of the [universal error types](#universal-errors).
|
||||
* `internal` if one the parameters is specified incorrectly. (This is a bug; the intended error code is `invalidParams`.)
|
||||
|
||||
@@ -1,11 +1,11 @@
|
||||
## ledger_request
|
||||
# ledger_request
|
||||
[[Source]<br>](https://github.com/ripple/rippled/blob/e980e69eca9ea843d200773eb1f43abe3848f1a0/src/ripple/rpc/handlers/LedgerRequest.cpp "Source")
|
||||
|
||||
The `ledger_request` command tells server to fetch a specific ledger version from its connected peers. This only works if one of the server's immediately-connected peers has that ledger. You may need to run the command several times to completely fetch a ledger.
|
||||
|
||||
*The `ledger_request` request is an [admin command](#connecting-to-rippled) that cannot be run by unprivileged users!*
|
||||
|
||||
#### Request Format
|
||||
### Request Format
|
||||
An example of the request format:
|
||||
|
||||
<!-- MULTICODE_BLOCK_START -->
|
||||
@@ -37,7 +37,7 @@ The request includes the following parameters:
|
||||
|
||||
You must provide either `ledger_index` or `ledger_hash` but not both.
|
||||
|
||||
#### Response Format
|
||||
### Response Format
|
||||
|
||||
The response follows the [standard format](#response-formatting). However, the request returns a failure response if it does not have the specified ledger _even if it successfully instructed the `rippled` server to start retrieving the ledger_.
|
||||
|
||||
@@ -156,7 +156,7 @@ The three possible response formats are as follows:
|
||||
2. When the response shows the server is currently fetching the ledger, the body of the result is a [Ledger Request Object](#ledger-request-object) indicating the progress of fetching the ledger from the peer-to-peer network.
|
||||
3. When the ledger is fully available, the response is a representation of the [ledger header](reference-ledger-format.html#header-format).
|
||||
|
||||
#### Ledger Request Object
|
||||
### Ledger Request Object
|
||||
|
||||
When the server is in the progress of fetching a ledger, but has not yet finished, the `rippled` server returns a ledger request object indicating its progress towards fetching the ledger. This object has the following fields:
|
||||
|
||||
@@ -171,7 +171,7 @@ When the server is in the progress of fetching a ledger, but has not yet finishe
|
||||
| `peers` | Number | How many peers the server is querying to find this ledger. |
|
||||
| `timeouts` | Number | Number of times fetching this ledger has timed out so far. |
|
||||
|
||||
#### Possible Errors
|
||||
### Possible Errors
|
||||
|
||||
* Any of the [universal error types](#universal-errors).
|
||||
* `invalidParams` - One or more fields are specified incorrectly, or one or more required fields are missing. This error can also occur if you specify a ledger index equal or higher than the current in-progress ledger.
|
||||
|
||||
@@ -1,11 +1,11 @@
|
||||
## log_level
|
||||
# log_level
|
||||
[[Source]<br>](https://github.com/ripple/rippled/blob/155fcdbcd0b4927152892c8c8be01d9cf62bed68/src/ripple/rpc/handlers/LogLevel.cpp "Source")
|
||||
|
||||
The `log_level` command changes the `rippled` server's logging verbosity, or returns the current logging level for each category (called a _partition_) of log messages.
|
||||
|
||||
_The `log_level` method is an [admin command](#connecting-to-rippled) that cannot be run by unprivileged users._
|
||||
|
||||
#### Request Format
|
||||
### Request Format
|
||||
An example of the request format:
|
||||
|
||||
<!-- MULTICODE_BLOCK_START -->
|
||||
@@ -37,7 +37,7 @@ The request includes the following parameters:
|
||||
| `severity` | String | _(Optional)_ What level of verbosity to set logging at. Valid values are, in order from least to most verbose: `fatal`, `error`, `warn`, `info`, `debug`, and `trace`. If omitted, return current log verbosity for all categories. |
|
||||
| `partition` | String | _(Optional)_ Ignored unless `severity` is provided. Which logging category to modify. If omitted, or if provided with the value `base`, set logging level for all categories. |
|
||||
|
||||
#### Response Format
|
||||
### Response Format
|
||||
|
||||
Examples of successful responses:
|
||||
|
||||
@@ -129,7 +129,7 @@ Otherwise, the request contains the following field:
|
||||
|:--------|:-------|:----------------------------------------------------------|
|
||||
| `level` | Object | The current log levels of each category. This list of categories is subject to change without notice in future releases. You can use the field names as values to `partition` in requests to this command. |
|
||||
|
||||
#### Possible Errors
|
||||
### Possible Errors
|
||||
|
||||
* Any of the [universal error types](#universal-errors).
|
||||
* `invalidParams` - One or more fields are specified incorrectly, or one or more required fields are missing.
|
||||
|
||||
@@ -1,11 +1,11 @@
|
||||
## logrotate
|
||||
# logrotate
|
||||
[[Source]<br>](https://github.com/ripple/rippled/blob/743bd6c9175c472814448ea889413be79dfd1c07/src/ripple/rpc/handlers/LogRotate.cpp "Source")
|
||||
|
||||
The `logrotate` command closes and reopens the log file. This is intended to help with log rotation on Linux file systems.
|
||||
|
||||
_The `logrotate` method is an [admin command](#connecting-to-rippled) that cannot be run by unprivileged users._
|
||||
|
||||
#### Request Format
|
||||
### Request Format
|
||||
An example of the request format:
|
||||
|
||||
<!-- MULTICODE_BLOCK_START -->
|
||||
@@ -29,7 +29,7 @@ rippled logrotate
|
||||
|
||||
The request includes no parameters.
|
||||
|
||||
#### Response Format
|
||||
### Response Format
|
||||
|
||||
An example of a successful response:
|
||||
|
||||
@@ -70,6 +70,6 @@ The response follows the [standard format](#response-formatting), with a success
|
||||
|:----------|:-------|:--------------------------------------------------------|
|
||||
| `message` | String | On success, contains the message `The log file was closed and reopened.` |
|
||||
|
||||
#### Possible Errors
|
||||
### Possible Errors
|
||||
|
||||
* Any of the [universal error types](#universal-errors).
|
||||
|
||||
Reference in New Issue
Block a user