can_delete

[ソース]

can_deleteメソッドは指示による削除が有効なオンライン削除を使用するrippledサーバーに削除が可能のレジャーバージョンを通知します。指定したレジャーバージョン以前が削除可能になります。指示による削除が有効ではない場合、このメソッドは何も行いません。

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

要求フォーマット

要求フォーマットの例:

{
 "id": 2,
 "command": "can_delete",
 "can_delete": 11320417
}

{
   "method": "can_delete",
   "params": [
       {
           "can_delete": 11320417
       }
   ]
}

#Syntax: can_delete [<ledger_index>|<ledger_hash>|now|always|never]
rippled can_delete 11320417

要求には以下のパラメーターを指定できます。

応答フォーマット

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

既存のcan_delete設定を照会する場合は、パラメーターを指定せずにこのコマンドを実行します。

考えられるエラー

• 汎用エラータイプのすべて。
• invalidParams - 1つ以上のフィールドの指定が正しくないか、1つ以上の必須フィールドが指定されていません。
• lgrNotFound 要求のcan_deleteフィールドに指定されているレジャーが存在しないか、存在しているがサーバーにはありません。
• notEnabled - オンライン削除または指示による削除のいずれかがサーバーの設定で有効になっていない場合。
• notReady - サーバーは現在オンライン削除を実行する準備ができていません。これは通常、サーバーが起動したが、検証済みレジャーをまだ取得していないことを意味します。

参照項目

• オンライン削除
• 指示による削除の設定