تعيين رمز الحالة

ينطبق على: جميع مستويات إدارة واجهة برمجة التطبيقات

يعين نهج set-status التعليمة البرمجية لحالة HTTP على القيمة المحددة.

إشعار

تعيين عناصر النهج والعناصر التابعة بالترتيب الوارد في بيان النهج. تعلم كيفية إعداد نُهج APIM أو تعديلها.

نهج السياسة

<set-status code="HTTP status code" reason="description"/>

سمات

السمة ‏‏الوصف مطلوبة افتراضي
الكود Integer. التعليمة البرمجية لحالة HTTP للإرجاع. يتم السماح بتعبيرات النهج. ‏‏نعم‬ غير متوفر
السبب السلسلة. وصف سبب إرجاع التعليمة البرمجية للحالة. يتم السماح بتعبيرات النهج. ‏‏نعم‬ غير متوفر

الاستخدام

  • أقسام النهج: واردة وصادرة وخلفية وعند الخطأ
  • نطاقات النهج: العمومية، ومساحة العمل، والمنتج، وواجهة برمجة التطبيقات، والتشغيل
  • البوابات: الكلاسيكية، الإصدار 2، الاستهلاك، المستضافة ذاتيا

مثال

يوضح هذا المثال كيفية إرجاع استجابة 401 إذا كان رمز التفويض غير صالح. لمزيد من المعلومات، راجع استخدام الخدمات الخارجية من خدمة Azure API Management.

<choose>
  <when condition="@((bool)((IResponse)context.Variables["tokenstate"]).Body.As<JObject>()["active"] == false)">
    <return-response response-variable-name="existing response variable">
      <set-status code="401" reason="Unauthorized" />
      <set-header name="WWW-Authenticate" exists-action="override">
        <value>Bearer error="invalid_token"</value>
      </set-header>
    </return-response>
  </when>
</choose>

لمزيد من المعلومات حول العمل مع النُهج، راجع: