API-Anfrage zur Objektverwendung
Mithilfe von API-GET-Anfragen können Sie die Namen und die Nutzungshäufigkeit der Konfigurationen abrufen, in denen ein Objekt verwendet wird. Aktuell enthält die Antwort keine abhängigen Konfigurationen.
Lernen Sie die Objekte, die entsprechenden XML-Tags und die Syntax anhand von Beispielen für API-Anfragen und die Anwendung von Filtern kennen.
Weitere Informationen zur Objektverwendung finden Sie unter Objektverwendung.
Objekte
Sie können die GET-Anfrage verwenden, um einige Objekte abzurufen.
Host- und Serviceobjekte
| Objekt | XML-Tag |
|---|---|
| IP-Hosts | <IPHostStatistics></IPHostStatistics> |
| IP-Hostgruppen | <IPHostGroupStatistics></IPHostGroupStatistics> |
| MAC-Hosts | <MACHostStatistics></MACHostStatistics> |
| FQDN-Hosts | <FQDNHostStatistics></FQDNHostStatistics> |
| FQDN-Hostgruppen | <FQDNHostGroupStatistics></FQDNHostGroupStatistics> |
| Ländergruppen | <CountryGroupStatistics></CountryGroupStatistics> |
| Dienstleistungen | <ServicesStatistics></ServicesStatistics> |
| Servicegruppen | <ServiceGroupStatistics></ServiceGroupStatistics> |
Netzwerk- und Routingobjekte
| Objekt | XML-Tag |
|---|---|
| Schnittstellen | <InterfaceStatistics></InterfaceStatistics> |
| Zonen | <ZoneStatistics></ZoneStatistics> |
| Gateways | <GatewayStatistics></GatewayStatistics> |
| SD-WAN-Profile | <SDWANProfileStatistics></SDWANProfileStatistics> |
GET Anfragen
Syntax
Die Syntax zur Ermittlung der Nutzungshäufigkeit von IP-Hosts in Webbrowsern lautet wie folgt:
https://<Firewall IP address or hostname>:<Firewall's port>/webconsole/APIController?reqxml=<Request><Login><Username><Web admin console administrator's username></Username><Password><Administrator's password></Password></Login><Get><IPHostStatistics></IPHostStatistics></Get></Request> Beispiel
https://myfirewall.com:4444/webconsole/APIController?reqxml=<Request><Login><Username>admin</Username><Password>@Passw0rd</Password></Login><Get><IPHostStatistics></IPHostStatistics></Get></Request> Für andere Objekte verwenden Sie diese Syntax mit dem entsprechenden Objekt.
Filter
Sie können die folgenden Filter in der API verwenden. GET Anfrage nach dem Namen des Objekts und der Nutzungshäufigkeit.
| Feldname | Filter |
|---|---|
| Name | like, not like, startswith, in, =, != |
| Nutzungsanzahl | in, =, !=, >, >= |
Die Filter zeigen die Nutzungszahlen wie folgt an:
| Filter | Kriterien |
|---|---|
like | Der Name enthält die von Ihnen angegebenen Buchstaben. |
not like | Der Name enthält nicht die von Ihnen angegebenen Buchstaben. |
startswith | Der Name beginnt mit den von Ihnen angegebenen Buchstaben. |
in | Exakte Übereinstimmungen der von Ihnen angegebenen Namen oder Nutzungswerte. Geben Sie durch Kommas getrennte Werte ein. |
= | Den genauen Namen oder Verwendungswert geben Sie an. |
!= | Objekte, die nicht genau dem von Ihnen angegebenen Namen oder Verwendungswert entsprechen. |
> | Größer als der von Ihnen angegebene Nutzungswert. |
>= | Größer oder gleich dem von Ihnen angegebenen Nutzungswert. |
Die Syntax zur Verwendung eines Filters für den Namen eines IP-Hosts lautet wie folgt:
https://<Firewall's IP address or hostname>:<Firewall's port>/webconsole/APIController?reqxml=<Request><Login><Username><Web admin console administrator's username></Username><Password><Administrator's password></Password></Login><Get><IPHostStatistics><Filter><key name="Name" criteria="like"><Name value></key></Filter></IPHostStatistics></Get></Request> Beispiel
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> Die Syntax zur Verwendung eines Filters für die Nutzung eines IP-Hosts lautet wie folgt:
https://<Firewall's IP address or hostname>:<Firewall's port>/webconsole/APIController?reqxml=<Request><Login><Username><Web admin console administrator's username></Username><Password><Administrator's password></Password></Login><Get><IPHostStatistics><Filter><key name="Usage" criteria="in"><Usage value>,<Usage value></key></Filter></IPHostStatistics></Get></Request> Beispiel
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>