9.8. ファイルの公開¶
-
PUT
/1/
(tenantId)/files/
(bucketName)/
(fileName)/publish
¶ ファイル1件を公開する。
公開されたファイルには一意な URL が付与され、一切のアクセス制限なく読み込みアクセスができるので、 a タグの href 属性や img タグの src 属性に指定できるようになる。
Request Headers: - X-Application-Id -- アプリケーションID(必須)
- X-Application-Key -- アプリケーションキー(必須)
- X-Session-Token -- セッショントークン(オプション)
Parameters: - bucketName (string) -- バケット名
- fileName (string) -- ファイル名
Query Parameters: - metaETag (string) -- メタデータETag値
Status Codes: - 200 OK -- 正常終了した
- 400 Bad Request -- パラメータ・リクエストボディ不正
- 401 Unauthorized -- 認証エラー
- 403 Forbidden -- 権限エラー
- 404 Not Found -- 該当バケットまたはファイルが存在しない
- 409 Conflict -- ファイルがロック中(file_locked)、ETag 不一致(etag_mismatch)、データ重複(duplicate_key)
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)がレスポンスボディで返却される。
成功した場合、metaETag フィールドに更新された ETag 値(metaETag)が格納される (データの内容に変更がない場合であっても、常に updatedAt とmetaETag 値は更新される)。
409 Conflictの場合はその原因をJSON形式で返す。
以下レスポンスボディの例を示す。 publicUrl に公開 URL が格納される。また、metaETag が更新される。
{ "_id": "533d31c43cbc3dd2d0b32cd1", "filename": "hello.txt", "contentType": "text/plain", "length": 12, "ACL": { /*ACL*/ }, "createdAt": "2013-08-27T04:37:30.000Z", "updatedAt": "2013-08-27T04:37:30.000Z", "metaETag": "8c92c97e-01a7-11e4-9598-53792c688d1b", // 更新される "fileETag": "8c92c97e-01a7-11e4-9598-53792c688d1c", "cacheDisabled": false, "publicUrl": "http://xxxx/yyyyy/hello.txt", // 公開URL "options": { "owner": "日電 太郎", "fileVersion": "1.0.0" } }
更新が成功した場合、metaETag フィールドに更新された ETag 値(metaETag)が格納される (データの内容に変更がない場合であっても、常に updatedAt とmetaETag 値は更新される)。
409 Conflictの場合はその原因をJSON形式で返す。
注意事項
- すでに公開中のファイルを再公開しても URL は変更されない。
- バケット contentACL の update 権限が必要。
- 対象ファイルの admin権限が必要。
- バケットcontentACL、および対象ファイルのread権限が無くても、上記のレスポンスが返却される。