Usage Plans
  • PDF

Usage Plans

  • PDF

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

API를 생성, 배포한 후 Usage Plan(사용 계획)을 통해 API 사용량을 제어할 수 있습니다.

참고

API의 Satge에서도 기본 Usage Plan을 설정할 수 있습니다.
자세한 내용은 My Products 메뉴의 Usage Plans 변경을 참고해 주십시오.

Usage Plans 화면 및 목록

API Gateway 이용을 위한 Usage Plans 메뉴의 기본적인 설명은 다음과 같습니다.

apigw-apigw-2-3-list_ko

영역 설명
① 메뉴명 현재 확인 중인 메뉴 이름, 운영 중인 Usage plan 개수
② 기본 기능 Usage plan 생성, API Gateway 상세 정보 확인, 페이지 새로 고침
③ 생성 후 기능 운영 중인 Usage Plan 수정, 삭제, Stage에 연결 및 관리
④ 검색창 Usage Plan 이름을 입력한 후 i-apigateway-find을 클릭해 항목 검색
⑤ 정렬 목록 페이지당 표시할 Usage Plan 개수 설정
⑥ Usage plan 목록 운영 중인 Usage plan 목록 확인
  • Usage Plan ID: 생성한 Usage Plan의 ID(자동 부여)
  • Usage Plan 이름: Usage Plan 생성 시 설정한 Usage Plan의 이름
  • 설명: Usage Plan 생성 시 입력한 Usage Plan의 설명
  • 요청 처리량: Usage Plan 생성 시 설정한 요청 처리량(단위: 건/초)
  • 일 요청 처리 한도: Usage Plan 생성 시 설정한 요청 처리 한도(단위: 건/일)
  • 월 요청 처리 한도: Usage Plan 생성 시 설정한 요청 처리 한도(단위: 건/월)

Usage Plan 생성

Usage Plan을 생성하는 방법은 다음과 같습니다.

  1. 네이버 클라우드 플랫폼 콘솔에서 Services > Application Services > API Gateway 메뉴를 차례대로 클릭해 주십시오.
  2. Usage Plans 메뉴를 클릭해 주십시오.
  3. [Usage Plan 생성] 버튼을 클릭해 주십시오.
  4. Usage Plan 생성 정보를 입력한 후 [저장] 버튼을 클릭해 주십시오.
    • 이름: Usage Plan의 이름을 입력
    • 설명: Usage Plan의 설명을 입력
    • 요청 처리량(Rate): 초당 요청 수를 설정
    • 요청 처리 한도(Quota): 일별, 월별 API 사용량을 설정
    • 사용량은 일/월의 시작을 기준으로 카운트됩니다.
    • 엔드포인트의 응답 코드에 따라 사용량을 카운트합니다.
  5. Usage plans 목록에서 생성한 Usage plan이 표시되는지 확인해 주십시오.
    • 요청 처리량과 요청 처리 한도가 제대로 설정되지 않으면 요청 처리량이 설정되지 않았습니다. 또는 요청 처리 한도가 설정되지 않았습니다. 라는 메시지가 표시됩니다. 해당 Usage Plan을 수정해 주십시오(Usage plans 수정 참고).

Usage Plan 수정

Usage Plan을 수정하는 방법은 다음과 같습니다.

  1. 네이버 클라우드 플랫폼 콘솔에서 Services > Application Services > API Gateway 메뉴를 차례대로 클릭해 주십시오.
  2. Usage Plans 메뉴를 클릭해 주십시오.
  3. Usage Plans 목록에서 수정할 Usage Plan을 클릭해 선택한 후 [수정] 버튼을 클릭해 주십시오.
  4. Usage Plan 수정 화면에서 설정 정보를 수정한 후 [저장] 버튼을 클릭해 주십시오.
  5. Usage plans 목록에서 Usage plan이 수정되었는지 확인해 주십시오.

Usage Plan 삭제

Usage Plan을 삭제하는 방법은 다음과 같습니다.

  1. 네이버 클라우드 플랫폼 콘솔에서 Services > Application Services > API Gateway 메뉴를 차례대로 클릭해 주십시오.
  2. Usage Plans 메뉴를 클릭해 주십시오.
  3. Usage Plans 목록에서 삭제할 Usage Plan을 클릭해 선택한 후 [삭제] 버튼을 클릭해 주십시오.
  4. 삭제 확인 팝업 창에서 내용을 확인한 후 [삭제] 버튼을 클릭해 주십시오.

Stage 연결 및 관리

설정한 Usage Plan을 Stage에 연결하고 관리할 수 있습니다.

  • Usage Plan과 Stage의 각 화면에서 연결할 수 있습니다.
  • Usage Plan에 연결된 Stage의 API 사용량은 통합 관리됩니다.

Usage Plan에 연결된 Stage 목록에 대한 설명은 다음과 같습니다.

apigw-apigw-2-3-stage-list_ko

영역 설명
① Usage Plan 현재 설정 정보
② Stage 연결 관리 선택한 Usage Plan을 Stage에 연결연결 해제
③ 목록 Usage Plan에 연결된 Stage 목록
④ 정렬 목록 페이지당 표시할 Stage 개수 설정

Stage 연결

Usage Plan을 Stage에 연결하는 방법은 다음과 같습니다.

참고

Usage Plan을 Stage에 연결하려면 먼저 해당 API에 Stage를 생성해야 합니다.
자세한 내용은 Stage 생성을 참고해 주십시오.

  1. 네이버 클라우드 플랫폼 콘솔에서 Services > Application Services > API Gateway 메뉴를 차례대로 클릭해 주십시오.
  2. Usage Plans 메뉴를 클릭해 주십시오.
  3. Usage Plans 목록에서 대상 Usage Plan을 클릭해 선택한 후 [Stage] 버튼을 클릭해 주십시오.
  4. 연결된 Stage 목록 화면에서 [Stage 연결] 버튼을 클릭해 주십시오.
  5. Stage 연결 팝업 창에서 연결할 Stage를 선택한 후 [추가] 버튼을 클릭해 주십시오.
    • Product: 연결할 Stage가 있는 Product를 선택
    • API: 연결할 Stage가 있는 API 선택
    • Stage: 연결할 Stage를 선택

Stage 연결 해제

Usage Plan과 연결된 Stage의 연결을 해제하는 방법은 다음과 같습니다.

  1. 네이버 클라우드 플랫폼 콘솔에서 Services > Application Services > API Gateway 메뉴를 차례대로 클릭해 주십시오.
  2. Usage Plans 메뉴를 클릭해 주십시오.
  3. Usage Plans 목록에서 연결을 해제할 Usage Plan을 클릭해 선택한 후 [Stage] 버튼을 클릭해 주십시오.
  4. 연결된 Stage 목록 화면에서 연결을 해제할 Stage를 클릭해 선택한 후 [삭제] 버튼을 클릭해 주십시오.
  5. Stage 연결 해제 팝업 창에서 내용을 확인한 후 [삭제] 버튼을 클릭해 주십시오.
    • Stage의 연결이 해제되며 목록에서 삭제됩니다.

이 글이 도움이 되었나요?

What's Next