ledger_cleaner
ledger_cleanerコマンドはレジャークリーナーを制御します。レジャークリーナーは、rippledのレジャーデータベースの破損を検出して修復できる非同期メンテナンスプロセスです。
ledger_cleanerメソッドは、権限のないユーザは実行できない管理メソッドです。
リクエストのフォーマット
リクエストのフォーマットの例:
{
"command": "ledger_cleaner",
"max_ledger": 13818756,
"min_ledger": 13818000,
"stop": false
}リクエストには以下のパラメーターが含まれます。
Field | 型 | 説明 |
|---|---|---|
ledger | 数値 - レジャーインデックス | (省略可) 指定されている場合は、指定されたレジャーのみをチェックして訂正します。 |
max_ledger | 数値 - レジャーインデックス | (省略可) レジャーインデックスがこの番号以下のレジャーをチェックするようにレジャークリーナーを設定します。 |
min_ledger | 数値 - レジャーインデックス | (省略可) レジャーインデックスがこの番号以上のレジャーをチェックするようにレジャークリーナーを設定します。 |
full | ブール値 | (省略可) trueの場合は、指定されたレジャーのレジャー状態オブジェクトとトランザクションを修正します。デフォルトではfalseです。ledgerが指定されている場合は、自動的にtrueに設定されます。 |
fix_txns | ブール値 | (省略可) trueの場合は、指定されたレジャーのトランザクションを修正します。指定されている場合はfullをオーバーライドします。 |
check_nodes | ブール値 | (省略可) trueの場合は、指定されているレジャーのレジャー状態オブジェクトを修正します。指定されている場合はfullをオーバーライドします。 |
stop | ブール値 | (省略可) trueの場合は、レジャークリーナーを無効にします。 |
レスポンスのフォーマット
処理が成功したレスポンスの例:
200 OK
{
"result" : {
"message" : "Cleaner configured",
"status" : "success"
}
}
このレスポンスは標準フォーマットに従っており、正常に完了した場合は結果に次のフィールドが含まれます。
Field | 型 | 説明 |
|---|---|---|
message | 文字列 | Cleaner configured: 正常終了の場合。 |
考えられるエラー
- いずれかの汎用エラータイプ。
internal: いずれかのパラメーターが正しく指定されていない場合。(これはバグです。本来のエラーコードはinvalidParamsです。)