Node.js APIリファレンス

ビュー:

Trend Vision One用Node.js SDKのAPIリファレンス™ファイルセキュリティ

AmaasGrpcClient

はAmaasGrpcClient classはSDKのメインクラスであり、APIと対話するためのメソッドを提供します。

の新しいインスタンスを作成します。 AmaasGrpcClientクラス。

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

AmaasGrpcClientパラメータ

パラメータ	説明	初期値
`amaasHostName`	Trend Vision OneアカウントのFile Securityサーバのアドレスまたは地域です。リージョンは、APIキーを取得する場所です。値には、次のいずれかのVision Oneリージョンを指定する必要があります。 `ap-northeast-1` `ap-south-1` `ap-southeast-1` `ap-southeast-2` `eu-central-1` `us-east-1`
`credent`	Vision One APIキー。
`timeout`	サーバへの接続をキャンセルするタイムアウト (秒単位)。	180
`enableTLS`	トランスポート層セキュリティ (TLS) を有効または無効にします。 File Securityサーバに接続するときは、常にTLSを有効にする必要があります。	True

[Return] AmaasGrpcClientインスタンス

ファイルの検索

ファイルの不正プログラムを検索し、APIから対応データを取得します。

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

scanFileパラメータ

パラメータ	説明	初期設定値
`name`	ファイルの名前と、検索するファイルを含むディレクトリのパス。
`tags`	検索のタグ付けに使用できるタグのリスト。タグはオプションです。タグの最大数は8です。各タグの最大サイズは63文字です。
`pml`	機械学習 (PML) を有効にします。	false
`フィードバック`	トレンドマイクロ Smart Protection Network (SPN)スマートフィードバックを有効にします。	false

[Return] API対応データに解決されるPromise。

スキャンバッファ

バッファで不正プログラムを検索し、APIから対応データを取得します。

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

scanBufferパラメータ

パラメータ	説明
`fileName`	バッファの作成元のファイルまたはオブジェクトの名前。この名前は、バッファの識別に使用されます。
`buff`	検索するバッファ。
`tags`	検索のタグ付けに使用できるタグのリスト。タグはオプションです。タグの最大数は8です。各タグの最大サイズは8文字です。
`pml`	機械学習 (PML) を有効にします。	false
`フィードバック`	トレンドマイクロ Smart Protection Network (SPN)スマートフィードバックを有効にします。	false

[戻る]API対応データに解決されるPromise。

接続を閉じる

AMaaSサーバへの接続を閉じます。

close(): void

パラメータ

パラメータ	説明
なし	なし

[戻る]ボイド

ログレベルの設定

[setLoggingLevel(level: Loglevel): void]

SDKのアクティブなログレベルを設定します。この変更は、すべてのAMaaSクライアントインスタンスにグローバルに適用されます。初期設定のレベルLogLevel.OFFは、すべてのログの無効化に対応します。ログを有効にすると、ログは次の場所に書き込まれます。標準出力を使用してカスタムログが設定されている場合を除きます。 configLoggingCallback() 。

setLoggingLevelパラメータ

パラメータ	説明	初期値
`level (Loglevel)`	有効な値: LogLevel.DEBUG LogLevel.ERROR LogLevel.FATAL LogLevel.INFO LogLevel.OFF LogLevel.WARN	LogLevel.OFF

[Return] ボイド

コールバックのログ記録

SDKがログを記録するかどうかに関係なく呼び出されるカスタムコールバック関数を使用してSDKをプロビジョニングすることにより、カスタムログを設定します。

configLoggingCallBack (LogCallback: Function): void

configLoggingCallBackパラメータ

パラメータ	説明
`LogCallback`	型を持つ関数`(レベル LogLevel、メッセージ: 文字列) => void`

[Return] ボイド

AmaasScanResult

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
}