विश्लेषण स्थिति की जाँच करें

analyze API को अनुरोध के उत्तर में Location हेडर के भाग के रूप में एक URL लौटाया जाता है. इसका उपयोग विश्लेषण कार्य की स्थिति के लिए HTTP GET के माध्यम से क्वेरी करने के लिए उपयोग किया जाएगा. जब विश्लेषण कार्य समाप्त हो जाता है, तो प्रतिक्रिया भाग में URL या URL की सूची शामिल होगी जिसमें परिणामों के आउटपुट डाउनलोड किए जा सकते हैं. इस URI को तब तक कॉल करें जब तक 200 का HTTP स्थिति कोड नहीं लौटाया जाता. कार्य अब भी चलते हुए, 202 का HTTP स्थिति कोड लौटाया जाएगा जिसमें Location हेडर में वही URI शामिल होगा जो analyze से लौटाया गया था. 200 प्रतिक्रिया मिलने पर, resultFileUris गुण में आउटपुट का डाउनलोड करने योग्य एक स्थान या स्थानों की सूची शामिल होगी, जो ज़िप फ़ाइल में शामिल है. स्थैतिक विश्लेषण परिणाम इंटरचेंज फ़ॉर्मेट (SARIF) V2 स्वरूपित फ़ाइल इस ज़िप डाउनलोड के भीतर शामिल है जो कि एक JSON स्वरूपित फ़ाइल है जिसमें विश्लेषण के परिणाम शामिल हैं. प्रतिक्रिया भाग में एक IssueSummary ऑब्जेक्ट शामिल होगा जिसमें पाए गई समस्याओं की गिनती का सारांश होता है.

नोट

स्थिति की जाँच के बीच 15 से 60 सेकंड तक प्रतीक्षा करने का सुझाव दिया जाता है. विश्लेषण चलाने में आमतौर पर 1 से 5 मिनट लगते हैं.
इस API को एक OAuth टोकन की आवश्यकता होती है जो उसी क्लाइंट अनुप्रयोग के लिए एक टोकन होना चाहिए जिसने विश्लेषण कार्य शुरू किया था.

शीर्ष लेख

नाम	प्रकार	अपेक्षित मान	आवश्यक?
प्रमाणन	string	आवेदन आईडी दावे के साथ Microsoft Entra ओएथ 1 वाहक टोकन।	हाँ
x-ms-tenant-id	मार्गदर्शक	एप्लिकेशन के लिए टैनेंट का ID.	हाँ
x-ms-correlation-id	GUID	विश्लेषण रन के लिए पहचानकर्ता. संपूर्ण निष्पादन (अपलोड, विश्लेषण, स्थिति) के लिए आपको एक ही Id प्रदान करना चाहिए	हाँ

अपेक्षित प्रतिक्रियाएँ

HTTP स्थिति कोड	परिदृश्य	परिणाम
200	एक या अधिक परिणाम पाए गए	नीचे दिया गया उदाहरण देखें. एक परिणाम लौटाया जाएगा.
202	अब भी संसाधित कर रहा है	नीचे दिया गया उदाहरण देखें. एक परिणाम लौटाया जाएगा.
403	निषिद्ध	अनुरोधकर्ता, विश्लेषण के लिए अनुरोध बनाने वाले के समान नहीं है.
404	नहीं मिला	URL में दिए गए संदर्भ से विश्लेषण अनुरोध खोजने में असमर्थ.

अपेक्षित प्रतिक्रिया हेडर

नाम	प्रकार	अपेक्षित मान	आवश्यक?
स्थान	uri	वर्तमान स्थिति की क्वेरी करने और परिणाम प्राप्त करने के लिए उपयोग किया जाने वाला URI	हाँ

अपेक्षित प्रतिक्रिया भाग

निम्न तालिका प्रत्येक अनुरोध (केवल HTTP 200 या 202 प्रतिक्रिया) के लिए प्रतिक्रिया की संरचना को रेखांकित करती है.

गुण	प्रकार	अपेक्षित मान	आवश्यक?
privacyPolicy	string	गोपनीयता नीति का URI.	हां
प्रगति	int	0-100 प्रतिशत पूर्णता के बीच का मान, जहां 10 का मतलब है कि संसाधन लगभग 10% पूर्ण है.	हां
runCorrelationId	GUID	अनुरोध पहचानकर्ता जो प्रत्येक अनुरोध में शामिल किया जाता है. यह, आवश्यकता होने पर पर, अनुरोध को सहसंबंध करने के लिए उपयोग किया जा सकता है.	हां
स्थिति	string	InProgress उस समय लौटाया जाता है जब कार्य अब भी संसाधित किया जा रहा हो. सर्वर पर कार्य संसाधित करते समय विपत्तिपूर्ण समस्या होने पर Failed लौटाया जाता है. त्रुटि गुण में अधिक विवरण होने चाहिए. कार्य किसी भी समस्या के बिना पूर्ण होने पर Finished लौटाया जाता है. कार्य सफलतापूर्वक पूर्ण होने पर FinishedWithErrors लौटाया जाता है, हालांकि, एक या अधिक नियम बिना त्रुटि के पूर्ण होने में विफल रहे. यह आपके लिए केवल एक संकेत है कि हो सकता है कि रिपोर्ट पूरी न हो. Microsoft बैकएंड में इन समस्याओं से अवगत है और चीजों का निदान करने और उनका समाधान करने के लिए कार्य करेगा.	हां
resultFileUris	स्ट्रिंग्स की सरणी	आउटपुट को सीधे डाउनलोड करने की अनुमति देने वाले URI की एक सूची. यह एक प्रति फ़ाइल होना चाहिए जिसे मूल विश्लेषण API कॉल में शामिल किया गया था.	नहीं. यह संसाधन पूरा होने पर ही शामिल किया जाता है.
issueSummary	IssueSummary	नीचे सूचीबद्ध गुण	नहीं. यह संसाधन पूरा होने पर ही शामिल किया जाता है.
issueSummary.criticalIssueCount	int	परिणाम में पहचान की गई महत्वपूर्ण गंभीरता वाली समस्याओं की गणना	हां
issueSummary.highIssueCount	int	परिणाम में पहचान की गई उच्च गंभीरता वाली समस्याओं की गणना	हां
issueSummary.mediumIssueCount	int	परिणाम में पहचान की गई मध्यम गंभीरता वाली समस्याओं की गणना	हां
issueSummary.lowIssueCount	int	परिणाम में पहचान की गई कम गंभीरता वाली समस्याओं की गणना	हां
issueSummary.informationalIssueCount	int	परिणाम में पहचान की गई जानकारी-युक्त गंभीरता वाली समस्याओं की गणना	हां

उदाहरण: पूर्ण होने पर स्थिति की जाँच

यह उदाहरण पूर्ण परिणाम के साथ स्थिति जाँच कॉल जारी करता है.

अनुरोध

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

Response

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 चेकर वेब API का उपयोग करें
नियमसेट की सूची पुनः प्राप्त करें
नियमों की सूची पुनः प्राप्त करें
फ़ाइल अपलोड करें
विश्लेषण इनवोक करें