Nach Ressourcen suchen

• Boolean: Suche nach booleschen Werten.
• Choice: Suchfelder, die einen definierten Satz gültiger Werte haben
• ID: Eindeutige IDs suchen
• Null: Suche nach Nullwerten
• Numeric: Suche nach numerischen Werten
• String: Suche nach Zeichenfolgen
• Datumsbereich: Suche nach Datumswerten

Tipp Wie in Hinweise zu Ressourcen-Eigenschaftswerten erwähnt, verwenden Sie bei direkter Nutzung der API 0, um einen Nullwert darzustellen. Um jedoch nach einem Nullwert zu suchen, verwenden Sie eine Nullsuche. Sie führen keine numerische Suche nach 0 durch.

• Der Name des Feldes (die Eigenschaft der Ressource), nach dem Sie suchen – beachten Sie, dass Feldnamen groß- und kleinschreibungssensitiv sind
• Ein Wert zum Suchen (oder, bei Datumswerten, ein Datumsbereich)
• Ein Operator zum Testen von Feldwerten (dies gilt nicht für Datumswert-Suchen)
• Die maximale Anzahl der zurückzugebenden Elemente (Standard ist 5000)

Tipp Beim Durchführen einer ID-Suche geben Sie den Namen des Feldes nicht an, da angenommen wird, dass es sich um das ID-Feld handelt.

# Set search criteria
search_criteria = api.SearchCriteria()
search_criteria.field_name = "name"
search_criteria.string_test = "equal"
search_criteria.string_value = name

# Create a search filter
search_filter = api.SearchFilter(None, [search_criteria])
search_filter.max_items = 1

# Perform the search
policies_api = api.PoliciesApi(api.ApiClient(configuration))
policies_api.search_policies(api_version, search_filter=search_filter)

# Set search criteria for platform
policy_criteria = api.SearchCriteria()
policy_criteria.field_name = "policyID"
policy_criteria.numeric_test = "equal"
policy_criteria.numeric_value = policy_id

# Set search criteria for relay
relay_criteria = api.SearchCriteria()
relay_criteria.field_name = "relayListID"
relay_criteria.numeric_test = "equal"
relay_criteria.numeric_value = relay_list_id

# Create the search filter
search_filter = api.SearchFilter(None, [policy_criteria, relay_criteria])

Durchsuchbare Felder

1. Klicken Sie auf eine Operation, die den Typ der Ressource zurückgibt, nach der Sie suchen. Zum Beispiel gibt die Describe a Computer-Operation eine Computer-Ressource zurück.
2. Klicken Sie im Abschnitt Antworten auf 200 successful operation.
3. Lesen Sie die Beschreibung des Feldes. Die Beschreibungen der durchsuchbaren Felder enthalten "Durchsuchbar als Datentyp", wobei Datentyp String, Numerisch, ID, Datum, Boolean und Auswahl sein kann.

• Das locale-Feld eines Objekts
• Die meisten Felder, die ein Objekt als Wert haben, wie das policySettings-Feld eines Policy-Objekts (siehe unten "Computer-Teilobjekte durchsuchen" für Ausnahmen).

Computer-Teilobjekte durchsuchen

{
    "hostName": "gui2-336",
    "displayName": "",
    "description": "",
    ...
    "interfaces": {
      "name": "ethernet",
      ...
    },
    "ec2VirtualMachineSummary": {
      "accountID": "123456789012",
      "availabilityZone": "ap-northeast-1",
      ...
    },
    ...
    "ID": 201
}

Tipp Verwenden Sie den expand-Parameter bei der Suche, um nur die Informationen einzuschließen, die Sie in den zurückgegebenen Computerobjekten benötigen. Weitere Informationen finden Sie unter "Minimieren der Computerantwortgröße" im Leitfaden für Leistungstipps.

# Search criteria
computer_criteria = api.SearchCriteria()
computer_criteria.field_name = "ec2VirtualMachineSummary/accountID"
computer_criteria.string_test = "equal"
computer_criteria.string_value = account_id

# Search filter
max_items = None
search_filter = api.SearchFilter(max_items, computer_criteria)

# Include only the EC2 virtual machine summary in the returned computers
expand = api.Expand(api.Expand.ec2_virtual_machine_summary)

# Perform the search
computers_api = api.ComputersApi(api.ApiClient(configuration))

return computers_api.search_computers(api_version, search_filter=search_filter, expand=expand.list(), overrides=False)

Feldnamen im Python-Code

1. Schreiben Sie den Buchstaben groß, der direkt nach jedem Unterstrich folgt.
2. Jeden Unterstrich löschen.

Verwenden Sie Platzhalter bei der Zeichenfolgensuche

• %: Steht für null oder mehr Zeichen
• _; Entspricht 1 Zeichen

# Create the search criteria
search_criteria = api.SearchCriteria()
search_criteria.field_name = "name"
search_criteria.string_test = "equal"
search_criteria.string_value = "Base%"

Tipp Um Platzhaltersuchen zu deaktivieren, setzen Sie die Eigenschaft `stringWildcards` des Objekts `SearchCriteria` auf `false`. search_criteria.string_wildcards = "false"

Datumsbereich-Suche durchführen

• FirstDate: Das frühere Datum im Bereich. Der Standardwert ist das frühestmögliche Datum.
• FirstDateInclusive: Ein boolescher Wert, der angibt, ob der Bereich das FirstDate einschließt (true) oder nicht (false). Der Standardwert ist false.
• LastDate: Das spätere Datum im Bereich. Der Standardwert ist das spätestmögliche Datum.
• LastDateInclusive: Ein boolescher Wert, der angibt, ob der Bereich das Enddatum einschließt (wahr) oder nicht (falsch). Der Standardwert ist falsch.

# Time that rules were last updated
current_time_in_ms = int(round(time.time() * 1000))
last_updated_in_ms = current_time_in_ms - (num_days * 24 * 60 * 60 * 1000)

# Set search criteria for the date range
search_criteria = api.SearchCriteria()
search_criteria.field_name = "lastUpdated"
search_criteria.first_date_value = last_updated_in_ms
search_criteria.last_date_value = current_time_in_ms
search_criteria.first_date_inclusive = True
search_criteria.last_date_inclusive = True

# Create a search filter
search_filter = api.SearchFilter(None, [search_criteria])

# Perform the search
intrusion_prevention_rules_api = api.IntrusionPreventionRulesApi(api.ApiClient(configuration))
return intrusion_prevention_rules_api.search_intrusion_prevention_rules(api_version, search_filter=search_filter)

Suche nach Nullwerten

# Search criteria
computer_criteria = api.SearchCriteria()
computer_criteria.field_name = "lastSendPolicySuccess"
computer_criteria.null_test = True

# Search filter
max_items = None
search_filter = api.SearchFilter(max_items, computer_criteria)

# Include minimal information in the returned computers
expand = api.Expand(api.Expand.none)

# Perform the search
computers_api = api.ComputersApi(api.ApiClient(configuration))

return computers_api.search_computers(api_version, search_filter=search_filter, expand=expand.list(), overrides=False)

Sortierreihenfolge

• Boolean, Choice, Null, and String searches: Sortiert nach der ID des zurückgegebenen Objekts in aufsteigender Reihenfolge.
• ID searches: Nach ID sortiert. Der Operator bestimmt, ob die Reihenfolge aufsteigend oder absteigend ist:
  • kleiner als und kleiner gleich: absteigend
  • Alle anderen Operatoren: aufsteigend
• Numeric searches: Sortiert nach dem Feld, das durchsucht wird. Der Operator bestimmt, ob die Reihenfolge aufsteigend oder absteigend ist:
  • kleiner als und kleiner gleich: absteigend
  • Alle anderen Operatoren: aufsteigend
  Wenn mehrere Suchergebnisse denselben Wert für das gesuchte Feld haben, werden diese Objekte sekundär nach ID sortiert.
• Date searches: Sortiert nach dem Feld, das durchsucht wird. Die für die Suche angegebenen Datumsbereich-Parameter bestimmen die Sortierreihenfolge:
  • Nur LastDate ist angegeben: absteigend
  • Jede andere Kombination: aufsteigend
  Wenn mehrere Suchergebnisse denselben Wert für das gesuchte Datumsfeld haben, werden diese Objekte sekundär nach ID sortiert.
• Multiple search criteria: Suchen, die mehrere Suchkriterien verwenden, werden nach ID (aufsteigend) sortiert, unabhängig von der Standardsortierreihenfolge der einzelnen Kriterien.

Suchergebnisse und Seitenumbruch begrenzen

• Suche nach ID mit dem Größer-als-Operator
• Verwenden Sie maxItems, um die Seitengröße festzulegen
• Berechnen Sie den Wert der ID, nach der gesucht werden soll, basierend auf der höchsten ID auf der vorherigen Ergebnisseite.

# Set search criteria
search_criteria = api.SearchCriteria()
search_criteria.id_value = 0
search_criteria.id_test = "greater-than"

# Create a search filter with maximum returned items
page_size = 10
search_filter = api.SearchFilter()
search_filter.max_items = page_size
search_filter.search_criteria = [search_criteria]

# Include the minimum information in the returned Computer objects
expand = api.Expand(api.Expand.none)

# Perform the search and do work on the results
computers_api = api.ComputersApi(api.ApiClient(configuration))
paged_computers = []


while True:
    computers = computers_api.search_computers(api_version, search_filter=search_filter, expand=expand.list(), overrides=False)
    num_found = len(computers.computers)
    current_paged_computers = []
    if num_found == 0:
        print("No computers found.")
        break

    for computer in computers.computers:
        current_paged_computers.append(computer)

    paged_computers.append(current_paged_computers)

    # Get the ID of the last computer in the page and return it with the number of computers on the page
    last_id = computers.computers[-1].id
    search_criteria.id_value = last_id
    print("Last ID: " + str(last_id), "Computers found: " + str(num_found))

return paged_computers