Node.js API-Referenz | Trend Micro Service Central

AmaasGrpcClient

Die AmaasGrpcClient-Klasse ist die Hauptklasse des SDK und bietet Methoden zur Interaktion mit der API.

Erstellen Sie eine neue Instanz der AmaasGrpcClient-Klasse.

constructor( amaasHostName: string, credent: string, timeout: number | undefined = 180, enableTLS: boolean | undefined = true)

AmaasGrpcClient-Parameter

Parameter	Beschreibung	Standardwert
`amaasHostName`	Die Adresse des File Security Servers oder die Region Ihres Trend Vision One-Kontos. Die Region ist der Ort, an dem Sie Ihren API-Schlüssel erhalten. Der angegebene Wert muss eine der Vision One-Regionen sein, zum Beispiel: `ap-northeast-1` `ap-south-1` `ap-southeast-1` `ap-southeast-2` `eu-central-1` `us-east-1`
`credent`	Ihr Vision One API-Schlüssel.
`timeout`	Zeitüberschreitung zum Abbrechen der Verbindung zum Server, in Sekunden.	180
`enableTLS`	Aktivieren oder deaktivieren Sie die Transportschichtsicherheit (TLS). Sie sollten TLS immer aktivieren, wenn Sie eine Verbindung zum File Security Server herstellen.	Wahr

Return Eine AmaasGrpcClient-Instanz

Datei durchsuchen

Eine Datei auf Malware durchsuchen und Antwortdaten von der API abrufen.

scanFile (name: string, tags?: string[]), Promise<AMaaSScanResultObject

scanFile-Parameter

Parameter	Beschreibung	Standardwert
`name`	Der Name der Datei mit dem Pfad des Verzeichnisses, das die zu durchsuchende Datei enthält.
`tags`	Die Liste der Tags, die verwendet werden können, um den Scan zu taggen. Tags sind optional. Die maximale Anzahl von Tags beträgt acht. Die maximale Größe jedes Tags beträgt 63 Zeichen.
`pml`	Ermöglicht Vorausschauendes Maschinenlernen (PML).	false
`feedback`	Aktiviert Trend Micro Smart Protection Network (SPN) Smart Feedback.	false

Return Ein Promise, das die API-Antwortdaten auflöst.

Puffer durchsuchen

Einen Puffer auf Malware durchsuchen und Antwortdaten von der API abrufen.

scanBuffer(fileName: string, buff: buffer, tags?: string[]): Promise<AmaasScanResultObject>

scanBuffer-Parameter

Parameter	Beschreibung
`fileName`	Der Name der Datei oder des Objekts, aus dem der Puffer erstellt wird. Der Name wird zur Identifizierung des Puffers verwendet.
`buff`	Der zu DURCHSUCHENDE Puffer.
`tags`	Die Liste der Tags, mit denen der Scan markiert werden kann. Tags sind optional. Die maximale Anzahl an Tags beträgt acht. Die maximale Größe jedes Tags beträgt acht Zeichen.
`pml`	Ermöglicht Vorausschauendes Maschinenlernen (PML).	false
`feedback`	Aktiviert Trend Micro Smart Protection Network (SPN) Smart Feedback.	false

Return Ein Versprechen, das die API-Antwortdaten auflöst.

Verbindung schließen

Verbindung zum AMaaS-Server trennen.

close(): void

Parameter schließen

Parameter	Beschreibung
Keine	Keine

Return Leere

Legen Sie die Protokollebene fest

setLoggingLevel(level: Loglevel): void

Konfigurieren Sie die aktive Protokollierungsebene des SDK. Die Änderung gilt global für alle AMaaS-Client-Instanzen. Die Standardebene, LogLevel.OFF, entspricht der Deaktivierung aller Protokollierungen. Wenn die Protokollierung aktiviert ist, werden Protokolle in stdout geschrieben, es sei denn, eine benutzerdefinierte Protokollierung wird mit configLoggingCallback() konfiguriert.

setLoggingLevel-Parameter

Parameter	Beschreibung	Standardwert
`level (Loglevel)`	Gültige Werte: LogLevel.DEBUG LogLevel.ERROR LogLevel.FATAL LogLevel.INFO LogLevel.AUS LogLevel.WARN	LogLevel.AUS

Return Leere

Protokollierungs-Callback

Richten Sie benutzerdefiniertes Logging ein, indem Sie das SDK mit einer benutzerdefinierten Callback-Funktion bereitstellen, die aufgerufen wird, wenn das SDK ein Protokoll aufzeichnen möchte.

configLoggingCallBack (LogCallback: Function): void

configLoggingCallBack-Parameter

Parameter	Beschreibung
`LogCallback`	Eine Funktion mit dem Typ `(level LogLevel, message: string) => void`

Return Leere

AmaasScanErgebnis

Die AmaasScanResultObject-Schnittstelle definiert die Struktur der Antwortdaten, die von unserer API abgerufen werden. Die folgenden Felder sind in der Schnittstelle enthalten.

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
    },
  ];
}

Protokollebene

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