Read Storage

POST /user/:user_code/request/read-storage

コンフィグ参照をリクエストする

詳細

リクエスト

Body
Key Type Value
sa Object

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

code: String
SAコード
targetTime String

実行予定時刻

  • 翌月末まで指定可能
  • null の場合は即時実行
storage String

取得するコンフィグ種別

startup
次回起動時コンフィグ
running
動作コンフィグ
backup
バックアップコンフィグ

レスポンス

Status Code
201
Body
Key Type Value
storage String

取得するコンフィグ種別

startup
次回起動時コンフィグ
running
動作コンフィグ
backup
バックアップコンフィグ
moduleMdData Array

モジュールの情報

常にnullとなる
上記以外  

共通パラメータ

サンプル

リクエスト

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

レスポンス

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",
  "requestCommands": [],
  "storage": "running",
  "moduleMdData": null
}

GET /user/:user_code/request/read-storage/:id

リクエストしたコンフィグ参照の情報を取得する

詳細

リクエスト

パラメータ無し

レスポンス

Body
Key Type Value
storage String

取得するコンフィグ種別

startup
次回起動時コンフィグ
running
動作コンフィグ
backup
バックアップコンフィグ
moduleMdData Array

モジュールの情報

id int
モジュールID
result int
結果コード
isBinary boolean
コンフィグがバイナリ形式か否か
上記以外  

共通パラメータ

サンプル

リクエスト

URL
GET https://*.sacm.jp/public-api/v1/user/tsa99990001/request/read-storage/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": "read-storage",
  "targetTime": "2012/06/27 14:51:25",
  "status": "successed",
  "proxyStatus": "success",
  "resultCode": "success",
  "requestCommands": [],
  "storage": "running",
  "moduleMdData": [
    {
      "id": 0,
      "result": 0,
      "binary": false
    },
    {
      "id": 1,
      "result": 0,
      "binary": false
    }
  ]
}

PUT /user/:user_code/request/read-storage/:id

リクエストされたコンフィグ参照の情報を変更する (実行の中止、実行日時の変更)

詳細

リクエスト

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

リクエストの状態

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

実行予定日時

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

レスポンス

Body
Key Type Value
storage String

取得するコンフィグ種別

startup
次回起動時コンフィグ
running
動作コンフィグ
backup
バックアップコンフィグ
moduleMdData Array

モジュールの情報

常にnullとなる
上記以外  

共通パラメータ

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

リクエスト

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

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

リクエスト

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

備考

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

GET /user/:user_code/request/read-storage/:id/result/module/:module_id/plain

リクエストしたコンフィグ参照の実行結果を取得する (テキスト形式)

詳細

リクエスト

パラメータ無し

レスポンス

Header
Content-Type: text/plain
Body

コンフィグ(テキスト)

サンプル

リクエスト

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

レスポンス

Header
Content-Type: text/plain
Body
hostname "SEIL/B1 001"
interface lan0 add 192.168.0.1/24
interface lan1 add dhcp
route add default dhcp
telnetd enable

GET /user/:user_code/request/read-storage/:id/result/module/:module_id/binary

リクエストしたコンフィグ参照の実行結果を取得する (バイナリ形式)

詳細

リクエスト

パラメータ無し

レスポンス

Header
Content-Type: application/octet-stream
Body

コンフィグ(バイナリ)

サンプル

リクエスト

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

レスポンス

Header
Content-Type: application/octet-stream
Body

コンフィグ(バイナリ)