コンテンツにスキップ
Sophos XG シリーズのハードウェアアプライアンスは、2025年 3月 31日にサポート終了 (EOL) となります。XG から XGS への移行に関しては、こちらをクリックしてください。

API GET 要求

現在、API GET 要求では名前と使用回数に基づいてオブジェクトを取得できます。依存構成は取得できません。

オブジェクトの使用回数について詳しくは、オブジェクトの使用を参照してください。

オブジェクト

ホストおよびサービスオブジェクト

オブジェクト XML タグ
IP ホスト <IPHostStatistics></IPHostStatistics>
IP ホストグループ <IPHostGroupStatistics></IPHostGroupStatistics>
MAC ホスト <MACHostStatistics></MACHostStatistics>
FQDN ホスト <FQDNHostStatistics></FQDNHostStatistics>
FQDN ホストグループ <FQDNHostGroupStatistics></FQDNHostGroupStatistics>
国別グループ <CountryGroupStatistics></CountryGroupStatistics>
サービス <ServicesStatistics></ServicesStatistics>
サービスグループ <ServiceGroupStatistics></ServiceGroupStatistics>

ネットワークおよびルーティングオブジェクト

オブジェクト XML タグ
インターフェース <InterfaceStatistics></InterfaceStatistics>
ゾーン <ZoneStatistics></ZoneStatistics>
ゲートウェイ <GatewayStatistics></GatewayStatistics>
SD-WAN プロファイル <SDWANProfileStatistics></SDWANProfileStatistics>

GET 要求

構文

Web ブラウザで IP ホストの使用回数を取得する構文は以下の通りです。

https://<ファイアウォールの IP アドレスまたはホスト名>:<ファイアウォールのポート>/webconsole/APIController?reqxml=<Request><Login><Username><Web 管理コンソールの管理者のユーザー名></Username><Password><管理者のパスワード></Password></Login><Get><IPHostStatistics></IPHostStatistics></Get></Request>

https://myfirewall.com:4444/webconsole/APIController?reqxml=<Request><Login><Username>admin</Username><Password>@Passw0rd</Password></Login><Get><IPHostStatistics</IPHostStatistics></Get></Request>

その他のオブジェクトの場合は、この構文でオブジェクトの箇所を置き換えてください。

フィルタ

オブジェクトの名前と使用回数について、API GET 要求で以下のフィルタを使用できます。

フィールド名 フィルタ
名前 likenot likestartswithin=!=
使用回数 in=!=>>=

それぞれ、以下のようにフィルタの条件が適用されます。

フィルタ 検索条件
like 指定した文字が名前に含まれる。
not like 指定した文字が名前に含まれない。
startswith 名前が指定した文字から始まる。
in

名前または使用回数が、指定した値に完全一致する。

複数の値は、カンマで区切ります。

= 指定した名前または使用回数に完全一致する。
!= 指定した名前または使用回数に完全一致しないオブジェクト。
> 指定した使用回数より大きい値。
>= 指定した使用回数に一致するか、それより大きい値。

IP ホスト名に基づきフィルタを適用する構文は以下の通りです。

https://<ファイアウォールの IP アドレスまたはホスト名>:<ファイアウォールのポート>/webconsole/APIController?reqxml=<Request><Login><Username><Web 管理コンソールの管理者のユーザー名></Username><Password><管理者のパスワード></Password></Login><Get><IPHostStatistics><Filter><key name="Name" criteria="like"><名前の値></key></Filter></IPHostStatistics></Get></Request>

https://myfirewall.com:4444/webconsole/APIController?reqxml=<Request><Login><Username>admin</Username><Password>@Passw0rd</Password></Login><Get><IPHostStatistics><Filter><key name="Name" criteria="like">Internet</key></Filter></IPHostStatistics></Get></Request>

IP ホストの使用回数に基づきフィルタを適用する構文は以下の通りです。

https://<ファイアウォールの IP アドレスまたはホスト名>:<ファイアウォールのポート>/webconsole/APIController?reqxml=<Request><Login><Username><Web 管理コンソールの管理者のユーザー名></Username><Password><管理者のパスワード></Password></Login><Get><IPHostStatistics><Filter><key name="Usage" criteria="in"><使用回数の値>,<使用回数の値></key></Filter></IPHostStatistics></Get></Request>

https://myfirewall.com:4444/webconsole/APIController?reqxml=<Request><Login><Username>admin</Username><Password>@Passw0rd</Password></Login><Get><IPHostStatistics><Filter><key name="Usage" criteria="in">1,2,3</key></Filter></IPHostStatistics></Get></Request>

その他のリソース