非構造化データの DLP コンテンツ検査ジョブの開始 (非同期)

このAPIは、DLP（データ損失防止）コンテンツ検査ジョブをスケジュールするための非同期エンドポイントです。このAPIは検査対象コンテンツを受け取り、非同期処理のためのジョブID、または利用可能な場合はキャッシュからの即時結果を返します。

このエンドポイントには、いくつかの追加の制限事項があります。

• Max File Size: 1 megabyte
• Max DLP Profiles: 100
• Character Length of Each Profile name: 256文字

リクエストエンドポイント

POST

https://<appliance_ip>/inspections/jobs

呼び出し例

curl -X 'POST' \
  'https://10.0.0.1/inspections/jobs' \
  -H 'accept: multipart/form-data' \
  -H 'x-netskope-generate-incidents: true' \
  -H 'Content-Type: multipart/form-data' \
  -F 'request={"profiles":["DLP-PCI","DLP-PII"],"content":{"id":"b1f793e4d4a26ac7b695bb1fd1fb0ce3cb5d729c401d8528f8bb92598006cf85","name":"SecretFile.txt","object_id":"AA-74GXZ","true_file_type":230},"modules":{"file_filter":{"skip":true},"drm":{"labels":[{"id":"c7d03ebd-804d-489c-94c6-8167224c3c1b","name":"chris_encryption_all_enabled","instance":"epdlpsjc1","vendor":"mip"}]}},"results":{"verdict":"summary"},"sender":{"app_name":"AWS_RDS"}}' \
  -F 'content=@SecretFile.txt;type=text/txt'

回答例

#A cached hit was found, therefore no job was scheduled. The results are returned in json.
#200 Response
HTTP/1.1 200 OK
Content-Type: multipart/form-data; boundary=8b9eb155309408d78d1886c2af2803fdba94a7bea3dac274b3da5fa31e92

--8b9eb155309408d78d1886c2af2803fdba94a7bea3dac274b3da5fa31e92
Content-Disposition: form-data; name="result_data"
Content-Type: application/json

{"status":"success","summary":{"profiles":["DLP-PCI","DLP-PII"],"transaction_id":"3947352303853909965","verdict":"hit","verdict_type":"full"}}
--8b9eb155309408d78d1886c2af2803fdba94a7bea3dac274b3da5fa31e92--

#No prior request is found and a new job is started.
#202 Response
{
  "job_id": "8a426a5f-0d2e-0a2e-3595a-303202a7a2e"
}

リクエストヘッダーx-netskope-generate-incidentsが追加されるのは、ユーザーがアラートやインシデントの生成方法を指定できるようにするためです。

レスポンスヘッダーも作成されました: x-netskope-incidents-posted 。レスポンスヘッダーには、アラートとインシデントが管理プレーンに投稿されたかどうかが反映されます。

Valid Query Parameters are:

名前	In	タイプ	Required	デスクリプション
body	body	object	true	none
" リクエスト	body	object	true	検査依頼のプロパティを指定します。
»» プロフィール	body		true	スキャン中に使用するプロファイルのリスト。 プロファイルは、一致するものを検索する際にどの DLP ルールを使用するかを決定します。 一致を検索する際に。
"" コンテンツ	body		true	リクエストの一部としてDLPに送信されるコンテンツについて説明します。
»»» id	body	string	true	コンテンツのSHA256ハッシュ
»»» name	body	string	false	名前（例）コンテンツのファイル名)
»»» オブジェクトID	body	string	false	データのオブジェクト識別子。
»»» 真のファイルタイプ	body	integer	false	Netskopeの真のファイルタイプ（数値ID）
»» modules	body		false	検査中に実行される個々のDLPモジュールの設定を指定します。 検査中。
»»» ファイルフィルター	body	object	false	ファイルフィルタモジュールの設定を指定します。
»»»» スキップ	body	boolean	false	条件が真の場合、ファイルフィルタリングはスキップされます。
»»» drm	body	object	false	DLPに明示的なDRMラベルを渡すことを可能にします。
»»»» labels	body	[物体]	true	none
»»»»» id	body	string	true	ラベルのID。
»»»»» name	body	string	false	ラベルの名前。
""""" 実例	body	string	false	ラベルのインスタンス。
»»»»» vendor	body	string	true	ラベルの販売業者。
"" 結果	body	object	false	検査から返されるDLPオンデマンド結果のプロパティを指定します。
»»» 判決	body	string	false	返される試合の詳細情報の量を指定します。次のいずれかが返されます: summary – 判決の要約が返されます。これには、結果、判決の種類、プロファイルのリスト、重大度が含まれます。 details – 試合の詳細が含まれます。判決に関する詳細は、結果の一致、プロファイル、およびファイルごとのルールを含みます。 forensics – 試合の概要、詳細、および鑑識結果が含まれます。ルール情報、一致したテキスト、抽出されたコンテンツなど、試合に関するすべての詳細情報が返されます。ご注意ください。この操作を行うと、ファイル全体のフルスキャンが実行されます。判決が指定されていない場合は、デフォルトで要約タイプとなり、判決の要約が返されます。
»» 送信者	body		false	リクエストの呼び出し元について説明します。
»»» アプリ名	body	string	true	呼び出しをトリガーしたアプリケーション
" コンテンツ	body	文字列（バイナリ）	true	none

Enumerated Values

パラメータ	Value
»»» 判決	summary
	details
	forensics

Responses

状態	Meaning	デスクリプション	Schema
200	OK	以前のリクエストが見つかりました。これはキャッシュされたレスポンスです。結果はJSON形式で返されます。	列をなして
202	Accepted	リクエストが承認されたことを示します。これは正常で、予想される結果です。	列をなして
400	要求の形式が正しくありません	リクエストは無効でした。レスポンスには、リクエストが拒否された原因となったエラー情報が含まれています（利用可能な場合）。	string
413	ペイロードが大きすぎる	指定されたコンテンツは大きすぎるため、スキャンできません。	なし
500	内部サーバーエラー	リクエストの実行中にエラーが発生しました。レスポンスには、リクエストが拒否された原因となったエラー情報が含まれています（利用可能な場合）。	string
503	サービスは利用できません	リクエストを実行するためのリソースがありません。	なし

allOf

名前	タイプ	Required	制限	デスクリプション
»»»»» anonymous		false	none	プロフィール名。

and

名前	タイプ	Required	制限	デスクリプション
»»»»» anonymous	any	false	none	一致するルールが関連付けられているプロファイル。

continued

名前	タイプ	Required	制限	デスクリプション
»»»» action_threshold_met	boolean	true	none	真の場合、アクションしきい値に達したことを意味し、DLPクライアントはこのプロファイルに関連付けられたアクションを実行する必要があります。このフィールドがfalseの場合、アクションのしきい値に達していないため、このプロファイルに関連付けられたアクションは実行されません。
»»»» 最大重症度	string	false	none	一致するルールの最大厳格度。
»»»» ルール	[物体]	false	none	none
»»»»» name	string	true	none	ルールの名称。
""""" 重大度	string	true	none	ルールの厳しさが響いた。以下のいずれか： none low medium high critical
""""" タイプ	string	true	none	ルールの種類。次のいずれか: entity : 特定のエンティティが見つかったときに一致するルール。これらのルールに一致する場合、エンティティのサブフィールドが存在します。 not_entity : 特定のエンティティが見つからない場合に一致するルール。これらのルールに一致する場合、エンティティのサブフィールドが存在します。 file_filter : ファイルフィルタルール。分類 分類規則。指紋 指紋に関する規則。これらのルールに一致する場合、指紋サブフィールドが存在します。fingerprint_group : フィンガープリント 2.0 グループルール。これらのルールに一致する場合、 fingerprint_groupサブフィールドが存在します。 structured_classification ：構造化された分類ルール。これらのルールに一致する場合、 structured_classificationサブフィールドが存在します。
»»»»» entity	object	false	none	Contains details about the entity rule that matched. This field is present when type is entity or not_entity.
»»»»»» 加重平均	boolean	true	none	If true this rule is using the weighted score to determine the severity. If false, count is being used.
"""""" スコア	integer	true	none	ルールの加重スコアは一致しています。
»»»»»» 制限に達しました	boolean	true	none	もしこれが真実であれば、このルールにおける最大一致数に達したことになります。これは、特定されたデータの一部が結果から除外されたことを意味します。
»»»»»» エンティティの概要		true	none	一致したエンティティとそのエンティティに対応するカウントの配列。
»»»»»»» entity	string	true	none	一致したエンティティの名前。
»»»»»»» カウント	integer	true	none	指定されたエンティティが一致した回数。
»»»»»»» データ型		false	none	このエンティティを記述する一般的なデータ型。
»»»»»»» 感度レベル		true	none	ルールの厳しさが響いた。以下のいずれか： none low medium high critical
»»»»»» マッチ数	integer	true	none	エンティティルールが一致する件数。
»»»»»» 感度レベル		true	none	このエンティティはどの程度感度の高い一致ですか？以下のいずれか： not_sensitive low medium high critical
»»»»»» ユニークカウント	integer	false	none	ルールに一致した固有のエントリの数。このフィールドは、プロファイルでルールを一意にカウントするように指定されている場合にのみ表示されます。
»»»»» 構造化分類	object	false	none	一致する分類タイプルールの詳細
»»»»»» エンティティの概要		true	none	一致したエンティティとそのエンティティに対応するカウントの配列。
»»»»»» マッチ数	integer	true	none	エンティティルールが一致する件数。
»»»»»» 感度レベル		true	none	このエンティティはどの程度感度の高い一致ですか？の 1 つ not_sensitive low medium high critical
»»»»»» データ型		false	none	このエンティティを記述する一般的なデータ型。
»»»»» 指紋	object	false	none	This field is present when type is fingerprint.
»»»»»» 分類	string	true	none	一致した分類。
"""""" マッチ	string	true	none	一致したファイル。
"""""" スコア	integer	true	none	一致した指紋のスコア。
»»»»» 指紋グループ	object	false	none	This field is present when type is fingerprint_group.
"""""" マッチ	string	true	none	一致した指紋ファイル。
"""""" スコア	integer	true	none	一致した指紋ファイルの類似度スコア。
»»» 鑑識	object	false	none	none
»»»» 抽出されたテキスト	string(string)	false	none	文字列識別子使うは、抽出されたテキストをマルチパート応答の対応する部分と相関させるためです
»»»» エンティティルールが一致する	string(string)	false	none	エンティティルールをマルチパート応答の対応する部分と一致させるための文字列識別子使う。
»»»» プレビュー画像	string(string)	false	none	文字列識別子使うはプレビュー画像をマルチパート応答の対応する部分と相関させます。
»»»» オリジナルサブファイル	string(string)	false	none	文字列識別子 元のサブファイルをマルチパートレスポンス内の対応する部分と関連付けるために使用されます。

Enumerated Values

Property	Value
検査状況: ステータス	success
	timeout
	error
verdict	hit
	no_hit
verdict_type	full
	partial
重大度	none
	low
	medium
	high
	critical
MicrosoftAipProtectionStation: ステータス	protected
	unsanctioned
	sanctioned
重大度	none
	low
	medium
	high
	critical
タイプ	entity
	not_entity
	file_filter
	classification
	fingerprint
	fingerprint_group
	structured_classification
sensitivity_level	not_sensitive
	low
	medium
	high
	critical

ステータスコード 202

このオブジェクトは、DLPがリクエストを受け入れ、非同期で処理することを示すために、非同期検査リクエストのためにDLPオンデマンドアプライアンスに返されます。

名前	タイプ	Required	制限	デスクリプション
» job_id		true	none	リクエスト固有のトークン。

この操作には認証は必要ありません