إشعار
يتطلب الوصول إلى هذه الصفحة تخويلاً. يمكنك محاولة تسجيل الدخول أو تغيير الدلائل.
يتطلب الوصول إلى هذه الصفحة تخويلاً. يمكنك محاولة تغيير الدلائل.
تبدأ مهمة تحليل عن طريق إرسال طلب POST إلى مسار analyze. قد يكون التحليل عملية تشغيل طويلة عاده ما تستمر لأكثر من دقيقة. تقوم واجهه برمجة التطبيقات أولاً بعملية تحقق أساسية من الصحة، وتبدأ الطلب في الخلفية عن طريق إرسال مهمة، ثم تستجيب مع رمز الحالة 202 ورأس Location أو مع تفاصيل الخطأ المناسبة. قيمة الرأس Location هي عنوان URL يمكن استخدامه للتحقق من حالة الطلب والحصول على عناوين URL للنتائج. هناك العديد من الخيارات من خلال الاجراء POST لضبط المهمة وفقًا لمعاييرك، مثل قائمة القواعد أو مجموعات القواعد أو الملفات لاستثنائها من التحليل، وغير ذلك. يمكنك البدء بالتحليل باستخدام ما يلي [Geographical URL]/api/analyze?api-version=1.0:
ملحوظة
من المستحسن الانتظار ما بين 15 إلى 60 ثانية بين عمليات التحقق من الحالة. يستغرق التحليل عادةً ما بين دقيقة إلى 5 دقائق كي يعمل.
تتطلب واجهة برمجة التطبيقات هذه رمزا OAuth مميزا.
الرؤوس
| الاسم | النوع | القيمة المتوقعة | هل هو مطلوب؟ |
|---|---|---|---|
| التصريح | سلسلة نصية | الرمز المميز للمالك OAuth 1 مع مطالبة معرف التطبيق من Microsoft Entra ID. | نعم |
| x-ms-tenant-id | Guid | معرف المستأجر الخاص بالتطبيق. | نعم |
| x-ms-correlation-id | Guid | معرف تشغيل التحليل. يجب عليك توفير المعرف نفسه للتنفيذ بالكامل (التحميل والتحليل والحالة). | نعم |
| قبول | الهدف | application/json, application/x-ms-sarif-v2 |
نعم |
| "اللغة المقبولة (Accept-Language)" | سلسلة نصية | كود أو أكواد اللغة (على سبيل المثال، en-US). اللغة الافتراضية هي en-US. إذا تم توفير لغات متعددة، فستكون اللغة الأولى الأساسية. ومع ذلك، سيتم تضمين كافة الترجمات (إذا كانت اللغة مدعومة). | لا |
الجسم
الخيارات شائعة الاستخدام:
| الخاصية | النوع | القيمة المتوقعة | هل هو مطلوب؟ |
|---|---|---|---|
| sasUriList | صفيف من السلاسل النصية | قائمه من URI توفر الوصول إلى الخدمة لتنزيل حل واحد أو ملف zip يحتوي على ملفات حلول متعددة أو حزمة. | نعم |
| ruleSets | صفيف مخصص | 0 أو أكثر | لا. |
| ruleSets.id | guid | معرف مجموعة القواعد، الذي يمكن العثور عليه من خلال الاستعلام عن واجهة برمجة تطبيقات مجموعة القواعد. | لا، ولكن هذا عادة ما تريد استخدامه. يجب عليك استخدام إما هذه أو ruleCodes. |
| ruleCodes.code | سلسلة نصية | معرف القاعدة المحددة، الذي يمكن العثور عليه من خلال الاستعلام عن واجهة API لمجموعة القواعد والقاعدة. | لا، يجب عليك استخدام هذه أو ruleSets. |
| fileExclusions | صفيف من السلاسل النصية | قائمة أسماء الملفات أو أنماط أسماء الملفات التي سيتم استبعادها. يوجد دعم لاستخدام "*" كحرف بدل في بداية اسم ملف و/أو نهاية (على سبيل المثال، *jquery.dll و*jquery*). | لا. |
الاستجابات المتوقعة
| رمز حالة HTTP | سيناريو | النتيجة |
|---|---|---|
| 202 | تم قبول طلب التحليل وتم إرجاع URI للتحقق من الحالة في العنوان Location |
لا يوجد نص نتيجة |
| 400 | تم إرسال ملف ليس من نوع zip، أو تم تضمين معلمات غير صحيحة، أو تم تضمين ملف مع فيروس | لا يوجد نص نتيجة |
| 409 | تم إرسال طلب بقيمة رأس x-ms-correlation-id متكررة |
لا يوجد نص نتيجة |
رؤوس الاستجابة المتوقعة
| الاسم | النوع | القيمة المتوقعة | هل هو مطلوب؟ |
|---|---|---|---|
| الموقع | Uri | عنوان URL الذي سيتم استخدامه في الاستعلام عن الحالة الحالية والحصول على النتائج | نعم |
مثال: بدء عملية تحليل
هذا مثال على بدء مهمة تحليل باستخدام مجموعة قواعد شهادة Marketplace ، وملف واحد، واستبعاد الملفات التي تحتوي على jquery النصي وjson في الاسم.
الطلب
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*"]
}
استجابة
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
راجع أيضًا
استخدام واجهة برمجة تطبيقات الويب لمدقق Power Apps
استرداد قائمة مجموعات القواعد
استرداد قائمة القواعد
تحميل ملف
تحقَّق من حالة التحليل