Reboot

POST /user/:user_code/request/reboot

Request Reboot

Detail

Request

Body

Key

Type

Value

sa

Object

Requested service adaptor information

code: String

SA code

targetTime

String

Execution schedule time

  • Can specify up to one month ahead

  • Execute immediately if blank string (“”)

Response

Status Code
201
Body

See “ Request information “

Sample

Request

URL
POST https://*.sacm.jp/public-api/v1/user/tsa99990001/request/reboot
Header
Content-Type: application/json
Body
{
  "sa": {
    "code": "tss99990001"
  },
  "targetTime": "2012/06/27 14:51:25"
}

Request

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": "read-storage",
  "targetTime": "2012/06/27 14:51:25",
  "status": "initial",
  "proxyStatus": "none",
  "resultCode": "none"
}

GET /user/:user_code/request/reboot/:id

Read information for requested Reboot

Detail

Request

No Parameters

Response

Body

See “ Request information “

Sample

Request

URL
GET https://*.sacm.jp/public-api/v1/user/tsa99990001/request/reboot/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": "read-storage",
  "targetTime": "2012/06/27 14:51:25",
  "status": "successed",
  "proxyStatus": "success",
  "resultCode": "success"
}

PUT /user/:user_code/request/reboot/:id

Update information of requested Reboot (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

See “ Request information “

Sample (to stop execution)

Request

URL
PUT https://*.sacm.jp/public-api/v1/user/tsa99990001/request/reboot/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": "reboot",
  "targetTime": "2012/06/27 14:51:25",
  "status": "canceled",
  "proxyStatus": "none",
  "resultCode": "none"
}

Sample (to update execution date/time)

Request

URL
PUT https://*.sacm.jp/public-api/v1/user/tsa99990001/request/reboot/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": "reboot",
  "targetTime": "2012/06/27 16:00:00",
  "status": "initial",
  "proxyStatus": "none",
  "resultCode": "none"
}

Description

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

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