Classic/VPC 환경에서 이용 가능합니다.
생성한 메서드의 요청 파라미터 목록을 조회합니다.
요청
요청 형식을 설명합니다. 요청 형식은 다음과 같습니다.
메서드 | URI |
---|
GET | /products/{product-id}/apis/{api-id}/resources/{resource-id}/methods/{method-name}/parameters |
요청 헤더
API Gateway에서 공통으로 사용하는 헤더에 대한 자세한 내용은 API Gateway 요청 헤더를 참조해 주십시오.
요청 경로 파라미터
파라미터에 대한 설명은 다음과 같습니다.
필드 | 타입 | 필수 여부 | 설명 |
---|
product-id | String | Required | API가 속한 Product ID |
api-id | String | Required | 파라미터를 조회할 API의 ID |
resource-id | String | Required | API 내 대상 리소스의 ID |
method-name | String | Required | 대상 메서드 타입ANY | GET | POST | PUT | DELETE | PATCH | OPTIONS | HEAD
|
요청 예시
요청 예시는 다음과 같습니다.
응답
응답 형식을 설명합니다.
응답 구문
응답 구문은 다음과 같습니다.
{
"headers" : [ {
"resourceId" : "resourceId",
"methodCode" : "methodCode",
"tenantId" : "tenantId",
"parameterCode" : "REQUEST_HEADER",
"parameterType" : "string",
"apiId" : "apiId",
"parameterName" : "parameterName",
"statusCode" : 6,
"parameterDescription" : "parameterDescription",
"isRequired" : true,
"isArray" : true,
"modifier" : "modifier",
"parameterNo" : 0
} ],
"queryStrings" : [ {
"resourceId" : "resourceId",
"methodCode" : "methodCode",
"tenantId" : "tenantId",
"parameterCode" : "REQUEST_HEADER",
"parameterType" : "string",
"apiId" : "apiId",
"parameterName" : "parameterName",
"statusCode" : 6,
"parameterDescription" : "parameterDescription",
"isRequired" : true,
"isArray" : true,
"modifier" : "modifier",
"parameterNo" : 0
} ],
"formDatas" : [ {
"resourceId" : "resourceId",
"methodCode" : "methodCode",
"tenantId" : "tenantId",
"parameterCode" : "REQUEST_HEADER",
"parameterType" : "string",
"apiId" : "apiId",
"parameterName" : "parameterName",
"statusCode" : 6,
"parameterDescription" : "parameterDescription",
"isRequired" : true,
"isArray" : true,
"modifier" : "modifier",
"parameterNo" : 0
} ],
"isNcpTenant" : true,
"useBodyWhenFormData" : true
}
응답 상태 코드
API Gateway에서 공통으로 사용하는 응답 상태 코드에 대한 자세한 내용은 API Gateway 응답 상태 코드를 참조해 주십시오.
응답 예시
응답 예시는 다음과 같습니다.
의견을 보내 주셔서 감사합니다! 우리 팀이 당신에게 돌아갈 것입니다.