分析の呼び出し

[アーティクル]
10/16/2024

分析ジョブは、POST 要求を analyze ルートに送信することによって開始されます。分析は、通常 1 分以上続く長時間のプロセスです。 API はまず何らかの基本的な検証を行い、ジョブを送信することでバックエンドで要求を開始し、そしてス状態コード 202 と Location ヘッダー、あるいは適切なエラーの詳細で応答します。 Location ヘッダー値は、要求の状態を確認し、その結果の URL を取得するために使うことができます。ルールやルールセットのリスト、分析から除外するファイルなど、基準に基づいてジョブを調整する POST アクションによるさまざまなオプションがあります。次を使用して分析を開始できます。[Geographical URL]/api/analyze?api-version=1.0。

Note

状態チェックの間隔は 15～60 秒空けることをお勧めします。分析の実行には通常 1～5 分かかります。
このAPIには OAuth トークンが必要です。

ヘッダー

件名	タイプ	予測値	必須?
認可	string	IDアプリケーションIDクレームを持つ OAuth 1つのベアラートークン。 Microsoft Entra	yes
x-ms-tenant-id	GUID	アプリケーションのテナントの ID。	はい
x-ms-correlation-id	GUID	分析実行の識別子。実行全体 (アップロード、分析、状態) に同じ ID を指定する必要があります。	はい
引き受け	object	`application/json, application/x-ms-sarif-v2`	はい
言語の承諾	文字列	言語コード (例: en-US)。既定値は en-US です。複数の言語が提供されている場合は、最初の言語が優先されます。ただし、すべての翻訳 (言語がサポートされている場合) が含まれます。	無効

本文

通常オプション:

プロパティ	型	予想値	必須?
sasUriList	文字列の配列	単一のソリューション、複数のソリューションファイルを含む zip ファイル、またはパッケージをダウンロードするためのサービスアクセスを提供する URI の一覧。	あり
ruleSets	カスタムの配列	0 以上	無効
ruleSets.id	guid	ルールセットの ID。ルールセット API のクエリを行うことにより見つけることができます。	いいえ、でもこれは通常使うものです。これか、ruleCodes を使う必要があります。
ruleCodes.code	文字列	望ましいルールの ID。ルールセット API およびルール API のクエリを行うことにより見つけることができます。	いいえ、これか、ruleSets を使う必要があります。
fileExclusions	文字列の配列	除外するファイル名またはファイル名パターンの一覧。ファイル名の先頭または末尾にワイルドカードとして "" を使用するためのサポートが存在します (例: jquery.dll、jquery)。	番号

予想回答率

HTTP 状態コード	シナリオ	Result
202	分析要求が受け入れられ、状態チェック URI が `Location` ヘッダーに返されました	本体に結果が見つかりませんでした
400	zip 以外のファイルが送信されたか、パラメーターが正しくないか、ファイルにウイルスに含まれていました	本体に結果が見つかりませんでした
409	重複した `x-ms-correlation-id` ヘッダー値の要求が送られました	本体に結果が見つかりませんでした

予想回答ヘッダー

Name	型	予想値	必須?
Location	Uri	現在の状態のクエリと結果の取得に使用する URL	はい

例: 分析の開始

これは、AppSource認証 ルールセット、単一ファイル、そして名前にテキスト jquery および json を含む除外ファイルで分析ジョブを開始する例です。

リクエスト

POST [Geographical URI]/api/analyze?api-version=1.0
Accept: application/json
Content-Type: application/json; charset=utf-8
x-ms-correlation-id: aaaa0000-bb11-2222-33cc-444444dddddd
x-ms-tenant-id: aaaabbbb-0000-cccc-1111-dddd2222eeee

{
    "ruleSets": [{
        "id": "0ad12346-e108-40b8-a956-9a8f95ea18c9"
    }],
    "sasUriList": ["https://testenvfakelocation.blob.core.windows.net/mySolution.zip"],
    "fileExclusions": ["*jquery*", "*json*"]
}

応答

HTTP/1.1 202 Accepted
Content-Type: application/json; charset=utf-8
Location: [Geographical URI]/api/status/aaaa0000-bb11-2222-33cc-444444dddddd&api-version=1.0

次の方法で共有

分析の呼び出し

ヘッダー

本文

通常オプション:

予想回答率

予想回答ヘッダー

例: 分析の開始

関連項目

フィードバック

その他のリソース