Compartilhar via

Definir código de status

  • Artigo

APLICA-SE A: todas as camadas do Gerenciamento de API

A política set-status define o código de status HTTP para o valor especificado.

Observação

Defina os elementos da política e os elementos filho na ordem fornecida na declaração da política. Saiba mais sobre como definir e editar as políticas de Gerenciamento de API.

Declaração de política

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

Atributos

Atributo Descrição Obrigatório Padrão
code Inteiro. O código de status HTTP a ser retornado. Expressões de política são permitidas. Sim N/D
reason Cadeia de caracteres. Uma descrição do motivo para retornar o código de status. Expressões de política são permitidas. Sim N/D

Uso

Exemplo

Este exemplo mostra como retornar uma resposta 401, se o token de autorização for inválido. Para obter mais informações, consulte Uso dos serviços externos do serviço de Gerenciamento de API do Azure.

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

Conteúdo relacionado

Para obter mais informações sobre como trabalhar com políticas, consulte: