Available in Classic and VPC
View the list of responses from the gateway that are generated by the API Gateway service.
Request
The following describes the request format for the endpoint. The request format is as follows:
| Method | URI |
|---|---|
| GET | /products/{product-id}/apis/{api-id}/responses |
Request headers
For headers common to API Gateway, see API Gateway common request headers.
Request path parameters
The following describes the parameters.
| Field | Type | Required | Description |
|---|---|---|---|
product-id |
String | Required | Product ID that the API belongs to
|
api-id |
String | Required | ID of the API whose response you want to view
|
Request example
The following is a sample request.
curl --location --request GET 'https://apigateway.apigw.ntruss.com/api/v1/products/********o9/apis/cvcohvd2xj/responses' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}' \
--header 'Content-Type: application/json'
Response
The following describes the response format.
Response syntax
The response syntax is as follows.
{
"gatewayResponses": [
{
"apiId": "apiId",
"responseType": "responseType",
"responseName": "headerName",
"statusCode": 000,
"headers": [
{
"apiId": "apiId",
"responseType": "responseType",
"headerName": "header",
"headerValue": "value"
}
],
"templates": [
{
"apiId": "apiId",
"responseType": "responseType",
"contentType": "application/json",
"mappingTemplate": "mappingTemplate"
}
],
"default": false
}
]
}
Response status codes
For response status codes common to all API Gateway APIs, see API Gateway response status codes.
Response example
The following is a sample response.
{
"gatewayResponses": [
{
"apiId": "cvcohvd2xj",
"responseType": "AUTHENTICATION_FAILED",
"responseName": "Authentication Failed",
"statusCode": 401,
"headers": [
{
"apiId": "cvcohvd2xj",
"responseType": "AUTHENTICATION_FAILED",
"headerName": "header",
"headerValue": "value"
}
],
"templates": [
{
"apiId": "cvcohvd2xj",
"responseType": "AUTHENTICATION_FAILED",
"contentType": "application/json",
"mappingTemplate": "{ \n \"error\":{ \n \"errorCode\":\"${context.error.errorCode}\",\n \"message\":\"${context.error.messageString}\",\n \"details\":\"$!{context.error.details}\"\n }\n }"
},
{
"apiId": "cvcohvd2xj",
"responseType": "AUTHENTICATION_FAILED",
"contentType": "application/xml",
"mappingTemplate": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n <Message>\n <error>\n <errorCode>${context.error.errorCode}</errorCode>\n <message>${context.error.messageString}</message>\n <details>$!{context.error.details}</details>\n </error>\n </Message>"
}
],
"default": false
}
]
}