can_delete

[ソース]

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

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

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

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

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

リクエストには以下のパラメーターを指定できます。

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

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

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

考えられるエラー

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

参照項目

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