Έλεγχος για κατάσταση ανάλυσης

Άρθρο
03/27/2023

Μια διεύθυνση URL επιστρέφεται ως τμήμα της κεφαλίδας Location ως απόκριση σε μια αίτηση στο analyze API. Πρόκειται να χρησιμοποιηθεί για την υποβολή ερωτημάτων μέσω της HTTP GET για την κατάσταση της εργασίας ανάλυσης. Όταν ολοκληρωθεί η εργασία ανάλυσης, ο οργανισμός απόκρισης θα συμπεριλάβει τη διεύθυνση URL ή τη λίστα διευθύνσεων URL στις οποίες είναι δυνατή η λήψη των αποτελεσμάτων. Συνεχίστε να κάνετε κλήση αυτού του URI μέχρι να επιστραφεί κωδικός κατάστασης HTTP 200. Όταν η εργασία εξακολουθεί να εκτελείται, θα επιστραφεί ένας κωδικός κατάστασης HTTP 202 με την κεφαλίδα Location να περιέχει αυτό το ίδιο URI που επιστράφηκε από το analyze. Μόλις επιστραφεί απόκριση 200, η ιδιότητα resultFileUris θα συμπεριλάβει την απλή θέση ή τη λίστα με τις επιδεχόμενες λήψης θέσεις της εξόδου, η οποία περιέχεται σε ένα αρχείο zip. Ένα αρχείο με διαμόρφωση Static Analysis Results Interchange Format (SARIF) V2 περιλαμβάνεται σε αυτό το στοιχείο λήψης zip που είναι ένα μορφοποιημένο αρχείο JSON που περιέχει τα αποτελέσματα της ανάλυσης. Το σώμα απόκρισης θα περιέχει ένα αντικείμενο IssueSummary που περιέχει μια σύνοψη του πλήθους των ζητημάτων που εντοπίστηκαν.

Σημείωμα

Συνιστάται να περιμένετε ανάμεσα σε 15 και 60 δευτερόλεπτα μεταξύ των ελέγχων κατάστασης. Η εκτέλεση της ανάλυσης διαρκεί συνήθως από 1 έως 5 λεπτά.
Αυτό το API απαιτεί ένα OAuth διακριτικό που πρέπει να είναι διακριτικό για την ίδια εφαρμογή προγράμματος-πελάτη που ξεκίνησε την εργασία ανάλυσης.

Κεφαλίδες

Ονομασία	Type	Αναμενόμενη τιμή	Υποχρεωτικό;
Εξουσιοδότηση	string	Το OAuth διακριτικό 1 κομιστή με Microsoft Entra αξίωση αναγνωριστικού εφαρμογής.	yes
x-ms-tenant-id	GUID	Το αναγνωριστικό του μισθωτή για την εφαρμογή.	ναι
x-ms-correlation-id	GUID	Το αναγνωριστικό για την εκτέλεση της ανάλυσης. Θα πρέπει να παρέχετε το ίδιο Id για ολόκληρη την εκτέλεση (αποστολή, ανάλυση, κατάσταση)	ναι

Αναμενόμενες αποκρίσεις

Κωδικός κατάστασης HTTP	Σενάριο	Αποτέλεσμα
200	Εντοπίστηκαν ένα ή περισσότερα αποτελέσματα	Δείτε το παρακάτω παράδειγμα. Θα επιστραφεί ένα αποτέλεσμα.
202	Η επεξεργασία συνεχίζεται	Δείτε το παρακάτω παράδειγμα. Θα επιστραφεί ένα αποτέλεσμα.
403	Δεν επιτρέπεται	Ο αιτών δεν είναι ο ίδιος με τον δημιουργό της αίτησης για ανάλυση.
404	Δεν βρέθηκε	Δεν είναι δυνατή η εύρεση του αιτήματος ανάλυσης με την αναφορά που παρέχεται στη διεύθυνση URL.

Επικεφαλίδες αναμενόμενης απόκρισης

Ονομασία	Τύπος	Αναμενόμενη τιμή	Υποχρεωτικό;
Τοποθεσία	uri	URI που θα χρησιμοποιηθεί στο ερώτημα για την τρέχουσα κατάσταση και για τη λήψη των αποτελεσμάτων	ναι

Σώμα αναμενόμενης απόκρισης

Ο ακόλουθος πίνακας περιγράφει τη δομή της απόκρισης για κάθε αίτηση (μόνο για απόκριση HTTP 200 ή 202).

Ιδιότητα	Τύπος	Αναμενόμενη τιμή	Υποχρεωτικό;
privacyPolicy	string	Το URI της πολιτικής προστασίας προσωπικών δεδομένων.	Ναι
Πρόοδος	ακέραιος	Μια τιμή που κυμαίνεται από 0-100 για το ποσοστό ολοκλήρωσης, όπου 10 σημαίνει ότι η επεξεργασία έχει ολοκληρωθεί περίπου στο 10%.	Ναι
runCorrelationId	GUID	Το αναγνωριστικό αίτησης που περιλαμβάνεται σε κάθε αίτηση. Αυτό μπορεί να χρησιμοποιηθεί για συσχέτιση με την αίτηση, εάν είναι απαραίτητο.	Ναι
κατάσταση	string	`InProgress` επιστρέφεται όταν η εργασία βρίσκεται ακόμη υπό επεξεργασία. `Failed` επιστρέφεται όταν παρουσιάστηκε ένα καταστροφικό ζήτημα κατά την επεξεργασία της εργασίας στο διακομιστή. Θα πρέπει να υπάρχουν περισσότερες λεπτομέρειες στην ιδιότητα σφάλματος. `Finished` επιστρέφεται όταν η εργασία έχει ολοκληρωθεί με επιτυχία χωρίς προβλήματα. `FinishedWithErrors` επιστρέφεται όταν η εργασία ολοκληρώθηκε με επιτυχία, ωστόσο, ένας ή περισσότεροι κανόνες απέτυχαν να ολοκληρωθούν χωρίς σφάλμα. Αυτό είναι καθαρά ένα μήνυμα για εσάς, ώστε να γνωρίζετε ότι η αναφορά μπορεί να μην έχει ολοκληρωθεί. Microsoft γνωρίζει αυτά τα ζητήματα στο backend και θα εργαστεί για να διαγνώσει και να αντιμετωπίσει τα πράγματα.	Ναι
resultFileUris	πίνακας συμβολοσειρών	Μια λίστα των URI που επιτρέπουν την άμεση λήψη του αποτελέσματος. Θα πρέπει να υπάρχει ένα ανά αρχείο που περιλαμβανόταν στην αρχική κλήση API υπό ανάλυση.	Όχι. Αυτό περιλαμβάνεται μόνο όταν η επεξεργασία έχει ολοκληρωθεί.
issueSummary	IssueSummary	Ιδιότητες που παρατίθενται παρακάτω	Όχι. Αυτό περιλαμβάνεται μόνο όταν η επεξεργασία έχει ολοκληρωθεί.
issueSummary.criticalIssueCount	ακέραιος	Πλήθος ζητημάτων που έχουν προσδιορισθεί ότι έχουν κρίσιμη σοβαρότητα στο αποτέλεσμα	Ναι
issueSummary.highIssueCount	ακέραιος	Πλήθος ζητημάτων που έχουν προσδιορισθεί ότι έχουν υψηλή σοβαρότητα στο αποτέλεσμα	Ναι
issueSummary.mediumIssueCount	ακέραιος	Πλήθος ζητημάτων που έχουν προσδιορισθεί ότι έχουν μέση σοβαρότητα στο αποτέλεσμα	Ναι
issueSummary.lowIssueCount	ακέραιος	Πλήθος ζητημάτων που έχουν προσδιορισθεί ότι έχουν χαμηλή σοβαρότητα στο αποτέλεσμα	Ναι
issueSummary.informationalIssueCount	ακέραιος	Πλήθος ζητημάτων που έχουν προσδιορισθεί ότι έχουν πληροφοριακής φύσης σοβαρότητα στο αποτέλεσμα	Ναι

Παράδειγμα: έλεγχος κατάστασης μόλις ολοκληρωθεί

Αυτό το παράδειγμα εκδίδει μια κλήση ελέγχου κατάστασης με το αποτέλεσμα να είναι ολοκλήρωση.

Αίτηση

GET [Geographical URI]/api/status/9E378E56-6F35-41E9-BF8B-C0CC88E2B832&api-version=1.0
Accept: application/json
Content-Type: application/json; charset=utf-8
x-ms-correlation-id: 9E378E56-6F35-41E9-BF8B-C0CC88E2B832
x-ms-tenant-id: F2E60E49-CB87-4C24-8D4F-908813B22506

απάντηση

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":"9E378E56-6F35-41E9-BF8B-C0CC88E2B832","status":"Finished","issueSummary":
    {
        "informationalIssueCount":0,
        "lowIssueCount":0,
        "mediumIssueCount":302,
        "highIssueCount":30,
        "criticalIssueCount":0
    }
}

Δείτε επίσης

Χρησιμοποιήστε το Power Apps checker web API
Ανάκτηση της λίστας συνόλων κανόνων
Ανάκτηση της λίστας κανόνων
Αποστολή αρχείου
Κλήση ανάλυσης

Κοινή χρήση μέσω