Product Overview 조회

인쇄
공유
PDF

기사 요약

이 요약이 도움이 되었나요?

의견을 보내 주셔서 감사합니다.

Classic/VPC 환경에서 이용 가능합니다.

지정한 Product의 Overview를 조회합니다.

요청

요청 형식을 설명합니다. 요청 형식은 다음과 같습니다.

메서드	URI
GET	/products/{product-id}/overview

요청 헤더

API Gateway에서 공통으로 사용하는 헤더에 대한 자세한 내용은 API Gateway 요청 헤더를 참조해 주십시오.

요청 경로 파라미터

파라미터에 대한 설명은 다음과 같습니다.

필드	타입	필수 여부	설명
`product-id`	String	Required	Overview를 조회할 Product ID 0~10자 Product 목록 조회를 통해 확인

요청 예시

요청 예시는 다음과 같습니다.

curl --location --request GET 'https://apigateway.apigw.ntruss.com/api/v1/products/***ksk9***/overview' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}'

응답

응답 형식을 설명합니다.

응답 구문

응답 구문은 다음과 같습니다.

{
    "apis" : [ {
        "apiName" : "apiName",
        "domainCode" : "domainCode",
        "methodsCount" : 2,
        "stages" : [ {
            "deployedStageDeploymentNo" : 0,
            "stageName" : "stageName",
            "host" : "host",
            "stageId" : "stageId"
        } ],
        "apiId" : "apiId"
    } ],
    "apiKeyCountInfo" : {
        "request" : 5,
        "total" : 5,
        "rejected" : 1,
        "accepted" : 0,
        "denied" : 6
    }
}

응답 상태 코드

API Gateway에서 공통으로 사용하는 응답 상태 코드에 대한 자세한 내용은 API Gateway 응답 상태 코드를 참조해 주십시오.

응답 예시

응답 예시는 다음과 같습니다.

{
    "apis": [
        {
            "stages": [
                {
                    "stageId": "***5ei7***",
                    "stageName": "stage",
                    "deployedStageDeploymentNo": 250***,
                    "host": "https://***ksk9***.apigw.ntruss.com"
                }
            ],
            "apiId": "***51hs***",
            "apiName": "api000",
            "methodsCount": 6
        }
    ],
    "apiKeyCountInfo": {
        "accepted": 0,
        "rejected": 0,
        "request": 0,
        "denied": 0,
        "total": 0
    }
}