Memeriksa status analisis
URL dikembalikan sebagai bagian dari header Location
sebagai respons terhadap permintaan ke API analyze
. Ini digunakan untuk kueri melalui HTTP GET
untuk status pekerjaan analisis. Setelah pekerjaan analisis selesai, badan respons akan mencakup URL atau daftar URL di mana hasil output dapat diunduh. Tetap memanggil URI ini hingga kode status HTTP 200 dihasilkan. Sementara pekerjaan masih berjalan, kode status HTTP 202 akan dihasilkan dengan header Location
yang berisi URI yang sama yang dihasilkan dari analyze
. Setelah respons 200 dihasilkan, properti resultFileUris
akan mencakup daftar lokasi atau lokasi tunggal yang dapat diunduh dari output, yang terkandung dalam file zip. File berformat Format pertukaran hasil analisis statis (SARIF) v2 disertakan dalam unduhan Zip ini yang merupakan file berformat JSON
yang berisi hasil analisis. Badan respons akan berisi objek IssueSummary
yang berisi ringkasan jumlah masalah yang ditemukan.
Catatan
Sebaiknya tunggu antara 15 hingga 60 detik di antara pemeriksaan status. Analisis biasanya membutuhkan waktu antara 1 hingga 5 menit untuk dijalankan.
API ini memang memerlukan OAuth token yang harus menjadi token untuk aplikasi klien yang sama yang memulai pekerjaan analisis.
Header
Nama | Tipe | Nilai yang diharapkan | Diperlukan? |
---|---|---|---|
Otorisasi | string | Token OAuth pembawa 1 dengan Microsoft Entra klaim ID Aplikasi. | ya |
x-ms-tenant-id | GUID | ID penyewa untuk aplikasi. | ya |
x-ms-correlation-id | GUID | Pengidentifikasi untuk menjalankan analisis. Anda harus menyediakan ID yang sama untuk seluruh eksekusi (upload, analisis, status) | ya |
Respons yang diharapkan
Kode Status HTTP | Skenario | Hasil |
---|---|---|
200 | Satu atau beberapa hasil ditemukan | Lihat contoh di bawah ini. Salah satu hasil akan dihasilkan. |
202 | Masih memproses | Lihat contoh di bawah ini. Salah satu hasil akan dihasilkan. |
403 | Terlarang | Peminta tidak sama dengan pencetus permintaan analisis. |
404 | Tidak ditemukan | Tidak dapat menemukan permintaan analisis dengan referensi yang diberikan di URL. |
Header respons yang diharapkan
Nama | Jenis | Nilai yang diharapkan | Diperlukan? |
---|---|---|---|
Lokasi | uri | URI untuk digunakan dalam kueri untuk status saat ini dan untuk mendapatkan hasil | ya |
Badan respons yang diharapkan
Tabel berikut menguraikan struktur respons untuk setiap permintaan (hanya respons HTTP 200 atau 202).
Properti | Jenis | Nilai yang diharapkan | Diperlukan? |
---|---|---|---|
privacyPolicy | string | URI kebijakan privasi. | Ya |
kemajuan | int | Nilai berkisar dari persentase 0-100 selesai, dengan 10 berarti bahwa pemrosesan kira-kira 10% selesai. | Ya |
runCorrelationId | GUID | Pengidentifikasi permintaan yang disertakan dalam setiap permintaan. Ini dapat digunakan untuk berkorelasi dengan permintaan, jika diperlukan. | Ya |
status | string | InProgress dikembalikan saat pekerjaan masih diproses. Failed dikembalikan ketika ada masalah bencana saat memproses pekerjaan di server. Harus ada rincian lebih lanjut di properti kesalahan. Finished dikembalikan ketika pekerjaan telah berhasil diselesaikan tanpa masalah. FinishedWithErrors dikembalikan ketika pekerjaan telah berhasil diselesaikan, namun, satu atau beberapa aturan gagal diselesaikan tanpa kesalahan. Ini adalah murni sinyal untuk Anda ketahui bahwa laporan mungkin tidak lengkap. Microsoft menyadari masalah ini di backend dan akan bekerja untuk mendapatkan hal-hal yang didiagnosis dan ditangani. |
Ya |
resultFileUris | larik string | Daftar URI yang memungkinkan pengunduhan langsung output. Harus ada satu per file yang tercakup dalam panggilan API analisis asli. | Tidak. Ini hanya disertakan saat pemrosesan selesai. |
issueSummary | IssueSummary | Properti tercantum di bawah ini | Tidak. Ini hanya disertakan saat pemrosesan selesai. |
issueSummary.criticalIssueCount | int | Jumlah masalah yang diidentifikasi memiliki tingkat keparahan kritis pada hasil | Ya |
issueSummary.highIssueCount | int | Jumlah masalah yang diidentifikasi memiliki tingkat keparahan tinggi pada hasil | Ya |
issueSummary.mediumIssueCount | int | Jumlah masalah yang diidentifikasi memiliki tingkat keparahan sedang pada hasil | Ya |
issueSummary.lowIssueCount | int | Jumlah masalah yang diidentifikasi memiliki tingkat keparahan rendah pada hasil | Ya |
issueSummary.informationalIssueCount | int | Jumlah masalah yang diidentifikasi memiliki tingkat keparahan informasional pada hasil | Ya |
Contoh: pemeriksaan status setelah selesai
Contoh ini mengeluarkan panggilan pemeriksaan status dengan hasil berupa penyelesaian.
Minta
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
respons
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
}
}
Lihat juga
Menggunakan Power Apps API web pemeriksa
Mengambil daftar kumpulan aturan
Mengambil daftar aturan
Mengupload file
Panggil analisis