Κλήση ανάλυσης

Η προετοιμασία μιας εργασίας ανάλυσης γίνεται με την υποβολή μιας αίτησης POST στη διαδρομή analyze. Η ανάλυση μπορεί να είναι μια μακρά διεργασία η οποία διαρκεί συνήθως περισσότερο από ένα λεπτό. Το API πραγματοποιεί κατ' αρχάς κάποια βασική επικύρωση, προετοιμάζει την αίτηση στο παρασκήνιο υποβάλλοντας μια εργασία και, στη συνέχεια, απαντά με έναν κωδικό κατάστασης 202 και μια κεφαλίδα Location ή με τις κατάλληλες λεπτομέρειες σφάλματος. Η τιμή κεφαλίδας Location είναι μια διεύθυνση URL που μπορεί να χρησιμοποιηθεί για τον έλεγχο της κατάστασης της αίτησης και για τη λήψη της(-ων) διεύθυνσης(-υθύνσεων) URL του(-ων) αποτελέσματος(-εσμάτων). Υπάρχουν διάφορες επιλογές μέσω της ενέργειας POST που θα προσαρμόσουν την εργασία με βάση τα κριτήριά σας, όπως τη λίστα κανόνων ή ομάδων κανόνων, τα αρχεία που θα αποκλεισθούν από την ανάλυση και πολλά άλλα. Μπορείτε να προετοιμάσετε την ανάλυση χρησιμοποιώντας το παρακάτω [Geographical URL]/api/analyze?api-version=1.0.

Note

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

Κεφαλίδες

Πλήρες όνομα	Τύπος	Αναμενόμενη τιμή	Υποχρεωτικό;
Authorization	συμβολοσειρά	Το διακριτικό φορέα OAuth 1 με την αξίωση αναγνωριστικού εφαρμογής από το Microsoft Entra ID.	ναι
x-ms-tenant-id	GUID	Το αναγνωριστικό του μισθωτή για την εφαρμογή.	ναι
x-ms-correlation-id	GUID	Το αναγνωριστικό για την εκτέλεση της ανάλυσης. Θα πρέπει να παρέχετε το ίδιο ID για ολόκληρη την εκτέλεση (αποστολή, ανάλυση, κατάσταση).	ναι
Αποδοχή	αντικείμενο	application/json, application/x-ms-sarif-v2	ναι
Αποδεκτή Γλώσσα	συμβολοσειρά	Ο κωδικός ή οι κωδικοί γλώσσας (π.χ. en-US). Η προεπιλεγμένη τιμή είναι en-US. Εάν παρέχονται πολλές γλώσσες, η πρώτη θα είναι η κύρια. Ωστόσο, θα συμπεριληφθούν όλες οι μεταφράσεις (εάν υποστηρίζεται η γλώσσα).	όχι

Σώμα

Επιλογές που χρησιμοποιούνται συνήθως:

Property	Τύπος	Αναμενόμενη τιμή	Υποχρεωτικό;
sasUriList	πίνακας συμβολοσειρών	Μια λίστα URI που παρέχει την πρόσβαση υπηρεσίας για τη λήψη μιας μεμονωμένης λύσης, ενός αρχείου zip που περιέχει πολλαπλά αρχεία λύσεων ή ένα πακέτο.	Ναι
ruleSets	πίνακας προσαρμοσμένων στοιχείων	0 ή περισσότερα	Αρ.
ruleSets.id	guid	Το αναγνωριστικό του συνόλου κανόνων, το οποίο μπορείτε να βρείτε κάνοντας ερώτημα στο σύνολο κανόνων API.	Όχι, αλλά συνήθως αυτό είναι αυτό που θέλετε να χρησιμοποιήσετε. Πρέπει να χρησιμοποιήσετε είτε αυτό είτε το ruleCodes.
ruleCodes.code	συμβολοσειρά	Το αναγνωριστικό του επιθυμητού κανόνα, το οποίο μπορείτε να βρείτε κάνοντας ερώτημα στο σύνολο κανόνων και τα API κανόνων.	Όχι, πρέπει να χρησιμοποιήσετε είτε αυτό είτε τα ruleSets.
Εξαιρέσεις Αρχείων	πίνακας συμβολοσειρών	Μια λίστα ονομάτων αρχείων ή μοτίβων ονομάτων αρχείων που θα αποκλεισθούν. Υπάρχει υποστήριξη για τη χρήση του "*" ως χαρακτήρα μπαλαντέρ στην αρχή ή/και στο τέλος ενός ονόματος αρχείου (π.χ. *jquery.dll και *jquery*).	Αρ.

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

Κωδικός κατάστασης HTTP	Σενάριο	Αποτέλεσμα
202	Έγινε δεκτή η αίτηση για ανάλυση και επιστράφηκε το URI ελέγχου κατάστασης στην κεφαλίδα Location	Κανένα σώμα αποτελέσματος
400	Εστάλη ένα αρχείο που δεν ήταν zip, εσφαλμένες παράμετροι ή συμπεριλήφθηκε αρχείο με ιό	Κανένα σώμα αποτελέσματος
409	Εστάλη μια αίτηση με διπλότυπη κεφαλίδα x-ms-correlation-id	Κανένα σώμα αποτελέσματος

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

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

Παράδειγμα: έναρξη μιας ανάλυσης

Αυτό είναι ένα παράδειγμα εκκίνησης μιας εργασίας ανάλυσης με το σύνολο κανόνων πιστοποίησης Marketplace , ένα μόνο αρχείο και την εξαίρεση αρχείων που περιέχουν το 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

Δείτε επίσης

Χρήσιμη χρήση του API Web ελέγχου Power Apps
Ανάκτηση της λίστας συνόλων κανόνων
Ανάκτηση της λίστας κανόνων
Αποστολή αρχείου
Έλεγχος για κατάσταση ανάλυσης