Memanggil analisis

Memulai pekerjaan analisis dilakukan dengan mengirimkan permintaan POST ke rute analyze. Analisis dapat berupa proses berjalan panjang yang biasanya berlangsung lebih dari satu menit. API terlebih dahulu melakukan validasi dasar, memulai permintaan pada backend dengan mengirimkan pekerjaan, lalu merespons dengan kode status 202 dan header Location atau dengan rincian kesalahan yang sesuai. Nilai header Location adalah URL yang dapat digunakan untuk memeriksa status permintaan dan untuk mendapatkan URL hasil. Ada berbagai pilihan melalui tindakan POST untuk menyesuaikan pekerjaan berdasarkan kriteria Anda, seperti daftar aturan atau rulesets, file untuk dikecualikan dari analisis, dan banyak lagi. Anda dapat memulai analisis menggunakan [Geographical URL]/api/analyze?api-version=1.0 berikut ini.

Note

Sebaiknya tunggu antara 15 hingga 60 detik di antara pemeriksaan status. Analisis biasanya membutuhkan waktu antara 1 hingga 5 menit untuk dijalankan.
API ini memerlukan token OAuth.

Header

Nama Type Nilai yang diharapkan Diperlukan?
Authorization string Token pembawa OAuth 1 dengan klaim ID Aplikasi Microsoft Entra ID. yes
x-ms-tenant-id GUID ID penyewa untuk aplikasi. yes
x-ms-correlation-id GUID Pengidentifikasi untuk menjalankan analisis. Anda harus menyediakan ID yang sama untuk seluruh eksekusi (upload, analisis, status). yes
Terima objek application/json, application/x-ms-sarif-v2 yes
Accept-Language string Kode atau kode-kode bahasa (mis. en-US). Waktu default adalah en-US. Jika tersedia beberapa bahasa, yang pertama akan menjadi yang utama. Namun, semua terjemahan (jika bahasa didukung) akan disertakan. no

Body

Pilihan yang umum digunakan:

Property Type Nilai yang diharapkan Diperlukan?
sasUriList larik string Daftar URI yang menyediakan akses layanan untuk mengunduh satu solusi, file zip yang berisi beberapa file solusi, atau paket. Yes
ruleSets larik kustom 0 atau lebih No
ruleSets.id guid ID ruleset, yang dapat ditemukan dengan kueri API ruleset. Tidak, tapi ini biasanya yang ingin Anda gunakan. Anda harus menggunakan baik ini maupun ruleCodes.
ruleCodes.code string ID aturan yang diinginkan, yang dapat ditemukan dengan kueri ruleset dan API aturan. Tidak, Anda harus menggunakan ini atau ruleSets.
fileExclusions larik string Daftar nama file atau pola nama file untuk dikecualikan. Ada dukungan untuk menggunakan "*" sebagai wildcard di awal dan/atau akhir nama file (misalnya, *jQuery.dll dan *jQuery*). No

Respons yang diharapkan

Kode Status HTTP Skenario Result
202 Permintaan untuk analisis diterima dan URI pemeriksaan status dikembalikan ke header Location Tidak ada badan hasil
400 File non-zip dikirim, parameter salah, atau file disertakan dengan virus Tidak ada badan hasil
409 Permintaan dengan nilai header x-ms-correlation-id duplikat dikirim Tidak ada badan hasil

Header respons yang diharapkan

Nama Type Nilai yang diharapkan Diperlukan?
Lokasi Uri URL untuk digunakan dalam kueri untuk status saat ini dan untuk mendapatkan hasil yes

Contoh: memulai analisis

Ini adalah contoh memulai pekerjaan analisis dengan serangkaian aturan Sertifikasi Marketplace, file tunggal, dan mengecualikan file yang berisi teks jquery dan json dalam namanya.

Permintaan

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*"]
}

Jawaban

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

Baca juga

Menggunakan API web Power Apps Checker
Mengambil daftar set aturan
Mengambil daftar aturan
Mengunggah file
Memeriksa status analisis

  • Last updated on