Establecimiento de código de estado
SE APLICA A: todos los niveles de API Management
La directiva set-status establece el código de estado HTTP en el valor especificado.
Nota:
Establezca los elementos de la directiva y los elementos secundarios en el orden proporcionado en la instrucción de directiva. Obtenga más información sobre el establecimiento o modificación de directivas de API Management.
Instrucción de la directiva
<set-status code="HTTP status code" reason="description"/>
Atributos
| Atributo | Descripción | Necesario | Valor predeterminado |
|---|---|---|---|
| código | Entero. Código de estado HTTP que se devuelve. Se permiten expresiones de directiva. | Sí | N/D |
| reason | String. Una descripción del motivo por el que se devuelve el código de estado. Se permiten expresiones de directiva. | Sí | N/D |
Uso
- Secciones de directiva: entrante, saliente, back-end, on-error
- Ámbitos de la directiva: global, área de trabajo, producto, API, operación
- Puertas de enlace: clásica, v2, consumo, autohospedada y área de trabajo
Ejemplo
En este ejemplo se muestra cómo devolver una respuesta 401 si el token de autorización no es válido. Para más información, consulte Uso de servicios externos desde el servicio 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>
Directivas relacionadas
Contenido relacionado
Para más información sobre el trabajo con directivas, vea:
- Tutorial: Transformación y protección de una API
- Referencia de directivas para una lista completa de instrucciones de directivas y su configuración
- Expresiones de directiva
- Establecimiento o edición de directivas
- Reutilización de configuraciones de directivas
- Repositorio de fragmentos de código de directiva
- kit de herramientas de directivas de Azure API Management
- Creación de directivas mediante Microsoft Copilot en Azure