Documentation Index

Fetch the complete documentation index at: https://cli-fin.ncloud-docs.com/llms.txt

Use this file to discover all available pages before exploring further.

createCloudPostgresqlInstance

Prev Next

Cloud DB for PostgreSQL 인스턴스를 생성합니다.

구문

createCloudPostgresqlInstance 구문은 다음과 같습니다.

./ncloud vpostgresql createCloudPostgresqlInstance \
    --vpcNo <vpc-no> \
    --subnetNo <subnet-no> \
    --cloudPostgresqlServiceName <service-name> \
    --cloudPostgresqlServerNamePrefix <server-name-prefix> \
    --cloudPostgresqlDatabaseName <database-name> \
    --cloudPostgresqlUserName <user-name> \
    --cloudPostgresqlUserPassword <user-password> \
    --clientCidr <client-cidr> \
    [--cloudPostgresqlImageProductCode <image-product-code>] \
    [--cloudPostgresqlProductCode <product-code>] \
    [--engineVersionCode <engine-version-code>] \
    [--dataStorageTypeCode <SSD|HDD>] \
    [--isStorageEncryption <true|false>] \
    [--isHa <true|false>] \
    [--isMultiZone <true|false>] \
    [--secondarySubnetNo <secondary-subnet-no>] \
    [--isBackup <true|false>] \
    [--isAutomaticBackup <true|false>] \
    [--backupTime <hh:mm>] \
    [--backupFileRetentionPeriod <retention-days>] \
    [--backupFileStorageCount <storage-count>] \
    [--isBackupFileCompression <true|false>] \
    [--cloudPostgresqlPort <port>] \
    [--regionCode <FKR>] \
    [--output <json|xml>]

옵션

createCloudPostgresqlInstance 실행 시 지정할 수 있는 옵션을 설명합니다.

필수 옵션

createCloudPostgresqlInstance의 필수 옵션입니다.

옵션 타입 필수 여부 설명
--vpcNo String Required Cloud DB for PostgreSQL 인스턴스를 생성할 VPC 번호
--subnetNo String Required Cloud DB for PostgreSQL 인스턴스에서 사용할 기본 네트워크 인터페이스의 Subnet 번호
  • Public 도메인은 Public Subnet에 생성된 DB 서버에서만 이용 신청 가능
  • Cloud DB for PostgreSQL 인스턴스 생성 이후 Subnet 이전 불가
  • getCloudPostgresqlTargetSubnetList 참조
--cloudPostgresqlServiceName String Required Cloud DB for PostgreSQL 서비스 이름
  • 영문자, 한글, 숫자, 특수문자 -를 조합하여 3~30자 이내로 입력
--cloudPostgresqlServerNamePrefix String Required Cloud DB for PostgreSQL 서버 이름 접두사
  • 영문 소문자, 숫자, 특수문자 -를 조합하여 3~20자 이내로 입력
  • 문자열의 시작은 영문자, 마지막은 영문자 또는 숫자로 구성
  • 접두사 뒤에 3자리 숫자가 자동으로 만들어지고, 호스트명 중복 방지를 위해 임의의 텍스트가 추가로 포함되어 생성됨
  • 예시: 접두사가 test-123인 경우, test-123-001-523a
--cloudPostgresqlDatabaseName String Required Cloud DB for PostgreSQL 인스턴스에 기본으로 생성할 DB 이름
  • 영문 소문자, 숫자, 특수문자 _를 조합하여 1~30자 이내로 입력
  • 문자열은 영문자로 시작
--cloudPostgresqlUserName String Required DB User 계정 ID
  • 영문 소문자, 숫자, 특수문자 _를 조합하여 4~16자 이내로 입력
  • 문자열은 영문자로 시작
  • 미리 정의된 role 및 예약어 사용 불가
--cloudPostgresqlUserPassword String Required DB User 계정 비밀번호
  • 영문자, 숫자, 특수문자를 각 1자 이상씩 포함하여 8~20자 이내로 입력
  • 특수문자 ` & + \ " ' / 및 공백 사용 불가
  • User ID 포함 불가
--clientCidr String Required PostgreSQL 서버에 접속을 허용할 클라이언트의 CIDR 대역
  • 전체 허용: 0.0.0.0/0
  • 특정 IP: 192.168.1.1/32
  • IP 대역: 192.168.1.0/24
--isMultiZone Boolean Conditional 멀티존 여부
  • true | false (기본값)
    • true: Primary 서버와 Secondary 서버를 서로 다른 존에 생성하여 더욱 높은 가용성 제공
    • false: 멀티존 사용 안 함
  • isHa=true인 경우, 필수 입력
  • Neurocloud 환경에서는 이용 불가
--secondarySubnetNo String Conditional Secondary 서버의 Subnet 번호
  • Cloud DB for PostgreSQL이 멀티존인 경우, 필수 입력
  • Primary 서버의 Subnet과 존이 다르고, Public 또는 Private는 같아야 함
  • getCloudPostgresqlTargetSubnetList 참조
--backupTime String Conditional 백업 시점 설정 (HH:MM)
  • isBackup=true이고 isAutomaticBackup=false인 경우, 필수 입력

선택 옵션

createCloudPostgresqlInstance의 선택 옵션입니다. 지정하지 않은 옵션에는 기본값이 적용됩니다.

옵션 타입 필수 여부 설명
--cloudPostgresqlImageProductCode String Optional Cloud DB for PostgreSQL 이미지 상품 코드
--cloudPostgresqlProductCode String Optional Cloud DB for PostgreSQL 상품 코드
--engineVersionCode String Optional DB 엔진 버전
--dataStorageTypeCode String Optional 데이터 스토리지 타입 코드
  • SSD (기본값) | HDD
  • 설치 이후 데이터 스토리지 타입 변경 불가
--isStorageEncryption Boolean Optional 데이터 스토리지 암호화 적용 여부 (추후 적용)
  • true | false (기본값)
  • 암호화 적용 시 DB 데이터는 암호화되어 스토리지에 저장
  • Cloud DB for PostgreSQL 인스턴스 생성 이후 스토리지 암호화 설정 변경 불가
  • Neurocloud 환경에서는 이용 불가
--isHa Boolean Optional 고가용성 여부
  • true (기본값) | false
    • true: Secondary 서버를 포함한 2대의 서버로 생성되며 추가 요금 발생
    • false: isMultiZone, secondarySubnetNo 사용 불가
--isBackup Boolean Optional PostgreSQL의 백업 설정 여부
  • true (기본값) | false
  • isHa=true인 경우, true로 고정됨
--isAutomaticBackup Boolean Optional 백업 시점 자동 설정 여부
  • true (기본값) | false
  • true인 경우, backupTime 입력 불가
--backupFileRetentionPeriod Integer Optional 백업 파일 보관 기간 (일)
  • 1 (기본값)
  • 백업은 매일 수행되며, 백업 파일은 별도의 스토리지에 저장
  • 요금은 사용하는 공간만큼 과금
--backupFileStorageCount Integer Optional 백업 파일 보관 개수
  • 1~`30`
--isBackupFileCompression Boolean Optional 백업 파일 압축 여부
  • true (기본값) | false
--cloudPostgresqlPort Integer Optional Cloud DB for PostgreSQL 인스턴스에 접근하기 위한 TCP 포트 번호
  • 10000~`20000(기본값:5432`)
  • 한 번 지정한 포트 번호는 변경 불가

공통 옵션

vpostgresql 명령에서 공통으로 사용하는 옵션에 대한 정보는 Cloud DB for PostgreSQL 옵션을 참조해 주십시오.

예시

Cloud DB for PostgreSQL 인스턴스 생성 요청이 성공하면 인스턴스의 구성 정보와 생성 상태가 반환됩니다.

명령

명령 예시는 다음과 같습니다.

./ncloud vpostgresql createCloudPostgresqlInstance \
    --vpcNo 12345678 \
    --subnetNo 23456789 \
    --cloudPostgresqlServiceName test-pgsql \
    --cloudPostgresqlServerNamePrefix testpg \
    --cloudPostgresqlDatabaseName testdb \
    --cloudPostgresqlUserName testuser \
    --cloudPostgresqlUserPassword Examplepw123! \
    --clientCidr 0.0.0.0/0 \
    --cloudPostgresqlImageProductCode SW.VPGSL.OS.LNX64.ROCKY.0810.PGSQL.B050 \
    --cloudPostgresqlProductCode SVR.VPGSL.DBSVR.STAND.C002.M004.NET.SSD.B050.G001 \
    --dataStorageTypeCode SSD \
    --isHa true \
    --cloudPostgresqlPort 13432 \
    --regionCode FKR \
    --output json

출력

출력 예시는 다음과 같습니다.

{
  "createCloudPostgresqlInstanceResponse": {
    "totalRows": 1,
    "cloudPostgresqlInstanceList": [
      {
        "cloudPostgresqlInstanceNo": "34567890",
        "cloudPostgresqlServiceName": "test-pgsql",
        "cloudPostgresqlInstanceStatusName": "creating",
        "cloudPostgresqlInstanceStatus": {
          "code": "INIT",
          "codeName": "CLOUD DATABASE(VPC) Init 상태"
        },
        "cloudPostgresqlInstanceOperation": {
          "code": "CREAT",
          "codeName": "CLOUD DATABASE(VPC) Creat OP"
        },
        "cloudPostgresqlImageProductCode": "SW.VPGSL.OS.LNX64.ROCKY.0810.PGSQL.B050",
        "generationCode": "G2",
        "engineVersion": "PostgreSQL 15.15",
        "license": "PostgreSQL License",
        "cloudPostgresqlPort": 13432,
        "isHa": true,
        "isMultiZone": false,
        "isBackup": true,
        "backupFileRetentionPeriod": 1,
        "backupTime": "AUTO",
        "createDate": "2026-06-22T13:27:26+0900",
        "accessControlGroupNoList": [],
        "cloudPostgresqlServerInstanceList": [
          {
            "cloudPostgresqlServerName": "testpg-001-3oo3",
            "cloudPostgresqlServerRole": {
              "code": "M",
              "codeName": "Primary"
            },
            "cloudPostgresqlServerInstanceStatusName": "creating",
            "cloudPostgresqlServerInstanceStatus": {
              "code": "PEND",
              "codeName": "CLOUD DATABASE(VPC) 서버 Pending 상태"
            },
            "cloudPostgresqlServerInstanceOperation": {
              "code": "CREAT",
              "codeName": "CLOUD DATABASE(VPC) 서버 Create OP"
            },
            "cloudPostgresqlProductCode": "SVR.VPGSL.DBSVR.STAND.C002.M004.NET.SSD.B050.G001",
            "regionCode": "FKR",
            "zoneCode": "FKR-1",
            "vpcNo": "12345678",
            "subnetNo": "23456789",
            "isPublicSubnet": false,
            "dataStorageType": {
              "code": "SSD",
              "codeName": "SSD"
            },
            "isStorageEncryption": false,
            "dataStorageSize": 10737418240,
            "cpuCount": 2,
            "memorySize": 4294967296,
            "createDate": "2026-06-22T13:27:26+0900"
          },
          {
            "cloudPostgresqlServerName": "testpg-002-3oo4",
            "cloudPostgresqlServerRole": {
              "code": "H",
              "codeName": "Secondary"
            },
            "cloudPostgresqlServerInstanceStatusName": "creating",
            "cloudPostgresqlServerInstanceStatus": {
              "code": "PEND",
              "codeName": "CLOUD DATABASE(VPC) 서버 Pending 상태"
            },
            "cloudPostgresqlServerInstanceOperation": {
              "code": "CREAT",
              "codeName": "CLOUD DATABASE(VPC) 서버 Create OP"
            },
            "cloudPostgresqlProductCode": "SVR.VPGSL.DBSVR.STAND.C002.M004.NET.SSD.B050.G001",
            "regionCode": "FKR",
            "zoneCode": "FKR-1",
            "vpcNo": "12345678",
            "subnetNo": "23456789",
            "isPublicSubnet": false,
            "dataStorageType": {
              "code": "SSD",
              "codeName": "SSD"
            },
            "isStorageEncryption": false,
            "dataStorageSize": 10737418240,
            "cpuCount": 2,
            "memorySize": 4294967296,
            "createDate": "2026-06-22T13:27:26+0900"
          }
        ]
      }
    ],
    "requestId": "cce89592-8bc6-4b41-b654-aa8d4342ede4",
    "returnCode": "0",
    "returnMessage": "success"
  }
}