當您列出電腦時,預設會返回所有可用的電腦資訊。您可以使用
expand 查詢參數,以便只返回您感興趣的資訊。至少會返回每台電腦的基本資訊,例如電腦識別碼、策略識別碼和平台。
注意當您不包含
expand 查詢字串時,將返回所有電腦防護資訊。 |
|
返回資訊的類別
|
支援的值為
expand |
|
最少資訊
|
無 |
|
所有資訊
|
全部(預設) |
|
目前狀態
|
電腦狀態, 安全更新,任務 |
|
設定
|
computerSettings,interfaces |
|
安全模組配置
|
allSecurityModules(包含所有模組的資訊),antiMalware,applicationControl,防火牆,integrityMonitoring,intrusionPrevention,logInspection,SAP,webReputation |
|
虛擬機器資訊
|
allVirtualMachineSummaries(包含所有類型虛擬機的資訊),azureARMVirtualMachineSummary,azureVMVirtualMachineSummary,ec2VirtualMachineSummary,ESXSummary,noConnectorVirtualMachineSummary,vcloudVMVirtualMachineSummary,vmwareVMVirtualMachineSummary,workspaceVirtualMachineSummary, |
在您開始之前
您應該已經驗證過您的環境是否已設置為使用 Bash 或 PowerShell 來使用 API。
收集您需要完成此食譜的以下資訊:
- 伺服器與工作負載保護 的 URL
- 您 API 金鑰的密鑰
Bash
-
打開終端機或您偏好的命令行工具。
-
輸入以下命令來儲存有關您請求的詳細資訊,將
<YOUR URL>替換為 伺服器與工作負載保護 的 URL,並將<YOUR SECRET KEY>替換為您 API 金鑰的密鑰:-
url=<YOUR URL>例如,url=https://cloudone.trendmicro.com -
secret=<YOUR SECRET KEY>例如,secret=5C58EADA-04BC-4ABC-45CF-B72925A0B674:aFBgpPV8eJQGaY2Dk0LmyQMD7nUGvyIDfIbIQo8Zgm8= -
expand=computerStatus
-
-
輸入以下命令來指定您要儲存回應資料的 JSON 檔案,將
<FILE PATH>替換為要建立的檔案。請指定副檔名為 .json 的檔案名稱:file=<FILE PATH>例如,file=~/Documents/computers_status.json將檔案儲存在您主目錄下。 -
輸入以下命令以發送請求:
curl -X GET "$url/api/computers?expand=$expand" -H "api-secret-key: $secret" -H "api-version: v1" > $file
秘訣
-
在網頁瀏覽器中打開 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鍵包含狀態資訊。在此範例中,電腦防護未啟用。 -
(可選)嘗試更改
expand變數的值,看看它如何影響返回的 JSON。例如,輸入expand=computerProperties並重新運行curl命令。
PowerShell
-
開啟 PowerShell。
-
輸入以下命令以使用 TLS 1.2,管理員需要它來建立安全連接:
[Net.ServicePointManager]::SecurityProtocol += [Net.SecurityProtocolType]::Tls12
-
輸入以下命令來儲存有關您請求的詳細資訊,將
<YOUR URL>替換為 伺服器與工作負載保護 的 URL,並將<YOUR SECRET KEY>替換為您 API 金鑰的密鑰:-
$url = "<YOUR URL>"例如,url=https://cloudone.trendmicro.com -
$secret = "<YOUR API KEY SECRET>"例如,$secret="5C58EADA-04BC-4ABC-45CF-B72725A0B674:aFBgpPV8eJQGaY2Dk0LmyQMD7nUGvyIDfIbIQo8Zgm8=" -
$headers = @{api-version = v1; api-secret-key = $secret} -
$expand="computerStatus"
-
-
輸入以下命令來指定您要儲存回應資料的 JSON 檔案,將
<FILE PATH>替換為要建立的檔案。請指定副檔名為 .json 的檔案名稱:$file="<FILE PATH>"例如,$file="$HOME\Documents\computers_status.json"將檔案儲存在您主目錄下。 -
輸入以下命令以發送請求:
Invoke-RestMethod "$url/api/computers?expand=$expand" -Headers $headers -OutFile $file
-
在網頁瀏覽器中打開 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鍵包含狀態資訊。在此範例中,電腦防護未啟用。 -
(可選)嘗試更改
expand變數的值,看看它如何影響返回的 JSON。例如,輸入$expand="computerProperties"並重新運行Invoke-RestMethod命令。
筆記
- 如果您在文字編輯器中打開 JSON 文件,代碼會顯示在單行上,這樣很難閱讀。網頁瀏覽器通常會格式化 JSON 以便於閱讀。如果您的瀏覽器沒有自動格式化 JSON,請考慮安裝一個瀏覽器插件來實現。
- 要為
expand查詢參數包含多個值,API 呼叫中的 URL 必須為每個值包含一個expand查詢字串,例如:?expand=computerStatus&expand=computerProperties
相關資源
- 設定使用 Bash 或 PowerShell
- 列出電腦防護(API 參考)
- 電腦防護狀態報告(指南)
- 效能提示(指南)
