1.7.21

Cellスナップショットファイル取得

概要

Cellスナップショットファイルを取得する。
If-None-Matchヘッダに指定されたETag値によって、返却される内容が異なる。

必要な権限

root

リクエスト

リクエストURL

{CellURL}__snapshot/{FileName}

メソッド

GET

リクエストクエリ

クエリ名概要有効値必須備考
p_cookie_peerクッキー認証値認証時にサーバから返却されたクッキー認証値×Authorizationヘッダの指定が無い場合のみ有効
クッキーの認証情報を利用する場合に指定する

リクエストヘッダ

ヘッダ名概要有効値必須備考
X-HTTP-Method-Overrideメソッドオーバーライド機能任意×POSTメソッドでリクエスト時にこの値を指定すると、指定した値がメソッドとして使用される。
X-Overrideヘッダオーバライド機能${上書きするヘッダ名}:${値}×通常のHTTPヘッダの値を上書きする。複数のヘッダを上書きする場合はX-Overrideヘッダを複数指定する。
X-Personium-RequestKeyイベントログに出力するRequestKeyフィールドの値半角英数、-(半角ハイフン)と_(半角アンダーバー)
最大128文字		×指定がない場合は、UUIDの独自短縮表現として${4桁}_${18桁}の形式のBase64url文字列を自動採番
AuthorizationOAuth2.0形式で、認証情報を指定するBearer {AccessToken}×※認証トークンは認証トークン取得APIで取得したトークン
If-None-MatchETagの値を指定するString
以下のフォーマットでETag値を指定する
"*"または、"{半角数字}-{半角数字}"		×例）ETag値「1-1372742704414」を指定する場合
"1-1372742704414"

リクエストボディ

なし

レスポンス

ステータスコード

  • リクエストでIf-None-Matchヘッダが指定されていない場合、またはリクエストでIf-None-MatchヘッダのETag値がWebDavに保存されているリソースのETagと一致しない場合
    （指定されたETag値のフォーマットが不正な場合を含む）
コードメッセージ概要
200OK取得成功
  • リクエストでIf-None-MatchヘッダのETag値がWebDavに保存されているリソースのETagと一致する場合
コードメッセージ概要
304Not Modifiedドキュメントが更新されていない

レスポンスヘッダ

ヘッダ名概要備考
Content-TypeリソースのContent-Typeステータスコード200の場合のみ返却する
ETagリソースのバージョン情報
Access-Control-Allow-Originクロスドメイン通信許可ヘッダ返却値は"*"固定
X-Personium-VersionAPIの実行バージョンリクエストが処理されたAPIバージョン

レスポンスボディ

ファイルの内容を返却する
ただし、ステータスコードが304の場合はレスポンスボディを返却しない

エラーメッセージ一覧

エラーメッセージ一覧を参照

cURLサンプル

curl "https://cell1.unit1.example/__snapshot/snapshot-file1" -X GET -i -H \
'Authorization: Bearer AA~PBDc...(省略)...FrTjA'
← Cellスナップショットファイル登録更新Cellスナップショットファイル設定取得 →