API GET
Anfrage
Derzeit ist die API GET
Die Anforderung ruft Objekte nur basierend auf ihrem Namen und ihrer Nutzungsanzahl ab. Die abhängigen Konfigurationen werden nicht abgerufen.
Weitere Informationen zur Objektverwendung finden Sie unter Objektverwendung.
Objekte
Host- und Serviceobjekte
Objekt | XML-Tag |
---|---|
IP-Hosts | <IPHostStatistics></IPHostStatistics> |
IP-Hostgruppe | <IPHostGroupStatistics></IPHostGroupStatistics> |
MAC-Hosts | <MACHostStatistics></MACHostStatistics> |
FQDN-Hosts | <FQDNHostStatistics></FQDNHostStatistics> |
FQDN-Hostgruppe | <FQDNHostGroupStatistics></FQDNHostGroupStatistics> |
Ländergruppen | <CountryGroupStatistics></CountryGroupStatistics> |
Leistungen | <ServicesStatistics></ServicesStatistics> |
Servicegruppe | <ServiceGroupStatistics></ServiceGroupStatistics> |
Netzwerk- und Routingobjekte
Objekt | XML-Tag |
---|---|
Schnittstellen | <InterfaceStatistics></InterfaceStatistics> |
Söhne | <ZoneStatistics></ZoneStatistics> |
Gateways | <GatewayStatistics></GatewayStatistics> |
SD-WAN-Profil | <SDWANProfileStatistics></SDWANProfileStatistics> |
GET
Anfragen
Syntax
Die in Webbrowsern zu verwendende Syntax zum Abrufen der Nutzungsanzahl für IP-Hosts 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>
Verwenden Sie für andere Objekte diese Syntax mit dem entsprechenden Objekt.
Filter
Sie können die folgenden Filter in der API verwenden GET
Anforderung des Objektnamens und der Nutzungsanzahl.
Feldname | Filter |
---|---|
Name | like , not like , startswith , in , = , != |
Nutzungsanzahl | in , = , != , > , >= |
Die Filter zeigen die Nutzungsanzahl 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 | Genaue Übereinstimmungen mit den von Ihnen angegebenen Namens- oder Verwendungswerten. Geben Sie durch Kommas getrennte Werte ein. |
= | Genauer Name oder Verwendungswert, den Sie angeben. |
!= | Objekte, die nicht genau mit dem von Ihnen angegebenen Namen oder Verwendungswert übereinstimmen. |
> | 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 zum Verwenden eines Filters für die Verwendung 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>
Weitere Ressourcen