listClusters

The latest service changes have not yet been reflected in this content. We will update the content as soon as possible. Please refer to the Korean version for information on the latest updates.

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

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

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

인증 주체가 소유한 클러스터 목록을 조회합니다. 결과가 없으면 빈 배열을 반환합니다. 정렬 가능 키는 name, createdDateTime이며 기본 정렬은 createdDateTime,desc입니다. 정렬 키가 고유하지 않은 경우 name 기준으로 안정 정렬합니다.

요청

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

메서드	URI
GET	/clusters

요청 헤더

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

요청 쿼리 파라미터

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

필드	타입	필수 여부	설명
`pageNo`	Integer (int32)	Optional	페이지 번호 (0부터 시작). 생략 시 기본값 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' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}'

응답

응답 형식을 설명합니다.

응답 바디

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

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

ClusterSummary

클러스터 요약 (목록 조회용)

필드	타입	필수 여부	설명
`name`	String	-	클러스터 이름 (하이픈 시작/끝 불가, 예약 prefix 금지, 멤버 내 유일, 생성 후 변경 불가) 패턴: `^[a-z0-9-]+$` 길이: 3 ~ 30 <예시> new-cluster (읽기 전용)
`storageType`	String	-	데이터 스토리지 타입 `CB2` `CB2`: 현재 제공하는 유일한 스토리지 타입 <예시> CB2
`status`	String	-	클러스터 상태 `CREATING` \| `RUNNING` \| `MODIFYING` \| `PAUSED` \| `DELETING` \| `FAILED` `CREATING`: 생성 중인 상태 `RUNNING`: 정상 기동되어 접속 가능한 상태 `MODIFYING`: 설정 변경을 적용 중인 상태 `PAUSED`: 일시 정지된 상태 `DELETING`: 삭제 중인 상태 `FAILED`: 오류로 중단된 상태 <예시> RUNNING (읽기 전용)
`ready`	Boolean	-	목표 복제본이 모두 서비스 가능한 상태인지 여부 `true` \| `false` `true`: 접속 가능 `false`: 일부 복제본 준비 중 <예시> true (읽기 전용)
`highAvailability`	Boolean	-	고가용성(자동 장애 조치) 사용 여부 `true` \| `false` `true`: 사용 `false`: 미사용 <예시> true
`multiZone`	Boolean	-	멀티 존 구성 여부 `true` \| `false` `true`: 백업 존에 복제본 배치 `false`: 단일 존 구성 <예시> false
`unit`	UnitRange	-	컴퓨팅 unit
`primaryZoneCode`	String \| null	-	주 인스턴스가 배치된 존 코드 (배치 전이면 null) <예시> KR-1 (읽기 전용)
`createdDateTime`	String (date-time)	-	클러스터 생성 시각 (RFC3339 UTC) <예시> 2026-07-01T09:00:00Z (읽기 전용)
`engineVersion`	String	-	DB 엔진 버전 <예시> 8.4.5

UnitRange

컴퓨팅 unit 범위 (0.5 단위, 1 이상, min ≤ max)

필드	타입	필수 여부	설명
`min`	Number (double)	-	최솟값 범위: 1 ~ 0.5의 배수 <예시> 1
`max`	Number (double)	-	최댓값 범위: 1 ~ 0.5의 배수 <예시> 3

응답 상태 코드

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

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

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

응답 예시

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

{
  "clusters": [
    {
      "name": "new-cluster",
      "storageType": "CB2",
      "status": "RUNNING",
      "ready": true,
      "highAvailability": true,
      "multiZone": false,
      "unit": {
        "min": 1,
        "max": 3
      },
      "primaryZoneCode": "KR-1",
      "createdDateTime": "2026-07-01T09:00:00Z",
      "engineVersion": "8.4.5"
    }
  ],
  "pageNo": 0,
  "pageSize": 20,
  "totalElements": 3,
  "totalPages": 1
}