AS 名
自律システム(AS)トラフィックに関するデータを表示するインターフェース レポートは、通常、名前と番号により AS トラフィックにラベルを付けます。管理者は、レポート内の AS 参照がより短く、またはより記述的になるように AS 名をカスタマイズできます。このセクションでは、AS 名でサポートされている、API を使用した以下の操作について説明します。
nfa1000
自律システム(AS)トラフィックに関するデータを表示するインターフェース レポートは、通常、名前と番号により AS トラフィックにラベルを付けます。管理者は、レポート内の AS 参照がより短く、またはより記述的になるように AS 名をカスタマイズできます。このセクションでは、AS 名でサポートされている、API を使用した以下の操作について説明します。
詳細:
AS 名のカスタマイズAS 名の取得
この API を使用すると、AS 名のリストを取得できます。
リソース
URIhttp://<nfa odata host>:<nfa odata port>/odata/api/asNames
メソッド
GET
サンプル リクエスト
http://127.0.0.1:8981/odata/api/asNames
サンプル レスポンス
{ "@odata.context": "http://localhost:8981/odata/api/$metadata#asNames(ASNumber,Description,isBaseDescription)", "value": [ { "isBaseDescription": "true", "Description": "LVLT-1 - Level 3 Communications, Inc.", "ASNumber": 1 }, { "isBaseDescription": "true", "Description": "DCN-AS - University of Delaware", "ASNumber": 2 }, { "isBaseDescription": "true", "Description": "MIT-GATEWAYS - Massachusetts Institute of Technology", "ASNumber": 3 }, { "isBaseDescription": "true", "Description": "ISI-AS - University of Southern California", "ASNumber": 4 }, { "isBaseDescription": "true", "Description": "SYMBOLICS - Symbolics, Inc.", "ASNumber": 5 }, { "isBaseDescription": "true", "Description": "BULL-NETWORK for further information please visit http://www.bull.com", "ASNumber": 6 }, { "isBaseDescription": "true", "Description": "UK Defence Research Agency", "ASNumber": 7 }, { "isBaseDescription": "true", "Description": "RICE-AS - Rice University", "ASNumber": 8 }, { "isBaseDescription": "true", "Description": "CMU-ROUTER - Carnegie Mellon University", "ASNumber": 9 }, { "isBaseDescription": "true", "Description": "CSNET-EXT-AS - CSNET Coordination and Information Center (CSNET-CIC)", "ASNumber": 10 } ], "@odata.nextLink": "http://localhost:8981/odata/api/asNames?$skiptoken=10" }
リクエストで domainId を指定しない場合、デフォルトの domainId 1 が指定されたとみなされ、そのドメインの AS 名が返されます。
デフォルト ドメイン以外のドメインの AS 名を取得するには、リクエストに domainId パラメータを追加します。
URI
: http://127.0.0.1:8981/odata/api/asNames?domainId=2メソッド:
GET単一の AS 名の取得
この API を使用すると、単一の AS 名を取得できます。
リソース
URIhttp://<nfa odata host>:<nfa odata port>/odata/api/asNames(asNameID)
メソッド
GET
サンプル リクエスト
http://127.0.0.1:8981/odata/api/asNames(1)
サンプル レスポンス
{ "@odata.context": "http://localhost:8981/odata/api/$metadata#asNames(ASNumber,Description,isBaseDescription)/$entity", "isBaseDescription": "true", "Description": "LVLT-1 - Level 3 Communications, Inc.", "ASNumber": 1 }
リクエストで domainId を指定しない場合、デフォルトの domainId 1 が指定されたとみなされ、そのドメインの AS 名が返されます。
デフォルト ドメイン以外のドメインの AS 名を取得するには、リクエストに domainId パラメータを追加します。
サンプル リクエスト
: http://127.0.0.1:8981/odata/api/asNames(1)?domainId=2AS 名の編集
この API を使用すると、単一の AS 名を更新できます。この API は、一括編集をサポートしていません。
リソース
URIhttp://<nfa odata host>:<nfa odata port>/odata/api/asNames(asNameID)
メソッド
PATCH
ペイロード
{ "Description": "<description to be updated", "DomainId": <domainId> }
サンプル リクエスト
http://127.0.0.1:8981/odata/api/asNames(1)
サンプル ペイロード
{ "Description": "new updated as description", "DomainId": 1 }
サンプル レスポンス
この API に対するレスポンスはありません。
- 指定されたドメインの AS 名を取得するには、ペイロードに domainId を含める必要があります。
- Description は唯一編集可能なフィールドであり、編集するペイロードに含める必要があります。
AS 名のリセット
この API を使用すると、AS 名をリセットできます。
リソース
URIhttp://<nfa odata host>:<nfa odata port>/odata/api/asNames(asNameID)/com.ca.nfa.odata.reset
メソッド
POST
サンプル リクエスト
http://127.0.0.1:8981/odata/api/asNames(1)/com.ca.nfa.odata.reset
サンプル レスポンス
{ "@odata.context": "$metadata#com.ca.nfa.odata.asNames", "ASNumber": 1, "Description": "LVLT-1 - Level 3 Communications, Inc.", "isBaseDescription": "true" }
この API は、デフォルトの domainId 1 で指定された AS に関連付けられている AS 名の説明をリセットします。
別のドメインの同じ AS をリセットする場合は、リクエストに domainId を追加します。
サンプル リクエスト
: http://127.0.0.1:8981/odata/api/asNames(1)/com.ca.nfa.odata.reset?domainId=2