共用方式為


設定狀態碼

適用於:所有 APIM 層

set-status 原則會將 HTTP 狀態碼設為指定值。

注意

請依照原則陳述式中提供的順序,來設定原則的元素和子元素。 深入了解如何設定或編輯 APIM 原則

原則陳述式

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

屬性

屬性 描述 是必要欄位 預設
code Integer (整數)。 要傳回的 HTTP 狀態碼。 允許原則運算式。 Yes N/A
reason 字串。 狀態碼傳回原因的描述。 允許原則運算式。 Yes N/A

使用方式

範例

此範例會說明如何在授權權杖無效時傳回 401 回應。 如需詳細資訊,請參閱使用來自 Azure APIM 服務的外部服務

<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>

如需使用原則的詳細資訊,請參閱: