10.1. Cloud Functions 実行ログ取得

GET /1/(tenantId)/logs/cloudfn

Cloud Functions の実行ログを取得する。

Request Headers:
 
  • X-Application-Id -- アプリケーションID(必須)
  • X-Application-Key -- マスターキー(必須)
Query Parameters:
 
  • where (string) -- 検索条件 (オプション)
  • limit (int) -- 検索数上限。デフォルト値は 100件。 (オプション)
  • start (string) -- 開始日時(ISODate形式) (オプション)
  • end (string) -- 終了日時(ISODate形式) (オプション)
Status Codes:
Response JSON Object:
 
  • results (array) -- 実行ログの配列

レスポンスボディ

条件に一致するログ情報を含む JSON データ。

結果は以下のように "results" に配列形式で格納される。

{
  "results":[
    {
      "_id":"52117490ac521e5637000001",
      "tenantId":"…",
      "appId":"…",
      "userId":"…",
      "level":"DEBUG",
      "handlerName":"testHandler",
      "functionName":"function",
      "log":"this is log",
      "time": "2013-08-27T05:19:16.000Z"
    },
    /*...*/
  ]
}

注意事項

  • マスターキーが必要。
  • デフォルトの検索上限数は 100件。
  • time キー昇順でソートした結果が返却される。

10.1.1. 検索条件 (where)

条件指定は where パラメータで指定する。where パラメータには、JSON で検索条件を設定する。

特定のキーに対して完全一致させたい場合は、以下のように指定する。

where={"handlerName": "Foo", "functionName": "Bar"}

その他、以下の演算子を使用できる。これらは MongoDB の演算子と同じものがそのまま使用できる。

  • $lt, $gt : Less Than / Greater Than
  • $lte, $gte : Less or Equal / Greater of Equal
  • $ne : Not equal to
  • $in
  • $all
  • $regex
  • $exists
  • $not
  • $or
  • $and

10.1.2. 検索数上限 (limit)

返却する検索数の上限を指定する。

以下の例では、50件を取得する。

limit=50

limit のデフォルト値は 100件とする。limit を指定しなかった場合は、デフォルトでこの値が指定されたものとみなされる。

limit に -1 を指定した場合は制限なし(無限大)として扱う。

注意

サーバ側のコンフィグレーションによっては、limit 値に制限がかけられている場合がある。 この場合、上限値を越える値を指定したり -1 を指定した場合は 400 Bad Request エラーとなる。

10.1.3. 開始日時 (start)、終了日時(end)

ログの開始日時と終了日時をUTC時刻で指定する。

例) 2016/04/01 から 2016/05/31 までのログを取得したい場合

start=2016-04-01T00:00:00.000Z&end=2016-05-31T00:00:00.000Z