通过

设置状态代码

  • 项目

适用于：所有 API 管理层级

set-status 策略将 HTTP 状态代码设置为指定的值。

注意

按照策略声明中提供的顺序设置策略的元素和子元素。 详细了解如何设置或编辑 API 管理策略。

策略语句

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

属性

属性 说明 需要 默认
code 整数。 要返回的 HTTP 状态代码。 允许使用策略表达式。 是 空值
reason 字符串。 说明返回状态代码的原因。 允许使用策略表达式。 是 空值

使用情况

示例

以下示例演示如何在授权令牌无效的情况下返回 401 响应。 有关详细信息，请参阅通过 Azure API 管理服务使用外部服务。

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

后续步骤

有关使用策略的详细信息，请参阅：