檢視次數:

Trend Vision One™ 檔案安全的 Node.js SDK API 參考

AmaasGrpcClient

AmaasGrpcClient 類別是 SDK 的主要類別，提供與 API 互動的方法。
建立 AmaasGrpcClient 類別的新實例。
constructor( amaasHostName: string, credent: string, timeout: number | undefined = 180, enableTLS: boolean | undefined = true)

AmaasGrpcClient 參數

參數
說明
預設值
amaasHostName
File Security 伺服器位址或您 Trend Vision One 帳戶的區域。區域是您取得 API 金鑰的 位置資訊。提供的值必須是 Vision One 區域之一，例如：
  • ap-northeast-1
  • ap-south-1
  • ap-southeast-1
  • ap-southeast-2
  • eu-central-1
  • us-east-1
憑證
您 Vision One 的 API 金鑰。
逾時
取消與伺服器連接的超時時間，以秒為單位。
180
enableTLS
啟用或關閉傳輸層安全性 (TLS)。連接到檔案安全伺服器時，您應該始終啟用 TLS。
True
Return 一個 AmaasGrpcClient 實例

掃瞄檔案

掃瞄檔案以檢測惡意程式並從 API 獲取回應資料。
scanFile (name: string, tags?: string[]), Promise<AMaaSScanResultObject

scanFile 參數

參數
說明
預設值
名稱
包含要掃瞄檔案的目錄路徑的檔案名稱。
  
標籤
可用來標記掃瞄的標籤列表。標籤是可選的。標籤的最大數量為八個。每個標籤的最大長度為63個字元。
  
pml
啟用 Machine Learning (PML)。
false
反饋
啟用趨勢科技主動雲端截毒技術 (SPN) Smart Feedback。
false
Return 一個承諾，解析為 API 回應資料。

掃瞄緩衝區

掃瞄緩衝區以檢測惡意程式並從 API 獲取回應資料。
scanBuffer(fileName: string, buff: buffer, tags?: string[]): Promise<AmaasScanResultObject>

scanBuffer 參數

參數
說明
  
fileName
檔案或物件的名稱，該緩衝區是從中建立的。名稱用於識別緩衝區。
  
緩衝區
要掃瞄的緩衝區。
  
標籤
可用來標記掃瞄的標籤列表。標籤是可選的。標籤的最大數量為八個。每個標籤的最大長度為八個字元。
  
pml
啟用 Machine Learning (PML)。
false
反饋
啟用趨勢科技主動雲端截毒技術 (SPN) Smart Feedback。
false
Return 一個承諾，解決 API 回應資料。

關閉連線

關閉與AMaaS伺服器的連接。
close(): void

關閉參數

參數
說明
none
none
Return 無效

設定日誌級別

setLoggingLevel(level: Loglevel): void
配置 SDK 的活動日誌級別。此變更將全域應用於所有 AMaaS Client 實例。預設級別 LogLevel.OFF 對應於所有日誌已禁用。當日誌已啟動時，日誌將寫入 stdout，除非使用 configLoggingCallback() 配置了自定義日誌。

setLoggingLevel 參數

參數
說明
預設值
層級 (Loglevel)
有效值：
  • LogLevel.DEBUG
  • LogLevel.ERROR
  • LogLevel.FATAL
  • LogLevel.INFO
  • LogLevel.OFF
  • LogLevel.WARN
LogLevel.OFF
Return 無效

記錄回調

透過提供自訂回呼函數來設置自訂日誌記錄，該函數會在 SDK 想要記錄日誌時被調用。
configLoggingCallBack (LogCallback: Function): void

configLoggingCallBack 參數

參數
說明
LogCallback
具有類型 (level LogLevel, message: string) => void 的函數
Return 無效

Amaas掃描結果

AmaasScanResultObject 介面定義了從我們的 API 獲取的回應資料防護的結構。以下是介面中的欄位。
interface AmaasScanResultObject {
  scanTimestamp: string        // Timestamp of the scan in ISO 8601 format
  version: string              // Scan result schema version
  fileName: string             // Name of the file scanned
  scanId: string               // ID of the scan
  scanResult: number           // Number of malwares found. A value of 0 means no malware was found
  foundMalwares: [             // A list of malware names and the filenames found by AMaaS
    {
      fileName: string; // File name which found the malware
      malwareName: string; // Malware name
    },
  ];
}

日誌層級

enum LogLevel {
  OFF, // 0
  FATAL, // 1
  ERROR, // 2
  WARN, // 3
  INFO, // 4
  DEBUG, // 5
}