9.6. ファイルメタデータの更新¶
-
PUT
/1/
(tenantId)/files/
(bucketName)/
(fileName)/meta
¶ ファイル1件のメタデータを更新する。
Request Headers: - X-Application-Id -- アプリケーションID(必須)
- X-Application-Key -- アプリケーションキー(必須)
- X-Session-Token -- セッショントークン(オプション)
- Content-Type -- "application/json"
Parameters: - bucketName (string) -- バケット名
- fileName (string) -- ファイル名
Query Parameters: - metaETag (string) -- メタデータETag値
Request JSON Object: - filename (string) -- ファイル名
- contentType (string) -- Content-Type
- ACL (object) -- ACL
- cacheDisabled (boolean) -- キャッシュ無効フラグ
- options (object) -- オプション。JSONオブジェクト形式で記述された任意のオブジェクトを指定できる。
Status Codes: - 200 OK -- 正常に更新した
- 400 Bad Request -- パラメータ・リクエストボディ不正
- 401 Unauthorized -- 認証エラー
- 403 Forbidden -- 権限エラー
- 404 Not Found -- 該当バケットまたはファイルが存在しない
- 409 Conflict -- ファイルがロック中(file_locked)、ETag 不一致(etag_mismatch)、ファイル名重複(duplicate_filename)
- 415 Unsupported Media Type -- Content-Type 不正
Response JSON Object: - _id (string) -- ファイルID
- filename (string) -- ファイル名
- contentType (string) -- Content-Type
- length (int) -- ファイルサイズ
- ACL (object) -- ACL
- createdAt (string) -- 作成日時
- updatedAt (string) -- 更新日時
- metaETag (string) -- メタデータETag
- fileETag (string) -- ファイルETag
- cacheDisabled (boolean) -- キャッシュ無効フラグ
- publicUrl (string) -- 公開URL
- options (object) -- オプション
- _deleted (boolean) -- 論理削除フラグ
リクエスト
リクエストボディに更新用メタデータを JSON で指定する。
更新できるのは、filename, contentType, ACL, cachedDisabled のみである。指定したプロパティのみが変更される。 length など他のプロパティは更新できない。
なお、filename に使用できる文字・長さの制限は、 ファイルの新規アップロード の制限と同じである。
レスポンス
更新したメタデータ(JSON)がレスポンスボディで返却される。
更新が成功した場合、metaETag フィールドに更新された ETag 値(metaETag)が格納される (データの内容に変更がない場合であっても、常に updatedAt とmetaETag 値は更新される)。
409 Conflictの場合はその原因をJSON形式で返す。
注意事項
- バケットcontentACLと対象ファイルの update 権限が必要。
- ACLとcacheDisabledを変更する場合は、admin 権限も必要。
- バケットcontentACL、および対象ファイルのread権限が無くても、上記のレスポンスが返却される。