Gunakan analisis

Memulakan tugas analisis dilakukan dengan menyerahkan permintaan POST kepada laluan analyze. Analisis boleh menjadi proses jalanan yang panjang yang lazimnya berlangsung lebih daripada satu minit. Pertama, API melakukan penentusahan asas tertentu, memulakan permintaan ke atas tunggakan kerja dengan menyerahkan tugas, kemudian memberi respons dengan kod status 202 dan pengepala Location atau dengan butiran ralat yang sesuai. Nilai pengepala Location ialah URL yang boleh digunakan untuk menyemak pada status permintaan dan untuk mendapatkan URL keputusan. Terdapat pelbagai pilihan melalui tindakan POST untuk menyesuaikan tugas berdasarkan kriteria anda, seperti senarai peraturan atau set peraturan, fail untuk dikecualikan daripada analisis dan banyak lagi. Anda boleh memulakan analisis menggunakan[Geographical URL]/api/analyze?api-version=1.0 yang berikut.

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.

Pengepala

Nama	Jenis	Nilai yang dijangka	Diperlukan?
Pengesahan	rentetan	Token pembawa OAuth 1 dengan tuntutan ID Aplikasi Microsoft Entra ID.	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
Terima	objek	application/json, application/x-ms-sarif-v2	ya
Accept-Language	rentetan	Kod bahasa (cth,. en-US). Bahasa lalai ialah en-US. Jika berbilang bahasa diberikan, bahasa pertama akan menjadi bahasa utama. Namun, semua terjemahan (jika bahasa disokong) akan disertakan.	tidak

Isi

Pilihan yang sering digunakan:

Sifat	Jenis	Nilai yang dijangka	Diperlukan?
sasUriList	tatasusunan rentetan	Senarai URI yang menyediakan akses perkhidmatan untuk muat turun penyelesaian tunggal, fail zip mengandungi berbilang fail penyelesaian, atau pakej.	Ya
ruleSets	tatasusunan tersuai	0 atau lebih	Tidak
ruleSets.id	Guid	ID set peraturan yang boleh ditemui dengan bertanyakan API set peraturan.	Tidak, tetapi ini lazimnya apa yang anda mahu gunakan. Anda mesti menggunakan sama ada ini atau ruleCodes.
ruleCodes.code	rentetan	ID peraturan yang diingini yang boleh ditemui dengan bertanyakan API set peraturan dan peraturan.	Tidak, anda mesti menggunakan ini atau set peraturan.
fileExclusions	tatasusunan rentetan	Senarai nama fail atau corak nama fail untuk dikecualikan. Sokongan wujud untuk menggunakan "*" sebagai kad bebas pada awal dan/atau akhir nama fail ( cth.,*jquery.dll and *jquery*).	Tidak

Respons yang dijangka

Kod status HTTP	Senario	Keputusan
202	Minta analisis diterima dan URI semakan status dikembalikan dalam pengepala Location	Tiada badan keputusan
400	Fail bukan zip telah dihantar, parameter tidak tepat atau fail dimasukkan dengan virus	Tiada badan keputusan
409	Permintaan dengan nilai pengepala x-ms-correlation-id pendua telah dihantar	Tiada badan keputusan

Pengepala respons yang dijangka

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

Contoh: mulakan analisis

Ini ialah contoh memulakan kerja analisis dengan set peraturan Pensijilan Pasaran , satu fail dan mengecualikan fail yang mengandungi teks jquery dan json dalam nama.

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

Respons

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

Lihat juga

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