listInstances

이 가이드는 API 명세를 기반으로 AI가 자동 생성했습니다.

VPC 환경에서 이용 가능합니다.

Ncloud 표준 표현을 적용한 API입니다.

클러스터의 인스턴스 목록을 조회합니다. 인스턴스 단위 제어 API는 제공하지 않습니다. 정렬 가능 키는 name, role, zoneCode, createdDateTime이며 기본 정렬은 role,asc입니다. 정렬 키가 고유하지 않은 경우 name 기준으로 안정 정렬합니다.

요청

요청 형식을 설명합니다. 요청 형식은 다음과 같습니다.

메서드	URI
GET	/clusters/{clusterName}/instances

요청 헤더

Cloud DB Serverless API에서 공통으로 사용하는 헤더에 대한 정보는 Cloud DB Serverless 요청 헤더를 참조해 주십시오.

요청 경로 파라미터

요청 경로 파라미터에 대한 설명은 다음과 같습니다.

필드	타입	필수 여부	설명
`clusterName`	String	Required	클러스터 이름 (cluster의 name) 패턴: `^[a-z0-9-]+$` 길이: 3 ~ 30 <예시> new-cluster

요청 쿼리 파라미터

요청 쿼리 파라미터에 대한 설명은 다음과 같습니다.

필드	타입	필수 여부	설명
`pageNo`	Integer (int32)	Optional	페이지 번호 (0부터 시작) 범위: 0 ~ 기본값: 0 <예시> 0
`pageSize`	Integer (int32)	Optional	페이지 크기 범위: 1 ~ 100 기본값: 20 <예시> 20
`sort`	List<String>	Optional	정렬 기준 — `<field>,<asc\|desc>` 형식. 반복 지정으로 다중 정렬. 허용 정렬 키와 기본 정렬 순서는 각 operation 설명 참고. <예시> `["name,asc"]`

요청 예시

요청 예시는 다음과 같습니다.

curl --location --request GET 'https://clouddb-serverless.apigw.ntruss.com/mysql/v1/clusters/new-cluster/instances' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}'

응답

응답 형식을 설명합니다.

응답 바디

응답 바디에 대한 설명은 다음과 같습니다.

필드	타입	필수 여부	설명
`instances`	List<Instance>	-	인스턴스 목록
`pageNo`	Integer (int32)	-	페이지 번호 (0부터 시작) <예시> 0
`pageSize`	Integer (int32)	-	페이지 크기 <예시> 20
`totalElements`	Integer (int32)	-	전체 항목 수 <예시> 3
`totalPages`	Integer (int32)	-	전체 페이지 수 <예시> 1

Instance

클러스터 인스턴스 (read-only)

필드	타입	필수 여부	설명
`name`	String	-	이름 <예시> new-cluster-28f07378
`role`	String	-	인스턴스 역할 `PRIMARY` \| `REPLICA` `PRIMARY`: 읽기·쓰기 `REPLICA`: 읽기 전용 <예시> PRIMARY
`unit`	Number (double)	-	컴퓨팅 unit <예시> 1
`memoryGb`	Integer (int32)	-	할당 메모리 (GiB) <예시> 2
`storageType`	String	-	인스턴스 데이터 스토리지 타입 `CB2` `CB2`: 현재 제공하는 유일한 스토리지 타입 <예시> CB2
`storageUsage`	Integer (int64)	-	스토리지 사용량 (bytes) <예시> 10737418240
`zoneCode`	String	-	인스턴스가 배치된 존 코드 <예시> KR-1
`status`	String	-	인스턴스 상태 `CREATING` \| `RUNNING` \| `MODIFYING` \| `PAUSED` \| `DELETING` \| `FAILED` `CREATING`: 생성 중인 상태 `RUNNING`: 정상 기동되어 접속 가능한 상태 `MODIFYING`: 설정 변경을 적용 중인 상태 `PAUSED`: 일시 정지된 상태 `DELETING`: 삭제 중인 상태 `FAILED`: 오류로 중단된 상태 <예시> RUNNING
`createdDateTime`	String (date-time)	-	인스턴스 생성 시각 (RFC3339 UTC) <예시> 2026-07-01T09:00:00Z
`startDateTime`	String (date-time)	-	인스턴스 기동 시각 (RFC3339 UTC) <예시> 2026-07-01T09:05:00Z

응답 상태 코드

Cloud DB Serverless API에서 공통으로 사용하는 응답 상태 코드에 대한 정보는 Cloud DB Serverless 응답 상태 코드를 참조해 주십시오.

이 API에만 해당하는 응답 상태 코드는 다음과 같습니다.

HTTP 상태 코드	코드	메시지	설명
200	-	-	인스턴스 목록
400	InvalidParameter	The specified parameter is invalid.	파라미터 값이 허용 범위나 형식을 벗어난 경우

응답 예시

응답 예시는 다음과 같습니다.

{
  "instances": [
    {
      "name": "new-cluster-28f07378",
      "role": "PRIMARY",
      "unit": 1,
      "memoryGb": 2,
      "storageType": "CB2",
      "storageUsage": 10737418240,
      "zoneCode": "KR-1",
      "status": "RUNNING",
      "createdDateTime": "2026-07-01T09:00:00Z",
      "startDateTime": "2026-07-01T09:05:00Z"
    }
  ],
  "pageNo": 0,
  "pageSize": 20,
  "totalElements": 3,
  "totalPages": 1
}