API 인덱스
카카오클라우드 API를 엔드포인트별로 확인하고, API 호출에 필요한 기본 URL과 요청 정보를 찾아보세요.
API 검색창
왼쪽 사이드바 상단의 API 검색창에서 API 이름이나 리소스 이름으로 전체 API 문서를 검색할 수 있습니다. 검색 결과에서 API를 선택하면 요청 정보와 상세 문서로 이동합니다.
엔드포인트별 API
아래 목록에서 엔드포인트를 선택하면 관련 API와 주요 리소스를 확인할 수 있습니다. 개별 API 문서에서는 HTTP 메서드, 요청 경로, 파라미터와 응답 스키마를 확인할 수 있습니다.
요청 URL은 기본 URL에 개별 API의 경로를 붙여 구성합니다. 자세한 설명은 API 요청 URL 구성을 참고하세요.
요청 URL = 기본 URL + API 경로
엔드포인트: bcs
리전: kr-central-2
API 경로: /api/v1/flavors/{flavor_id}
요청 URL: https://bcs.kr-central-2.kakaocloud.com/api/v1/flavors/{flavor_id}
| 엔드포인트별 문서 | 주요 작업 |
|---|---|
| Beyond Compute Service | 인스턴스·키페어 관리, 인스턴스에 볼륨·네트워크 인터페이스·퍼블릭 IP 연결 |
| Image | 이미지 조회·수정·삭제 및 프로젝트 간 공유 |
| Volume | 볼륨·스냅샷 관리, 볼륨에서 이미지 생성 |
| VPC | VPC·서브넷·라우팅 테이블·네트워크 인터페이스 관리 |
| Network | 퍼블릭 IP·보안 그룹 관리 |
| Load Balancer | 로드 밸런서·리스너·대상 그룹·헬스 체크 관리 |
| Transit Gateway | Transit Gateway 연결·공유 및 라우팅 관리 |
| Kubernetes Engine | 클러스터·노드 풀 관리, 스케일링 및 버전 업그레이드 |
| MySQL | 인스턴스 그룹 운영, 백업 및 파라미터 설정 |
| File Storage | Basic·Infinite 파일 시스템, 백업 및 공유 볼륨 관리 |
| KMS | 키 수명주기·접근 제어, 암호화 및 서명 |
| Secrets Manager | 시크릿·버전 수명주기 및 접근 제어 |
| Resource Explorer | 프로젝트의 리소스 및 태그 조회 |
VPC & Network 엔드포인트 구분
사이드바의 VPC & Network는 네트워크 리소스를 한 곳에서 찾을 수 있도록 두 엔드포인트의 API를 합친 항목입니다. 문서 탐색 항목은 하나지만 실제 호출 호스트는 VPC와 Network로 구분됩니다.
두 엔드포인트의 API가 같은 목록에 표시되므로, 문서 경로만 보고 호출 호스트를 추정하지 마세요. 자동화 코드나 운영 스크립트에는 개별 API 문서에 표시된 기본 URL을 사용해야 합니다.
작업에 맞는 API 찾기
같은 리소스와 관련된 작업도 리소스 자체를 관리하는 엔드포인트와 다른 리소스에 연결하는 엔드포인트가 다를 수 있습니다. 다음은 자주 구분해야 하는 작업입니다.
| 작업 | 호출 엔드포인트 | API 문서 |
|---|---|---|
| 볼륨 생성·조회·삭제 | volume | Volume API 목록 |
| 인스턴스에 볼륨 연결·분리 | bcs | Attach volume, Detach volume |
| 네트워크 인터페이스 생성·관리 | vpc | Network interfaces API 목록 |
| 퍼블릭 IP와 보안 그룹 관리 | network | Public IPs, Security groups |
| 인스턴스에 퍼블릭 IP 연결 | bcs | Associate public IP |
| 로드 밸런서에 퍼블릭 IP 연결 | load-balancer | Associate public IP |
엔드포인트를 선택한 뒤에는 다음 정보를 확인하세요.
- API 문서의 기본 URL, HTTP 메서드와 요청 경로
- 경로·쿼리·요청 본문의 필수 파라미터
- 성공·오류 응답과 후속 작업에 필요한 리소스 ID
- 요청 헤더에 전달할 API 인증 토큰