Ping

POST /user/:user_code/request/ping

ping をリクエストする

詳細

リクエスト

Header

Content-Type: application/json

Body

Key	Type	Value
sa	Object	リクエストの対象となるサービスアダプタ情報 code: String SAコード
targetTime	String	実行予定日時 翌月末まで指定可能 null の場合は即時実行
targetAddress	String	pingの送信先IPアドレス
size	int	パケットサイズ (0 - 65467)
count	int	試行回数 (1 - 128)

レスポンス

Status Code

201

Body

Key	Type	Value
targetAddress	String	pingの送信先IPアドレス
size	int	パケットサイズ
count	int	試行回数
resultSuccess	int	成功した回数 常にnullとなる
resultFailure	int	失敗した回数 常にnullとなる
上記以外		共通パラメータ リクエスト情報 を参照

サンプル

リクエスト

URL

POST https://*.sacm.jp/public-api/v1/user/tsa99990001/request/ping

Header

Content-Type: application/json

Body

{
  "sa": {
    "code": "tss99990001"
  },
  "targetTime": "2012/06/27 14:51:25",
  "targetAddress": "210.130.137.80",
  "size": 60,
  "count": 5
}

レスポンス

Header

Content-Type: application/json

Body

{
  "id": "1:1",
  "sa": {
    "code": "tss99990001",
    "name": "Service adapter 001",
    "description": "MEMO",
    "distributionId": "0001-0000-0101-0000-0000-0000-1234-5678",
    "up": true
  },
  "type": "ping",
  "targetTime": "2012/06/27 14:51:25",
  "status": "initial",
  "proxyStatus": "none",
  "resultCode": "none",
  "requestCommands": [],
  "targetAddress": "210.130.137.80",
  "size": 60,
  "count": 5,
  "resultSuccess": null,
  "resultFailure": null
}

GET /user/:user_code/request/ping/:id

リクエストされた ping の情報を取得する

詳細

リクエスト

パラメータ無し

レスポンス

Body

Key	Type	Value
targetAddress	String	pingの送信先IPアドレス
size	int	パケットサイズ
count	int	試行回数
resultSuccess	int	成功した回数
resultFailure	int	失敗した回数
上記以外		共通パラメータ リクエスト情報 を参照

サンプル

リクエスト

URL

GET https://*.sacm.jp/public-api/v1/user/tsa99990001/request/ping/1:1

レスポンス

Header

Content-Type: application/json

Body

{
  "id": "1:1",
  "sa": {
    "code": "tss99990001",
    "name": "Service adapter 001",
    "description": "MEMO",
    "distributionId": "0001-0000-0101-0000-0000-0000-1234-5678",
    "up": true
  },
  "type": "ping",
  "targetTime": "2012/06/27 14:51:25",
  "status": "successed",
  "proxyStatus": "success",
  "resultCode": "success",
  "requestCommands": [],
  "targetAddress": "210.130.137.80",
  "size": 60,
  "count": 5,
  "resultSuccess": 5,
  "resultFailure": 0
}

PUT /user/:user_code/request/ping/:id

リクエストされた ping の情報を変更する (実行の中止、実行予定日時の変更)

詳細

リクエスト

Header

Content-Type: application/json

Body

Key	Type	Value
status	int	リクエストの状態 実行を中止する場合に使用する status が “initial” の場合のみ変更可能 “3” (キャンセル)のみ指定可能
targetTime	String	実行予定日時 実行予定日時を変更する場合に使用する status が “initial” の場合のみ変更可能 翌月末まで指定可能、

レスポンス

Body

Key	Type	Value
targetAddress	String	pingの送信先IPアドレス
size	int	パケットサイズ
count	int	試行回数
resultSuccess	int	成功した回数 常にnullとなる
resultFailure	int	失敗した回数 常にnullとなる
上記以外		共通パラメータ リクエスト情報 を参照

サンプル(実行を中止する時)

リクエスト

URL

PUT https://*.sacm.jp/public-api/v1/user/tsa99990001/request/ping/1:1

Header

Content-Type: application/json

Body

{"status": 3}

レスポンス

Header

Content-Type: application/json

Body

{
  "id": "1:1",
  "sa": {
    "code": "tss99990001",
    "name": "Service adapter 001",
    "description": "MEMO",
    "distributionId": "0001-0000-0101-0000-0000-0000-1234-5678",
    "up": true
  },
  "type": "ping",
  "targetTime": "2012/06/27 15:00:00",
  "status": "canceled",
  "proxyStatus": "none",
  "resultCode": "none",
  "requestCommands": [],
  "targetAddress": "210.130.137.80",
  "size": 60,
  "count": 5,
  "resultSuccess": null,
  "resultFailure": null
}

サンプル(実行日時を変更する時)

リクエスト

URL

PUT https://*.sacm.jp/public-api/v1/user/tsa99990001/request/ping/1:1

Header

Content-Type: application/json

Body

{"targetTime": "2012/06/27 16:00:00"}

レスポンス

Header

Content-Type: application/json

Body

{
  "id": "1:1",
  "sa": {
    "code": "tss99990001",
    "name": "Service adapter 001",
    "description": "MEMO",
    "distributionId": "0001-0000-0101-0000-0000-0000-1234-5678",
    "up": true
  },
  "type": "ping",
  "targetTime": "2012/06/27 16:00:00",
  "status": "initial",
  "proxyStatus": "none",
  "resultCode": "none",
  "requestCommands": [],
  "targetAddress": "210.130.137.80",
  "size": 60,
  "count": 5,
  "resultSuccess": null,
  "resultFailure": null
}

備考

• 実行予定日時を変更すると id が変更される可能性がある
• 実行の中止と実行予定日時の変更の同時実行は不可