檢視次數:

Trend Vision One™ 檔案安全的 Java SDK API 參考

AMaasClient

AMaasClient 類別是 SDK 的主要類別，並提供使用 AMaaS 掃描服務的方法。
建立新的 AmaasClient 類別實例，並配置基本設置，包括驗證/授權憑證（API 金鑰），例如首選服務區域。
public AMaasClient (String region, String apikey, long timeoutInSecs, boolean enabledTLS) throw AMaasException

AMaaS 客戶端實例參數

參數
說明
區域
與您的 API 金鑰對應的區域。提供的值必須是 Trend Vision One 區域之一：
  • ap-northeast-1
  • ap-south-1
  • ap-southeast-1
  • ap-southeast-2
  • eu-central-1
  • us-east-1
apikey
您的 Trend Vision One API 金鑰。
timeoutInSecs
取消伺服器連線的逾時時間（以秒為單位）。預設值為 0，最大值為 180 秒。
enabledTLS
啟用或關閉 TLS。連接到 AMaaS 伺服器時應始終啟用 TLS。
返回 AMaaS 客戶端實例。

建立實例

創建一個新的 AmaasClient 類實例，並配置基本設置，包括驗證/授權憑證（API 金鑰）、首選服務區域等。enabledTLS 默認為 true。
public AMaasClient(String region, String apiKey, long timeoutInSecs) throws AMaasException

AMaasClient 實例參數

參數
說明
區域
與您的 API 金鑰對應的區域。提供的值必須是 Trend Vision One 區域之一：
  • ap-northeast-1
  • ap-south-1
  • ap-southeast-1
  • ap-southeast-2
  • eu-central-1
  • us-east-1
apikey
您的 Trend Vision One API 金鑰
timeoutInSecs
超時（以秒為單位）以取消與伺服器的連接。預設為 0，最大為 180 秒。
Return 一個 AMaasClient 實例

掃瞄檔案

掃瞄檔案以檢測惡意程式並從 API 獲取回應資料。
public String scanFile(string fileName) throws AMaasException

參數

參數
說明
檔案名稱
包含要掃瞄檔案的檔案目錄路徑的檔案名稱。
Return 以 JSON 格式顯示掃描結果。

掃瞄緩衝區

掃瞄緩衝區以檢測惡意程式並從 API 獲取回應資料。
public String scanBuffer(byte[] buffer, String identifier) throws AMaasException

參數

參數
說明
緩衝區
要掃瞄的位元緩衝區
識別碼
用於識別緩衝區的唯一名稱
Return以 JSON 格式顯示掃描結果。

Amaas掃描結果

AmaasScanResult 包含從 Trend Vision One™ API 檢索的回應資料的資料元素。該類別具有以下私有成員。每個成員都有 getter 和 setter 方法。
public class AmaasScanResult {
  private String version;               // API version
  private int scanResult;               // Number of malwares found. A value of 0 means no malware was found
  private String scanId;                // ID of the scan
  private String scanTimestamp;         // Timestamp of the scan in ISO 8601 format
  private String fileName:              // Name of the file scanned
  private MalwareItem[] foundMalwares;  // A list of malware names and the filenames found by AMaaS

  // getter and seter methods for the above private variables.
}

惡意軟體項目

MalwareItem 包含從我們的 API 檢索到的回應資料中檢測到的惡意程式資訊。該類別具有以下私有成員。每個成員都有 getter 和 setter 方法。
public class MalwareItem {
  private String malwareName;           // A detected Malware name
  private String fileName:              // File name that the malware is detected.

  // getter and seter methods for the above private variables.
}

AMaasException

AMaasException 類別是 AMaaS SDK 的例外類別。
public final class AMaasException extends Exception {
  private AMaasErrorCode erroCode;

  public AMaasException(AMaasErrorCode erroCode, Object... params) {
    ...
  }
}

AMaasErrorCode

AMaasErrorCode 是一個列舉類型，包含由 AMaasException 類別拋出的所有錯誤狀況。

錯誤條件

列舉型別
錯誤訊息範本
說明
MSG_ID_ERR_INVALID_REGION
%s 不是支援的地區。
提供給 AMaasClient 構造函數的區域代碼不是有效的區域。
MSG_ID_ERR_MISSING_AUTH
必須提供 API 金鑰才能使用客戶端。
提供給 AMaasClient 構造函數的 API 金鑰不能為空或 null。
MSG_ID_ERR_KEY_AUTH_FAILED
您未通過身份驗證。C1 令牌或 API 金鑰無效。
API 金鑰無效。請確保使用正確的 Trend Vision One API 金鑰。
MSG_ID_ERR_FILE_NOT_FOUND
無法開啟檔案。沒有此目錄或檔案 %s。
找不到指定的檔案。請確保檔案存在。
MSG_ID_ERR_FILE_NO_PERMISSION
無法開啟檔案。沒有權限開啟 %s。
存在檔案存取權限問題。請確保 SDK 對該檔案具有讀取權限。
MSG_ID_GRPC_ERROR
收到 gRPC 狀態碼 %d，訊息：%s。
報告了一個 gRPC 錯誤，狀態碼為 https://grpc.github.io/grpc/core/md_doc_statuscodes.html。詳情請參閱 gRPC 狀態碼。
MSG_ID_ERR_UNEXPECTED_INTERRUPT
遇到意外中斷。
客戶端收到意外的中斷信號。

執行緒安全性

scanFile() 和 scanBuffer() 都被設計為線程安全。它們應該能夠從多個線程同時調用 scanFile()，而無需使用互斥鎖或其他同步機制來保護 scanFile()。