본문으로 건너뛰기

Beyond Compute Service (BCS)

BCS API의 호출 주소와 인스턴스·키페어 관리 작업을 안내합니다. 각 API 링크에서 요청 파라미터, 본문 스키마와 응답을 확인할 수 있습니다.

기본 URL​

https://bcs.kr-central-2.kakaocloud.com

리소스별 API​

인스턴스와 키페어 등 주요 리소스의 API를 선택하면 요청 정보와 응답 형식을 확인할 수 있습니다.

Instances​

인스턴스 수명 주기, 사양 변경, 네트워크·볼륨 연결 및 운영 정보를 관리합니다.

API설명
Associate new public IP인스턴스의 네트워크 인터페이스에 새 퍼블릭 IP를 연결합니다.
Associate public IP지정한 인스턴스의 네트워크 인터페이스에 기존 퍼블릭 IP를 연결합니다.
Attach network interface인스턴스에 네트워크 인터페이스를 연결합니다.
Attach security group인스턴스에 보안 그룹을 연결합니다.
Attach volume인스턴스에 볼륨을 연결합니다.
Create instance새로운 인스턴스를 생성합니다. 생성 요청 시 제공된 정보를 바탕으로 인스턴스를 프로비저닝하며, 응답으로 해당 인스턴스의 ID와 관련 정보를 반환합니다.
Delete instance인스턴스를 완전히 삭제합니다. 삭제 요청이 성공하면 인스턴스는 시스템에서 완전히 제거됩니다.
Detach network interface인스턴스에서 연결된 네트워크 인터페이스(Network Interface)를 분리합니다.
Detach security group인스턴스에 연결된 보안 그룹을 연결 해제합니다.
Detach volume인스턴스에 연결된 볼륨을 분리합니다.
Get instance인스턴스의 상세 정보를 조회합니다.
Get instance console log인스턴스의 콘솔 로그를 최신순으로 조회합니다. 이 로그는 인스턴스의 실행 상태를 확인하거나 문제를 진단하는 목적으로 활용될 수 있습니다.
Get instance password인스턴스의 비밀번호를 조회합니다. 이 비밀번호는 운영체제에 로그인하거나 원격 접속(RDP 또는 SSH)을 위한 인증 수단으로 사용됩니다.
Get instance type인스턴스 유형(Flavor)의 상세 정보를 조회합니다.
Hard reboot instance실행 중인 상태의 인스턴스를 강제 재시작합니다. 이 작업은 인스턴스의 전원을 강제로 셧다운한 뒤 즉시 다시 켜는 방식입니다.
List instance action logs인스턴스에 수행된 작업 이력을 조회합니다.
List instance network interfaces인스턴스의 네트워크 인터페이스 목록과 상세 정보를 조회합니다.
List instance types (flavors)등록된 인스턴스 유형(Flavor) 목록을 조회합니다.
List instances인스턴스 목록을 조회합니다.
Operate instances인스턴스에 대해 시작, 정지, 재부팅, 삭제 등의 액션을 수행합니다.
Rebuild instance인스턴스를 리빌드하여 운영체제 및 키 페어를 재설정 및 재설치합니다.
Remove public IP인스턴스에 연결된 퍼블릭 IP의 연결을 해제하고, 요청에 따라 퍼블릭 IP를 함께 삭제합니다.
Resize instance인스턴스의 유형(flavor)을 변경하여 CPU, 메모리, 스토리지 등의 리소스 사양을 조정합니다.
Shelve instance인스턴스를 Shelved_offloaded(종료) 상태로 변경합니다.
Soft reboot instance실행 중인 인스턴스를 재시작(Soft reboot)하여, 인스턴스 상태를 Active(실행 중) 상태로 전환합니다.
Start instanceStopped(정지) 상태의 인스턴스를 시작하여 Active(실행) 상태로 전환합니다.
Stop instanceActive(실행)인 인스턴스를 Stopped(중지) 상태로 전환합니다.
Unshelve instanceShelved_offloaded(종료) 상태의 인스턴스를 시작하여 Active(실행) 상태로 전환합니다.
Update instance인스턴스의 정보(이름, 설명)를 수정합니다.
Update instance volume인스턴스에 연결된 특정 볼륨의 정보(이름, 설명, 인스턴스 삭제 시 볼륨 삭제 여부)를 수정합니다.
Update network interface allowed addresses인스턴스에 연결된 네트워크 인터페이스의 패킷 송신 허용 IP를 수정합니다.

Keypairs​

인스턴스 접속에 사용할 키페어를 관리합니다.

API설명
Create keypair새로운 키 페어를 생성합니다. 키 페어는 VM 인스턴스에 접속할 때 사용하는 보안 자격 증명입니다.
Delete keypair키 페어를 삭제합니다.
Get keypair키 페어의 상세 정보를 조회합니다.
List keypairs사용자가 생성한 키 페어 목록과 각 키 페어의 상세 정보를 조회합니다.