createUser

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

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

클러스터에 DB 사용자 계정을 비동기로 생성합니다.

요청

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

메서드	URI
POST	/mysql/v1/clusters/{clusterName}/users

요청 헤더

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

요청 경로 파라미터

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

필드	타입	필수 여부	설명
`clusterName`	String	Required	클러스터 이름 listClusters 참조

요청 바디

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

필드	타입	필수 여부	설명
`name`	String	Required	DB 사용자 이름 영문자, 숫자, 특수문자 `_`, `-`를 조합하여 4~16자 이내로 입력 문자열의 시작은 영문자, 마지막은 영문자 또는 숫자로 구성 예약어(`admin`, `root`, `agent` 등) 사용 불가
`password`	String	Required	DB 사용자 비밀번호 영문자, 숫자, 특수문자를 각각 1자 이상 포함하여 8~20자 이내로 입력 특수문자 `, `&`, `+`, `\`, `"`, `'`, `/` 및 공백 사용 불가
`permission`	String	Required	DB 사용자에 부여할 권한 `READ` \| `CRUD` \| `DDL` `READ`: 데이터 조회만 가능 `CRUD`: 데이터 입력, 조회, 수정, 삭제 가능 `DDL`: CRUD 권한을 포함하여 스키마 변경 가능

요청 예시

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

curl --location --request POST 'https://clouddb-serverless.apigw.ntruss.com/mysql/v1/clusters/test-cluster-01/users' \
--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/json' \
--data '{
  "name": "test_user_01",
  "password": "Passw0rd!",
  "permission": "CRUD"
}'

응답

응답 형식을 설명합니다.

응답 헤더

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

필드	필수 여부	설명
`retry-after`	-	권장 폴링 간격 (초) `done`이 `false`인 동안 이 간격으로 진행 상태 조회 202 응답에 포함

응답 바디

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

필드	타입	필수 여부	설명
`id`	String	-	Operation 식별자 UUID 형식 진행 상태 조회: getUserOperation 참조
`done`	Boolean	-	완료 여부 `true` \| `false` `true`: 완료 `false`: 진행 중
`metadata`	Object	-	Operation 부가 정보
`metadata.operationType`	String	-	작업 유형 `CREATE` \| `UPDATE` \| `DELETE` `CREATE`: 생성 `UPDATE`: 변경 `DELETE`: 삭제
`metadata.resourceType`	String	-	대상 리소스 REST 경로의 리소스 세그먼트와 일치 <예시> users
`metadata.startDateTime`	String	-	작업 시작 일시 ISO 8601 형식 (UTC)
`metadata.endDateTime`	String	-	작업 완료 일시 ISO 8601 형식 (UTC) 진행 중이면 `null` 반환
`metadata.progress`	Integer	-	진행률 (%) `0`~`100` 제공 가능한 작업에 한해 반환 완료 후 미반환
`results`	Object	-	성공 결과 요청 인덱스를 키로 하는 객체. 단건 작업은 `0` 키 하나를 사용 클러스터 작업에서만 값을 반환하며, 그 외 작업은 `null` 반환
`error`	Object	-	실패 사유 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.`	클러스터가 DB 사용자 계정을 생성할 수 있는 상태가 아닌 경우
409	`Conflict`	`The request could not be processed because of a conflict in the current status of the resource.`	같은 이름의 DB 사용자가 이미 존재하는 경우
409	`ResourceInUse`	`The specified resource is in use.`	클러스터에 다른 작업이 진행 중인 경우

참고

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

응답 예시

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

{
  "id": "94c927ba-2471-487b-8999-2971eae5bfbf",
  "done": false,
  "metadata": {
    "operationType": "CREATE",
    "resourceType": "users",
    "startDateTime": "2026-10-13T10:10:00.925811262Z",
    "endDateTime": null
  },
  "results": null
}