Semak status analisis

URL dikembalikan sebagai sebahagian daripada pengepala Location berhubung dengan permintaan API analyze. Ia akan digunakan untuk bertanya melalui GET HTTP untuk status tugas analisis. Apabila tugas analisis selesai, badan respons akan menyertakan URL atau senarai URL yang mana output keputusan boleh dimuat turun. Teruskan memanggil URI ini sehingga kod status HTTP 200 dikembalikan. Semasa tugas masih berjalan, kod status HTTP 202 akan dikembalikan dengan pengepala Location yang mengandungi URI sama ini yang telah dikembalikan daripada analyze. Setelah respons 200 dikembalikan, sifat resultFileUris akan memasukkan lokasi output tunggal atau senarai lokasi output boleh dimuat turun yang terkandung dalam fail zip. Fail berformatkan V2 Format Pertukaran Keputusan Analisis Statik (SARIF) termasuk dalam muat turun zip ini iaitu fail berformat JSON yang mengandungi keputusan analisis. Badan respons akan mengandungi objek IssueSummary yang mengandungi ringkasan kiraan isu yang ditemui.

Nota

Anda disyorkan agar menunggu antara 15 hingga 60 saat antara semakan status. Analisis lazimnya mengambil masa antara 1 hingga 5 minit untuk berjalan.
API ini memerlukan OAuth token yang mestilah token untuk aplikasi klien yang sama yang memulakan kerja analisis.

Pengepala

Nama Jenis Nilai yang dijangka Diperlukan?
Pengesahan rentetan Token OAuth pembawa 1 dengan Microsoft Entra tuntutan ID Permohonan. ya
x-ms-tenant-id GUID ID penyewa untuk aplikasi. ya
x-ms-correlation-id GUID Pengecam untuk jalanan analisis. Anda hendaklah memberikan Id yang sama untuk keseluruhan pelaksanaan (muat naik, analisis, status) ya

Respons yang dijangka

Kod status HTTP Senario Hasil
200 Satu atau lebih keputusan ditemui Lihat contoh di bawah. Satu keputusan akan dikembalikan.
202 Masih memproses Lihat contoh di bawah. Satu keputusan akan dikembalikan.
403 Dilarang Peminta tidak sama seperti pengasal permintaan untuk analisis.
404 Tidak ditemui Gagal menemui permintaan analisis dengan rujukan yang disediakan dalam URL.

Pengepala respons yang dijangka

Nama Jenis Nilai yang dijangka Diperlukan?
Lokasi uri URI untuk digunakan untuk meminta status semasa dan memperoleh keputusan ya

Badan respons yang dijangka

Jadual berikut menggariskan struktur respons bagi setiap permintaan (respons HTTP 200 atau 202 sahaja).

Sifat Jenis Nilai yang dijangka Diperlukan?
privacyPolicy rentetan URI untuk dasar privasi. Ya
kemajuan int Nilai antara 0-100 peratus selesai, di mana 10 bermaksud pemprosesan sudah kira-kira 100% selesai. Ya
runCorrelationId GUID Pengecam permintaan yang termasuk dalam setiap permintaan. Ini boleh digunakan untuk dihubungkaitkan dengan permintaan, jika perlu. Ya
status rentetan InProgress dikembalikan apabila kerja masih diproses. Failed dikembalikan apabila terdapat isu bencana memproses kerja pada pelayan. Sepatutnya terdapat butiran lanjut dalam sifat ralat. Finished dikembalikan apabila kerja telah berjaya diselesaikan tanpa masalah. FinishedWithErrors dikembalikan apabila kerja telah berjaya diselesaikan, walau bagaimanapun, satu atau lebih peraturan gagal diselesaikan tanpa ralat. Ini sememangnya satu isyarat untuk anda mengetahui bahawa laporan tersebut mungkin tidak lengkap. Microsoft maklum tentang isu ini dalam produk akhir dan akan berusaha untuk mendiagnosis dan menyelesaikan perkara ini. Ya
resultFileUris tatasusunan rentetan Senarai URL yang membenarkan muat turun output secara terus. Sepatutnya terdapat satu bagi setiap fail yang disertakan dalam panggilan API analisis asal. Tidak. Ini hanya termasuk apabila pemprosesan selesai.
issueSummary IssueSummary Sifat disenaraikan di bawah Tidak. Ini hanya termasuk apabila pemprosesan selesai.
issueSummary.criticalIssueCount int Kiraan isu yang dikenal pasti mempunyai keterukan yang kritikal dalam keputusan Ya
issueSummary.highIssueCount int Kiraan isu yang dikenal pasti mempunyai keterukan yang tinggi dalam keputusan Ya
issueSummary.mediumIssueCount int Kiraan isu yang dikenal pasti mempunyai keterukan yang sederhana dalam keputusan Ya
issueSummary.lowIssueCount int Kiraan isu yang dikenal pasti mempunyai keterukan yang rendah dalam keputusan Ya
issueSummary.informationalIssueCount int Kiraan isu yang dikenal pasti mempunyai keterukan yang bermaklumat dalam keputusan Ya

Contohnya: semakan status apabila selesai

Contoh ini mengeluarkan panggilan semakan status dengan keputusan yang lengkap.

Permintaan

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

Gunakan Power Apps API web penyemak
Dapatkan semula senarai set peraturan
Dapatkan semula senarai peraturan
Muat naik fail
Invoke analisis

  • Last updated on