can_deleteメソッドは指示による削除が有効なオンライン削除を使用するrippledサーバに削除が可能のレジャーバージョンを通知します。指定したレジャーバージョン以前が削除可能になります。指示による削除が有効ではない場合、このメソッドは何も行いません。
can_deleteメソッドは、権限のないユーザは実行できない管理メソッドです。
リクエストのフォーマットの例:
{
"id": 2,
"command": "can_delete",
"can_delete": 11320417
}リクエストには以下のパラメーターを指定できます。
Field | 型 | 説明 |
|---|---|---|
can_delete | 文字列 または整数 | （省略可） 削除可能な最大レジャーバージョンのレジャーインデックス。特殊ケースneverを指定すると、オンライン削除が無効になります。特殊ケースalwaysを指定すると、指示による削除が無効な場合と同様に、自動オンライン削除が有効になります。特殊ケースnowを指定すると、設定されているonline_delete値に一致するかまたはこの値を超える次の検証済みレジャーで、オンライン削除が1回実行されます。省略すると、サーバは変更を行いません（ただし現在のcan_deleteの値でレスポンスします）。 |
レスポンスは標準フォーマットに従っており、正常に完了した場合は結果に次のフィールドが含まれています。
Field | 型 | 説明 |
|---|---|---|
can_delete | 整数 | オンライン削除ルーチンにより削除できる最大レジャーインデックス。 |
既存のcan_delete設定を照会する場合は、パラメーターを指定せずにこのコマンドを実行します。
- 汎用エラータイプのすべて。
invalidParams- 1つ以上のフィールドの指定が正しくないか、1つ以上の必須フィールドが指定されていません。lgrNotFoundリクエストのcan_deleteフィールドに指定されているレジャーが存在しないか、存在しているがサーバにはありません。notEnabled- オンライン削除または指示による削除のいずれかがサーバの設定で有効になっていない場合。notReady- サーバは現在オンライン削除を実行する準備ができていません。これは通常、サーバが起動したが、検証済みレジャーをまだ取得していないことを意味します。