본문으로 건너뛰기

사용량 계획 생성 및 관리

카카오클라우드의 API Gateway에서 사용량 계획을 통해 API 키를 통한 API 호출량을 제한할 수 있습니다.
API Gateway에서 사용량 계획을 생성 및 관리하는 방법은 다음과 같습니다.

Usage Plan 생성

신규 사용량 계획을 생성할 수 있습니다.

  1. 카카오클라우드 콘솔에서 Beyond Networking Service > API Gateway 메뉴로 이동합니다.

  2. Usage Plan 메뉴를 클릭한 후, [Usage Plan 만들기] 버튼을 클릭합니다.

  3. Usage Plan 생성 화면에서 이름, 유형, 제한값, 시간 단위 등의 값들을 입력하고 [생성] 버튼을 클릭합니다.

    구분설명
    Usage Plan 이름사용량 계획에 대한 이름
    Usage Plan 유형2가지 유형을 제공합니다.
    - Count: 호출 횟수 기반
    - Body Length: Request Body의 길이 기반
    제한값제한 값을 입력
    시간 단위아래의 단위 중 하나를 선택 가능
    - Second: 초 단위
    - Minute: 분 단위
    - Hour: 시간 단위
    - Day: 일 단위
    - Month: 월 단위
    시간 계산 방식2가지 유형을 제공합니다.
    - Remain: 요청된 현재 시간을 기준으로 남은 시간을 계산하는 방식
    - Fixed: 요청된 현재 시간을 기준으로 시간 단위만큼 계산하는 방식
    타임존2가지 유형을 제공합니다.
    - UTC: 협정세계시
    - KST: 한국표준시

Usage Plan 조회

현재 생성된 사용량 계획 목록을 확인할 수 있습니다.

  1. 카카오클라우드 콘솔에서 Beyond Networking Service > API Gateway 메뉴로 이동합니다.

  2. Usage Plan 메뉴를 클릭한 후, 현재 생성된 사용량 계획 목록을 확인합니다.

    구분설명
    Usage Plan생성되어 있는 사용량 계획의 이름
    유형이 사용량 계획에 설정된 유형 구분
    시간 단위초, 분, 시 등 이 사용량 계획에 설정된 시간 단위
    제한값이 사용량 계획에 설정된 제한값
    타임존UTC 또는 KST 중 하나로 설정된 타임존
    성공만 적용이 옵션 적용 시 2xx 응답일 경우에만 사용량 계획 잔여량을 차감
    생성일해당 사용량 계획이 생성된 일시
    [더 보기] 아이콘Usage Plan 설정: 사용량 계획의 제한값 수정
    Usage Plan 삭제: 사용량 계획을 삭제

Usage Plan 설정

지정되어 있는 제한값을 변경할 수 있습니다.

  1. 카카오클라우드 콘솔에서 Beyond Networking Service > API Gateway 메뉴로 이동합니다.
  2. Usage Plan 메뉴를 클릭한 후, 설정할 사용량 계획의 [더 보기] 아이콘 > Usage Plan 설정를 선택합니다.
  3. Usage Plan 설정 팝업창에서 제한값을 입력하고, [적용] 버튼을 클릭합니다.
구분설명
Usage Plan 이름사용량 계획에 대한 이름을 표시
제한값제한값을 조정 가능

Usage Plan 삭제

더 이상 사용하지 않는 서비스를 삭제할 수 있습니다.

  1. 카카오클라우드 콘솔에서 Beyond Networking Service > API Gateway 메뉴로 이동합니다.
  2. Usage Plan 메뉴를 클릭한 후, 삭제할 사용량 계획의 [더 보기] 아이콘 > Usage Plan 삭제를 선택합니다.
  3. Usage Plan 삭제 팝업창에서 사용량 계획의 이름을 입력하고, [삭제] 버튼을 클릭합니다.