- FutureNet製品活用ガイド
- FutureNet NXR,VXRシリーズ
- REST-API編
FutureNet
NXR,VXRシリーズ
REST-API編
12. システム設定
12-9. LED設定(led)
処理概要
LED設定に関する処理を実行します。
URIおよびメソッド
機能 | Version | URI | メソッド | |||
POST | PUT | GET | DELETE | |||
LED | v2 | /api/v2/led | - | - | - | - |
/api/v2/led/led-list | 〇 | - | ● | - | ||
/api/v2/led/led-list/{NAME} | - | 〇 | ● | 〇 |
凡例:
● : 読み取り専用ユーザも含めアクセス可
〇 : 読み取り専用ユーザはアクセス不可
- : 未対応
- ext0 LEDの補足についてはこちら
実行例
LED設定の作成
メソッド | URI |
POST | /api/v2/led/led-list |
JSON
リクエスト
POST /api/v2/led/led-list
Content-Type: application/json
{
"led-list": {
"name": "status2",
"type": "interface",
"target": "ppp0"
}
}
レスポンス
201 Created
XML
リクエスト
POST /api/v2/led/led-list
Content-Type: application/xml
<led>
<led-list>
<name>status2</name>
<type>interface</type>
<target>ppp0</target>
</led-list>
</led>
レスポンス
201 Created
全LED設定の取得
メソッド | URI |
GET | /api/v2/led/led-list |
JSON
リクエスト
GET /api/v2/led/led-list
Accept: application/json
レスポンス
200 OK
Content-Type: application/json
{
"led-list": [
{
"name": "status2",
"type": "interface",
"target": "ppp0"
},
{
"name": "ext0"
},
{
"name": "aux1",
"type": "track",
"target": 1
}
]
}
XML
リクエスト
GET /api/v2/led/led-list
Accept: application/xml
レスポンス
200 OK
Content-Type: application/xml
<led>
<led-list>
<name>status2</name>
<type>interface</type>
<target>ppp0</target>
</led-list>
<led-list>
<name>ext0</name>
</led-list>
<led-list>
<name>aux1</name>
<type>track</type>
<target>1</target>
</led-list>
</led>
TEXT/PLAIN
リクエスト
GET /api/v2/led/led-list
Accept: text/plain
レスポンス
200 OK
Content-Type: text/plain
system led status 2 interface ppp 0
no system led ext 0
system led aux 1 track 1
LED設定の更新
メソッド | URI |
PUT | /api/v2/led/led-list/{NAME} |
JSON
リクエスト
PUT /api/v2/led/led-list/status2
Content-Type: application/json
{
"name": "status2",
"type": "interface",
"target": "tunnel1"
}
レスポンス
204 No content
XML
リクエスト
PUT /api/v2/led/led-list/status2
Content-Type: application/xml
<led-list>
<name>status2</name>
<type>interface</type>
<target>tunnel1</target>
</led-list>
レスポンス
204 No content
LED設定の取得
メソッド | URI |
GET | /api/v2/led/led-list/{NAME} |
JSON
リクエスト
GET /api/v2/led/led-list/status2
Accept: application/json
レスポンス
200 OK
Content-Type: application/json
{
"name": "status2",
"type": "interface",
"target": "tunnel1"
}
XML
リクエスト
GET /api/v2/led/led-list/status2
Accept: application/xml
レスポンス
200 OK
Content-Type: application/xml
<led-list>
<name>status2</name>
<type>interface</type>
<target>tunnel1</target>
</led-list>
TEXT/PLAIN
リクエスト
GET /api/v2/led/led-list/status2
Accept: text/plain
レスポンス
200 OK
Content-Type: text/plain
system led status 2 interface tunnel 1
LED設定の削除
メソッド | URI |
DELETE | /api/v2/led/led-list/{NAME} |
リクエスト
DELETE /api/v2/led/led-list/status2
レスポンス
204 No content
パラメータ
指定可能なパラメータは下記の通りです。
なお、指定可能なパラメータは製品およびファームウェアのバージョンにより異なりますので、各パラメータの詳細については各製品のユーザーズガイド(CLI版)も合わせてご参照ください。
- パラメータ表の説明文中の記号について
< > … 括弧内の値の範囲から選択することを示しています。
[ ] … 括弧内の値のどれかを選択することを示しています。
数字,文字列 … 初期値
パラメータおよびレベル | 説明 | |||
---|---|---|---|---|
Lv.1 | Lv.2 | Lv.3 | Lv.4 | |
global | led | led-list | name | LED名 …
|
type | LED点灯対象情報 … [ interface | signal | track ] | |||
target | LED点灯対象 …
|
|||
interval | シグナルレベル確認間隔 … <0-60(5)>(sec) | |||
color | カラー … [ green | orange | red ] | |||
status | LED点灯対象ステータス … [ down | up | updown ] |
補足
ext0 LEDについて
ext0 LEDは、デフォルトで下記が設定されています。
そのため、POSTメソッドの実行は必要ありません。なお、DELETEメソッドを実行した場合、上記デフォルト設定となります。
また、ext0 LED設定を無効にする場合、以下を実行します。
JSON
リクエスト
PUT /api/v2/led/led-list/ext0
Content-Type: application/json
{
"name": "ext0"
}
レスポンス
204 No content
XML
リクエスト
PUT /api/v2/led/led-list/ext0
Content-Type: application/xml
<led-list>
<name>ext0</name>
</led-list>
レスポンス
204 No content
目次
更新情報
→ 一覧へカテゴリ
タグ
- CRG
- DDNS
- DHCP
- DNAT
- DNSインターセプト
- Ethernet
- IIJモバイル
- IKE Modeconfig
- IKEv2 Configuration Payload
- IPinIP
- IPoE
- IPv6
- KDDI
- L2TPv3
- MAP-E
- NGN
- NTTドコモ
- PBR
- Policy Based IPsec
- PPP
- PPPoE
- QoS
- RADIUS連携
- RAシリーズ
- Route Based IPsec
- SMS
- SNAT
- SoftBank
- UPnP
- URL転送
- VLAN
- VRRP
- Web認証
- WiMAX
- コンフィグロールバック
- ネットイベント
- フィルタ
- ブリッジ
- モニタログ
- ワイモバイル
- 仮想スイッチ
- 冗長化
- 無線LAN