Analiz çağırma

Analiz işi POST yoluna bir analyze isteği gönderilerek başlatılır. Analiz, genellikle bir dakikadan fazla zaman alır; uzun süre çalışan bir işlem olabilir. API, bazı temel doğrulamalar yapar, bir iş göndererek arka uçta isteği başlatır ve ardından 202 durum kodu ve Location başlığı veya uygun hata ayrıntılarıyla yanıt verir. Location başlık değeri, isteğin durumunu denetlemek ve sonuçların URL'lerini almak için kullanılabilen bir URL'dir. POST eyleminde işi ölçütlerinize uygun hale getirmek için kuralların veya kural kümelerinin listesi, analiz dışında bırakılacak dosyalar ve bunlar gibi çeşitli seçenekler vardır. Aşağıdaki [Geographical URL]/api/analyze?api-version=1.0 öğesini kullanarak analizi başlatabilirsiniz.

Note

Durum denetimleri arasında 15 - 60 saniye beklenilmesi önerilir. Analizin çalışması genellikle 1 - 5 dakika sürer.
Bu API bir OAuth belirteç gerektirir.

Headers

İsim Türü Beklenen değer Gerekli mi?
Authorization string Microsoft Entra ID Uygulama Kimliği talebine sahip OAuth 1 taşıyıcı belirteci. evet
x-ms-tenant-id GUID Uygulama kiracısının kimliği. evet
x-ms-correlation-id GUID Analizi çalıştırma Tanımlayıcısı. Yürütmenin tamamı için aynı kimliği sağlamanız gerekir (yükleme, çözümleme, durum). evet
Kabul Et Nesne application/json, application/x-ms-sarif-v2 evet
Accept-Language string Dil kodu veya kodları (örn. en-US). Varsayılan en-US değeridir. Birden çok dil sağlanırsa ilk sağlanan dil birincil olur. Bununla beraber tüm çeviriler (dil destekleniyorsa) dahil edilir. hayır

Body

Sık kullanılan seçenekler:

Mülkiyet Türü Beklenen değer Gerekli mi?
sasUriList stringler dizisi Tek bir çözüm, birden çok çözüm dosyası içeren bir zip dosyası veya bir paket indirmek için hizmete erişim sağlayan URI'lerin listesi. Evet
ruleSets özel dizi 0 veya daha fazla Hayır
ruleSets.id guid Kural kümesi API'si sorgulanarak bulunabilen kural kümesinin kimliği. Hayır, ama bu genellikle kullanmak isteyeceğiniz şeydir. Bunu veya ruleCodes'u kullanmanız gerekir.
ruleCodes.code string Kural kümesi ve kural API'si sorgulanarak bulunabilen, istenilen kuralın kimliği. Hayır, bunu veya ruleSets'i kullanmanız gerekir.
fileExclusions stringler dizisi Dışlanacak dosya adları veya dosya adı kalıplarının listesi. Dosya adının başında ve/veya sonunda "*" karakterini joker karakteri olarak kullanma desteği vardır (örn *jquery.dll ve *jquery*). Hayır

Beklenen yanıtlar

HTTP durum kodu Scenario Result
202 Analiz isteği kabul edildi ve durum denetimi URI'si Location başlığında döndürüldü Sonuç içeriği yok
400 Zip olmayan bir dosya gönderildi, yanlış parametreler veya virüs olan bir dosya eklenmiş Sonuç içeriği yok
409 Yinelenen x-ms-correlation-id başlık değerine sahip bir istek gönderildi Sonuç içeriği yok

Beklenen yanıt başlıkları

İsim Türü Beklenen değer Gerekli mi?
Yer Uri Geçerli durumu sorgulamada ve sonuçları elde etmede kullanılacak URL evet

Örnek: analiz başlatma

Bu, Marketplace Sertifikasyonu kural kümesiyle, adında jquery ve json metnini içeren dosyaları dışlayarak, tek bir dosyayla bir analiz işi başlatmanın bir örneğidir.

İstek

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

Yanıt

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

Ayrıca bakınız

Power Apps denetleyicisi web API'sini kullanın
Kural kümeleri listesini alma
Kurallar listesini alma
Dosyayı karşıya yükleme
Analiz durumunu denetleme

  • Last updated on