Classic/VPC 환경에서 이용 가능합니다.
생성된 바디 모델 중 특정 모델에 대한 간단한 정보를 조회합니다.
요청
요청 형식을 설명합니다. 요청 형식은 다음과 같습니다.
| 메서드 | URI |
|---|---|
| GET | /products/{product-id}/apis/{api-id}/models/{model-id} |
요청 헤더
API Gateway에서 공통으로 사용하는 헤더에 대한 자세한 내용은 API Gateway 요청 헤더를 참조해 주십시오.
요청 경로 파라미터
파라미터에 대한 설명은 다음과 같습니다.
| 필드 | 타입 | 필수 여부 | 설명 |
|---|---|---|---|
product-id |
String | Required | API가 속한 Product ID
|
api-id |
String | Required | 모델 정보를 조회할 API의 ID
|
model-id |
String | Required | 대상 모델의 ID
|
요청 예시
요청 예시는 다음과 같습니다.
curl --location --request GET 'https://apigateway.apigw.gov-ntruss.com/api/v1/products/********o9/apis/cvcohvd2xj/models/tua1hd0pi4' \
--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'
응답
응답 형식을 설명합니다.
응답 구문
응답 구문은 다음과 같습니다.
{
"modelId" : "modelId",
"apiId" : "apiId",
"modelName" : "modelName",
"modelDescription" : "modelDescription",
"modelSchema" : "modelSchema"
}
응답 상태 코드
API Gateway API에서 공통으로 사용하는 응답 상태 코드에 대한 자세한 내용은 API Gateway 응답 상태 코드를 참조해 주십시오.
응답 예시
응답 예시는 다음과 같습니다.
{
"modelId": "tua1hd0pi4",
"apiId": "cvcohvd2xj",
"modelName": "testmodel",
"modelDescription": "test model",
"modelSchema": "{\n \"type\": \"object\",\n \"properties\": {\n \"firstName\": {\n \"type\": \"string\"\n },\n \"lastName\": {\n \"type\": \"string\"\n },\n \"age\": {\n \"description\": \"Age in years\",\n \"type\": \"integer\",\n \"minimum\": 3\n }\n },\n \"required\": [\n \"firstName\",\n \"lastName\"\n ]\n}"
}