搜尋資源

• Boolean: 搜尋布林值。
• Choice: 搜尋欄位具有一組定義的有效值
• ID: 搜尋唯一 ID
• Null: 搜尋空值
• Numeric: 搜尋數值
• String: 搜尋字串值
• Date range: 搜尋日期值

秘訣 如資源屬性值的注意事項中所述，當您直接使用 API 時，使用 0 來表示空值。然而，要搜尋空值時，您需要使用 Null 搜尋。您不會執行數值搜尋 0。

• 您正在搜尋的欄位名稱（資源的屬性）-- 請注意欄位名稱區分大小寫
• 要搜尋的值（或對於日期值，則為日期範圍）
• 運算子用於測試欄位值（不適用於日期值搜尋）
• 返回項目的最大數量（預設為 5000）

秘訣 在執行 ID 搜尋時，您不需要包含欄位名稱，因為預設為 ID 欄位。

# 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])

可搜尋欄位

1. 點選返回您正在搜尋的資源類型的操作。例如，描述電腦 操作返回電腦防護資源。
2. 點選200 successful operation在回應部分。
3. 閱讀欄位的描述。可搜尋欄位的描述包含「可搜尋為資料類型」，其中資料類型可以是字串、數值、ID、日期、布林值和選擇。

• 任何物件的 locale 欄位
• 大多數具有物件作為值的欄位，例如 Policy 物件的 policySettings 欄位（例外情況請參見下文的“搜尋電腦防護子物件”）。

搜尋電腦防護子物件

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

秘訣 在搜尋時使用 expand 參數，以僅包含您在返回的電腦防護物件中所需的資訊。欲了解詳細資訊，請參閱 效能提示 指南中的「最小化電腦防護回應大小」。

# 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)

Python 代碼中的欄位名稱

1. 將每個底線後面的字母大寫。
2. 刪除每個底線。

在字串搜尋中使用萬用字元

• %：匹配零個或多個字元
• _; 匹配 1 個字元

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

秘訣 若要關閉萬用字元搜尋，請將 `SearchCriteria` 物件的 `stringWildcards` 屬性設置為 `false`。 search_criteria.string_wildcards = "false"

執行日期範圍搜尋

• FirstDate: 範圍內的較早日期。預設值是最早的可能日期。
• FirstDateInclusive: 一個布林值，指示範圍是否包含 FirstDate（true）或不包含（false）。預設值為 false。
• LastDate: 範圍內的較晚日期。預設值為最晚的可能日期。
• LastDateInclusive: 一個布林值，指示範圍是否包含 LasteDate（true）或不包含（false）。預設值為 false。

# 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)

搜尋空值

# 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)

排序順序

• Boolean, Choice, Null, and String searches: 按返回對象的 ID 以升序排序。
• ID searches: 按 ID 排序。操作員決定順序是升序還是降序：
  • 小於和小於或等於：降序
  • 所有其他運算子：遞增
• Numeric searches: 按照搜尋的欄位排序。運算子決定順序是升序還是降序：
  • 小於和小於或等於：降序
  • 所有其他運算子：遞增
  當多個搜尋結果在搜尋欄位中具有相同的值時，這些對象將按 ID 進行次要排序。
• Date searches: 按照搜尋的欄位排序。搜尋提供的日期範圍參數決定排序順序：
  • 僅提供 LastDate：降序
  • 任何其他組合：升序
  當多個搜尋結果在搜尋日期欄位具有相同的值時，這些對象將按 ID 進行次要排序。
• Multiple search criteria: 使用多個搜尋條件的搜尋結果會按 ID（升序）排序，而不考慮各個條件的預設排序順序。

限制搜尋結果和分頁

• 使用大於運算符號依 ID 搜尋
• 使用 maxItems 來設定頁面大小
• 根據上一頁結果中的最高 ID 計算要搜尋的 ID 值。

# 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