API Gateway REST API를 사용하여 API 키 설정

API 키를 설정하려면 다음 작업을 수행합니다.

• API 메서드를 구성해 API 키를 요구합니다.

• 리전의 API에 대해 API 키를 생성하거나 가져옵니다.

API 키를 설정하기 전에 API를 생성하여 단계에 배포해야 합니다. API 키 값을 일단 생성하면 이후에 변경할 수 없습니다.

API를 생성하고 배포하기 위한 REST API 호출의 경우 각각 restapi:create 및 deployment:create를 참조하세요.

참고

고려해야 할 모범 사례는 API 키 및 사용량 계획의 위한 모범 사례 섹션을 참조하세요.

메서드에서 API 키 한 개 요구

메서드에서 API 키를 요구하려면 다음 중 하나를 실시합니다.

• method:put을 호출하여 메서드를 생성합니다. 요청 페이로드에서 apiKeyRequired를 true로 설정합니다.

• method:update를 호출하여 apiKeyRequired를 true로 설정합니다.

API 키 생성 또는 가져오기

API 키를 생성하거나 가져오려면 다음 중 하나를 실시합니다.

• apikey:create를 호출하여 API 키를 생성합니다.

• apikey:import를 호출하여 파일에서 API 키를 가져옵니다. 파일 형식은 API Gateway API 키 파일 형식 단원을 참조하세요.

새 API 키의 값은 변경할 수 없습니다. 사용량 계획을 구성하는 방법에 대해 알아보려면 API Gateway CLI 및 REST API를 사용하여 사용량 계획을 생성, 구성 및 테스트 단원을 참조하세요.