文档首页/ API网关 APIG/ 用户指南/ 调用API/ APIG的API响应消息头说明
更新时间:2024-11-27 GMT+08:00

APIG的API响应消息头说明

调用API时,API网关增加如下响应消息头。

X-Apig-Mode: debug表示响应消息头增加API网关调试信息。

响应消息头

描述

说明

X-Request-Id

请求ID

所有合法请求,都会返回此参数

X-Apig-Latency

从API网关接收请求到后端返回消息头的用时

仅在请求消息头包含X-Apig-Mode: debug时,返回此参数

X-Apig-Upstream-Latency

从API网关请求后端到后端返回消息头的用时

仅在请求消息头包含X-Apig-Mode: debug,且后端服务类型不为Mock时,返回此参数

X-Apig-RateLimit-api

API流量控制信息

示例:remain:9,limit:10,time:10 second

仅在请求消息头包含X-Apig-Mode: debug,且API配置了API流量控制时,返回此参数

X-Apig-RateLimit-user

用户流量限制信息

示例:remain:9,limit:10,time:10 second

仅在请求消息头包含X-Apig-Mode: debug,且API配置了用户流量限制时,返回此参数

X-Apig-RateLimit-app

凭据流量限制信息

示例:remain:9,limit:10,time:10 second

仅在请求消息头包含X-Apig-Mode: debug,且API配置了凭据流量限制时,返回此参数

X-Apig-RateLimit-ip

源IP流量限制信息

示例:remain:9,limit:10,time:10 second

仅在请求消息头包含X-Apig-Mode: debug,且API配置了源IP流量限制时,返回此参数

X-Apig-RateLimit-api-allenv

API默认流控信息

示例:remain:199,limit:200,time:1 second

仅在请求消息头包含X-Apig-Mode: debug时,返回此参数

X-Apig-count

请求经过APIG的总次数

经过APIG调用的合法请求都会返回此参数,当X-Apig-count请求头取值大于10时,会报错APIG.0612