API网关 APIGAPI网关 APIG

更新时间:2021/08/10 GMT+08:00
分享

HTTP响应头管理插件

API响应是指API网关返回客户端的响应,HTTP响应头是API响应中的一部分。您可以自定义HTTP响应头,在返回的API响应中指定您配置的响应头。

2021年6月1日后创建的专享版实例支持HTTP响应头管理插件,在这之前创建的专享版实例不支持HTTP响应头管理插件,如需使用HTTP响应头管理插件,请联系客服。

使用限制

无法修改API网关增加的系统响应头(x-apig-*,x-request-id等),包括API网关提供的CORS功能增加的响应头。

配置参数说明

表1 配置参数说明

参数

配置说明

Name

响应头名称。每个插件中不能添加重复名称的响应头(不区分大小写),且最多添加10条响应头。

Value

响应头的值。当“Action”为“Delete”时响应头的值不生效,可为空。

Action

响应头操作,您可以覆盖、添加、删除、跳过或新增指定的响应头。

Override:覆盖

  • 当API响应中存在指定的响应头时,使用当前响应头的值覆盖已有响应头的值。
  • 当API响应中存在多个与指定响应头相同名称的响应头时,该操作只会按当前响应头的值返回一条响应头记录。
  • 当API响应中不存在指定的响应头时,添加当前响应头。

Append:添加

  • 当API响应中存在指定的响应头时,使用当前响应头的值覆盖已有响应头的值。
  • 当API响应中存在多个与指定响应头相同名称的响应头时,会将多个响应头的值用“,”拼接后,再添加当前响应头的值。
  • 当API响应中不存在指定的响应头时,添加当前响应头。

Delete:删除

  • 当API响应中存在指定的响应头时,删除当前响应头。
  • 当API响应中存在多个与指定响应头相同名称的响应头时,删除所有相同名称的响应头。

Skip:跳过

  • 当API响应中存在指定的响应头时,跳过当前响应头。
  • 当API响应中存在多个与指定响应头相同名称的响应头时,均不作处理直接返回。
  • 当API响应中不存在指定的响应头时,添加当前响应头。

Add:新增

无论API响应中是否存在指定的响应头,都添加当前响应头。

脚本配置示例

{
    "response_headers": [
        {
            "name": "test",
            "value": "test",
            "action": "append"
        },
        {
            "name": "test1",
            "value": "test1",
            "action": "override"
        }
    ]
}
分享:

    相关文档

    相关产品