Ping

POST /user/:user_code/request/ping

Request ping

Detail

Request

Header

Content-Type: application/json

Body

Key	Type	Value
sa	Object	Requested service adaptor information code: String SA code
targetTime	String	Execute schedule date/time Can specify up to one month ahead Execute immediately if null
targetAddress	String	Ping recipient IP address
size	int	Packet size (0 - 65467)
count	int	Number of attempts (1 - 128)

Response

Status Code

201

Body

Key	Type	Value
targetAddress	String	Ping recipient IP address
size	int	Packet size
count	int	Number of attempts
resultSuccess	int	Number of times succeeded Always null
resultFailure	int	Number of times failed Always null
Other than the above		Shared parameters See “ Request information “

Sample

Request

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
}

Response

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",
  "targetAddress": "210.130.137.80",
  "size": 60,
  "count": 5,
  "resultSuccess": null,
  "resultFailure": null
}

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

Read information for requested ping

Detail

Request

No Parameters

Response

Body

Key	Type	Value
targetAddress	String	Ping recipient IP address
size	int	Packet size
count	int	Number of attempts
resultSuccess	int	Number of times succeeded
resultFailure	int	Number of times failed
Other than the above		Shared parameters See “ Request information “

Sample

Request

URL

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

Response

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",
  "targetAddress": "210.130.137.80",
  "size": 60,
  "count": 5,
  "resultSuccess": 5,
  "resultFailure": 0
}

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

Update information of requested ping (stop execution, update execution schedule date/time)

Detail

Request

Header

Content-Type: application/json

Body

Key	Type	Value
status	int	Request status Use to stop execution Can update only if status is “initial” Only “3” (cancel) can be specified
targetTime	String	Execute schedule date/time Use to update execution schedule date/time Can update only if status is “initial” Can specify up to one month ahead,

Response

Body

Key	Type	Value
targetAddress	String	Ping recipient IP address
size	int	Packet size
count	int	Number of attempts
resultSuccess	int	Number of times succeeded Always null
resultFailure	int	Number of times failed Always null
Other than the above		Shared parameters See “ Request information “

Sample (to stop execution)

Request

URL

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

Header

Content-Type: application/json

Body

{"status": 3}

Response

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",
  "targetAddress": "210.130.137.80",
  "size": 60,
  "count": 5,
  "resultSuccess": null,
  "resultFailure": null
}

Sample (to update execution date/time)

Request

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"}

Response

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",
  "targetAddress": "210.130.137.80",
  "size": 60,
  "count": 5,
  "resultSuccess": null,
  "resultFailure": null
}

Description

• ID may be updated if the execution schedule date/time is updated

• Simultaneous execution cancel and execution schedule date/time update not allowed