Ansichten:
Suchen Sie nach Richtlinien auf Server- und Workload Protection, um Informationen darüber abzurufen. Zum Beispiel können Sie nach Richtlinien suchen, bei denen der Empfehlungsmodus deaktiviert ist, oder nach einer bestimmten Richtlinie nach Namen suchen und den konfigurierten Status der Schutzmodule einsehen. In diesem Beispiel verwenden Sie die Richtlinien suchen-Operation, um nach Richtlinien nach Namen zu suchen.

Bevor Sie beginnen Übergeordnetes Thema

Sie sollten bereits überprüft haben, dass Ihre Umgebung für die Nutzung der API mit Bash oder PowerShell eingerichtet ist.
Sammeln Sie die folgenden Informationen, die Sie benötigen, um dieses Rezept abzuschließen:
  • Der Name oder ein Teil des Namens einer Richtlinie auf Server- und Workload Protection
  • Die URL Ihres Managers
  • Der geheime Schlüssel für Ihren API-Schlüssel

Bash Übergeordnetes Thema

Prozedur

  1. Öffnen Sie das Terminal oder Ihr bevorzugtes Befehlszeilenwerkzeug.
  2. Geben Sie die folgenden Befehle ein, um Details zu Ihrer Anfrage zu speichern. Ersetzen Sie dabei <YOUR URL> durch die URL von Server- und Workload Protection und <YOUR SECRET KEY> durch das Geheimnis Ihres API-Schlüssels:
    • url=<YOUR URL>
      zum Beispiel, url=https://cloudone.trendmicro.com
    • secret=<YOUR SECRET KEY>
      zum Beispiel, secret=5C58EADA-04BC-4ABC-45CF-B72925A0B674:aFBgpPV8eJQGaY2Dk0LmyQMD7nUGvyIDfIbIQo8Zgm8=
  3. Geben Sie den folgenden Befehl ein, um Ihren Suchbegriff zu speichern, und ersetzen Sie <YOUR POLICY NAME> durch den gesamten oder einen Teil des Namens der zu suchenden Richtlinie:
    keyword="%<YOUR POLICY NAME>%"
    zum Beispiel, keyword="%Base Policy%"
  4. Geben Sie den folgenden Befehl ein, um die JSON-Datei anzugeben, in der Sie die Antwortdaten speichern möchten, und ersetzen Sie <FILE PATH> durch die zu erstellende Datei. Geben Sie einen Dateinamen mit der Erweiterung .json an:
    file=<FILE PATH>
    zum Beispiel, file=~/Documents/policy_search.json
  5. Geben Sie folgenden Befehl ein, um die Anfrage zu senden:
    curl -X POST "$url/api/policies/search" -H "api-secret-key: $secret" -H "api-version: v1" -H "Content-Type: application/json" \
-d "{ \
\"searchCriteria\": [ \
{ \
\"fieldName\": \"name\", \
\"stringTest\": \"equal\", \
\"stringValue\": \"$keyword\", \
\"stringWildcards\": true \
} \
] \
}" \
-k > $file
    Die -k-Option ist nur erforderlich, wenn Server- und Workload Protection ein selbstsigniertes Zertifikat verwendet, um TLS-Verbindungen herzustellen, was für den Einsatz in Produktionsumgebungen nicht geeignet ist.
    Tipp
    Tipp
    Um das zurückgegebene JSON im Terminal in einem lesbaren Format anzuzeigen (anstatt es in eine Datei zu schreiben), leiten Sie die Ergebnisse des cURL-Befehls an jq weiter. Ersetzen Sie im obigen Befehl > $file durch | jq ..
  6. Öffnen Sie die JSON-Datei in einem Webbrowser. (Der Webbrowser sollte das JSON so formatieren, dass es lesbar ist.) Sie sollten JSON-Code sehen, der ein Array von einer oder mehreren Richtlinien darstellt, ähnlich dem folgenden Beispiel:
    {
	name: "Base Policy",
	description: "A policy from which all other policies can inherit. ",
	policySettings: {...},
	recommendationScanMode: "ongoing",
	autoRequiresUpdate: "on",
	ID: 1,
	antiMalware: {...},
	webReputation: {...},
	sensingMode: {...},
	firewall: {...},
	intrusionPrevention: {...},
	integrityMonitoring: {...},
	logInspection: {...},
	applicationControl: {...}
}
    Tipp
    Tipp
    Um das Beispiel kurz zu halten, werden Werte, die aus mehreren Eigenschaften bestehen (d. h. Objekte), als dargestellt. Sie werden alle Informationen in Ihren Suchergebnissen sehen.
  7. (Optional) Versuchen Sie, den Wert der Schlüsselwortvariablen zu ändern, um zu sehen, wie sich dies auf die Suchergebnisse auswirkt. Geben Sie zum Beispiel keyword=%linux% ein und führen Sie den curl-Befehl erneut aus.

Nächste Schritte

PowerShell Übergeordnetes Thema

Prozedur

  1. PowerShell öffnen.
  2. Geben Sie den folgenden Befehl ein, um TLS 1.2 zu verwenden, das der Manager benötigt, um eine sichere Verbindung herzustellen:
    [Net.ServicePointManager]::SecurityProtocol += [Net.SecurityProtocolType]::Tls12
  3. Geben Sie die folgenden Befehle ein, um Details zu Ihrer Anfrage zu speichern. Ersetzen Sie dabei <YOUR URL> durch die URL von Server- und Workload Protection und <YOUR SECRET KEY> durch das Geheimnis Ihres API-Schlüssels:
    • $url = "<YOUR URL>"
      zum Beispiel, url=https://cloudone.trendmicro.com
    • $secret = "<YOUR API KEY SECRET>"
      zum Beispiel, $secret="5C58EADA-04BC-4ABC-45CF-B72725A0B674:aFBgpPV8eJQGaY2Dk0LmyQMD7nUGvyIDfIbIQo8Zgm8="
    • $headers = @{‘api-version’ = “v1”; ‘api-secret-key’ = $secret; 'Content-Type' = "application/json"}
  4. Geben Sie den folgenden Befehl ein, um Ihren Suchbegriff zu speichern, und ersetzen Sie <YOUR POLICY NAME> durch den gesamten oder einen Teil des Namens der zu suchenden Richtlinie:
    $keyword="%<YOUR POLICY NAME>%"
    zum Beispiel, $keyword="%Base Policy%"
  5. Geben Sie den folgenden Befehl ein, um die JSON-Datei anzugeben, in der Sie die Antwortdaten speichern möchten, und ersetzen Sie <FILE PATH> durch die zu erstellende Datei. Geben Sie einen Dateinamen mit der Erweiterung .json an:
    $file="<FILE PATH>"
    zum Beispiel, $file="$HOME\Documents\policy_search.json"
  6. Geben Sie folgenden Befehl ein, um die Anfrage zu senden:
    Invoke-RestMethod -Method 'Post' -Uri "$url/api/policies/search" -Headers $headers -Body @"
{"searchCriteria": [
{
"fieldName": "name",
"stringTest": "equal",
"stringValue": "$keyword",
"stringWildcards": true
}
]}
"@ -OutFile $file
    Wenn Sie die Fehlermeldung The underlying connection was closed: An unexpected error occurred on a send erhalten, schließen Sie PowerShell, öffnen Sie PowerShell erneut und versuchen Sie, die Schritte zu wiederholen.
  7. Öffnen Sie die JSON-Datei in einem Webbrowser. (Der Webbrowser sollte das JSON so formatieren, dass es lesbar ist.) Sie sollten JSON-Code sehen, der ein Array von einer oder mehreren Richtlinien darstellt, ähnlich dem folgenden Beispiel:
    {
	name: "Base Policy",
	description: "A policy from which all other policies can inherit. ",
	policySettings: {...},
	recommendationScanMode: "ongoing",
	autoRequiresUpdate: "on",
	ID: 1,
	antiMalware: {...},
	webReputation: {...},
	sensingMode: {...},
	firewall: {...},
	intrusionPrevention: {...},
	integrityMonitoring: {...},
	logInspection: {...},
	applicationControl: {...}
}
    Tipp
    Tipp
    Um das Beispiel kurz zu halten, werden Werte, die aus mehreren Eigenschaften bestehen (d. h. Objekte), als dargestellt. Sie werden alle Informationen in Ihren Suchergebnissen sehen.
  8. (Optional) Versuchen Sie, den Wert der Schlüsselwortvariablen zu ändern, um zu sehen, wie sich dies auf die Suchergebnisse auswirkt. Geben Sie zum Beispiel keyword=%linux% ein und führen Sie den Invoke-RestMethod-Befehl erneut aus

Nächste Schritte

Hinweise Übergeordnetes Thema

  • Wenn Sie die JSON-Datei in einem Texteditor öffnen, erscheint der Code in einer einzigen Zeile, was schwer lesbar ist. Webbrowser neigen dazu, JSON so zu formatieren, dass es lesbar ist. Wenn Ihr Browser das JSON nicht automatisch formatiert, sollten Sie in Erwägung ziehen, ein Browser-Plugin zu installieren, das dies tut.
  • Das 200-Response-Beispiel im API-Referenzhandbuch für die Suchrichtlinien-Operation bietet Beschreibungen der Richtlinienfelder, die angeben, welche Felder durchsuchbar sind.