POST range_purgejob
API情報
| HTTPメソッド | API名 | 目的 |
|---|---|---|
| POST | range_purgejob | 範囲指定キャッシュ削除ジョブ登録 |
- キャッシュ削除ジョブを登録します。登録されたジョブは順番に実行されます。
- 登録したキャッシュ削除ジョブのステータスは、GET range_purgejob(一覧)またはGET range_purgejob (JobID指定)で確認できます。
個別パラメータ
URL
- なし
HTTPリクエストボディ
| フィールド | タイプ | 意味 |
|---|---|---|
| UrlScheme | String | URLスキーム 値: http, https |
| Path | String | 始点ディレクトリパス 半角英数字および右記記号256文字以内： _ / . ~ - |
| SubDirectory | String | 検索範囲 値: on, off (on: 配下すべて,off: 直下のみ) |
| FileName | String | ファイル名 半角英数字および右記記号256文字以内： _ . ~ - |
| Extension | String | ファイルタイプ(拡張子) 半角英数字、およびアンダースコア(_) 5文字以内 |
レスポンス
| フィールド | タイプ | 意味 |
|---|---|---|
| Result.JobID | String | ジョブID |
エラーコード
- このAPIに関する個別エラーはありません。
- 共通エラーコードはエラーレスポンスを参照してください。
制限
- パターンで指定されたURLを検索して一致したキャッシュデータを削除します。
- 一度の検索で抽出されるURLの上限は10,000件です。
- 検索対象は1週間以内にアクセスがあったURLです。
アクセス頻度が低いURLは1週間以内にアクセスがあっても検索できない場合がありますのでご注意ください。 - 確実にキャッシュを削除したいた場合は「リストを指定して削除」で直接削除したいURLを指定してください
- 実際の削除件数より多くのURLが検索により抽出されていることで削除処理に時間がかかっている場合があります。
削除が遅いと感じられる場合はパターンを見直してお試しください。
サンプル
リクエスト
POST /r/(APIVersion)/(ServiceCode)/range_purgejob.json
Host: cac.api.iij.jp
Content-Type: application/json
Date: Mon, 20 Jan 2014 12:34:56 GMT
x-iijapi-Expire: (Expire)
x-iijapi-SignatureMethod: (SignatureMethod)
x-iijapi-SignatureVersion: (SignatureVersion)
Authorization: IIJAPI (AccessKeyId):(Signature)
{
"UrlScheme": "http",
"Path": "img/sample",
"SubDirectory": "off",
"FileName": "",
"Extension": "png"
}
レスポンスボディ
{
"Result": {
"RequestId": "xxxxxxxx-xxxxxxxx-xxxxxxxx-xxxxxxxx-xxxxxxxx",
"JobID": "9999999999.999",
"ServiceCode": "cac########"
}
}