1. FutureNet製品活用ガイド
  2. FutureNet NXR,VXRシリーズ
  3. REST-API編

FutureNet

NXR,VXRシリーズ

REST-API編

5. アクセスリスト設定

5-7. クラスアクセスリスト設定（acl_class）

 処理概要

クラスアクセスリスト設定に関する処理を実行します。

 

URIおよびメソッド

機能 Version URI メソッド
POST PUT GET DELETE
Class ACL v2 /api/v2/acl_class － － － －
/api/v2/acl_class/access-list 〇 － － －
/api/v2/acl_class/access-list/{NAME} － 〇 ● 〇

凡例：

● : 読み取り専用ユーザも含めアクセス可

〇 : 読み取り専用ユーザはアクセス不可

－ : 未対応

 

実行例

クラスアクセスリスト名の定義および設定の作成

メソッド URI
POST /api/v2/acl_class/access-list
JSON
リクエスト

POST /api/v2/acl_class/access-list
Content-Type: application/json

 

{
"access-list": {
"name": "CLASS_ACL",
"protocol": "ip",
"rule": {
"source": {
"address": "0.0.0.0/0"
},
"destination": {
"address": "0.0.0.0/0"
},
"proto": {
"protonum": "tcp"
}
}
}
}

 

レスポンス

201 Created

 

XML
リクエスト

POST /api/v2/acl_class/access-list
Content-Type: application/xml

 

<acl_class>
<access-list>
<name>CLASS_ACL</name>
<protocol>ip</protocol>
<rule>
<source>
<address>0.0.0.0/0</address>
</source>
<destination>
<address>0.0.0.0/0</address>
</destination>
<proto>
<protonum>tcp</protonum>
</proto>
</rule>
</access-list>
</acl_class>

 

レスポンス

201 Created

 

クラスアクセスリスト設定の追加

メソッド URI
PUT /api/v2/acl_class/access-list/{NAME}
  • PUT時は、既存のアクセスリスト名へのルールの追加のみ可能です。

 

JSON
リクエスト

PUT /api/v2/acl_class/access-list/CLASS_ACL
Content-Type: application/json

 

{
"name": "CLASS_ACL",
"protocol": "ip",
"rule": {
"source": {
"address": "0.0.0.0/0"
},
"destination": {
"address": "0.0.0.0/0"
},
"proto": {
"protonum": "udp"
}
}
}

 

レスポンス

204 No content

 

XML
リクエスト

PUT /api/v2/acl_class/access-list/CLASS_ACL
Content-Type: application/xml

 

<access-list>
<name>CLASS_ACL</name>
<protocol>ip</protocol>
<rule>
<source>
<address>0.0.0.0/0</address>
</source>
<destination>
<address>0.0.0.0/0</address>
</destination>
<proto>
<protonum>udp</protonum>
</proto>
</rule>
</access-list>

 

レスポンス

204 No content

 

クラスアクセスリスト設定の取得

メソッド URI
GET /api/v2/acl_class/access-list/{NAME}
JSON
リクエスト

GET /api/v2/acl_class/access-list/CLASS_ACL
Accept: application/json

 

レスポンス

200 OK
Content-Type: application/json

 

{
"name": "CLASS_ACL",
"protocol": "ip",
"rule": [
{
"source": {
"address": "0.0.0.0/0"
},
"destination": {
"address": "0.0.0.0/0"
},
"proto": {
"protonum": "tcp"
}
},
{
"source": {
"address": "0.0.0.0/0"
},
"destination": {
"address": "0.0.0.0/0"
},
"proto": {
"protonum": "udp"
}
}
]
}

 

XML
リクエスト

GET /api/v2/acl_class/access-list/CLASS_ACL
Accept: application/xml

 

レスポンス

200 OK
Content-Type: application/xml

 

<access-list>
<name>CLASS_ACL</name>
<protocol>ip</protocol>
<rule>
<source>
<address>0.0.0.0/0</address>
</source>
<destination>
<address>0.0.0.0/0</address>
</destination>
<proto>
<protonum>tcp</protonum>
</proto>
</rule>
<rule>
<source>
<address>0.0.0.0/0</address>
</source>
<destination>
<address>0.0.0.0/0</address>
</destination>
<proto>
<protonum>udp</protonum>
</proto>
</rule>
</access-list>

 

TEXT/PLAIN
リクエスト

GET /api/v2/acl_class/access-list/CLASS_ACL
Accept: text/plain

 

レスポンス

200 OK
Content-Type: text/plain

 

class access-list CLASS_ACL ip any any tcp
class access-list CLASS_ACL ip any any udp

 

クラスアクセスリスト設定の削除

メソッド URI
DELETE /api/v2/acl_class/access-list/{NAME}
  • Bodyを指定しなかった場合、指定したNAMEのクラスアクセスリスト設定を全て削除します。

 

JSON
リクエスト

DELETE /api/v2/acl_class/access-list/CLASS_ACL
Content-Type: application/json

 

{
"name": "CLASS_ACL",
"protocol": "ip",
"rule": {
"source": {
"address": "0.0.0.0/0"
},
"destination": {
"address": "0.0.0.0/0"
},
"proto": {
"protonum": "udp"
}
}
}

 

レスポンス

204 No content

 

XML
リクエスト

DELETE /api/v2/acl_class/access-list/CLASS_ACL
Content-Type: application/xml

 

<access-list>
<name>CLASS_ACL</name>
<protocol>ip</protocol>
<rule>
<source>
<address>0.0.0.0/0</address>
</source>
<destination>
<address>0.0.0.0/0</address>
</destination>
<proto>
<protonum>udp</protonum>
</proto>
</rule>
</access-list>

 

レスポンス

204 No content

 

パラメータ

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

なお、指定可能なパラメータは製品およびファームウェアのバージョンにより異なりますので、各パラメータの詳細については各製品のユーザーズガイド（CLI版）も合わせてご参照ください。

  • パラメータ表の説明文中の表記について
    < > … 括弧内の値の範囲から選択することを示しています。
    [ ] … 括弧内の値のどれかを選択することを示しています。
  • パラメータ表の説明文中のデータタイプについて
    A.B.C.D … IPv4アドレス
    A.B.C.D/M … IPv4プレフィックスおよびマスク長
    X:X::X:X … IPv6アドレス
    X:X::X:X/M … IPv6プレフィックスおよびプレフィックス長

 

パラメータおよびレベル 説明
Lv.1 Lv.2 Lv.3 Lv.4 Lv.5
acl_class access-list name ACL名
protocol プロトコル … [ ip | ipv6 ] 
rule source deny 指定アドレスを除く … not
address 送信元アドレス …

  • any
  • A.B.C.D
  • A.B.C.D/M
  • X:X::X:X
  • X:X::X:X/M
destination deny 指定アドレスを除く … not
address 宛先アドレス …

  • any
  • A.B.C.D
  • A.B.C.D/M
  • X:X::X:X
  • X:X::X:X/M
dst-dns-set setname 宛先dns-set名
proto deny 指定プロトコルを除く … not
protonum プロトコル … [ icmp | icmpv6 | tcp | udp | <0-255> ]
icmp deny 指定ICMPタイプ,コードを除く … not
type ICMPタイプ … <0-255>
code ICMPコード … <0-255>
src_port deny 指定ポートを除く … not
min 送信元ポート番号 … [ any | <1-65535> ]
max 送信元ポート番号 … <1-65535>
※範囲指定時のみ有効
dst_port deny 指定ポートを除く … not
min 宛先ポート番号 … [ any | <1-65535> ]
max 宛先ポート番号 … <1-65535>
※範囲指定時のみ有効