檢視次數:
取得Server & Workload Security保護所保護(或已偵測到)的電腦防護列表,並將返回的資料防護集中於每台電腦防護的安全狀態。使用列出電腦防護操作來獲取電腦防護列表。使用可選的expand查詢參數來集中於狀態資訊。
當您列出電腦時,預設會返回所有可用的電腦資訊。您可以使用 expand 查詢參數,以便只返回您感興趣的資訊。至少會返回每台電腦的基本資訊,例如電腦識別碼、策略識別碼和平台。
注意
注意
當您不包含 expand 查詢字串時,將返回所有電腦防護資訊。
返回資訊的類別
支援的值為
expand
最少資訊
none
所有資訊
all
(預設)
目前狀態
computerStatus
,
securityUpdates
,
tasks
設定
computerSettings
,
interfaces
安全模組配置
allSecurityModules
(包括所有模組的資訊),
antiMalware
,
applicationControl
,
firewall
,
integrityMonitoring
,
intrusionPrevention
,
logInspection
,
SAP
,
webReputation
虛擬機器資訊
allVirtualMachineSummaries
(包括所有類型的虛擬機資訊),
azureARMVirtualMachineSummary
,
azureVMVirtualMachineSummary
,
ec2VirtualMachineSummary
,
ESXSummary
,
noConnectorVirtualMachineSummary
,
vcloudVMVirtualMachineSummary
,
vmwareVMVirtualMachineSummary
,
workspaceVirtualMachineSummary
,

在您開始之前

您應該已經驗證過您的環境是否已設置為使用 Bash 或 PowerShell 來使用 API
收集您需要完成此食譜的以下資訊:
  • Server & Workload Security保護 的 URL
  • 您 API 金鑰的密鑰

Bash

  1. 打開終端機或您偏好的命令行工具。
  2. 輸入以下命令來儲存有關您請求的詳細資訊,將 <YOUR URL> 替換為 Server & Workload Security保護 的 URL,並將 <YOUR SECRET KEY> 替換為您 API 金鑰的密鑰:
    • url=<您的 URL>
      例如,url=https://cloudone.trendmicro.com
    • secret=<您的秘密金鑰>
      例如,secret=5C58EADA-04BC-4ABC-45CF-B72925A0B674:aFBgpPV8eJQGaY2Dk0LmyQMD7nUGvyIDfIbIQo8Zgm8=
    • expand=computerStatus
  3. 輸入以下命令來指定您要儲存回應資料的 JSON 檔案,將 <FILE PATH> 替換為要建立的檔案。請指定副檔名為 .json 的檔案名稱:
    file=<檔案路徑>
    例如,file=~/Documents/computers_status.json 將檔案儲存在您主目錄下。
  4. 輸入以下命令以發送請求:
    curl -X GET "$url/api/computers?expand=$expand" -H "api-secret-key: $secret" -H "api-version: v1" > $file
    秘訣
    秘訣
    要在終端機中以可讀格式列印返回的 JSON(而不是寫入檔案),請將 cURL 命令的結果通過管道傳送到 jq。在上述命令中,將 > $file 替換為 | jq .
  5. 在網頁瀏覽器中打開 JSON 文件。(網頁瀏覽器應該會格式化 JSON 以便於閱讀。)您應該會看到代表電腦防護陣列的 JSON 代碼。每台電腦防護都用類似於以下示例的代碼表示:
    {
        "hostName": "gui2-336",
        "displayName": "",
        "description": "",
        "lastIPUsed": "127.0.1.1",
        "platform": "Unknown",
        "groupID": 0,
        "policyID": 1,
        "relayListID": 0,
        "lastSendPolicyRequest": 1566335191390,
        "agentVersion": "0.0.0.0",
        "computerStatus": {
            "agentStatus": "inactive",
            "agentStatusMessages": [
                "Unmanaged (Unknown)"
            ]
        },
        "ID": 201
    }
    computerStatus 鍵包含狀態資訊。在此範例中,電腦防護未啟用。
  6. (可選)嘗試更改 expand 變數的值,看看它如何影響返回的 JSON。例如,輸入 expand=computerProperties 並重新運行 curl 命令。

PowerShell

  1. 開啟 PowerShell。
  2. 輸入以下命令以使用 TLS 1.2,管理員需要它來建立安全連接:
    [Net.ServicePointManager]::SecurityProtocol += [Net.SecurityProtocolType]::Tls12
  3. 輸入以下命令來儲存有關您請求的詳細資訊,將 <YOUR URL> 替換為 Server & Workload Security保護 的 URL,並將 <YOUR SECRET KEY> 替換為您 API 金鑰的密鑰:
    • $url = "<您的 URL>"
      例如,url=https://cloudone.trendmicro.com
    • $secret = "<您的 API 金鑰密鑰>"
      例如,$secret="5C58EADA-04BC-4ABC-45CF-B72725A0B674:aFBgpPV8eJQGaY2Dk0LmyQMD7nUGvyIDfIbIQo8Zgm8="
    • $headers = @{api-version = v1; api-secret-key = $secret}
    • $expand="computerStatus"
  4. 輸入以下命令來指定您要儲存回應資料的 JSON 檔案,將 <FILE PATH> 替換為要建立的檔案。請指定副檔名為 .json 的檔案名稱:
    $file="<檔案路徑>"
    例如,$file="$HOME\Documents\computers_status.json"將檔案儲存在您主目錄下。
  5. 輸入以下命令以發送請求:
    Invoke-RestMethod "$url/api/computers?expand=$expand" -Headers $headers -OutFile $file
  6. 在網頁瀏覽器中打開 JSON 文件。(網頁瀏覽器應該會格式化 JSON 以便於閱讀。)您應該會看到代表電腦防護陣列的 JSON 代碼。每台電腦防護都用類似於以下示例的代碼表示:
    {
        "hostName": "gui2-336",
        "displayName": "",
        "description": "",
        "lastIPUsed": "127.0.1.1",
        "platform": "Unknown",
        "groupID": 0,
        "policyID": 1,
        "relayListID": 0,
        "lastSendPolicyRequest": 1566335191390,
        "agentVersion": "0.0.0.0",
        "computerStatus": {
            "agentStatus": "inactive",
            "agentStatusMessages": [
                "Unmanaged (Unknown)"
            ]
        },
        "ID": 201
    }
    computerStatus 鍵包含狀態資訊。在此範例中,電腦防護未啟用。
  7. (可選)嘗試更改 expand 變數的值,看看它如何影響返回的 JSON。例如,輸入 $expand="computerProperties" 並重新運行 Invoke-RestMethod 命令。

筆記

  • 如果您在文字編輯器中打開 JSON 文件,代碼會顯示在單行上,這樣很難閱讀。網頁瀏覽器通常會格式化 JSON 以便於閱讀。如果您的瀏覽器沒有自動格式化 JSON,請考慮安裝一個瀏覽器插件來實現。
  • 要為 expand 查詢參數包含多個值,API 呼叫中的 URL 必須為每個值包含一個 expand 查詢字串,例如:?expand=computerStatus&expand=computerProperties

相關資源