Set File Retention Period

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

このインターフェースは、ファイルの保存期間(保持期限)を設定する機能を提供します。設定した日数を超えたファイルは自動的に削除されます。

注意: ファイル削除後の復旧はできませんので、慎重に操作してください。

リクエスト説明

リクエストパス

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

<requestParam>

ヘッダー説明

パラメータ 必須 説明
Host はい 管理ドメイン名(コンソールのバケット概要画面で取得可)
Authorization はい 管理認証情報

パラメータ説明

リクエストパラメータは以下の形式で送信します:

bucket=<Urlsafe_Base64_Encoded_Bucket>&key=<Urlsafe_Base64_Encoded_Key>&deadline=<deadline>&relevance=<relevance>
パラメータ 必須 説明
bucket はい スペース名(バケット名)
key はい ファイル名
deadline はい ファイルの保存期間(単位:日)。指定した日数を超えたファイルは自動で削除されます。例: 1,2,3…
注意: 0は「できるだけ早く削除」、-1は「期限なし・永久保存」を意味します。
relevance いいえ m3u8ファイル操作と連動してTSファイルの保存期間も設定するかどうか。0:連動しない、1:連動設定。
注意:
1. このパラメータを省略した場合、デフォルトで連動処理となります。m3u8以外のファイルはこの設定の影響を受けません。
2. m3u8内のTSアクセスパスが相対パスの場合のみ有効です。絶対パスのTSファイルには本設定は適用されません。
3. m3u8が絶対パスのTSファイルを参照する場合、先にm3u8内容を解析し、個別にTSファイルへ設定することを推奨します。

レスポンス説明

下記のようなJSON文字列が返されます。

{
    "code":     "<code string>",
    "message":   "<message string>"
}
フィールド名 必須 説明
code はい HTTPリクエストステータスコード。HTTP Response Status Codes参照
message はい 要求結果メッセージ。OKは成功を示します。

実行例

curl -v -X POST -d"bucket=aW1hZ2Vz&key=bGVodS5tcDQ==&deadline=1" -H "Authorization:86622e227a50d49d858c2494a935bc2e4ac543a7:Y2JmMGY0YTNhZmQxZmVlZGM2ZTA0YTdjNTcyOWQ1NjRkNTExYjg0Yg==" --url "http://mgrDomain/setdeadline"