API网关 APIG-新增网关响应:操作场景

时间:2024-04-09 20:49:19

操作场景

网关响应,指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网关运行时可获取变量
support.huaweicloud.com/usermanual-apig/apig-lgug-200226001.html