게이트웨이 응답 조회
- 인쇄
- PDF
게이트웨이 응답 조회
- 인쇄
- PDF
기사 요약
이 요약이 도움이 되었나요?
의견을 보내 주셔서 감사합니다.
Classic/VPC 환경에서 이용 가능합니다.
API Gateway 서비스에서 발생하는 게이트웨이의 응답 목록을 조회합니다.
요청
요청 형식을 설명합니다. 요청 형식은 다음과 같습니다.
메서드 | URI |
---|---|
GET | /products/{product-id}/apis/{api-id}/responses |
요청 헤더
API Gateway에서 공통으로 사용하는 헤더에 대한 자세한 내용은 API Gateway 요청 헤더를 참조해 주십시오.
요청 경로 파라미터
파라미터에 대한 설명은 다음과 같습니다.
필드 | 타입 | 필수 여부 | 설명 |
---|---|---|---|
product-id | String | Required | API가 속한 Product ID
|
api-id | String | Required | 응답을 조회할 API의 ID
|
요청 예시
요청 예시는 다음과 같습니다.
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'
응답
응답 형식을 설명합니다.
응답 구문
응답 구문은 다음과 같습니다.
{
"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
}
]
}
응답 상태 코드
API Gateway API에서 공통으로 사용하는 응답 상태 코드에 대한 자세한 내용은 API Gateway 응답 상태 코드를 참조해 주십시오.
응답 예시
응답 예시는 다음과 같습니다.
{
"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
}
]
}
이 문서가 도움이 되었습니까?