Md Command¶

POST /user/:user_code/request/md-command¶

任意コマンドの実行をリクエストする

詳細¶

リクエスト¶

Body¶

Key

Type

Value

code

String

SAコード

targetTime

String

実行予定時刻

翌月末まで指定可能

空文字 ("") の場合は即時実行

{moduleId}/{type}

int / String

モジュールID コンフィグ形式

(例)

<input type="text" name="0/plain">
<input type="file" name="1/binary">

レスポンス¶

Body¶

Key

Type

Value

requestModuleMdData

Object

リクエストしたモジュールの一覧

id int
モジュールID

binary boolean
コンフィグがバイナリ形式か否か

result int
結果コード

常にnullとなる

resultModuleMdData

Object

結果のモジュール一覧

常にnullとなる

上記以外

共通パラメータ

レスポンス情報を参照

サンプル¶

リクエスト¶

URL¶

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

Header¶

Content-Type: multipart/form-data; boundary=----pQ1z2mxlsg6koFX5

Body¶

------pQ1z2mxlsg6koFX5
Content-Disposition: form-data; name="0/plain"

show system
------pQ1z2mxlsg6koFX5
Content-Disposition: form-data; name="code"

tss99990001
------pQ1z2mxlsg6koFX5
Content-Disposition: form-data; name="targetTime"

2012/06/27 14:51:25
------pQ1z2mxlsg6koFX5--

レスポンス¶

Header¶

Content-Type: text/plain

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": "md-command",
  "targetTime": "2012/06/27 14:51:25",
  "status": "initial",
  "proxyStatus": "none",
  "resultCode": "none",
  "requestCommands": ["show system"],
  "requestModuleMdData": {
    "id": 0,
    "result": null,
    "binary": false
  },
  "resultModuleMdData": null
}

GET /user/:user_code/request/md-command/:id¶

リクエストした任意コマンドの実行の情報を取得する

詳細¶

リクエスト¶

パラメータ無し

レスポンス¶

Body¶

Key

Type

Value

requestModuleMdData

Object

リクエストしたモジュールの一覧

id int
モジュールID

binary boolean
コンフィグがバイナリ形式か否か

result int
結果コード

常にnullとなる

resultModuleMdData

Object

結果のモジュール一覧

id int
モジュールID

binary boolean
コンフィグがバイナリ形式か否か

result int
結果コード

成功

100

失敗

100以外

上記以外

共通パラメータ

レスポンス情報を参照

サンプル¶

リクエスト¶

URL¶

GET https://*.sacm.jp/public-api/v1/user/tsa99990001/request/md-command/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": "md-command",
  "targetTime": "2012/06/27 14:51:25",
  "status": "successed",
  "proxyStatus": "success",
  "resultCode": "success",
  "requestCommands": ["show system"],
  "requestModuleMdData": {
    "id": 0,
    "result": null,
    "binary": false
  },
  "resultModuleMdData": {
    "id": 0,
    "result": 100,
    "binary": false
  }
}

PUT /user/:user_code/request/md-command/:id¶

リクエストされた任意コマンドの実行の情報を変更する (実行の中止、実行予定日時の変更)

詳細¶

リクエスト¶

Header¶

Content-Type: application/json

Body¶

Key

Type

Value

status

int

リクエストの状態

実行を中止する場合に使用する

status が "initial" の場合のみ変更可能

"3" (キャンセル)のみ指定可能

targetTime

String

実行予定日時

実行予定日時を変更する場合に使用する

status が "initial" の場合のみ変更可能

翌月末まで指定可能

レスポンス¶

Body¶

Key

Type

Value

requestModuleMdData

Object

リクエストしたモジュールの一覧

id int
モジュールID

binary boolean
コンフィグがバイナリ形式か否か

result int
結果コード

常にnullとなる

resultModuleMdData

Object

結果のモジュール一覧

常にnullとなる

上記以外

共通パラメータ

レスポンス情報を参照

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

リクエスト¶

URL¶

PUT https://*.sacm.jp/public-api/v1/user/tsa99990001/request/md-command/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": "md-command",
  "targetTime": "2012/06/27 14:51:25",
  "status": "canceled",
  "proxyStatus": "none",
  "resultCode": "none",
  "requestCommands": ["show system"],
  "requestModuleMdData":{
    "id": 0,
    "result": null,
    "binary": false
  },
  "resultModuleMdData": null
}

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

リクエスト¶

URL¶

PUT https://*.sacm.jp/public-api/v1/user/tsa99990001/request/md-command/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": "md-command",
  "targetTime": "2012/06/27 16:00:00",
  "status": "initial",
  "proxyStatus": "none",
  "resultCode": "none",
  "requestCommands": ["show system"],
  "requestModuleMdData": {
    "id": 0,
    "result": null,
    "binary": false
  },
  "resultModuleMdData": null
}

備考¶

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

GET /user/:user_code/request/md-command/:id/request/module/:module_id/plain¶

リクエストした任意コマンドの実行の内容を取得する (テキスト形式)

詳細¶

リクエスト¶

パラメータ無し

レスポンス¶

Header¶

Content-Type: text/plain

Body¶

コマンド(テキスト)

サンプル¶

リクエスト¶

URL¶

GET https://*.sacm.jp/public-api/v1/user/tsa99990001/request/md-command/1:1/request/module/0/plain

レスポンス¶

Header¶

Content-Type: text/plain

Body¶

show system

GET /user/:user_code/request/md-command/:id/request/module/:module_id/binary¶

リクエストした任意コマンドの実行の内容を取得する (バイナリ形式)

詳細¶

リクエスト¶

パラメータ無し

レスポンス¶

Header¶

Content-Type: application/octet-stream

Body¶

コマンド(バイナリ)

サンプル¶

リクエスト¶

URL¶

GET https://*.sacm.jp/public-api/v1/user/tsa99990001/request/md-command/1:1/request/module/0/binary

レスポンス¶

Header¶

Content-Type: application/octet-stream

Body¶

コマンド(バイナリ)

GET /user/:user_code/request/md-command/:id/result/module/:module_id/plain¶

リクエストした任意コマンドの実行の結果を取得する (テキスト形式)

詳細¶

リクエスト¶

パラメータ無し

レスポンス¶

Header¶

Content-Type: text/plain

Body¶

実行結果(テキスト)

サンプル¶

リクエスト¶

URL¶

GET https://*.sacm.jp/public-api/v1/user/tsa99990001/request/md-command/1:1/result/module/0/plain

レスポンス¶

Header¶

Content-Type: application/json

Body¶

SEIL/B1 IPL Monitor version 1.01
SEIL/B1 Ver. 3.91 (Ritornello)

Arch    : SEIL/B1 Rev. A
CPU     : IXP43X 400.0MHz step A-1 (XScale core)
Vendor  : OEM
Serial  : UT509-##00XXX

Host    : "sample"
Bootinfo: rebooting by software reset
Bootdev : flash

Date    : 2001/01/03 13:53:18 (JST)
Up      : 2 days 4:53  (since 2001/01/01 09:00:00)

Users   : 0 users
Loadavg : 0.00 (1min), 0.00 (5min), 0.00 (15min)
CPUstat : Used 0%, Interrupts 0%
Memory  : Total 128MB, Used 58MB (45%), Avail 69MB (54%)

GET /user/:user_code/request/md-command/:id/result/module/:module_id/binary¶

リクエストした任意コマンドの実行の結果を取得する (バイナリ形式)

詳細¶

リクエスト¶

パラメータ無し

レスポンス¶

Header¶

Content-Type: application/octet-stream

Body¶

実行結果(バイナリ)

サンプル¶

リクエスト¶

URL¶

GET https://*.sacm.jp/public-api/v1/user/tsa99990001/request/md-command/1:1/result/module/0/binary

レスポンス¶

Header¶

Content-Type: application/octet-stream

Body¶

実行結果(バイナリ)

SACM service manual

Md Command¶

POST /user/:user_code/request/md-command¶

詳細¶

リクエスト¶

Header¶

Body¶

レスポンス¶

Body¶

サンプル¶

リクエスト¶

URL¶

Header¶

Body¶

レスポンス¶

Header¶

Body¶

GET /user/:user_code/request/md-command/:id¶

詳細¶

リクエスト¶

レスポンス¶

Body¶

サンプル¶

リクエスト¶

URL¶

レスポンス¶

Header¶

Body¶

PUT /user/:user_code/request/md-command/:id¶

詳細¶

リクエスト¶

Header¶

Body¶

レスポンス¶

Body¶

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

リクエスト¶

URL¶

Header¶

Body¶

レスポンス¶

Header¶

Body¶

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

リクエスト¶

URL¶

Header¶

Body¶

レスポンス¶

Header¶

Body¶

備考¶

GET /user/:user_code/request/md-command/:id/request/module/:module_id/plain¶

詳細¶

リクエスト¶

レスポンス¶

Header¶

Body¶

サンプル¶

リクエスト¶

URL¶

レスポンス¶

Header¶

Body¶

GET /user/:user_code/request/md-command/:id/request/module/:module_id/binary¶

詳細¶

リクエスト¶

レスポンス¶

Header¶

Body¶

サンプル¶

リクエスト¶

URL¶

レスポンス¶

Header¶

Body¶

GET /user/:user_code/request/md-command/:id/result/module/:module_id/plain¶

詳細¶

リクエスト¶

レスポンス¶