API Response Headers
The following table describes the response headers that APIC adds to the response returned when an API is called.
X-Apig-Mode: debug indicates APIC debugging information.
|
Response Header |
Description |
Remarks |
|---|---|---|
|
X-Request-Id |
Request ID. |
Returned for all valid requests. |
|
X-Apig-Latency |
Duration from the time when APIC receives a request to the time when the backend returns a message header. |
Returned only when the request header contains X-Apig-Mode: debug. |
|
X-Apig-Upstream-Latency |
Duration from the time when APIC sends a request to the backend to the time when the backend returns a message header. |
Returned only when the request header contains X-Apig-Mode: debug and the backend type is not Mock. |
|
X-Apig-RateLimit-api |
API request limit information. Example: remain:9,limit:10,time:10 second. |
Returned only when the request header contains X-Apig-Mode: debug and a limit has been configured for the number of times the API can be called. |
|
X-Apig-RateLimit-user |
User request limit information. Example: remain:9,limit:10,time:10 second. |
Returned only when the request header contains X-Apig-Mode: debug and a limit has been configured for the number of times the API can be called by a user. |
|
X-Apig-RateLimit-app |
Credential request limit information. Example: remain:9,limit:10,time:10 second. |
Returned only when the request header contains X-Apig-Mode: debug and a limit has been configured for the number of times the API can be called by a credential. |
|
X-Apig-RateLimit-ip |
IP address request limit information. Example: remain:9,limit:10,time:10 second. |
Returned only when the request header contains X-Apig-Mode: debug and a limit has been configured for the number of times the API can be called by an IP address. |
|
X-Apig-RateLimit-api-allenv |
Default API request limit information. Example: remain:199,limit:200,time:1 second. |
Returned only when the request header contains X-Apig-Mode: debug. |
|
X-Apig-count |
Total number of times that a request is forwarded by APIC. |
Returned for all valid requests forwarded by APIC. If the value of X-Apig-count is greater than 10, error APIC.0612 is reported. |
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.