スケジュール実行の結果取得

コマンドラインツールを使うと、Server Hook（スケジュール起動）による実行結果の履歴を取得できます。ツールでは、実行履歴の一覧と、その詳細の取得機能を提供しています。

実行履歴の一覧

スケジュール起動の実行結果の履歴をリストの形で一覧取得できます。

node bin/kii-servercode.js list-scheduled-execution \
  --site jp \
  --app-id <your_app_id> \
  --app-key <your_app_key> \
  --client-id <your_client_id> \
  --client-secret <your_client_secret> \
  --from <start_date> \
  --to <end_date> \
  --utc-time

指定可能なオプションは次のとおりです。

  • --site：サーバーの設置場所（jp）
  • --app-id：AppID。
  • --app-key：任意の値。
  • --client-id：ClientID。
  • --client-secret：ClientSecret。
  • --from：実行結果履歴リストの取得を開始する日時（例：2014-02-08）。
  • --to：実行結果履歴リストの取得を終了する日時（例：2014-04-30）。省略時は現在の時間を適用。
  • --utc-time：日時を UTC (協定世界時）で指定/出力する場合に指定。
  • --http-proxy：使用する HTTP プロクシ（例：https://my.proxy:8080 ）。ファイアウォールの内側など直接 Kii Cloud API にアクセスできない場合に利用。

日時は ISO 8601 表記 または YYY-MM-DD HH:mm:ss 表記を用いてください。また日時指定はデフォルトではローカル時間で行います。UTC（協定世界時）で指定する場合は --utc-time オプションをつけます。

また必ず開発者ポータルで取得した値を --site、--app-id、--app-key、--client-id および -- client-secret に設定するようにしてください。ClientID と ClientSecret を指定する代わりに、アプリ管理者トークンを --token オプションで指定することもできます（アプリ開発者トークンの取得方法は アプリ管理者向け機能 を参照してください）。

Kii Cloud は次のように応答します。

ID      STARTED (LOCAL)     FINISHED (LOCAL)    STATUS  JOB NAME
--------------------------------------------------------------------------
wtwer8y 2014-01-24 12:02:45                     RUNNING moveObjectsToUserBucket
w78eryy 2014-01-23 12:02:45 2014-01-23 12:10:45 SUCCESS moveObjectsToUserBucket
gdgyg5g 2014-01-22 12:02:45 2014-01-22 12:10:45 SUCCESS cleanUpMessagesBucket
ijj4uyd 2014-01-21 12:02:45 2014-01-22 12:10:45 FAILED  deleteInactiveUsers
  • ID：Server Code を実行するたびに払い出される実行 ID。実行結果の詳細を取得する際に使用します。
  • STARTED：実行が開始した日時。
  • FINISHED：実行が終了した日時。
  • STATUS：実行の状況（SUCCESS：成功、FAILED：失敗、RUNNING：実行中）。
  • JOB NAME：スケジュール起動用の Server Hook を定義した際に付けたジョブ名（詳しくは こちら を参照）。

日時はデフォルトではローカル時間で表示されます（--utc-time を指定した場合は UTC で表示されます）。

実行結果詳細の取得

スケジュール起動された Server Code の実行結果詳細を確認するには以下のコマンドを実行します。

node bin/kii-servercode.js get-scheduled-execution \
  --site jp \
  --app-id <your_app_id> \
  --app-key <your_app_key> \
  --client-id <your_client_id> \
  --client-secret <your_client_secret> \
  --id <id>

指定可能なオプションは次のとおりです。

  • --site：サーバーの設置場所（jp）
  • --app-id：AppID
  • --app-key：任意の値
  • --client-id：ClientID
  • --client-secret：ClientSecret
  • --id：実行結果詳細を確認する実行 ID
  • --http-proxy：使用する HTTP プロクシ（例：https://my.proxy:8080 ）。ファイアウォールの内側など直接 Kii Cloud API にアクセスできない場合に利用。

必ず開発者ポータルで取得した値を --site、--app-id、--app-key、--client-id および -- client-secret に設定するようにしてください。ClientID と ClientSecret を指定する代わりに、アプリ管理者トークンを --token オプションで指定することもできます（アプリ開発者トークンの取得方法は アプリ管理者向け機能 を参照してください）。

Kii Cloud は次のように応答します。

{
  "scheduledExecutionID": "fdueni3d",
  "started": 123344546,
  "finished": 123233345,
  "status": "FAILED",
  "name": "deleteInactiveUsers",
  "result": "Error found while deleting user: f81d4fae-7dec-11d0-a765-00a0c91e6bf6"
}

"result" には、以下の内容が記載されます。

  • 自動実行に成功した場合は、return ステートメントの値（同期的実行の場合）、または、コールバック関数 done への引数値を含む情報が記載されます。
  • 自動実行に失敗した場合は、例外メッセージなどを含む詳細な失敗理由が記載されます。