操作场景

网关响应，指API网关未能成功处理API请求，从而产生的错误响应。API网关提供默认的网关响应（default），如果您需要自定义响应状态码或网关响应内容，可在API分组管理中新增网关响应，其中响应内容符合JSON格式即可。

例如，“default”网关的响应内容为：

{"error_code": "$context.error.code", "error_msg": "$context.error.message", "request_id": "$context.requestId"}

您可以自定义为：

{"errorcode": "$context.error.code", "errormsg": "$context.error.message", "requestid": "$context.requestId","apiId":"$context.apiId"}

JSON体的内容可以按需定制，包括增减字段内容。

• API提供的默认网关响应“default”也可以编辑修改。

• 您可以新增多个网关响应，支持同一分组下不同API配置不同的网关响应内容。

• 网关响应所定义的错误类型固定且不可修改，具体见网关错误响应类型说明。

• 响应内容支持调用API网关运行时变量（$context变量），具体见API网关运行时可获取变量。

前提条件

已创建分组。

操作步骤

步骤 1 登录管理控制台。

步骤 2 单击管理控制台左上角，然后单击“API网关 APIG”。

步骤 3 在左侧导航单击“专享版”，进入专享版实例列表页，单击“查看控制台”，进入API开发与调用管理页面。

步骤 4 单击“开放API > API分组”，进入到API分组信息页面。

步骤 5 找到您要新增或编辑修改网关响应的分组，单击并进入分组详情页。

步骤 6 单击其中的“网关响应”页签，即可新增网关响应。

• 如需编辑具体某个响应的详情，右侧有“编辑”按钮，单击即可修改响应状态码、响应内容。

• 不论是“default”或是您自定义的网关响应，响应类型范围固定不可修改。您可以修改每种响应的状态码，以及响应内容。

• 响应内容的错误信息以及其他信息，可通过变量的方式获取，支持的变量见表2。

网关错误响应类型说明

API网关提供的错误响应类型见表1，其中响应状态码可以按实际需要做自定义修改。

表1API网关的错误响应类型

API网关运行时可获取变量

表2网关错误响应消息体支持的变量