--- title: "Cloud DB Serverless 개요" slug: "pub-clouddb-serverless-v1-overview" updated: 2026-10-13T10:45:51Z published: 2026-10-13T10:45:51Z canonical: "api.ncloud-docs.com/pub-clouddb-serverless-v1-overview" --- > ## 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. # Cloud DB Serverless 개요 VPC 환경에서 이용 가능합니다. Ncloud 표준 표현을 적용한 API입니다. Cloud DB Serverless는 이용 패턴에 따라 스펙과 용량을 자동으로 최적화하는 데이터베이스를 운영할 수 있도록 지원하는 네이버 클라우드 플랫폼의 서비스입니다. Cloud DB Serverless 서비스에서는 클러스터, 인스턴스, DB 사용자, Database, DB 파라미터, 로그, 백업, 이벤트, Operation, 엔진 버전 기능에 대한 API를 RESTful 형태로 제공합니다. ## Cloud DB Serverless 공통 설정 Cloud DB Serverless API에서 공통으로 사용하는 요청 형식과 응답 형식을 설명합니다. ### 요청 공통 요청 형식을 설명합니다. #### API URL 요청 API URL은 다음과 같습니다. ``` https://clouddb-serverless.apigw.ntruss.com ``` #### 요청 헤더 요청 헤더에 대한 설명은 다음과 같습니다. | 필드 | 필수 여부 | 설명 | | --- | --- | --- | | `x-ncp-apigw-timestamp` | Required | 1970년 1월 1일 00:00:00 협정 세계시(UTC)부터의 경과 시간 (밀리초) - API Gateway 서버와 5분 이상 시간 차 발생 시 유효하지 않은 요청으로 간주 - Unix Timestamp 형식 | | `x-ncp-iam-access-key` | Required | 네이버 클라우드 플랫폼에서 발급받은 Access Key - Access Key 발급 및 확인: [인증키 생성](/docs/common-ncpapi) 참조 - 서브 계정의 Access Key 발급 및 확인: [서브 계정 생성](https://guide.ncloud-docs.com/docs/subaccount-use#%EC%84%9C%EB%B8%8C-%EA%B3%84%EC%A0%95-%EC%83%9D%EC%84%B1) 참조 | | `x-ncp-apigw-signature-v2` | Required | 네이버 클라우드 플랫폼에서 발급받은 Access Key에 매핑되는 Secret Key 및 HMAC 암호화 알고리즘(HmacSHA256)으로 요청 정보를 암호화한 후 Base64로 인코딩한 서명 - Secret Key 발급 및 확인: [인증키 생성](/docs/common-ncpapi) 참조 - 서명 생성: [시그니처 생성](/docs/common-ncpapi) 참조 | | `Content-Type` | Conditional | 요청 바디의 미디어 타입 - `application/json` \| `application/merge-patch+json` - `application/json`: POST 요청, PATCH 요청 - `application/merge-patch+json`: PATCH 요청 - 요청 바디가 있는 경우, 필수 입력 | ### 응답 공통 응답 형식을 설명합니다. #### 응답 바디 응답 바디에 대한 설명은 다음과 같습니다. 호출이 성공한 경우, 응답 바디는 각 API 문서를 참조해 주십시오. **Error** Error는 API 호출 실패 정보를 정의합니다. Error에 대한 설명은 다음과 같습니다. | 필드 | 타입 | 필수 여부 | 설명 | | --- | --- | --- | --- | | `error` | Object | - | 오류 정보 | | `error.errorCode` | String | - | 오류 코드 | | `error.message` | String | - | 오류 메시지 | | `error.detail` | String | - | 오류 상세 정보 | #### 응답 상태 코드 응답 상태 코드에 대한 설명은 다음과 같습니다. | HTTP 상태 코드 | 코드 | 메시지 | 설명 | | --- | --- | --- | --- | | 200 | - | - | 요청 성공. 각 API 문서의 응답 상태 코드 참조 | | 202 | - | - | 요청 접수. 비동기 API의 응답으로 Operation 반환. 각 API 문서의 응답 바디 참조 | | 400 | `BadRequest` | `The request is malformed or contains an error such as an invalid parameter value or a missing required parameter.` | 요청 본문 또는 파라미터의 형식이 올바르지 않은 경우 | | 400 | `InvalidParameter` | `The specified parameter is invalid.` | 각 API 문서의 응답 상태 코드 참조 | | 400 | `InvalidState` | `Indicates that the specified state is not a valid state for an event source.` | 각 API 문서의 응답 상태 코드 참조 | | 401 | `Unauthorized` | `Invalid authentication credentials.` | 인증 헤더가 없거나 서명이 유효하지 않은 경우 | | 403 | `AccessDenied` | `The client is permanently forbidden from making the request.` | 요청한 리소스에 대한 접근 권한이 없는 경우 | | 403 | `Forbidden` | `You do not have sufficient permissions to perform this action.` | 해당 작업을 수행할 권한이 없는 경우 | | 404 | `NotFound` | `One or more of the resources in the request does not exist in the system.` | 지정한 리소스가 존재하지 않는 경우 | | 409 | `Conflict` | `The request could not be processed because of a conflict in the current status of the resource.` | 각 API 문서의 응답 상태 코드 참조 | | 409 | `ResourceInUse` | `The specified resource is in use.` | 각 API 문서의 응답 상태 코드 참조 | | 415 | `UnsupportedMediaType` | `The content type of the request body is not supported.` | 요청 `Content-Type`이 지원 대상이 아닌 경우. `accept-patch` 응답 헤더로 지원 미디어 타입 안내 | | 429 | `TooManyRequests` | `The operation failed because it was called too frequently and exceeded a throttle limit.` | 요청 한도를 초과한 경우 | | 429 | `ThrottlingExceeded` | `The request was denied due to request throttling.` | 단위 시간당 허용 호출 수를 초과한 경우 | | 500 | `InternalServerError` | `The request processing has failed because of an unknown error, exception, or failure.` | 서버 내부 오류가 발생한 경우 | 참고 네이버 클라우드 플랫폼에서 공통으로 사용하는 응답 상태 코드에 대한 정보는 [Ncloud API 응답 상태 코드](/docs/common-ncpapi#3%EC%9D%91%EB%8B%B5%EC%83%81%ED%83%9C%EC%BD%94%EB%93%9C)를 참조해 주십시오. #### 응답 예시 호출이 성공한 경우의 응답 예시는 각 API 명세에서 확인해 주십시오. 호출이 실패한 경우의 응답 예시는 다음과 같습니다. ``` { "error": { "errorCode": "Unauthorized", "message": "Invalid authentication credentials.", "detail": "Authentication information are missing." } } ``` ## Cloud DB Serverless API Cloud DB Serverless에서 제공하는 API에 대한 설명은 다음과 같습니다. ### Cluster 클러스터 관련 API에 대한 설명은 다음과 같습니다. | API | 설명 | | --- | --- | | [createCluster](/docs/pub-clouddb-serverless-v1-cluster-createcluster) | 클러스터 생성 | | [listClusters](/docs/pub-clouddb-serverless-v1-cluster-listclusters) | 클러스터 목록 조회 | | [getCluster](/docs/pub-clouddb-serverless-v1-cluster-getcluster) | 클러스터 상세 정보 조회 | | [updateCluster](/docs/pub-clouddb-serverless-v1-cluster-updatecluster) | 클러스터 설정 변경 | | [deleteCluster](/docs/pub-clouddb-serverless-v1-cluster-deletecluster) | 클러스터 삭제 | | [restoreCluster](/docs/pub-clouddb-serverless-v1-cluster-restorecluster) | 백업 복원으로 새 클러스터 생성 | ### Instance 인스턴스 관련 API에 대한 설명은 다음과 같습니다. | API | 설명 | | --- | --- | | [listInstances](/docs/pub-clouddb-serverless-v1-instance-listinstances) | 인스턴스 목록 조회 | | [getInstance](/docs/pub-clouddb-serverless-v1-instance-getinstance) | 인스턴스 상세 정보 조회 | | [listProcesses](/docs/pub-clouddb-serverless-v1-instance-listprocesses) | 인스턴스에 연결된 세션 목록 조회 | | [batchKillProcesses](/docs/pub-clouddb-serverless-v1-instance-batchkillprocesses) | 인스턴스의 세션 일괄 종료 | ### User DB 사용자 관련 API에 대한 설명은 다음과 같습니다. | API | 설명 | | --- | --- | | [createUser](/docs/pub-clouddb-serverless-v1-user-createuser) | DB 사용자 계정 생성 | | [batchCreateUsers](/docs/pub-clouddb-serverless-v1-user-batchcreateusers) | DB 사용자 계정 일괄 생성 | | [listUsers](/docs/pub-clouddb-serverless-v1-user-listusers) | DB 사용자 목록 조회 | | [getUser](/docs/pub-clouddb-serverless-v1-user-getuser) | DB 사용자 상세 정보 조회 | | [updateUser](/docs/pub-clouddb-serverless-v1-user-updateuser) | DB 사용자 계정의 비밀번호 또는 권한 변경 | | [deleteUser](/docs/pub-clouddb-serverless-v1-user-deleteuser) | DB 사용자 계정 삭제 | | [batchDeleteUsers](/docs/pub-clouddb-serverless-v1-user-batchdeleteusers) | DB 사용자 계정 일괄 삭제 | ### Database Database 관련 API에 대한 설명은 다음과 같습니다. | API | 설명 | | --- | --- | | [createDatabase](/docs/pub-clouddb-serverless-v1-database-createdatabase) | Database 생성 | | [batchCreateDatabases](/docs/pub-clouddb-serverless-v1-database-batchcreatedatabases) | Database 일괄 생성 | | [listDatabases](/docs/pub-clouddb-serverless-v1-database-listdatabases) | Database 목록 조회 | | [getDatabase](/docs/pub-clouddb-serverless-v1-database-getdatabase) | Database 존재 확인 | | [deleteDatabase](/docs/pub-clouddb-serverless-v1-database-deletedatabase) | Database 삭제 | | [batchDeleteDatabases](/docs/pub-clouddb-serverless-v1-database-batchdeletedatabases) | Database 일괄 삭제 | ### Config DB 파라미터 관련 API에 대한 설명은 다음과 같습니다. | API | 설명 | | --- | --- | | [getConfig](/docs/pub-clouddb-serverless-v1-config-getconfig) | DB 파라미터 설정 조회 | | [updateConfig](/docs/pub-clouddb-serverless-v1-config-updateconfig) | DB 파라미터 변경 | | [listConfigParameters](/docs/pub-clouddb-serverless-v1-config-listconfigparameters) | 변경할 수 있는 DB 파라미터 목록 조회 | ### Log 로그 관련 API에 대한 설명은 다음과 같습니다. | API | 설명 | | --- | --- | | [listLogs](/docs/pub-clouddb-serverless-v1-log-listlogs) | 인스턴스의 로그 파일 목록 조회 | | [exportLogs](/docs/pub-clouddb-serverless-v1-log-exportlogs) | 인스턴스의 로그 파일을 Object Storage로 내보내기 | | [batchDeleteLogs](/docs/pub-clouddb-serverless-v1-log-batchdeletelogs) | 인스턴스의 로그 파일 일괄 삭제 | | [getLogConfig](/docs/pub-clouddb-serverless-v1-log-getlogconfig) | 로그 로테이션 설정 조회 | | [updateLogConfig](/docs/pub-clouddb-serverless-v1-log-updatelogconfig) | 로그 로테이션 설정 변경 | ### Backup 백업 관련 API에 대한 설명은 다음과 같습니다. | API | 설명 | | --- | --- | | [listBackups](/docs/pub-clouddb-serverless-v1-backup-listbackups) | 백업 목록 조회 | | [getBackup](/docs/pub-clouddb-serverless-v1-backup-getbackup) | 백업 상세 정보 조회 | | [exportBackup](/docs/pub-clouddb-serverless-v1-backup-exportbackup) | 백업 파일을 Object Storage로 내보내기 | | [createImportedBackup](/docs/pub-clouddb-serverless-v1-backup-createimportedbackup) | Object Storage의 백업 파일을 가져와 Imported Backup 생성 | | [listImportedBackups](/docs/pub-clouddb-serverless-v1-backup-listimportedbackups) | Imported Backup 목록 조회 | | [getImportedBackup](/docs/pub-clouddb-serverless-v1-backup-getimportedbackup) | Imported Backup 상세 정보 조회 | | [deleteImportedBackup](/docs/pub-clouddb-serverless-v1-backup-deleteimportedbackup) | Imported Backup 삭제 | ### Event 이벤트 관련 API에 대한 설명은 다음과 같습니다. | API | 설명 | | --- | --- | | [listEvents](/docs/pub-clouddb-serverless-v1-event-listevents) | 이벤트 이력 조회 | ### Operation Operation 관련 API에 대한 설명은 다음과 같습니다. | API | 설명 | | --- | --- | | [listClusterOperations](/docs/pub-clouddb-serverless-v1-operation-listclusteroperations) | 클러스터 Operation 목록 조회 | | [getClusterOperation](/docs/pub-clouddb-serverless-v1-operation-getclusteroperation) | 클러스터 Operation 진행 상태 조회 | | [listProcessOperations](/docs/pub-clouddb-serverless-v1-operation-listprocessoperations) | 세션 종료 Operation 목록 조회 | | [getProcessOperation](/docs/pub-clouddb-serverless-v1-operation-getprocessoperation) | 세션 종료 Operation 진행 상태 조회 | | [listUserOperations](/docs/pub-clouddb-serverless-v1-operation-listuseroperations) | DB 사용자 Operation 목록 조회 | | [getUserOperation](/docs/pub-clouddb-serverless-v1-operation-getuseroperation) | DB 사용자 Operation 진행 상태 조회 | | [listDatabaseOperations](/docs/pub-clouddb-serverless-v1-operation-listdatabaseoperations) | Database Operation 목록 조회 | | [getDatabaseOperation](/docs/pub-clouddb-serverless-v1-operation-getdatabaseoperation) | Database Operation 진행 상태 조회 | | [listConfigOperations](/docs/pub-clouddb-serverless-v1-operation-listconfigoperations) | DB 파라미터 변경 Operation 목록 조회 | | [getConfigOperation](/docs/pub-clouddb-serverless-v1-operation-getconfigoperation) | DB 파라미터 변경 Operation 진행 상태 조회 | | [listLogOperations](/docs/pub-clouddb-serverless-v1-operation-listlogoperations) | 로그 Operation 목록 조회 | | [getLogOperation](/docs/pub-clouddb-serverless-v1-operation-getlogoperation) | 로그 Operation 진행 상태 조회 | | [listBackupOperations](/docs/pub-clouddb-serverless-v1-operation-listbackupoperations) | 백업 Operation 목록 조회 | | [getBackupOperation](/docs/pub-clouddb-serverless-v1-operation-getbackupoperation) | 백업 Operation 진행 상태 조회 | | [listImportedBackupOperations](/docs/pub-clouddb-serverless-v1-operation-listimportedbackupoperations) | Imported Backup Operation 목록 조회 | | [getImportedBackupOperation](/docs/pub-clouddb-serverless-v1-operation-getimportedbackupoperation) | Imported Backup Operation 진행 상태 조회 | ### Engine Version 엔진 버전 관련 API에 대한 설명은 다음과 같습니다. | API | 설명 | | --- | --- | | [listEngineVersions](/docs/pub-clouddb-serverless-v1-engine-version-listengineversions) | 클러스터 생성 시 사용할 수 있는 DB 엔진 버전 목록 조회 | ## Cloud DB Serverless 연관 리소스 Cloud DB Serverless API에 대한 사용자의 이해를 돕기 위해 다양한 연관 리소스를 제공하고 있습니다. - Cloud DB Serverless API 사용 방법 - [서명(시그니처) 생성](/docs/common-ncpapi): 요청 헤더에 추가할 서명 생성 방법 - [Sub Account 사용 가이드](https://guide.ncloud-docs.com/docs/subaccount-overview): 요청 헤더에 추가할 Access Key 발급 방법 - [Ncloud 공통 응답 상태 코드](/docs/common-ncpapi#3%EC%9D%91%EB%8B%B5%EC%83%81%ED%83%9C%EC%BD%94%EB%93%9C): Cloud DB Serverless에서 사용하는 네이버 클라우드 플랫폼의 공통 응답 상태 코드 정보 - Cloud DB Serverless 서비스 사용 방법 - [Cloud DB Serverless 사용 가이드](https://guide.ncloud-docs.com/docs/db-clouddbserverless-overview): 네이버 클라우드 플랫폼 콘솔에서 Cloud DB Serverless 사용하는 방법 - [Ncloud 사용 환경 가이드](https://guide.ncloud-docs.com/docs/environment-environment-1-1): VPC, Classic 플랫폼 및 지원 여부에 대한 가이드 - [요금 소개, 특징, 상세 기능](https://www.ncloud.com/product/database/cloudDbServerless): Cloud DB Serverless의 요금 체계, 특징, 상세 기능 요약 - [서비스 최신 소식](https://www.ncloud.com/intro/news?categoryCode=DB&serviceCode=SV_0288): Cloud DB Serverless 관련 최신 소식 - [자주 하는 질문](https://www.ncloud.com/support/faq/prod?categoryCode2=DB&categoryCode3=SV_0288&page=1): Cloud DB Serverless 사용자들이 자주 하는 질문 - [문의하기](https://www.ncloud.com/support/question/service): API 가이드를 통해서도 궁금증이 해결되지 않는 경우 직접 문의