API Gateway API 키 파일 형식 - Amazon API Gateway

기계 번역으로 제공되는 번역입니다. 제공된 번역과 원본 영어의 내용이 상충하는 경우에는 영어 버전이 우선합니다.

API Gateway API 키 파일 형식

API Gateway는 쉼표로 분리된 값(CSV) 형식의 외부 파일에서 API 키를 가져온 다음, 가져온 키를 하나 이상의 사용량 계획과 연결할 수 있습니다. 가져온 파일에는 NameKey열이 포함되어 있어야 합니다. 다음 예에서 보듯 열 헤더 이름은 대/소문자를 구분하지 않으며, 열 순서는 상관없습니다.

Key,name apikey1234abcdefghij0123456789,MyFirstApiKey

Key값은 20~128자 사이여야 합니다. Name 값은 1,204자를 초과할 수 없습니다.

또한 API 키 파일은 다음과 같이 Description열, Enabled 열 또는 UsagePlanIds열을 포함할 수 있습니다.

Name,key,description,Enabled,usageplanIds MyFirstApiKey,apikey1234abcdefghij0123456789,An imported key,TRUE,c7y23b

키 1개가 둘 이상의 사용량 계획과 연결된 경우, 다음 예에서 보듯 UsagePlanIds 값은 큰따옴표나 작은따옴표로 묶인 사용량 계획 ID를 쉼표로 구분한 문자열입니다.

Enabled,Name,key,UsageplanIds true,MyFirstApiKey,apikey1234abcdefghij0123456789,"c7y23b,glvrsr"

인식할 수 없는 열도 사용할 수 있지만 무시됩니다. 기본값은 빈 문자열 또는 true 부울 값입니다.

최신 버전으로 이전 버전을 덮어쓰면 동일한 API 키를 여러 번 가져올 수 있습니다. key 값이 동일한 경우 두 API 키는 동일합니다.

참고

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