# Response Rewrite 配置选项

response-rewrite 插件支持改写 API 网关和上游服务返回的响应，为 API 响应提供更高的灵活性。<!-- --> <!-- -->配置涵盖插件参数。

## 参数[​](#参数 "参数的直接链接")

请参阅[通用配置](https://docs.apiseven.com/apisix/reference/plugin-common-configurations.md)了解所有插件可用的配置选项。

* status\_code

  integer

  有效值：

  介于 200 和 598 之间（含边界值）

  ***

  响应中的新 HTTP 状态码。

* body

  string

  ***

  新的响应体。`Content-Length` 头也将被重置。不应与 `filters` 一起配置。

* body\_base64

  boolean

  默认值：`false`

  ***

  如果为 true，则在发送给客户端之前解码 `body` 中配置的响应体，这对于图像和 protobuf 解码很有用。请注意，此配置不能用于解码上游响应。

* headers

  object

  ***

  配置多个操作时，按 `add`、`set`、`remove` 的顺序执行。对于同一个响应头，`set` 会覆盖 `add` 添加的值，`remove` 会在这两项操作之后删除该响应头。

  * add

    array\[string]

    ***

    追加到响应的响应头。如果响应中已存在该响应头，则将追加该响应头值。响应头值可以设置为常量，或一个或多个[内置变量](https://docs.apiseven.com/apisix/reference/built-in-variables.md)。

  * set

    object

    ***

    设置到响应的响应头。如果响应中已存在该响应头，则将覆盖该响应头值。响应头值可以设置为常量，或一个或多个[内置变量](https://docs.apiseven.com/apisix/reference/built-in-variables.md)。

  * remove

    array\[string]

    ***

    从响应中删除的响应头。

* vars

  array\[array]

  ***

  一个或多个 [APISIX 表达式](https://docs.apiseven.com/apisix/reference/apisix-expressions.md) 形式的匹配条件数组，用于按条件执行插件。

* filters

  array\[object]

  ***

  通过将一个指定字符串替换为另一个字符串来修改响应体的过滤器列表。不应与 `body` 一起配置。

  * regex

    string

    必填

    ***

    在响应体上匹配的正则表达式模式。

  * scope

    string

    默认值：`once`

    有效值：

    `once` 或 `global`

    ***

    替换范围。`once` 替换第一个匹配的实例，`global` 进行全局替换。

  * replace

    string

    必填

    ***

    用于替换的内容。

  * options

    string

    默认值：`jo`

    ***

    用于控制匹配操作执行方式的正则表达式选项。请参阅 [Lua NGINX 模块](https://github.com/openresty/lua-nginx-module#ngxrematch)以了解可用选项。

* max\_resp\_body\_size

  integer

  默认值：`67108864`

  有效值：

  大于或等于 1

  ***

  配置 `filters` 时缓冲的响应体最大字节数。超过该大小的响应会在运行过滤器前截断到此大小。跨越阈值的数据块会在执行限制前先进入缓冲，因此瞬时内存用量可能超过配置值。未配置 `filters` 时，此字段无效。自 API7 企业版 3.9.17 和 3.10.4 以及 APISIX 3.18.0 起引入。
