解析ステータスを確認する
URLは analyze APIへのリクエストに応じて Location ヘッダーの一部として返されます。 これはHTTP GET を介して解析ジョブのステータスを照会するために使用されます。 分析ジョブが終了すると、レスポンスの本文には結果出力をダウンロードできるURL、またはURLのリストが含まれています。 HTTPステータスコードの200が返されるまで、このURIを呼び出しが継続されます。 ジョブが継続している間は、 analyze から返されたURIと同じURIを含む Location のヘッダを含むHTTPステータスコードの202が返されます。 コード200の応答が返されると、 resultFileUris のプロパティにはzipファイルが作成され、ダウンロードが可能な単一または複数の出力の場所が含まれています。 Static Analysis Results Interchange Format (SARIF) V2 形式のファイルは、このダウンロードされたzipファイルに含まれており、分析の結果を含む JSON 形式のファイルとなります。 応答の本体部分には、検出された問題数の要約を含む IssueSummary オブジェクトが含まれています。
Note
状態チェックの間隔は 15～60 秒空けることをお勧めします。 分析の実行には通常 1～5 分かかります。
このAPIには、分析ジョブを開始した同じクライアント アプリケーションのトークンである必要がある OAuth トークンが必要です。
ヘッダー
| 件名 | タイプ | 予測値 | 必須? |
|---|---|---|---|
| 認可 | string | OAuth アプリケーションIDクレームを含む1つのベアラー トークン。 Microsoft Entra | yes |
| x-ms-tenant-id | GUID | アプリケーションのテナントの ID。 | はい |
| x-ms-correlation-id | GUID | 解析実行の識別子 処理の全体 (アップロード、解析、状態) で同じIDを指定する必要があります | はい |
想定される反応
| HTTP 状態コード | シナリオ | 結果 |
|---|---|---|
| 200 | 1つまたは複数の結果が見つかりました | 以下の例を参照してください。 1件の結果が見つかりました。 |
| 202 | 処理中 | 以下の例を参照してください。 1件の結果が見つかりました。 |
| 403 | 許可されていません | 要求元が分析要求の依頼者と同じではありません。 |
| 404 | 見つかりません | URLに指定された参照を持つ分析要求が見つかりません。 |
予想回答ヘッダー
| Name | 型 | 予測値 | 必須? |
|---|---|---|---|
| Location | URI | 現在の状態を照会して結果の取得に使用するURI | はい |
想定される本文の反応
次の表に、各要求に対する応答の構造概要を示します(HTTP200または202応答のみ)。
| プロパティ | 型 | 予測値 | 必須? |
|---|---|---|---|
| privacyPolicy | 文字列 | プライバシーポリシーのURI。 | あり |
| 進捗状況 | int | 0 から 100 パーセントの範囲で処理完了までの進捗の値を表します。10 と表示された場合は処理が約10%完了したことを示します。 | あり |
| runCorrelationId | GUID | それぞれの処理要求に含まれる要求の識別子。 必要に応じて、これを使用して要求に関連付けることができます。 | あり |
| 状態 | 文字列 | InProgress ジョブがまだ処理中の場合に返されます。 Failed サーバー上でジョブを処理中に重大な問題が発生したときに返されます。 エラー プロパティには、詳細情報が含まれています。 Finished ジョブが問題なく正常に完了すると返されます。 FinishedWithErrors ジョブは正常に完了しましたが、1つ以上のルールがエラーなしで完了できなかった場合に返されます。 これは、レポートが完了していない可能性があることを通知します。 Microsoft バックエンドでのこれらの問題を認識しており、問題の診断と解決に取り組んでいます。 |
あり |
| resultFileUris | 文字列の配列 | アウトプットを直接ダウンロードできるURIのリスト。 元の解析APのI呼び出しに含まれていたファイルごとに1つずつ存在する必要があります。 | いいえ。 これは処理が完了した場合にのみ含まれます。 |
| issueSummary | IssueSummary | 以下がプロパティのリストです | いいえ。 これは処理が完了した場合にのみ含まれます。 |
| issueSummary.criticalIssueCount | int | 結果にて重大な深刻性を示した問題の数 | あり |
| issueSummary.highIssueCount | int | 結果にて高い深刻性を示した問題の数 | あり |
| issueSummary.mediumIssueCount | int | 結果にて中程度の深刻性を示した問題の数 | あり |
| issueSummary.lowIssueCount | int | 結果にて低い深刻性を示した問題の数 | あり |
| issueSummary.informationalIssueCount | int | 結果にて深刻性を示した問題の数 | あり |
例: 完了時のステータスチェック
この例では、ステータス チェック呼び出しを行い、結果を完了に更新します。
リクエスト
GET [Geographical URI]/api/status/aaaa0000-bb11-2222-33cc-444444dddddd&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
応答
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
{
"privacyPolicy":"https://go.microsoft.com/fwlink/?LinkID=310140",
"progress":100,
"resultFileUris":["https://fakeblob.blob.core.windows.net/report-files/mySolution.zip?sv=2017-11-09&sr=b&sig=xyz&se=2019-06-11T20%3A27%3A59Z&sp=rd"],"runCorrelationId":"aaaa0000-bb11-2222-33cc-444444dddddd","status":"Finished","issueSummary":
{
"informationalIssueCount":0,
"lowIssueCount":0,
"mediumIssueCount":302,
"highIssueCount":30,
"criticalIssueCount":0
}
}
関連項目
Power Apps チェッカーウェブAPIを使用する
ルールセットのリストを取得する
ルールのリストを取得する
ファイルをアップロードする
分析を呼び出す