予約シーティング ルール

トラフィック ボリュームまたはレートに関係なく、レポートに目的のポートとプロトコルの組み合わせが確実に含まれるように、予約シーティング ルールを作成できます。
nfa1000
トラフィック ボリュームまたはレートに関係なく、レポートに目的のポートとプロトコルの組み合わせが確実に含まれるように、予約シーティング ルールを作成できます。
このセクションでは、予約シーティング ルールでサポートされている、API を使用した以下の操作について説明します。
予約シーティング ルールの取得
この API を使用すると、予約シーティング ルールのリストを取得できます。
リソース
URI
http://<nfa odata host>:<nfa odata port>/odata/api/reservedSeatingRules
メソッド
GET
サンプル リクエスト
http://127.0.0.1:8981/odata/api/reservedSeatingRules
サンプル レスポンス
{ "@odata.context": "http://localhost:8981/odata/api/$metadata#reservedSeatingRules(ID,protocol,port,description)", "value": [ { "protocol": 6, "port": 4444, "description": "Reserved Seating Test", "ID": 3 }, { "protocol": 17, "port": 4444, "description": "Reserved Seating Test", "ID": 4 }, { "protocol": 6, "port": 8080, "description": "Reserved Seating Test 8080", "ID": 5 }, { "protocol": 17, "port": 8080, "description": "Reserved Seating Test 8080 UDP", "ID": 6 } ] }
単一の予約シーティング ルールの取得
この API を使用すると、単一の予約シーティング ルールを取得できます。
リソース
URI
http://<nfa odata host>:<nfa odata port>/odata/api/reservedSeatingRules(reservedSeatingRuleID)
メソッド
GET
サンプル リクエスト
http://127.0.0.1:8981/odata/api/reservedSeatingRules(4)
サンプル レスポンス
{ "@odata.context": "http://localhost:8981/odata/api/$metadata#reservedSeatingRules(ID,protocol,port,description)/$entity", "protocol": 17, "port": 4444, "description": "Reserved Seating Test", "ID": 4 }
予約シーティング ルールの作成
この API を使用すると、予約シーティング ルールを作成できます。
リソース
URI
http://<nfa odata host>:<nfa odata port>/odata/api/reservedSeatingRules
メソッド
POST
ペイロード
{ "protocol": <protocol value>, "port": <port value>,, "description": "<description details>" }
サンプル リクエスト
http://127.0.0.1:8981/odata/api/reservedSeatingRules
サンプル ペイロード
{ "protocol": 17, "port": 8080, "description": "Reserved Seating Test 8080 UDP" }
サンプル レスポンス
{ "@odata.context": "http://localhost:8981/odata/api/$metadata#reservedSeatingRules(ID,protocol,port,description)/$entity", "protocol": 17, "port": 8080, "description": "Reserved Seating Test 8080 UDP", "ID": 6 }
予約シーティング ルールの更新
この API を使用すると、単一の予約シーティング ルールを更新できます。この API は、一括編集をサポートしていません。
リソース
URI
http://<nfa odata host>:<nfa odata port>/odata/api/reservedSeatingRules(reservedSeatingRuleID)
メソッド
PATCH
ペイロード
{ "protocol": <protocol value>, "port": <port value>,, "description": "<description details>" }
サンプル リクエスト
http://127.0.0.1:8981/odata/api/reservedSeatingRules(5)
サンプル ペイロード
{ "protocol": 17, "port": 8080, "description": "Reserved Seating Test 8080 UDP Update" }
サンプル レスポンス
この API に対するレスポンスはありません。
予約シーティング ルールの削除
この API を使用すると、単一の予約シーティング ルールを削除できます。
リソース
URI
http://<nfa odata host>:<nfa odata port>/odata/api/reservedSeatingRules(reservedSeatingRuleID)
メソッド
DELETE
サンプル リクエスト
以下のリクエストは、予約シーティング ルール ID 5 を削除するためのアクションを示しています。
http://127.0.0.1:8981/odata/api/reservedSeatingRules(5)
サンプル レスポンス
この API に対するレスポンスはありません。
予約シーティング ルールの一括削除
以下のコードは、予約シーティング ルールの一括削除に関する参照メタデータ セクションです。
リソース
URI
http://<nfa odata host>:<nfa odata port>/odata/api/reservedSeatingRules/com.ca.nfa.odata.deleteReservedSeatingRules
メソッド
POST
ペイロード
"RuleIds":[<List of rule_ids separated by a comma>]
サンプル リクエスト
以下のリクエストは、予約シーティング ルールを一括で削除するための削除アクションを示しています。
http://127.0.0.1:8981/odata/api/reservedSeatingRules/com.ca.nfa.odata.deleteReservedSeatingRules
サンプル ペイロード
{ "RuleIds": [4,5] }
サンプル レスポンス
{ "@odata.context": "$metadata#Collection(com.ca.nfa.odata.reservedSeatingRules)", "value": [ { "ID": 4, "protocol": 17, "port": 4444, "description": "Reserved Seating Test" }, { "ID": 5, "protocol": 6, "port": 8080, "description": "Reserved Seating Test 8080" } ] }
検証チェック
値を入力する際は、以下のデータ検証を考慮する必要があります。
  • プロトコルとポートの組み合わせは一意である必要があります。
  • プロトコルの値は、TCP の場合は 6、UDP の場合は 17 にする必要があります。
  • ポートの値は 0 から 65535 までの値にする必要があります。
  • 説明の長さは 100 文字未満にする必要があります。