หมายเหตุ
การเข้าถึงหน้านี้ต้องได้รับการอนุญาต คุณสามารถลอง ลงชื่อเข้าใช้หรือเปลี่ยนไดเรกทอรีได้
การเข้าถึงหน้านี้ต้องได้รับการอนุญาต คุณสามารถลองเปลี่ยนไดเรกทอรีได้
URL ถูกส่งคืนเป็นส่วนหนึ่งของส่วนหัว Location ในการตอบสนองต่อคำขอไปยัง API analyze ซึ่งจะถูกใช้เพื่อสอบถามผ่าน HTTP GET สำหรับสถานะของงานวิเคราะห์ เมื่องานวิเคราะห์เสร็จสิ้น เนื้อหาการตอบสนองจะรวม URL หรือรายการ URL ที่สามารถดาวน์โหลดผลลัพธ์ได้ เรียกใช้ URI นี้ต่อไปจนกว่ารหัสสถานะ HTTP 200 จะถูกส่งคืน ขณะที่งานยังทำงานอยู่ รหัสสถานะ HTTP 202 จะถูกส่งคืนพร้อมกับส่วนหัว Location ที่มี URI เดียวกันนี้ที่ส่งคืนจาก analyze เมื่อมีการตอบกลับ 200 ครั้ง คุณสมบัติ resultFileUris จะรวมรายการเดี่ยวหรือรายการตำแหน่งที่สามารถดาวน์โหลดได้ของเอาต์พุต ซึ่งมีอยู่ในไฟล์ zip ไฟล์ที่จัดรูปแบบ V2 ของ รูปแบบการแลกเปลี่ยนผลการวิเคราะห์แบบคงที่ (SARIF) จะรวมอยู่ในการดาวน์โหลด zip นี้นั่นคือ รูปแบบไฟล์ JSON มีผลของการวิเคราะห์ เนื้อหาการตอบสนองจะมีออบเจ็กต์ IssueSummary ที่มีข้อมูลสรุปของจำนวนปัญหาที่พบ
หมายเหตุ
ขอแนะนำให้รอระหว่าง 15 ถึง 60 วินาทีระหว่างการตรวจสอบสถานะ การวิเคราะห์มักใช้เวลาประมาณ 1 ถึง 5 นาทีในการเรียกใช้
API นี้ต้องใช้โทเค็น OAuth ซึ่งจะต้องเป็นโทเค็นสำหรับแอปพลิเคชันไคลเอนต์เดียวกันที่เริ่มงานการวิเคราะห์
ส่วนหัว
| Name | ขนิด | ค่าที่คาดหวัง | จำเป็นหรือไม่ |
|---|---|---|---|
| การอนุญาต | สตริง | โทเค็นผู้ถือ OAuth 1 ที่มีการอ้างสิทธิ์ Microsoft Entra รหัสแอปพลิเคชัน | yes |
| รหัสผู้เช่า x-ms | GUID | รหัสของผู้เช่าสำหรับโปรแกรมประยุกต์ | yes |
| รหัสความสัมพันธ์ x-ms | GUID | ตัวบ่งชี้สำหรับการดำเนินการวิเคราะห์ คุณควรระบุรหัสเดียวกันสำหรับการดำเนินการทั้งหมด (อัปโหลด วิเคราะห์ สถานะ) | yes |
คำตอบที่คาดหวัง
| รหัสสถานะ HTTP | สถานการณ์สมมติ | ผลลัพธ์ |
|---|---|---|
| 200 | พบผลลัพธ์หนึ่งรายการขึ้นไป | ดูตัวอย่างด้านล่าง ผลลัพธ์หนึ่งรายการจะถูกส่งคืน |
| 202 | กำลังประมวลผล | ดูตัวอย่างด้านล่าง ผลลัพธ์หนึ่งรายการจะถูกส่งคืน |
| 403 | ไม่อนุญาต | ผูู้ขอไม่เหมือนผู้ส่งคำขอสำหรับการวิเคราะห์ |
| 404 | ไม่พบ | ไม่พบคำขอการวิเคราะห์พร้อมการอ้างอิงที่ให้ไว้ใน URL |
ส่วนหัวการตอบสนองที่คาดหวัง
| Name | ขนิด | ค่าที่คาดหวัง | จำเป็นหรือไม่ |
|---|---|---|---|
| สถานที่ตั้ง | uri | URI ที่จะใช้ในการสอบถามสถานะปัจจุบัน และเพื่อให้ได้ผลลัพธ์ | yes |
เนื้อหาคำตอบที่คาดหวัง
ตารางต่อไปนี้แสดงโครงสร้างของการตอบสนองสำหรับแต่ละคำขอ (การตอบสนอง HTTP 200 หรือ 202 เท่านั้น)
| คุณสมบัติ | ขนิด | ค่าที่คาดหวัง | จำเป็นหรือไม่ |
|---|---|---|---|
| privacyPolicy | สตริง | URI ของนโยบายความเป็นส่วนตัว | ได้ |
| ความคืบหน้า | int | ค่าตั้งแต่ 0-100 เปอร์เซ็นต์เสร็จสมบูรณ์ โดย 10 หมายความว่า การประมวลผลจะเสร็จสมบูรณ์ประมาณ 10% | ได้ |
| runCorrelationId | GUID | ตัวระบุคำขอที่รวมอยู่ในคำขอแต่ละรายการ สิ่งนี้สามารถใช้เพื่อเชื่อมโยงกับคำขอ หากจำเป็น | ได้ |
| สถานะ | สตริง |
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/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 ตัวตรวจสอบ
เรียกใช้ชุดรายการของข้อกำหนด
เรียกใช้รายการของข้อกำหนด
อัปโหลดแฟ้ม
เรียกใช้การวิเคราะห์