サービスアダプタ

GET /user/:user_code/sa

サービスアダプタの一覧情報を取得する

詳細

リクエスト

パラメータ無し

レスポンス

Body

Key

Type

Value

results

Array

サービスアダプタの一覧

サンプル

リクエスト

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

レスポンス

Body
{
  "results": [
    {
      "code": "tss99990001",
      "name": "SEIL/B1 001",
      "description": "MEMO",
      "distributionId": "0001-0000-0101-0000-0000-0000-1234-5678",
      "up": true,
      "configState": "pushready",
      "connection": [
        {
          "index": 1,
          "ipAddress": "10.0.0.1",
          "port": 10443,
          "state": "pushconfirmed"
        }, {
          "index": 2,
          "ipAddress": "10.0.0.1",
          "port": 10443,
          "state": "pushconfirmed"
        }
      ],
      "group": {
        "id": 1,
        "name": "Folder1"
      },
      "template": {
        "id": 1,
        "name": "Template1",
        "label": "label1"
      },
      "monitor": {
        "id": 1,
        "name": "Monitor1"
      },
      "tag": [
        {
          "id": 1,
          "name": "Tag1",
          "colorCode": "#000000"
        }
      ],
      "date": {
        "lastPushReady": "2012/06/05 16:00:09",
        "lastHeartbeatReport": "2012/05/11 17:10:02",
        "lastPulled": "2012/05/11 17:06:22",
        "firstPulled": "2012/04/11 17:07:00"
      },
      type: 0,
      mode: null
    },
    {
      "code": "tsw99990002",
      "name": "SA-W1 001",
      "description": "MEMO",
      "distributionId": "0001-0000-0101-0000-0000-0000-5678-1234",
      "up": true,
      "configState": "pushready",
      "connection": [
        {
          "index": 1,
          "ipAddress": "10.0.0.2",
          "port": 10443,
          "state": "pushconfirmed"
        }, {
          "index": 2,
          "ipAddress": "10.0.0.2",
          "port": 10443,
          "state": "pushconfirmed"
        }
      ],
      "group": {
        "id": 2,
        "name": "Folder2"
      },
      "template": {
        "id": 2,
        "name": "Template2",
        "label": "label2"
      },
      "monitor": {
        "id": 2,
        "name": "Monitor2"
      },
      "tag": [
        {
          "id": 1,
          "name": "Tag1",
          "colorCode": "#000000"
        }
      ],
      "date": {
        "lastPushReady": "2012/06/05 16:00:09",
        "lastHeartbeatReport": "2012/05/11 17:10:02",
        "lastPulled": "2012/05/11 17:06:22",
        "firstPulled": "2012/04/11 17:07:00"
      },
      "type": 1,
      "mode": "R0001"
    }
  ]
}

GET /user/:user_code/sa/:sa_code

サービスアダプタの詳細情報を取得する

詳細

リクエスト

パラメータ無し

レスポンス

Body

Key

Type

Value

code

String

SAコード

name

String

SAラベル

description

String

メモ

distributionId

String

Distribution ID

up

boolean

接続状態

true

接続中

false

切断中

connection

Array

各管理用サーバ (RS) との接続情報

index int

管理用サーバの識別番号

ipAddress String

接続元IPアドレス

port int

接続に利用されているポート

state String

管理用サーバとの接続状態

disconnected

切断中

pushconfirming

接続確認中

connected

接続有効 (接続持続型)

pushconfirmed

接続有効 (接続待受型)

pushconfirmed-retreat

接続有効 (接続待受型) - 低優先度状態

pulledTrigger

String

コンフィグ取得理由

none

なし

power-on-boot

電源投入

user-reboot

ユーザによる再起動

failure-reboot

異常による再起動

timeout-occured

通信タイムアウトによる再取得

error-reported

エラー通知による再取得

invalid-config

無効なコンフィグのため再取得

invalid-message

プロトコルメッセージ異常による再取得

fallbacked

サーバとの通信不能のため再取得

config-expired

コンフィグ期限切れ

module-sync-done

モジュール同期成功

module-sync-fail

モジュール同期失敗

no-rs

RS不明

rs-request-reboot

サーバからの再起動指示

boot-failed

起動失敗

server-failure

サーバからのエラー通知

internal-error

サービスアダプタの内部エラー

no-push-method

操作用接続形式不明

no-push-server

操作用サーバ不明

out-of-service

サービス停止

push-failed

操作失敗

need-reboot

再起動

retry-over

再試行失敗

rollback-failure

コンフィグのロールバック失敗

no-tunnel-url

接続持続URL不明

configState

String

コンフィグ反映状態

initial

コンフィグ未取得または同期無し

pulled

コンフィグ取得済み

pushready

操作・コンフィグ有効

pushed

コンフィグ操作中

pushconfirming

操作用接続確認中

pushMethod

String

サービスアダプタが利用する接続モード

none

なし (初期状態)

no-confirm

接続待受型 (確認なし)

simple

接続待受型 (確認あり)

tunnel

接続持続型

preferredPushMethod

String

RS が提案する接続モード

none

提案なし

simple

接続待受型 (確認あり)

tunnel

接続持続型

date

Object

各種日時情報

lastPushReady String

最後に操作可能状態通知を受信した日時

lastHeartbeatReport String

最後に監視通知を受信した日時

lastPulled String

サービスアダプタが最後にコンフィグを取得した日時

firstPulled String

サービスアダプタが最初にコンフィグを取得した日時

graph

Object

グラフにアクセスするために必要な情報

uri

String グラフCGIパス

keyCode

String グラフCGIのキー

group

Object

所属中のフォルダ情報 (所属していない場合は null)

id int

所属中のフォルダのID

name String

所属中のフォルダの名前

template

Object

所属中のテンプレートセット情報 (所属していない場合は null)

id int

所属中のテンプレートセットのID

name String

所属中のテンプレートセットの名前

label String

所属中のテンプレートセットのラベル

monitor

Object

所属中の監視グループ情報 (所属していない場合は null)

id int

所属中の監視グループのID

name String

所属中の監視グループの名前

tag

Array

所属中のタグ情報一覧 (所属していない場合は空の配列)

id int

所属中のタグのID

name String

所属中のタグの名前

colorCode String

所属中のタグの背景色

type

int

サービスアダプタの種別

0

通常のサービスアダプタ(tss)

1

レシピ対応のサービスアダプタ(tsw)

mode

String

レシピ対応のサービスアダプタのレシピコード (通常のサービスアダプタの場合は null)

サンプル

リクエスト

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

レスポンス

Header
Content-Type: application/json
Body
{
  "code": "tss99990001",
  "name": "SEIL/B1 001",
  "description": "MEMO",
  "distributionId": "0001-0000-0101-0000-0000-0000-1234-5678",
  "up": true,
  "configState": "pushready",
  "connection": [
    {
      "index": 1,
      "ipAddress": "10.0.0.1",
      "port": 10443,
      "state": "pushconfirmed"
    }, {
      "index": 2,
      "ipAddress": "10.0.0.1",
      "port": 10443,
      "state": "pushconfirmed"
    }
  ],
  "group": {
    "id": 1,
    "name": "Folder1"
  },
  "template": {
    "id": 1,
    "name": "Template1",
    "label": "label1"
  },
  "monitor": {
    "id": 1,
    "name": "Monitor1"
  },
  "tag": [
    {
      "id": 1,
      "name": "Tag1",
      "colorCode": "#000000"
    }
  ],
  "pulledTrigger": "power-on-boot",
  "pushMethod": "tunnel",
  "preferredPushMethod": "tunnel",
  "date": {
    "lastPushReady": "2012/06/05 16:00:09",
    "lastHeartbeatReport": "2012/05/11 17:10:02",
    "lastPulled": "2012/05/11 17:06:22",
    "firstPulled": "2012/04/11 17:07:00"
  },
  "graph": {
    "uri": "hb500/grapher.cgi",
    "keyCode": "graphkeycodesample"
  },
  "type": 0,
  "mode": null
}

PUT /user/:user_code/sa/:sa_code

サービスアダプタの詳細情報を変更する

詳細

リクエスト

Header
Content-Type: application/json
Body

Key

Type

Value

name

String

SAラベル(1 - 100 文字) (オプション)

description

String

メモ(1 - 500 文字) (オプション)

distributionId

String

Distribution ID(39文字) または空文字 (オプション)

  • Distribution ID の割り当てを解除するには空文字を指定します

  • 通常のサービスアダプタ(tss)にはレシピ対応機器の Distribution ID を割り当てることはできません

  • レシピ対応のサービスアダプタ(tsw)には通常機器の Distribution ID を割り当てることはできません

preferredPushMethod

String

RSが提案する接続モード (オプション)

none

提案無し

simple

接続待受型(確認あり)

tunnel

接続持続型
オプション

API コール時に特定のパラメータ option を Query String として付加すると、同時に所定の処理が実行されます。 option パラメータは省略可能です。

例

PUT https://*.sacm.jp/public-api/v1/user/tsa99990001/sa/tss99990001?option=module-update

指定可能なパラメータは以下の通りです。

Key

Type

Value

option

String
module-update

Distribution ID の変更時、作業コンフィグ及び次回起動時コンフィグのモジュールバージョンを、 変更後の機種で利用可能な最新版のバージョンで同時に更新します。

  • 変更前後で機種に変更がある場合のみ、 最新版のバージョンへ更新します。

  • SACM API の実行ユーザの権限に「コンフィグ【すべて】」権限が付与されている必要があります。権限が付与されていない場合は更新処理は行われません。

  • Distribution ID パラメータを指定していない場合や、Distribution ID の割当を解除する場合も更新処理は行われません。

module-update-force

Distribution ID の変更時、作業コンフィグ及び次回起動時コンフィグのモジュールバージョンを、 変更後の機種で利用可能な最新版のバージョンで同時に 強制的に 更新します。

  • 変更前後での機種の変化によらず、 最新版のバージョンへ更新します。

  • SACM API の実行ユーザの権限に「コンフィグ【すべて】」権限が付与されている必要があります。権限が付与されていない場合は更新処理は行われません。

  • Distribution ID パラメータを指定していない場合や、Distribution ID の割当を解除する場合も更新処理は行われません。

レスポンス

Body

Key

Type

Value

code

String

SAコード

name

String

SAラベル

description

String

メモ

distributionId

String

Distribution ID

up

boolean

接続状態

true

接続中

false

切断中

connection

Array

各管理用サーバ (RS) との接続情報

index int

管理用サーバの識別番号

ipAddress String

接続元IPアドレス

port int

接続に利用されているポート

state String

管理用サーバとの接続状態

disconnected

切断中

pushconfirming

接続確認中

connected

接続有効 (接続持続型)

pushconfirmed

接続有効 (接続待受型)

pushconfirmed-retreat

接続有効 (接続待受型) - 低優先度状態

pulledTrigger

String

コンフィグ取得理由

none

なし

power-on-boot

電源投入

user-reboot

ユーザによる再起動

failure-reboot

異常による再起動

timeout-occured

通信タイムアウトによる再取得

error-reported

エラー通知による再取得

invalid-config

無効なコンフィグのため再取得

invalid-message

プロトコルメッセージ異常による再取得

fallbacked

サーバとの通信不能のため再取得

config-expired

コンフィグ期限切れ

module-sync-done

モジュール同期成功

module-sync-fail

モジュール同期失敗

no-rs

RS不明

rs-request-reboot

サーバからの再起動指示

boot-failed

起動失敗

server-failure

サーバからのエラー通知

internal-error

サービスアダプタの内部エラー

no-push-method

操作用接続形式不明

no-push-server

操作用サーバ不明

out-of-service

サービス停止

push-failed

操作失敗

need-reboot

再起動

retry-over

再試行失敗

rollback-failure

コンフィグのロールバック失敗

no-tunnel-url

接続持続URL不明

configState

String

コンフィグ反映状態

initial

コンフィグ未取得または同期無し

pulled

コンフィグ取得済み

pushready

操作・コンフィグ有効

pushed

コンフィグ操作中

pushconfirming

操作用接続確認中

pushMethod

String

サービスアダプタが利用する接続モード

none

なし (初期状態)

no-confirm

接続待受型 (確認なし)

simple

接続待受型 (確認あり)

tunnel

接続持続型

preferredPushMethod

String

RS が提案する接続モード

none

提案なし

simple

接続待受型 (確認あり)

tunnel

接続持続型

date

Object

各種日時情報

lastPushReady String

最後に操作可能状態通知を受信した日時

lastHeartbeatReport String

最後に監視通知を受信した日時

lastPulled String

サービスアダプタが最後にコンフィグを取得した日時

firstPulled String

サービスアダプタが最初にコンフィグを取得した日時

graph

Object

グラフにアクセスするために必要な情報

uri

String グラフCGIパス

keyCode

String グラフCGIのキー

group

Object

所属中のフォルダ情報 (所属していない場合は null)

id int

所属中のフォルダのID

name String

所属中のフォルダの名前

template

Object

所属中のテンプレートセット情報 (所属していない場合は null)

id int

所属中のテンプレートセットのID

name String

所属中のテンプレートセットの名前

label String

所属中のテンプレートセットのラベル

monitor

Object

所属中の監視グループ情報 (所属していない場合は null)

id int

所属中の監視グループのID

name String

所属中の監視グループの名前

tag

Array

所属中のタグ情報一覧 (所属していない場合は空の配列)

id int

所属中のタグのID

name String

所属中のタグの名前

colorCode String

所属中のタグの背景色

type

int

サービスアダプタの種別

0

通常のサービスアダプタ(tss)

1

レシピ対応のサービスアダプタ(tsw)

mode

String

レシピ対応のサービスアダプタのレシピコード (通常のサービスアダプタの場合は null)

サンプル

リクエスト

URL
PUT https://*.sacm.jp/public-api/v1/user/tsa99990001/sa/tss99990001
Header
Content-Type: application/json
Body
{
    "name": "SEIL/B1 002",
    "description": "MEMO-CHANGED",
    "distributionId": "0001-0000-0101-0000-0000-0000-5678-1234",
    "preferredPushMethod": "simple"
}

レスポンス

Response Header
Content-Type: application/json
Response Body
{
  "code": "tss99990001",
  "name": "SEIL/B1 002",
  "description": "MEMO-CHANGED",
  "distributionId": "0001-0000-0101-0000-0000-0000-5678-1234",
  "up": true,
  "configState": "pushready",
  "connection": [
    {
      "index": 1,
      "ipAddress": "10.0.0.1",
      "port": 10443,
      "state": "pushconfirmed"
    }, {
      "index": 2,
      "ipAddress": "10.0.0.1",
      "port": 10443,
      "state": "pushconfirmed"
    }
  ],
  "group": {
    "id": 1,
    "name": "Folder1"
  },
  "template": {
    "id": 1,
    "name": "Template1",
    "label": "label1"
  },
  "monitor": {
    "id": 1,
    "name": "Monitor1"
  },
  "tag": [
    {
      "id": 1,
      "name": "Tag1",
      "colorCode": "#000000"
    }
  ],
  "pulledTrigger": "power-on-boot",
  "pushMethod": "tunnel",
  "preferredPushMethod": "simple",
  "date": {
    "lastPushReady": "2012/06/05 16:00:09",
    "lastHeartbeatReport": "2012/05/11 17:10:02",
    "lastPulled": "2012/05/11 17:06:22",
    "firstPulled": "2012/04/11 17:07:00"
  },
  "graph": {
    "uri": "hb500/grapher.cgi",
    "keyCode": "graphkeycodesample"
  },
  "type": 0,
  "mode": null
}

共通パラメータ

サービスアダプタの情報

Key

Type

Value

code

String

SAコード

name

String

SAラベル

description

String

メモ

distributionId

String

Distribution ID

up

boolean

接続状態

true

接続中

false

切断中

connection

Array

各管理用サーバ (RS) との接続情報

index int

管理用サーバの識別番号

ipAddress String

接続元IPアドレス

port int

接続に利用されているポート

state String

管理用サーバとの接続状態

disconnected

切断中

pushconfirming

接続確認中

connected

接続有効 (接続持続型)

pushconfirmed

接続有効 (接続待受型)

pushconfirmed-retreat

接続有効 (接続待受型) - 低優先度状態

configState

String

コンフィグ反映状態

initial

コンフィグ未取得または同期無し

pulled

コンフィグ取得済み

pushready

操作・コンフィグ有効

pushed

コンフィグ操作中

pushconfirming

操作用接続確認中

group

Object

所属中のフォルダ情報 (所属していない場合は null)

id int

所属中のフォルダのID

name String

所属中のフォルダの名前

template

Object

所属中のテンプレートセット情報 (所属していない場合は null)

id int

所属中のテンプレートセットのID

name String

所属中のテンプレートセットの名前

label String

所属中のテンプレートセットのラベル

monitor

Object

所属中の監視グループ情報 (所属していない場合は null)

id int

所属中の監視グループのID

name String

所属中の監視グループの名前

tag

Array

所属中のタグ情報一覧 (所属していない場合は空の配列)

id int

所属中のタグのID

name String

所属中のタグの名前

colorCode String

所属中のタグの背景色

date

Object

各種日時情報

lastPushReady String

最後に操作可能状態通知を受信した日時

lastHeartbeatReport String

最後に監視通知を受信した日時

lastPulled String

サービスアダプタが最後にコンフィグを取得した日時

firstPulled String

サービスアダプタが最初にコンフィグを取得した日時

type

int

サービスアダプタの種別

0

通常のサービスアダプタ(tss)

1

レシピ対応のサービスアダプタ(tsw)

mode

String

レシピ対応のサービスアダプタのレシピコード (通常のサービスアダプタの場合は null)

前のトピックへ

検索

次のトピックへ

コンフィグ