監視

GET /user/:user_code/monitor

監視グループの一覧を取得する

詳細

リクエスト

パラメータ無し

レスポンス

Key Type Value
results Array

監視グループの一覧

id int
監視グループのID。IDがnullのグループは監視グループに未所属のサービスアダプタを計上する
name String
監視グループの名前
member int
監視グループに所属しているサービスアダプタの数

サンプル

リクエスト

URL
GET https://*.sacm.jp/public-api/v1/user/tsa99990001/monitor

レスポンス

Body
{
  "results": [
    {
      "id": null,
      "name": null,
      "member": 3
    },
    {
      "id": 1535,
      "name":" Monitor1",
      "member": 2
    }
  ]
}

POST /user/:user_code/monitor

監視グループを追加する

詳細

リクエスト

Header
Content-Type: application/json
Body
Key Type Value
name String 監視グループの名前 (1 - 40 文字) (必須)

レスポンス

Status Code
201
Body
Key Type Value
id int 監視グループのID
name String 監視グループの名前
reports Array 通知先メールアドレスの一覧
sa Array

所属しているサービスアダプタの一覧

サンプル

リクエスト

URL
POST https://*.sacm.jp/public-api/v1/user/tsa99990001/monitor
Header
Content-Type: application/json
Body
{
  "name": "Monitor1"
}

レスポンス

Header
Content-Type: application/json
Body
{
  "id": 1,
  "name": "Monitor1",
  "reports": [
    null,
    null,
    null,
    null,
    null
  ],
  "sa": [
  ]
}

備考

追加できる監視グループは最大 5 件です

GET /user/:user_code/monitor/:id

監視グループの詳細情報を取得する

詳細

リクエスト

パラメータ無し

レスポンス

Body
Key Type Value
id int 監視グループのID
name String 監視グループの名前
reports Array 通知先メールアドレスの一覧
sa Array

所属しているサービスアダプタの一覧

サンプル

リクエスト

URL
GET https://*.sacm.jp/public-api/v1/user/tsa99990001/monitor/1

レスポンス

Header
Content-Type: application/json
Body
{
  "id": 1,
  "name": "Monitor1",
  "reports": [
    sample@example.com,
    sample@example.co.jp,
    null,
    null,
    null
  ],
  "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
    }
  ]
}

PUT /user/:user_code/monitor/:id

監視グループの詳細情報を変更する

詳細

リクエスト

Header
Content-Type: application/json
Body
Key Type Value
name String 監視グループの名前 (1 - 40 文字) (オプション)
reports Array

通知先メールアドレスの一覧 (必ず 5 つ) (オプション)

address String
通知先メールアドレス
sa Array

所属させるサービスアダプタの一覧 (オプション)

code String
SAコード
updateMode String

サービスアダプタの割当方法 (オプション)

  • “overwrite”: 上書き (省略時は “overwrite” となる)
  • “insert” : 追加
  • “remove” : 削除
オプション

API コール時に特定のパラメータ option を Query String として付加すると、同時に所定の処理が実行されます。 option パラメータは省略可能です。

PUT https://*.sacm.jp/public-api/v1/user/tsa99990001/monitor/1?option=no-content

指定可能なパラメータは以下の通りです。

Key Type Value
option String
no-content

クライアント側でレスポンスの body の内容が不要な場合に、body を空にした状態でレスポンスを返します。

  • 処理の内容自体に本オプション指定の有無による差異はありません。
  • 正常系の場合のみ有効になります。異常系の場合は本オプションを指定しても body にエラーメッセージは含まれます。

レスポンス

Body
Key Type Value
id int 監視グループのID
name String 監視グループの名前
reports Array

通知先メールアドレスの一覧

address String
通知先メールアドレス
sa Array

所属しているサービスアダプタの一覧

サンプル

リクエスト

URL
PUT https://*.sacm.jp/public-api/v1/user/tsa99990001/monitor/1
Header
Content-Type: application/json
Body
{
  "name": "Monitor2",
  "reports": [
    {
      "address": "sample@example.com"
    },
    {
      "address": "sample@example.co.jp"
    },
    null,
    null,
    null
  ],
  "sa": [
    {
      "code": "tss99990001"
    },
    {
      "code": "tss99990002"
    }
  ]
}

レスポンス

Header
Content-Type: application/json
Body
{
  "id": 1,
  "name": "Monitor1",
  "reports": [
    {
      "address": "sample@example.com"
    },
    {
      "address": "sample@example.co.jp"
    },
    null,
    null,
    null
  ],
  "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": "Monitor2"
      },
      "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
    },
    {
      "code": "tss99990002",
      "name": "Service adapter 002",
      "description": "MEMO",
      "distributionId": "0001-0000-0101-0000-0000-0000-5678-1234",
      "up": true,
      "configState": "pushready",
      "group": {
        "id": 2,
        "name": "Folder2"
      },
      "template": {
        "id": 2,
        "name": "Template2"
      },
      "monitor": {
        "id": 1,
        "name": "Monitor2"
      },
      "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
    }
  ]
}

DELETE /user/:user_code/monitor/:id

監視グループを削除する

詳細

リクエスト

パラメータ無し

レスポンス

Status Code
204
Header
Content-Type: text/plain
Body

ボディ無し

サンプル

リクエスト

URL
DELETE https://*.sacm.jp/public-api/v1/user/tsa99990001/monitor/1

レスポンス

Header
Content-Type: text/plain
Body

ボディ無し