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

> ## 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.

# updateCluster

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

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

클러스터 설정을 비동기로 변경합니다. 요청에 포함된 필드만 변경되며, 변경할 필드를 하나 이상 지정해야 합니다.

## 요청

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

| 메서드 | URI |
| --- | --- |
| PATCH | /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) 참조 |

### 요청 바디

요청 바디에 대한 설명은 다음과 같습니다.

| 필드 | 타입 | 필수 여부 | 설명 |
| --- | --- | --- | --- |
| `unit` | Object | Optional | 컴퓨팅 Unit 범위 - `autoScale.scaleUp.enabled`가 `false`이면 `unit.max` 값으로 고정 - Unit을 고정하려면 `unit.min`과 `unit.max`를 같은 값으로 입력 - 입력 시 `unit.min`과 `unit.max`를 모두 입력 |
| `unit.min` | Number | Required | 최소 값 - `1`~N (0.5 단위) - `unit.max` 이하 |
| `unit.max` | Number | Required | 최대 값 - `1`~N (0.5 단위) - `unit.min` 이상 |
| `multiZone` | Boolean | Optional | 멀티 존 구성 여부 - `true` \| `false` - `true`: Primary와 Replica 인스턴스를 서로 다른 존에 배치 - `false`: 단일 존 구성 - `true`로 변경 시 백업 존에 Replica 인스턴스 생성 |
| `autoScale` | Object | Optional | 오토 스케일링 설정 |
| `autoScale.scaleOut` | Object | Optional | 수평 확장(스케일 인/아웃) 설정 |
| `autoScale.scaleOut.enabled` | Boolean | Optional | 수평 확장 활성화 여부 - `true` \| `false` - `true`: 활성화 - `false`: 비활성화 - `false`인 경우에도 임계값과 `autoScale.scaleOut.replica`를 입력할 수 있으며, 활성화 전까지는 적용되지 않음 - `false`로 변경해도 기존 임계값과 `autoScale.scaleOut.replica` 값은 유지 |
| `autoScale.scaleOut.thresholdConnection` | Integer | Conditional | 연결 수 임계값 - `500`~`30000` - `autoScale.scaleOut.enabled`가 `true`인 경우, `autoScale.scaleOut.thresholdCpu`와 둘 중 하나만 필수 입력 (동시 입력 불가) |
| `autoScale.scaleOut.thresholdCpu` | Integer | Conditional | CPU 사용률 임계값 (%) - `30`~`99` - `autoScale.scaleOut.enabled`가 `true`인 경우, `autoScale.scaleOut.thresholdConnection`과 둘 중 하나만 필수 입력 (동시 입력 불가) |
| `autoScale.scaleOut.replica` | Object | Conditional | Replica 인스턴스 수 범위 - `autoScale.scaleOut.enabled`가 `true`인 경우, 필수 입력 |
| `autoScale.scaleOut.replica.min` | Integer | Conditional | 최소 값 - `1`~`3` - `autoScale.scaleOut.replica.max` 이하 - `autoScale.scaleOut.replica` 입력 시 필수 입력 |
| `autoScale.scaleOut.replica.max` | Integer | Conditional | 최대 값 - `1`~`15` - `autoScale.scaleOut.replica.min` 이상 - `autoScale.scaleOut.replica` 입력 시 필수 입력 |
| `autoScale.scaleUp` | Object | Optional | 수직 확장(스케일 업/다운) 설정 |
| `autoScale.scaleUp.enabled` | Boolean | Optional | 수직 확장 활성화 여부 - `true` \| `false` - `true`: `unit.min`에서 시작해 부하에 따라 `unit.min`~`unit.max` 범위에서 조정 - `false`: `unit`을 `unit.max` 값으로 고정 |
| `backupConfig` | Object | Optional | 자동 백업 설정 |
| `backupConfig.backupAuto` | Boolean | Optional | 자동 백업 시각 지정 방식 - `true` \| `false` - `true`: Cloud DB Serverless가 지정한 시각에 백업 (`backupConfig.backupTime` 무시) - `false`: `backupConfig.backupTime`에 지정한 시각에 백업 |
| `backupConfig.backupTime` | String | Conditional | 자동 백업 시각 - HH:MM 형식 (UTC) - `backupConfig.backupAuto`가 `false`인 경우, 필수 입력 |
| `backupConfig.retentionDays` | Integer | Required | 백업 보관 기간 (일) - `1`~`30` |

### 요청 예시

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

```
curl --location --request PATCH '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}' \
--header 'Content-Type: application/merge-patch+json' \
--data '{
  "unit": {
    "min": 1,
    "max": 4
  },
  "backupConfig": {
    "retentionDays": 7
  }
}'
```

## 응답

응답 형식을 설명합니다.

### 응답 헤더

응답 헤더에 대한 설명은 다음과 같습니다.

| 필드 | 필수 여부 | 설명 |
| --- | --- | --- |
| `retry-after` | - | 권장 폴링 간격 (초) - `done`이 `false`인 동안 이 간격으로 진행 상태 조회 - 202 응답에 포함 |
| `accept-patch` | - | 서버가 지원하는 PATCH 요청 미디어 타입 - 415 응답에 포함 |

### 응답 바디

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

| 필드 | 타입 | 필수 여부 | 설명 |
| --- | --- | --- | --- |
| `id` | String | - | Operation 식별자 - UUID 형식 - 진행 상태 조회: [getClusterOperation](/docs/pub-clouddb-serverless-v1-operation-getclusteroperation) 참조 |
| `done` | Boolean | - | 완료 여부 - `true` \| `false` - `true`: 완료 - `false`: 진행 중 |
| `metadata` | Object | - | Operation 부가 정보 |
| `metadata.operationType` | String | - | 작업 유형 - `CREATE` \| `UPDATE` \| `DELETE` - `CREATE`: 생성 - `UPDATE`: 변경 - `DELETE`: 삭제 |
| `metadata.resourceType` | String | - | 대상 리소스 - REST 경로의 리소스 세그먼트와 일치 - <예시> clusters |
| `metadata.startDateTime` | String | - | 작업 시작 일시 - ISO 8601 형식 (UTC) |
| `metadata.endDateTime` | String | - | 작업 완료 일시 - ISO 8601 형식 (UTC) - 진행 중이면 `null` 반환 |
| `metadata.progress` | Integer | - | 진행률 (%) - `0`~`100` - 제공 가능한 작업에 한해 반환 - 완료 후 미반환 |
| `results` | Object | - | 성공 결과 - 요청 인덱스를 키로 하는 객체. 단건 작업은 `0` 키 하나를 사용 - 클러스터 작업에서만 값을 반환하며, 그 외 작업은 `null` 반환 |
| `results.name` | String | - | 작업 대상 클러스터 이름 |
| `error` | Object | - | 실패 사유 - [Error](/docs/pub-clouddb-serverless-v1-overview#Error)와 동일한 형식 - 작업이 실패한 경우에 반환 |

### 응답 상태 코드

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

| HTTP 상태 코드 | 코드 | 메시지 | 설명 |
| --- | --- | --- | --- |
| 400 | `InvalidParameter` | `The specified parameter is invalid.` | 파라미터 값이 허용 범위나 형식을 벗어난 경우 |
| 400 | `InvalidState` | `Indicates that the specified state is not a valid state for an event source.` | 클러스터가 변경 가능한 상태가 아닌 경우 |
| 409 | `Conflict` | `The request could not be processed because of a conflict in the current status of the resource.` | 다른 변경 작업과 충돌하는 경우 |
| 409 | `ResourceInUse` | `The specified resource is in use.` | 클러스터에 다른 작업이 진행 중인 경우 |

              참고

              

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)를 참조해 주십시오.

### 응답 예시

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

```
{
  "id": "35e2a44c-a62e-4ee2-ae62-0eeb9e69887e",
  "done": false,
  "metadata": {
    "operationType": "UPDATE",
    "resourceType": "clusters",
    "startDateTime": "2026-10-13T09:30:00.225501719Z",
    "endDateTime": null
  },
  "results": null
}
```