Überprüfen des Analysestatus

Artikel
10/16/2024

Eine URL wird als Bestandteil der Location-Kopfzeile als Antwort auf eine Anfrage an die analyze-API zurückgegeben. Sie muss verwendet werden, um über HTTP GET den Analyseauftragsstatus abzufragen. Wenn der Analyseauftrag beendet ist, enthält der Antworttext die URL oder die Liste der URLs, in die die Ergebnisausgabe heruntergeladen werden kann. Rufen Sie diesen URI ab, bis der HTTP-Statuscode „200“ zurückgegeben wird. Während der Auftrag noch ausgeführt wird, wird ein HTTP-Statuscode „202“ mit der Location-Kopfzeile zurückgegeben, mit dem gleichen URI, der von analyze zurückgegeben werden wurde. Nachdem eine 200-Antwort zurückgegeben wurde, enthält die resultFileUris-Eigenschaft die einzelnen (oder die Liste aus) herunterladbaren Speicherorte der Ausgabe in einer ZIP-Datei. Eine formatierte Static Analysis Results Interchange Format (SARIF) V2-Datei ist in diesem ZIP-Download enthalten, d. h. eine formatierte JSON-Datei, die die Ergebnisse der Analyse umfasst. Der Antworttext enthält ein IssueSummary-Objekt, das eine Zusammenfassung der Anzahl der gefundenen Probleme enthält.

Notiz

Es wird empfohlen, 15 bis 60 Sekunden zwischen den Statusprüfungen zu warten. Die Analyse wird in der Regel in nur 1 bis 5 Minuten ausgeführt.
Diese API erfordert ein OAuth Token, das ein Token für dieselbe Clientanwendung sein muss, die den Analyseauftrag initiiert hat.

Kopfzeilen

Name des Dataflows	typ	Erwarteter Wert	Erforderlich?
Autorisierung	string	Der OAuth 1. Inhabertoken mit Microsoft Entra Anwendungs-ID-Anspruch.	yes
x-ms-tenant-id	GUID	Die ID des Mandanten für die Anwendung.	Ja
x-ms-correlation-id	GUID	Der Bezeichner für die Analyseausführung. Sie sollten dieselbe ID für die gesamte Ausführung angeben (Upload, Analyse, Status)	Ja

Erwartete Antworten

HTTP-Statuscode	Szenario	Ergebnis
200	Mindestens ein Ergebnis wurde gefunden.	Siehe das Beispiel unten. Ein Ergebnis wird zurückgegeben.
202	Wird noch verarbeitet	Siehe das Beispiel unten. Ein Ergebnis wird zurückgegeben.
403	Verboten	Der Anforderer ist nicht der Gleiche wie der Ersteller der Anforderung für die Analyse.
404	Nicht gefunden	Die Analyseanforderung konnte mit dem in der URL bereitgestellten Verweis nicht gefunden werden.

Erwartete Antwortkopfzeilen

Name	Typ	Erwarteter Wert	Erforderlich?
Location	URI	URI zum Verwenden in Abfragen für den aktuellen Status und zum Abrufen der Ergebnisse	Ja

Erwarteter Antworttext

In der folgenden Tabelle wird die Struktur der Antwort für jede Anfrage (nur HTTP-200- oder -202-Antwort) dargestellt.

Eigenschaft	Typ	Erwarteter Wert	Erforderlich?
privacyPolicy	Zeichenfolge	Der URI der Datenschutzrichtlinien.	Ja
Fortschritt	int	Ein Wert von 0-100 (Fertigstellungsprozentsatz), wobei 10 bedeutet, dass die Verarbeitung etwa zu 10 % vollständig ist.	Ja
runCorrelationId	GUID	Der Anforderungsbezeichner, der in jeder Anforderung enthalten ist. Dieser kann bei Bedarf zur Korrelation zur Anforderung verwendet werden.	Ja
Status	Zeichenfolge	`InProgress` wird zurückgegeben, wenn der Auftrag noch verarbeitet wird. `Failed` wird zurückgegeben, wenn bei der Verarbeitung des Auftrags auf dem Server ein katastrophales Problem aufgetreten ist. Es sollte weitere Details in der Fehlereigenschaft geben. `Finished` wird zurückgegeben, wenn der Auftrag erfolgreich und ohne Probleme abgeschlossen wurde. `FinishedWithErrors` wird zurückgegeben, wenn der Job erfolgreich abgeschlossen wurde, jedoch eine oder mehrere Regeln nicht ohne Fehler abgeschlossen werden konnten. Dies ist lediglich ein Hinweis für Sie, damit Sie wissen, dass der Bericht unter Umständen nicht vollständig ist. Microsoft ist sich dieser Probleme im Backend bewusst und wird daran arbeiten, die Probleme zu diagnostizieren und zu beheben.	Ja
resultFileUris	Zeichenfolgenarray	Eine Liste der URIs, die direkten Download der Ausgabe gewähren. Es sollte eine pro Datei geben, die in der ursprünglichen API-Analyse-Aufruf enthalten war.	Nein. Dies ist nur enthalten, wenn das Verarbeiten abgeschlossen wurde.
issueSummary	IssueSummary	Eigenschaften unten aufgeführt	Nein. Dies ist nur enthalten, wenn das Verarbeiten abgeschlossen wurde.
issueSummary.criticalIssueCount	int	Anzahl der identifizierten Probleme, die einen kritischen Schweregrad im Ergebnis haben	Ja
issueSummary.highIssueCount	int	Anzahl der identifizierten Probleme, die einen hohen Schweregrad im Ergebnis haben	Ja
issueSummary.mediumIssueCount	int	Anzahl der identifizierten Probleme, die einen mittleren Schweregrad im Ergebnis haben	Ja
issueSummary.lowIssueCount	int	Anzahl der identifizierten Probleme, die einen niedrigen Schweregrad im Ergebnis haben	Ja
issueSummary.informationalIssueCount	int	Anzahl der identifizierten Probleme, die einen informativen Schweregrad im Ergebnis haben	Ja

Beispiel: Statusprüfung, wenn fertig

Dieses Beispiel gibt einen Statusprüfungsaufruf mit dem Ergebnis aus, dass es ein Abschluss ist.

Anfrage

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

Antwort

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
    }
}

Siehe auch

Verwenden Sie die Power Apps Checker-Web-API
Abrufen der Liste der Regelsätze
Abrufen der Regelliste
Hochladen einer Datei
Analyse aufrufen

Freigeben über