next

Boxメタデータ取得

概要

Boxのメタデータを取得する。メタデータには、以下の情報が含まれる。

  • Boxの状態
    Boxインストールの状況（インストール結果、進捗率、エラーメッセージ等）
  • Boxの状態は以下の3種類が存在する
    • Boxが使用可能
    • Boxインストール処理中
    • Boxインストールの処理が異常終了
  • Boxの名前
  • BoxのURL
  • BoxのスキーマURL
  • Boxの作成日時
  • Cellメタデータ
  • Unitメタデータ

必要な権限

read

制限事項

  • Boxインストール状況が確認可能な有効期限は、Boxインストール完了（異常終了を含む）後Unitで設定されている期限まで
  • Boxインストールに失敗した場合は、EventBusに出力されたログを参照する必要がある

リクエスト

リクエストURL

{CellURL}{BoxName}

メソッド

GET

リクエストクエリ

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

リクエストヘッダ

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

リクエストボディ

なし

レスポンス

ステータスコード

コードメッセージ概要備考
200OK成功時Boxインストール成功可否はレスポンスボディを参照

レスポンスヘッダ

ヘッダ名概要備考
Access-Control-Allow-Originクロスドメイン通信許可ヘッダ返却値は"*"固定
X-Personium-VersionAPIの実行バージョンリクエストが処理されたAPIバージョン

レスポンスボディ

レスポンスはJSON形式で、オブジェクト（サブオブジェクト）に定義される。 キー(名前)と型、並びに値の対応は以下のとおり。

オブジェクト名前(キー)型値備考
ルートboxobjectObject (box format)
boxstatusstring以下のいずれかの文字列:
- "ready"
- "installation in progress"
- "installation failed"		Boxが使用可能な状態を示す
Boxインストール処理中を示す
Boxインストール完了（異常終了）を示す
boxstarted_atstringStart time (ISO 8610 UTC format)statusが以下の場合は出力しない。
- "Ready"
boxprogressstringProgress rate (for example, "30%")statusが以下の場合は出力しない。
- "Ready"
boxmessageobjectObject (message format)statusが以下の場合のみ出力する。
- "Installation failed"
詳細は エラーメッセージ一覧を参照
boxnamestringBoxの名前
boxurlstringBoxのURL
boxschemastringBoxが紐づいているスキーマのURLスキーマなしの場合は null
boxinstalled_atstringStart time (ISO 8610 UTC format)statusが以下のいずれかの場合は出力しない。
- "Installation in Progress"
- "installation failed"
ルートcellobjectObject (cell format)
cellnamestringCellの名前
cellurlstringCellのURL
ルートunitobjectObject (unit format)
uniturlstringUnitのURL
unitpath_based_cellurl_enabledbooleantrue:path based cell url
false:per cell fqdn url

エラーメッセージ一覧

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

レスポンスサンプル

Boxの作成後（Boxインストール完了時を含む）

{
  "box": {
    "status": "ready",
    "installed_at": "2017-02-13T09:00:00.000Z",
    "name": "app-box1",
    "url": "https://cell1.example.com/app-box1/",
    "schema": "https://app-cell1.example.com/"
  },
  "cell": {
    "name": "cell1",
    "url": "https://cell1.unit1.example/"
  },
  "unit": {
    "url": "https://unit1.example/",
    "path_based_cellurl_enabled": true
  }
}

Boxインストール処理中の場合

{
  "box": {
    "status": "installation in progress",
    "started_at": "2017-02-13T09:00:00.000Z",
    "progress": "81%",
    "name": "app-box1",
    "url": "https://cell1.unit1.example/app-box1/",
    "schema": "https://app-cell1.unit1.example/"
  },
  "cell": {
    "name": "cell1",
    "url": "https://cell1.unit1.example/"
  },
  "unit": {
    "url": "https://unit1.example/",
    "path_based_cellurl_enabled": true
  }
}

Boxインストール完了時（異常終了）の場合
（Boxインストールに失敗後、有効期限以内）

{
  "box": {
    "status": "installation failed",
    "started_at": "2017-02-13T09:00:00.000Z",
    "progress": "81%",
    "message": {
      "code" : "PR409-OD-0003",
      "message" : {
        "lang" : "en",
        "value" : "The entity already exists."
      }
    },
    "name": "app-box1",
    "url": "https://cell1.unit1.example/app-box1/",
    "schema": "https://app-cell1.unit1.example/"
  },
  "cell": {
    "name": "cell1",
    "url": "https://cell1.unit1.example/"
  },
  "unit": {
    "url": "https://unit1.example/",
    "path_based_cellurl_enabled": true
  }
}

cURLサンプル

curl "https://cell1.unit1.example/box1" -X GET -i \
-H 'Authorization: Bearer AA~PBDc...(省略)...FrTjA' -H 'Accept: application/json'
← BoxインストールBoxURL取得 →