動作コンフィグ

GET /user/:user_code/sa/:sa_code/config/running

動作コンフィグの概要の一覧を取得する

詳細

リクエスト

パラメータ無し

レスポンス

Body

Key

Type

Value

results

Array

動作コンフィグの概要の一覧

サンプル

リクエスト

URL
GET https://*.sacm.jp/public-api/v1/user/tsa99990001/sa/tss99990001/config/running

レスポンス

Body
{
  "results": [
    {
      "moduleId": 0,
      "moduleName": "SEIL/B1 3.75 (Saraband)",
      "version": "3.75.0-0",
      "binary": false,
      "lastModified": "2012/04/16 10:07:52"
    },
    {
      "moduleId": 1,
      "moduleName": "update-firmware",
      "version": "0.0.0-0",
      "binary": false,
      "lastModified": "2012/04/16 10:07:52"
    }
  ]
}

PUT /user/:user_code/sa/:sa_code/config/running

作業コンフィグまたはテンプレートセットの内容を動作コンフィグに反映する

詳細

リクエスト

Header
Content-Type: application/json
Body

Key

Type

Value

date

String

反映予定日時 (必須)

  • 指定可能な範囲は現在から1ヶ月先までの日時

  • 即時反映したい場合には null を指定

deployStartup

boolean

動作コンフィグと同時に次回起動時コンフィグにも反映するか否か(オプション)

true

次回起動時コンフィグにも同時に反映する

false

動作コンフィグにのみ反映する(デフォルト)

レスポンス(反映成功時)

Status Code
201
Header
Content-Type: application/json
Body

Key

Type

Value

saError

boolean

サービスアダプタのエラー情報があるか否か

常にnullとなる

moduleError

Array

モジュールの持つエラー一覧

常にnullとなる

上記以外

共通パラメータ

レスポンス(反映失敗時)

文法チェック対応のサービスアダプタのみ。機器に反映できないコンフィグと判断された場合、反映に失敗する

Status Code
400
Header
Content-Type: application/json
Body

Key

Type

Value

results

Array

失敗理由の一覧

row int

コンフィグ行の行番号 (箇所の特定が無ければ 0 が入る)

column int

エラーの箇所を示す列番号 (箇所の特定が無ければ 0 が入る),

error String

エラーの原因

line String

コンフィグ行の内容

label String

エラーのラベル

recipe

レシピコードによる制限エラー

syntax

文法エラー

サンプル

リクエスト

URL
PUT https://*.sacm.jp/public-api/v1/user/tsa99990001/sa/tss99990001/config/running
Body
{
  "date": null,
  "deployStartup": true
}

レスポンス(反映成功時)

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": "configure",
  "targetTime": "2012/06/27 15:00:00",
  "status": "initial",
  "proxyStatus": "none",
  "resultCode": "none",
  "requestCommands": [],
  "saError": null,
  "moduleError": null
}

レスポンス(反映失敗時)

Header
Content-Type: application/json
Body
{
  "results": [
    {
      "row": 3,
      "column ":null,
      "error": "invalidaddress:dhcpd",
      "line": "route.ipv4.0.gateway",
      "label": "syntax"
    },
    {
      "row": 4,
      "column" :null,
      "error": "unknownkey.",
      "line": "key",
      "label": "syntax"
    },
    {
      "row": 4,
      "column": null,
      "error": "refusekeyname.",
      "line": "key",
      "label": "recipe"
    }
  ]
}

GET /user/:user_code/sa/:sa_code/config/running/:module_id/plain

指定したモジュールのテキスト形式の動作コンフィグを取得する

詳細

リクエスト

パラメータ無し

レスポンス

Header
Content-Type: text/plain
Body

コンフィグ(テキスト)

サンプル

リクエスト

URL
GET https://*.sacm.jp/public-api/v1/user/tsa99990001/sa/tss99990001/config/running/0/plain

レスポンス

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

GET /user/:user_code/sa/:sa_code/config/running/:module_id/binary

指定したモジュールのバイナリ形式の動作コンフィグを取得する

詳細

リクエスト

パラメータ無し

レスポンス

Header
Content-Type: application/octet-stream
Body

コンフィグ(バイナリ)

サンプル

リクエスト

URL
GET https://*.sacm.jp/public-api/v1/user/tsa99990001/sa/tss99990001/config/running/0/binary

レスポンス

Header
Content-Type: application/octet-stream
Body

コンフィグ(バイナリ)