Estos contenidos se han traducido de forma automática para su comodidad, pero Huawei Cloud no garantiza la exactitud de estos. Para consultar los contenidos originales, acceda a la versión en inglés.
Centro de ayuda> API Gateway> Guía del usuario> API Opening> Plug-ins> Plug-in de gestión de encabezados de respuesta HTTP
Actualización más reciente 2023-11-30 GMT+08:00
Ver PDF

Plug-in de gestión de encabezados de respuesta HTTP

Los encabezados de respuesta HTTP son parte de la respuesta devuelta por API Gateway a un cliente que llama a una API. Puede personalizar los encabezados de respuesta HTTP que se incluirán en una respuesta de API.

Solo las puertas de enlace dedicadas creadas a partir del 1 de junio de 2021 admiten el complemento de gestión de encabezados de respuesta HTTP. Para utilizar este complemento para puertas de enlace dedicadas creadas antes del 1 de junio de 2021, póngase en contacto con el servicio de atención al cliente.

Directrices de uso

No puede modificar los encabezados de respuesta, como x-apig-* y x-request-id, agregados por API Gateway, o los encabezados configurados para CORS.

Parámetros de configuración

Tabla 1 Parámetros de configuración

Parámetro

Descripción

Name

Nombre del encabezado de la respuesta, que no distingue entre mayúsculas y minúsculas y debe ser único dentro de un plug-in. Puede agregar un máximo de 10 encabezados de respuesta.

Value

Valor del encabezado de respuesta. Este parámetro no tiene efecto y puede dejarse en blanco si establece Action en Delete.

Action

Operación del encabezado de respuesta. Puede anular, anexar, eliminar, omitir o agregar el encabezado especificado.

Override

  • El valor de este encabezado de respuesta anulará el del mismo encabezado que existe en una respuesta de API.
  • Si una respuesta de API contiene varios encabezados con el mismo nombre que el que ha establecido aquí, solo se devolverá el valor del encabezado especificado.
  • Si una respuesta de API no contiene el encabezado especificado, se devolverá el valor que establezca aquí.

Append

  • Si una respuesta de API contiene el encabezado especificado, se agregará el valor que establezcas aquí, siguiendo el valor existente. Los dos valores se separarán con comas (,).
  • Si una respuesta de API contiene varios encabezados con el mismo nombre que el que estableces aquí, los valores de estos encabezados se separarán con comas (,) y seguidos por el valor del encabezado especificado.
  • Si una respuesta de API no contiene el encabezado especificado, se devolverá el valor que establezca aquí.

Delete

  • Si una respuesta de API contiene el encabezado especificado, el encabezado se eliminará.
  • Si una respuesta de API contiene varios encabezados con el mismo nombre que el que configuraste aquí, todos estos encabezados se eliminarán.

Skip

  • Si una respuesta de API contiene el encabezado especificado, el encabezado se omitirá.
  • Si una respuesta de API contiene varios encabezados con el mismo nombre que el que ha establecido aquí, los valores de todos estos encabezados se devolverán sin modificación.
  • Si una respuesta de API no contiene el encabezado especificado, se devolverá el valor que establezca aquí.

Add

El valor del encabezado especificado se devolverá incluso si el encabezado no existe en una respuesta de API.

Script de ejemplo

{
    "response_headers": [
        {
            "name": "test",
            "value": "test",
            "action": "append"
        },
        {
            "name": "test1",
            "value": "test1",
            "action": "override"
        }
    ]
}
Tema principal: Plug-ins