안녕하세요. 멀티클라우드 관리 플랫폼, SpaceONE입니다.
미국의 MRFR 시장 조사 미래에서 배포한 종합 연구 보고서 ‘클라우드 API 마켓’에 따르면 전 세계 클라우드 API 시장은 2022년까지 약 7억 6,300만 달러의 가치를 평가받고 있었으며, 2030년까지 연평균 성장률 23%를 기록할 것이라고 밝혔습니다. 워크플로우의 간소화를 위한 데이터 기반 의사 결정, 자동화 및 디지털 전환을 증가시키기 위한 요구 사항이 API 시장의 성장을 주도하고 있습니다.
시장의 성장함에 따라 기업이 API를 도입하며 비즈니스를 확장하는 사례 또한 증가하고 있습니다. 바로 API의 장점인 개발 비용 절감, 서비스 확장성 등 효율적이고 안정적인 개발이 가능한 점 때문인데요.
이러한 특징을 갖고 있는 API의 간략한 설명과 함께,
SpaceONE의 API Key 발급 과정부터 활용법까지 소개해드리겠습니다 !
API(Application Programming Interface)란 무엇인가?
API는 서버와 클라이언트가 데이터를 서로 주고받을 수 있도록 도움을 주는 매개체라고 할 수 있습니다. 쉽게 말해서, API를 통해 내부 시스템이나 다양한 애플리케이션에서 데이터를 받아올 수 있습니다. API는 플러그인, 인터페이스 및 소프트웨어 통신 등과 같이 우리가 사용하는 모든 디지털 프로그램 측면에 존재하고 있습니다.
프로그램끼리 통신하기 위해서는 몇 가지 규칙을 따라야 하는데요. 데이터를 주고받기 위한 사용 방법과 규격을 나타내는 규칙을 API 문서라고 합니다.
SpaceONE에서도 500여 개의 API 기반 통신을 활용하여
유연한 시스템을 통합 관리할 수 있습니다. 오늘은 SpaceONE의 API 활용법에 대해서 살펴보고자 합니다.
SpaceONE API Key 발급 과정
API를 사용하기 전에 우선 API Key 발급이 선행되어야 합니다. API Key는 소프트웨어와 애플리케이션이 서로를 식별하고 함께 작동하도록 인증하는 고유 코드로 일종의 액세스 권한을 식별하는 키라고 할 수 있습니다. API Key를 통해 API의 사용을 추적하고 제어하며 API 남용을 방지하기 위해 사용되고 있습니다.
SpaceONE에서 API Key 발급 과정은 아래와 같습니다.
1.
부여 받은 도메인에 Console 접속합니다.
2.
로그인 후 메인 페이지 우측 상단에 마이페이지 버튼을 클릭합니다.
3.
API & CLI 설정 메뉴를 클릭합니다.
4.
+API Key 생성 버튼을 눌러 Key 발급을 완료하며 spacectl을 사용하기 위해 <spacectl_config.yml> 파일을 다운로드 받습니다.
API 키 발급 시 주의사항
•
API 키는 생성 시에 단 한 번만 확인할 수 있습니다.
•
API 키는 사용자 아이디 당 2개까지 발급할 수 있습니다.
Spacectl 설치 과정
API Key 발급이 끝났다면 Spacectl 설치 및 설정 과정이 필요합니다. Spacectl은 SpaceONE에서 관리하는 리소스에 대한 명령을 쉽고 빠르게 실행할 수 있는 커맨드라인 도구(CLI)입니다. 지원되는 모든 설정 및 명령에 대한 자세한 내용은 API 참고 부탁드리며, Spacectl 설치 과정은 아래와 같습니다.
1.
pip3를 사용하여 PyPI 명령으로 최신 Spacectl 릴리스를 설치합니다.
sudo pip3 install --upgrade pip
sudo pip3 install spaceone-core spaceone-api --upgrade
sudo pip3 install spacectl
Python
복사
2.
Spacectl을 사용하기 위해 config 파일을 지정해야 합니다. 이때, 이전 단계인 API Key 발급 과정에서 다운 받은 <spacectl_config.yml> 파일이 필요합니다.
spacectl config init -f <spacectl_config.yml>
# <spacectl_config.yml>에 spacectl_config.yml 파일의 경로를 입력해야 합니다.
Python
복사
3.
spacectl api-resources 명령으로 설정 파일 적용이 완료 되었는지 확인합니다. 성공적으로 적용 되었다면 아래와 같이 조회 가능한 서비스 목록이 출력됩니다.
Spacectl를 활용한 간단한 예제 만들기
Spacectl 설치까지 끝났다면 모든 준비는 끝난 상태입니다. 설치가 성공적으로 끝난 Spacectl를 어떤 식으로 활용하며 SpaceONE의 다양한 마이크로 서비스들의 API를 활용할 수 있는지 몇 가지 예시를 중심으로 보여드리겠습니다.
1.
클라우드 리소스가 위치한 지역 확인하기 (list 명령어)
spacectl list inventory.Region
Python
복사
2.
리소스에 대한 상세 정보 조회하기 (get 명령어 & -p 옵션)
spacectl get inventory.Region -p region_id=<region_id>
Python
복사
3.
특정 provider만 선택하여 조회하기 (-p 옵션)
spacectl list inventory.Region -p provider=aws
Python
복사
4.
provider와 region 코드로 정보 조회하기(-p 옵션)
spacectl list inventory.Region -p provider=aws -p region_code=ap-northeast-2
Python
복사
5.
축약된 정보로 조회하기 (–miniaml 옵션)
spacectl list inventory.Region –minimal
Python
복사
6.
원하는 컬럼만 선택하여 조회하기 (-c 옵션)
spacectl list inventory.Region -c name,provider
Python
복사
문의사항이 있다면? spaceone-support@megazone.com