8.7. オブジェクトの一括削除¶
-
DELETE
/1/
(tenantId)/objects/
(bucketName)¶ 条件に合致するオブジェクトを一括削除する。
Request Headers: - X-Application-Id -- アプリケーションID(必須)
- X-Application-Key -- アプリケーションキー(必須)
- X-Session-Token -- セッショントークン(オプション)
Parameters: - bucketName (string) -- バケット名
Query Parameters: - where (string) -- 削除条件( オブジェクトのクエリ の where と同じ)
- deleteMark (int) -- 論理削除を行う場合は1
Status Codes: - 200 OK -- 正常終了
- 400 Bad Request -- パラメータ不正
- 401 Unauthorized -- 認証エラー
- 403 Forbidden -- 権限エラー
- 404 Not Found -- 該当バケットが存在しない
Response JSON Object: - result (string) -- 削除結果
- deletedObjects (int) -- 削除されたオブジェクトの個数
クエリパラメータの詳細
whereで条件指定した場合、その条件とACLを満たすオブジェクトが削除される。
whereを指定しない場合、ACLを満たす全てのオブジェクトが削除対象となる。
deleteMark を 1 にした場合、対象のオブジェクトを一括で論理削除状態にする。 updatedAt,etag は自動更新される。既に論理削除状態となっているオブジェクトは対象外となる。
レスポンスボディの例
レスポンスには、以下のように削除したオブジェクトの個数がJSON形式で返却される。
{ "result":"ok", "deletedObjects":3 }
削除対象が見つからない場合のレスポンスは、正常終了で削除個数0となる。
注意事項
- バケットcontentACLと対象オブジェクトの delete 権限が必要