イベント

GET /user/:user_code/event

イベントの一覧を取得する

詳細

リクエスト

Body
Key Type Value
sacode String SAコードを指定して絞り込む(オプション)
type String

イベント種別を指定して絞り込む(オプション)

configure
サービスアダプタ設定イベント
monitor
監視イベント
request
リクエストイベント

レスポンス

Body
Key Type Value
results Array

イベントの一覧

  • 最大 100 件
  • 過去 3 ヶ月前まで
  • 一覧は timestamp でソートされる
id String
イベントのID
sa Array

イベントに関連するサービスアダプタの一覧

priority String

イベントの重要性

debug info warn alert
type String

イベントの種別

configure
サービスアダプタ設定イベント
monitor
監視イベント
request
リクエストイベント
subType String

イベントの詳細

config-solicitation
サービスアダプタによるコンフィグ取得
push-ready
操作用接続・コンフィグ反映有効
configure-started
動作コンフィグ反映の開始
configure-succeeded
動作コンフィグ反映の成功
configure-failed
動作コンフィグ反映の失敗
reboot-init
再起動による動作コンフィグの初期化
timeout-init
反映タイムアウトによる動作コンフィグの初期化
confirmation-started
操作用接続確認の開始
confirmation-failed
操作用接続確認の失敗
disconnected
操作用接続(持続型)の全切断
distribution-id-changed
Distribution IDの変更
report-status-up
Heartbeat受信情報更新 (UP)
report-status-down
Heartbeat受信情報更新 (DOWN)
proxy-run
リクエストの中継サーバでの処理開始
sa-run
リクエストのサービスアダプタでの処理開始
succeed
リクエストの処理成功
failed
リクエストの処理失敗
reinit
リクエストの再処理開始
cancel
リクエストのタイムアウト
no-distid-failed
リクエストの処理失敗
startup-succeeded
次回起動時コンフィグ反映の成功
parameters Array

イベントの関連パラメータ

key String

パラメータのキー文字列

  • subType: distribution-id-changed の場合

    after-update

    変更後のDistribution ID

    before-update

    変更前のDistribution ID

  • subType: config-solicitation の場合

    firmware-info

    コンフィグ取得時のサービスアダプタのファームウェア情報

    src-ip-address

    コンフィグ取得時のサービスアダプタの接続元IPアドレス

value String
パラメータの値
timestamp String
イベントの発生時間
requestId String
イベントに紐づくリクエストID
紐づくリクエストIDがない場合は空

サンプル

リクエスト

URL
GET https://*.sacm.jp/public-api/v1/user/tsa99990001/event?sacode=tss99990001&type=request

レスポンス

Body
{
  "results":[
    {
      "id": "1:2",
      "sa":[
        {
          "code": "tss99990001",
          "name": "Service adapter 001",
          "description": "MEMO",
          "distributionId": "0001-0000-0101-0000-0000-0000-1234-5678",
          "up": true,
          "configState": "pushready",
          "group": {
            "id": 1,
            "name": "Folder1"
          },
          "template": {
            "id": 1,
            "name": "Template1"
          },
          "monitor": {
            "id": 1,
            "name": "Monitor1"
          },
          "date": {
            "lastPushReady": "2012/06/05 16:00:09",
            "lastHeartbeatReport": "2012/05/11 17:10:02",
            "lastPulled": "2012/05/11 17:06:22",
            "firstPulled": "2012/04/11 17:07:00"
          },
          "type": 0,
          "mode": null
        }
      ],
      "priority": "info",
      "type": "request",
      "subtype": "failed",
      "parameters": [],
      "timestamp": "2012/06/25 17:10:54"
    },
    {
      "id": "1:1",
      "sa":[
        {
          "code": "tss99990001",
          "name": "Service adapter 001",
          "description": "MEMO",
          "distributionId": "0001-0000-0101-0000-0000-0000-1234-5678",
          "up": true,
          "configState": "pushready",
          "group": {
            "id": 1,
            "name": "Folder1"
          },
          "template": {
            "id": 1,
            "name": "Template1"
          },
          "monitor": {
            "id": 1,
            "name": "Monitor1"
          },
          "date": {
            "lastPushReady": "2012/06/05 16:00:09",
            "lastHeartbeatReport": "2012/05/11 17:10:02",
            "lastPulled": "2012/05/11 17:06:22",
            "firstPulled": "2012/04/11 17:07:00"
          },
          "type": 0,
          "mode": null
        }
      ],
      "priority": "info",
      "type": "request",
      "subtype": "proxy-run",
      "parameters": [],
      "timestamp": "2012/06/25 17:07:54",
      "requestId": "1:1111"
    }
  ]
}