サービスアダプタの一覧情報を取得する
Content-Type: application/json
{ "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" }, "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" }, "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" } ] }
サービスアダプタの詳細情報を取得する
パラメータ無し
Key | Type | Value |
---|---|---|
code | String | SAコード |
name | String | SAラベル |
description | String | メモ |
distributionId | String | Distribution ID |
up | boolean | 接続状態
|
connection | Array | 各管理用サーバ (RS) との接続情報
|
pulledTrigger | String | コンフィグ取得理由
|
configState | String | コンフィグ反映状態
|
pushMethod | String | サービスアダプタが利用する接続モード
|
preferredPushMethod | String | RS が提案する接続モード
|
date | Object | 各種日時情報
|
graph | Object | グラフにアクセスするために必要な情報
|
group | Object | 所属中のフォルダ情報 (所属していない場合は null)
|
template | Object | 所属中のテンプレートセット情報 (所属していない場合は null)
|
monitor | Object | 所属中の監視グループ情報 (所属していない場合は null)
|
type | int | サービスアダプタの種別
|
mode | String | レシピ対応のサービスアダプタのレシピコード (通常のサービスアダプタの場合は null) |
Content-Type: application/json
{ "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" }, "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 }
サービスアダプタの詳細情報を変更する
Content-Type: application/json
Key | Type | Value |
---|---|---|
name | String | SAラベル(1 - 100 文字) (オプション) |
description | String | メモ(1 - 500 文字) (オプション) |
distributionId | String | Distribution ID(39文字) または空文字 (オプション)
|
preferredPushMethod | String | RSが提案する接続モード (オプション)
|
API コール時に特定のパラメータ option を Query String として付加すると、同時に所定の処理が実行されます。 option パラメータは省略可能です。
例
PUT https://*.sacm.jp/public-api/v1/user/tsa99990001/sa/tss99990001?option=module-update
指定可能なパラメータは以下の通りです。
Key | Type | Value |
---|---|---|
option | String |
|
Key | Type | Value |
---|---|---|
code | String | SAコード |
name | String | SAラベル |
description | String | メモ |
distributionId | String | Distribution ID |
up | boolean | 接続状態
|
connection | Array | 各管理用サーバ (RS) との接続情報
|
pulledTrigger | String | コンフィグ取得理由
|
configState | String | コンフィグ反映状態
|
pushMethod | String | サービスアダプタが利用する接続モード
|
preferredPushMethod | String | RS が提案する接続モード
|
date | Object | 各種日時情報
|
graph | Object | グラフにアクセスするために必要な情報
|
group | Object | 所属中のフォルダ情報 (所属していない場合は null)
|
template | Object | 所属中のテンプレートセット情報 (所属していない場合は null)
|
monitor | Object | 所属中の監視グループ情報 (所属していない場合は null)
|
type | int | サービスアダプタの種別
|
mode | String | レシピ対応のサービスアダプタのレシピコード (通常のサービスアダプタの場合は null) |
PUT https://*.sacm.jp/public-api/v1/user/tsa99990001/sa/tss99990001
Content-Type: application/json
{ "name": "SEIL/B1 002", "description": "MEMO-CHANGED", "distributionId": "0001-0000-0101-0000-0000-0000-5678-1234", "preferredPushMethod": "simple" }
Content-Type: application/json
{ "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" }, "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 | 接続状態
|
connection | Array | 各管理用サーバ (RS) との接続情報
|
configState | String | コンフィグ反映状態
|
group | Object | 所属中のフォルダ情報 (所属していない場合は null)
|
template | Object | 所属中のテンプレートセット情報 (所属していない場合は null)
|
monitor | Object | 所属中の監視グループ情報 (所属していない場合は null)
|
date | Object | 各種日時情報
|
type | int | サービスアダプタの種別
|
mode | String | レシピ対応のサービスアダプタのレシピコード (通常のサービスアダプタの場合は null) |