Bulk Modify File Retention Period

最終更新日:2025-08-18 15:32:48

このインターフェースは非同期インターフェースであり、指定したスペース内のすべてのファイル、または指定したディレクトリ内のファイルの保持期間を一括で変更することが可能です。

注意:同じファイルの保持期間は上書きによって設定されます。

リクエスト説明

POST /fmgr/setdeadline
Host:<MgrDomain>
Authorization:<AccessToken>

ヘッダー説明

パラメータ 必須 説明
HOST はい 管理ドメイン名(コンソールのバケット概要で取得可能)
Authorization はい 管理クレデンシャル

パラメータ説明

リクエストパラメータは下記のフォーマットで構成され、リクエスト本文として送信されます。

fops =bucket/<Urlsafe_Base64_Encoded_Bucket>/deadline/<deadline>;bucket/<Urlsafe_Base64_Encoded_Bucket>/prefix/<Urlsafe_Base64_Encoded_prefix>/deadline/<deadline>&notifyURL=<Urlsafe_Base64_Encoded_notifyUrl>&separate=<Separate>
パラメータ 必須 説明
fops はい 処理パラメータリストです。上述のフォーマットで、複数の処理リクエストを同時にサポートします。リスト間は ; で区切ります。
bucket はい バケット名を指定します。<Urlsafe_Base64_Encoded_bucket> は、指定バケット名をURLセーフBase64でエンコードした文字列です。
prefix いいえ 指定したプレフィックス、つまりディレクトリ名です。<Urlsafe_Base64_Encoded_prefix> は指定したプレフィックスをURLセーフBase64でエンコードした文字列です。
注意:
1. プレフィックスが空でない場合、ディレクトリ内すべてのファイルが対象となります。プレフィックスが空の場合、指定スペース内すべてのファイルが対象です。
2. あいまい(部分一致)検索は非対応です。たとえば、プレフィックスに test を指定しても、キーのプレフィックスが test123 のリソースには適用されません。
deadline はい ファイル保持期間(日数単位)。指定日数を超えたファイルは自動的に削除されます。例:1, 2, 3 …
注意:
0 は「できるだけ早く削除」、-1 は「有効期限を解除し、永久保存」を意味します。
notifyURL いいえ 処理結果の通知を受け取るURL

リクエストパラメータ例

fops=bucket/bXlidWNrZXQ=/prefix/YWFjLw==/deadline/10;bucket/bXlidWNrZXQ=/prefix/YWFiLw==/deadline/30&notifyURL=aHR0cDovL3Rlc3QuY29tL25vdGlmeVVSbA==&separate=1

レスポンス説明

  • リクエストが成功した場合、以下の内容を持つJson文字列が返されます:
{ "persistentId": <persistentId> }
パラメータ 説明
persistentId タスクプロセスID。このIDを使ってタスクの進捗状況を照会できます。
  • リクエストが失敗した場合、以下の内容を持つJson文字列が返されます:
{
    "code":     "<code string>",
    "message":  "<ErrMsg string>"
}
フィールド名 説明
code HTTPリクエストのレスポンスコード。詳細はHTTP response status code を参照してください。
message リクエスト失敗時のエラーメッセージ

curl -v -X POST -d "fops=bucket/bXlidWNrZXQ=/prefix/YWFjLw==/deadline/10;bucket/bXlidWNrZXQ=/prefix/YWFiLw==/deadline/30&notifyURL=aHR0cDovL3Rlc3QuY29tL25vdGlmeVVSbA==&separate=1" -H "Authorization:86622e227a50d49d858c2494a935bc2e4ac543a7:Y2JmMGY0YTNhZmQxZmVlZGM2ZTA0YTdjNTcyOWQ1NjRkNTExYjg0Yg==" --url "http://mgrDomain/fmgr/setdeadline"