Usage Plan이 연결된 Stage 조회

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

지정한 Usage Plan이 연결된 Stage의 상세 정보를 조회합니다.

요청

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

메서드	URI
GET	/usage-plans/{usage-plan-id}/stages

요청 헤더

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

요청 경로 파라미터

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

필드	타입	필수 여부	설명
`usage-plan-id`	String	Required	Stage를 조회할 Usage Plan ID 0~10자 Usage Plan 목록 조회를 통해 확인

요청 쿼리 파라미터

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

필드	타입	필수 여부	설명
`offset`	Long	Optional	응답 데이터의 시작 지점 0~9,223,372,036,854,775,807 `limit`과 함께 페이지네이션 구현에 사용
`limit`	Long	Optional	응답 데이터의 최대 수 1~9,223,372,036,854,775,807 `offset`과 함께 페이지네이션 구현에 사용
`name`	String	Optional	조회할 Stage의 이름 1~20자

요청 예시

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

curl --location --request GET 'https://apigateway.apigw.gov-ntruss.com/api/v1/usage-plans/***9rpm***/stages' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}'

응답

응답 형식을 설명합니다.

응답 구문

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

{
    "total" : 0,
    "stages" : [ {
        "apiName" : "apiName",
        "stageName" : "stageName",
        "productId" : "productId",
        "apiId" : "apiId",
        "productName" : "productName",
        "stageId" : "stageId"
    } ],
    "usagePlan" : {
        "domainCode" : "domainCode",
        "monthQuotaRequest" : 1,
        "dayQuotaRequest" : 6,
        "rateRps" : 5,
        "quotaCondition" : "quotaCondition"
  }
}

응답 상태 코드

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

응답 예시

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

{
    "stages": [
        {
            "productName": "product",
            "apiName": "api000",
            "stageName": "stage",
            "stageId": "***5ei7***",
            "productId": "***ksk9***",
            "apiId": "***51hs***"
        }
    ],
    "total": 1,
    "usagePlan": {
        "domainCode": "GOV"
    }
}