Traceroute

POST /user/:user_code/request/traceroute

traceroute をリクエストする

詳細

リクエスト

Body
Key Type Value
sa Object

リクエストの対象となるサービスアダプタ情報 (必須)

code: String
SAコード
targetTime String

実行予定日時 (必須)

  • 翌月末まで指定可能
  • null の場合は即時実行
targetAddress String tracerouteの送信先IPアドレス (必須)
maxHop int 最大ホップ数 (0 - 255) (必須)
count int ホップ毎の送出パケット数 (1 - 10) (必須)

レスポンス

Status Code
201
Body
Key Type Value
targetAddress String tracerouteの送信先IPアドレス
maxHop int 最大ホップ数 (0 - 255)
count int ホップ毎の送出パケット数 (1 - 10)
resultNodeInfo Array

tracerouteの結果一覧

常にnullとなる
上記以外  

共通パラメータ

サンプル

リクエスト

URL
POST https://*.sacm.jp/public-api/v1/user/tsa99990001/request/traceroute
Header
Content-Type: application/json
Body
{
  "sa": {
    "code": "tss99990001"
  },
  "targetTime": "2012/06/27 14:51:25",
  "targetAddress": "210.130.137.80",
  "maxHop": 100,
  "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": "traceroute",
  "targetTime": "2012/06/27 14:51:25",
  "status": "initial",
  "proxyStatus": "none",
  "resultCode": "none",
  "requestCommands": [],
  "targetAddress": "210.130.137.80",
  "maxHop": 100,
  "count": 5,
  "resultNodeInfo": null
}

GET /user/:user_code/request/traceroute/:id

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

詳細

リクエスト

パラメータ無し

レスポンス

Body
Key Type Value
targetAddress String tracerouteの送信先IPアドレス
maxHop int 最大ホップ数 (0 - 255)
count int ホップ毎の送出パケット数 (1 - 10)
resultNodeInfo Array

tracerouteの結果一覧 (リクエストが完了した場合のみ)

hop int
ホップの番号
address String
ホップのIPアドレス
上記以外  

共通パラメータ

サンプル

リクエスト

URL
GET https://*.sacm.jp/public-api/v1/user/tsa99990001/request/traceroute/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": "traceroute",
  "targetTime": "2012/06/27 14:51:25",
  "status": "successed",
  "proxyStatus": "success",
  "resultCode": "success",
  "requestCommands": [],
  "targetAddress": "210.130.137.80",
  "maxHop": 100,
  "count": 5,
  "resultNodeInfo": [
    {
      "hop": 1,
      "address": "192.168.0.1"
    },
    {
      "hop": 2,
      "address": "210.149.34.69"
    },
    {
      "hop": 3,
      "address": "210.149.34.133"
    },
    {
      "hop": 4,
      "address": "210.149.34.97"
    },
    {
      "hop": 5,
      "address": "58.138.100.213"
    },
    {
      "hop": 6,
      "address": "58.138.80.45"
    },
    {
      "hop": 7,
      "address": "58.138.80.242"
    },
    {
      "hop": 8,
      "address": "58.138.104.30"
    },
    {
      "hop": 9,
      "address": "210.130.137.80"
    }
  ]
}

PUT /user/:user_code/request/traceroute/:id

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

詳細

リクエスト

Header
Content-Type: application/json
Body
Key Type Value
status int

リクエストの状態

  • 実行を中止する場合に使用する
  • status が “initial” の場合のみ変更可能
  • “3” (キャンセル)のみ指定可能
targetTime String

実行予定日時

  • 実行予定日時を変更する場合に使用する
  • status が “initial” の場合のみ変更可能
  • 翌月末まで指定可能

レスポンス

Body
Key Type Value
targetAddress String tracerouteの送信先IPアドレス
maxHop int 最大ホップ数 (0 - 255)
count int ホップ毎の送出パケット数 (1 - 10)
resultNodeInfo Array

tracerouteの結果一覧

常にnullとなる
上記以外  

共通パラメータ

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

リクエスト

URL
PUT https://*.sacm.jp/public-api/v1/user/tsa99990001/request/traceroute/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": "traceroute",
  "targetTime": "2012/06/27 14:51:25",
  "status": "canceled",
  "proxyStatus": "none",
  "resultCode": "none",
  "requestCommands": [],
  "targetAddress": "210.130.137.80",
  "maxHop": 100,
  "count": 5,
  "resultNodeInfo": null
}

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

リクエスト

URL
PUT https://*.sacm.jp/public-api/v1/user/tsa99990001/request/traceroute/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": "traceroute",
  "targetTime": "2012/06/27 16:00:00",
  "status": "initial",
  "proxyStatus": "none",
  "resultCode": "none",
  "requestCommands": [],
  "targetAddress": "210.130.137.80",
  "maxHop": 100,
  "count": 5,
  "resultNodeInfo": null
}

備考

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