---
title: "getCluster"
slug: "pub-clouddb-serverless-v1-cluster-getcluster"
updated: 2026-10-13T10:09:26Z
published: 2026-10-13T10:09:26Z
canonical: "api.ncloud-docs.com/pub-clouddb-serverless-v1-cluster-getcluster"
---

> ## Documentation Index
> Fetch the complete documentation index at: https://api.ncloud-docs.com/llms.txt
> Use this file to discover all available pages before exploring further.

# getCluster

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

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

클러스터의 상세 정보를 조회합니다.

## 요청

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

| 메서드 | URI |
| --- | --- |
| GET | /mysql/v1/clusters/{clusterName} |

### 요청 헤더

Cloud DB Serverless API에서 공통으로 사용하는 헤더에 대한 정보는 [Cloud DB Serverless 요청 헤더](/docs/pub-clouddb-serverless-v1-overview#%EC%9A%94%EC%B2%AD%ED%97%A4%EB%8D%94)를 참조해 주십시오.

### 요청 경로 파라미터

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

| 필드 | 타입 | 필수 여부 | 설명 |
| --- | --- | --- | --- |
| `clusterName` | String | Required | 클러스터 이름 - [listClusters](/docs/pub-clouddb-serverless-v1-cluster-listclusters) 참조 |

### 요청 예시

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

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

## 응답

응답 형식을 설명합니다.

### 응답 바디

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

| 필드 | 타입 | 필수 여부 | 설명 |
| --- | --- | --- | --- |
| `cluster` | Object | - | 클러스터 상세 정보 |
| `cluster.name` | String | - | 클러스터 이름 |
| `cluster.storageType` | String | - | 데이터 스토리지 타입 - `CB2` - 현재 `CB2`만 제공 |
| `cluster.port` | Integer | - | DB 접속 포트 |
| `cluster.vpcNo` | Integer | - | VPC 번호 |
| `cluster.vpcName` | String | - | 클러스터가 배치된 VPC의 이름 |
| `cluster.writeEndpoint` | String | - | 쓰기 엔드포인트 - <예시> 10.1.2.6 |
| `cluster.readEndpoint` | String | - | 읽기 엔드포인트 - <예시> 10.1.2.7 |
| `cluster.endpoints` | Array | - | 인터페이스 상세: [endpoints](/docs/pub-clouddb-serverless-v1-cluster-getcluster#endpoints) |
| `cluster.multiZone` | Boolean | - | 멀티 존 구성 여부 - `true` \| `false` - `true`: Primary와 Replica 인스턴스를 서로 다른 존에 배치 - `false`: 단일 존 구성 |
| `cluster.primaryZoneCode` | String | - | Primary 인스턴스가 배치된 존 코드 - 배치 전이면 `null` 반환 |
| `cluster.backupZoneCode` | String | - | 멀티 존 구성 시 백업 Replica 인스턴스가 배치된 존 코드 - 단일 존 구성이면 `null` 반환 |
| `cluster.unit` | Object | - | 컴퓨팅 Unit 범위 - `cluster.autoScale.scaleUp.enabled`가 `false`이면 `cluster.unit.max` 값으로 고정 |
| `cluster.unit.min` | Number | - | 최소 값 - `1`~N (0.5 단위) - `cluster.unit.max` 이하 |
| `cluster.unit.max` | Number | - | 최대 값 - `1`~N (0.5 단위) - `cluster.unit.min` 이상 |
| `cluster.replica` | Object | - | Replica 인스턴스 현황 |
| `cluster.replica.target` | Integer | - | 목표 Replica 인스턴스 수 |
| `cluster.replica.current` | Integer | - | 현재 Replica 인스턴스 수 |
| `cluster.replica.ready` | Integer | - | 준비된 Replica 인스턴스 수 |
| `cluster.replica.min` | Integer | - | 최소 값 |
| `cluster.replica.max` | Integer | - | 최대 값 |
| `cluster.autoScale` | Object | - | 오토 스케일링 설정 |
| `cluster.autoScale.scaleOut` | Object | - | 수평 확장(스케일 인/아웃) 설정 |
| `cluster.autoScale.scaleOut.enabled` | Boolean | - | 수평 확장 활성화 여부 - `true` \| `false` - `true`: 활성화 - `false`: 비활성화 |
| `cluster.autoScale.scaleOut.thresholdConnection` | Integer | - | 연결 수 임계값 - `500`~`30000` - `thresholdCpu`와 둘 중 하나만 설정됨 |
| `cluster.autoScale.scaleOut.thresholdCpu` | Integer | - | CPU 사용률 임계값 (%) - `30`~`99` - `thresholdConnection`과 둘 중 하나만 설정됨 |
| `cluster.autoScale.scaleOut.replica` | Object | - | Replica 인스턴스 수 범위 |
| `cluster.autoScale.scaleOut.replica.min` | Integer | - | 최소 값 - `1`~`3` - `cluster.autoScale.scaleOut.replica.max` 이하 |
| `cluster.autoScale.scaleOut.replica.max` | Integer | - | 최대 값 - `1`~`15` - `cluster.autoScale.scaleOut.replica.min` 이상 |
| `cluster.autoScale.scaleUp` | Object | - | 수직 확장(스케일 업/다운) 설정 |
| `cluster.autoScale.scaleUp.enabled` | Boolean | - | 수직 확장 활성화 여부 - `true` \| `false` - `true`: 활성화 - `false`: 비활성화 |
| `cluster.autoScale.scaleUp.unit` | Object | - | 컴퓨팅 Unit 범위 |
| `cluster.autoScale.scaleUp.unit.min` | Number | - | 최소 값 - `1`~N (0.5 단위) - `cluster.autoScale.scaleUp.unit.max` 이하 |
| `cluster.autoScale.scaleUp.unit.max` | Number | - | 최대 값 - `1`~N (0.5 단위) - `cluster.autoScale.scaleUp.unit.min` 이상 |
| `cluster.autoScale.scaleIn` | Object | - | 축소 임계값 |
| `cluster.autoScale.scaleIn.thresholdConnection` | Integer | - | 연결 수 임계값 |
| `cluster.autoScale.scaleIn.thresholdCpu` | Integer | - | CPU 사용률 임계값 (%) |
| `cluster.backupConfig` | Object | - | 자동 백업 설정 |
| `cluster.backupConfig.backupAuto` | Boolean | - | 자동 백업 시각 지정 방식 - `true` \| `false` - `true`: Cloud DB Serverless가 지정한 시각에 백업 (`cluster.backupConfig.backupTime` 무시) - `false`: `cluster.backupConfig.backupTime`에 지정한 시각에 백업 |
| `cluster.backupConfig.backupTime` | String | - | 자동 백업 시각 |
| `cluster.backupConfig.retentionDays` | Integer | - | 백업 보관 기간 (일) - `1`~`30` |
| `cluster.status` | String | - | 클러스터 상태 - `CREATING` \| `RUNNING` \| `MODIFYING` \| `PAUSED` \| `DELETING` \| `FAILED` - `CREATING`: 생성 중인 상태 - `RUNNING`: 정상 기동되어 접속 가능한 상태 - `MODIFYING`: 설정 변경을 적용 중인 상태 - `PAUSED`: 일시 정지된 상태 - `DELETING`: 삭제 중인 상태 - `FAILED`: 오류로 중단된 상태 |
| `cluster.ready` | Boolean | - | 목표 Replica 인스턴스가 모두 서비스 가능한 상태인지 여부 - `true` \| `false` - `true`: 접속 가능 - `false`: 일부 Replica 인스턴스 준비 중 |
| `cluster.createdDateTime` | String | - | 클러스터 생성 일시 - ISO 8601 형식 (UTC) |
| `cluster.startDateTime` | String | - | 클러스터 서비스 시작 일시 - ISO 8601 형식 (UTC) |
| `cluster.highAvailability` | Boolean | - | 고가용성(자동 장애 조치) 사용 여부 - `true` \| `false` - `true`: 사용 - `false`: 미사용 |
| `cluster.engineVersion` | String | - | DB 엔진 버전 |
| `cluster.clusterNo` | Integer | - | 클러스터 번호 - 내부 식별자. API 경로에서는 `cluster.name` 사용 |

#### endpoints

`endpoints`에 대한 설명은 다음과 같습니다.

| 필드 | 타입 | 필수 여부 | 설명 |
| --- | --- | --- | --- |
| `interfaceName` | String | - | 네트워크 인터페이스 이름 |
| `interfaceType` | String | - | 엔드포인트 용도 - `READ_WRITE` \| `READ_ONLY` - `READ_WRITE`: 쓰기. Primary 인스턴스에 연결 - `READ_ONLY`: 읽기. Replica 인스턴스에 연결 |
| `subnetNo` | Integer | - | 서브넷 번호 |
| `subnetName` | String | - | 인터페이스가 배치된 서브넷 이름 |
| `zoneCode` | String | - | 인터페이스가 배치된 존 코드 |
| `accessControlGroupNo` | Integer | - | 인터페이스에 적용된 ACG(Access Control Group) 번호 |
| `accessControlGroupName` | String | - | 인터페이스에 적용된 ACG 이름 |

### 응답 상태 코드

응답 상태 코드에 대한 설명은 다음과 같습니다.

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

              참고

              

Cloud DB Serverless API에서 공통으로 사용하는 응답 상태 코드에 대한 정보는 [Cloud DB Serverless 응답 상태 코드](/docs/pub-clouddb-serverless-v1-overview#%EC%9D%91%EB%8B%B5%EC%83%81%ED%83%9C%EC%BD%94%EB%93%9C)를 참조해 주십시오.

### 응답 예시

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

```
{
  "cluster": {
    "name": "test-cluster-01",
    "storageType": "CB2",
    "port": 3306,
    "vpcNo": 12345,
    "vpcName": "test-vpc",
    "writeEndpoint": "10.1.2.6",
    "readEndpoint": "10.1.2.7",
    "endpoints": [
      {
        "interfaceName": "cdbserverless-a1b2c3d4",
        "interfaceType": "READ_WRITE",
        "subnetNo": 67890,
        "subnetName": "test-subnet",
        "zoneCode": "KR-1",
        "accessControlGroupNo": 11111,
        "accessControlGroupName": "cdbserverless-c9d0e1f2"
      },
      {
        "interfaceName": "cdbserverless-e5f6a7b8",
        "interfaceType": "READ_ONLY",
        "subnetNo": 67890,
        "subnetName": "test-subnet",
        "zoneCode": "KR-1",
        "accessControlGroupNo": 11111,
        "accessControlGroupName": "cdbserverless-c9d0e1f2"
      }
    ],
    "multiZone": false,
    "primaryZoneCode": "KR-1",
    "backupZoneCode": null,
    "unit": {
      "min": 1,
      "max": 1
    },
    "replica": {
      "target": 0,
      "current": 0,
      "ready": 0,
      "min": 1,
      "max": 2
    },
    "autoScale": {
      "scaleOut": {
        "enabled": true,
        "thresholdConnection": null,
        "thresholdCpu": 30,
        "replica": {
          "min": 1,
          "max": 2
        }
      },
      "scaleUp": {
        "enabled": true,
        "unit": {
          "min": 1,
          "max": 1
        }
      }
    },
    "backupConfig": {
      "backupAuto": false,
      "backupTime": "02:00",
      "retentionDays": 1
    },
    "status": "RUNNING",
    "ready": true,
    "createdDateTime": "2026-10-13T09:15:00Z",
    "startDateTime": "2026-10-13T09:20:00Z",
    "highAvailability": true,
    "engineVersion": "8.4.5",
    "clusterNo": 1000001
  }
}
```