Documentation Index

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

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

createCloudPostgresqlInstance

Prev Next

VPC環境で利用できます。

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|CB2>] \
    [--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 <KR|SGN|JPN>] \
    [--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=trueisAutomaticBackup=falseの場合、必ず入力

任意オプション

createCloudPostgresqlInstanceの任意オプションです。指定しない場合、オプションにはデフォルト値が適用されます。

オプション タイプ 必須の有無 説明
--cloudPostgresqlImageProductCode String Optional Cloud DB for PostgreSQLイメージ商品コード
--cloudPostgresqlProductCode String Optional Cloud DB for PostgreSQL商品コード
  • Cloud DB for PostgreSQLインスタンスのサーバスペックを決める
  • デフォルト: 最小スペック(メモリ、CPUの順)
  • getCloudPostgresqlProductListを参照
--engineVersionCode String Optional DBエンジンのバージョン
  • 入力しない場合、現在提供中の最新バージョンで作成
  • cloudPostgresqlImageProductCodegenerationCodeG3の場合、入力可能
  • getCloudPostgresqlImageProductListを参照
--dataStorageTypeCode String Optional データストレージタイプコード
  • cloudPostgresqlImageProductCodegenerationCodeに応じて有効な値が異なる
    • G2: SSD (デフォルト) | HDD
    • G3: CB2 (デフォルト)
  • インストール後、データストレージタイプは変更不可
--isStorageEncryption Boolean Optional データストレージ暗号化の適用有無(今後適用)
  • true | false (デフォルト)
  • 暗号化を適用すると、DBデータは暗号化されストレージに保存
  • Cloud DB for PostgreSQLインスタンスの作成後、ストレージ暗号化の設定は変更不可
  • Neurocloud環境では利用不可
--isHa Boolean Optional 高可用性の有無
  • true (デフォルト) | false
    • true: Secondaryサーバを含めて2台のサーバが作成され、追加料金が発生
    • false: isMultiZonesecondarySubnetNoは使用不可
--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 (VPC)のオプションを参照してください。

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.HICPU.C002.M004.NET.SSD.B050.G002 \
    --dataStorageTypeCode SSD \
    --isHa true \
    --cloudPostgresqlPort 13432 \
    --regionCode KR \
    --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-09T18:40:14+0900",
        "accessControlGroupNoList": [],
        "cloudPostgresqlServerInstanceList": [
          {
            "cloudPostgresqlServerName": "testpg-001-98b4",
            "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.HICPU.C002.M004.NET.SSD.B050.G002",
            "regionCode": "KR",
            "zoneCode": "KR-1",
            "vpcNo": "12345678",
            "subnetNo": "23456789",
            "isPublicSubnet": false,
            "dataStorageType": {
              "code": "SSD",
              "codeName": "SSD"
            },
            "isStorageEncryption": false,
            "dataStorageSize": 10737418240,
            "cpuCount": 2,
            "memorySize": 4294967296,
            "createDate": "2026-06-09T18:40:14+0900"
          },
          {
            "cloudPostgresqlServerName": "testpg-002-98b5",
            "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.HICPU.C002.M004.NET.SSD.B050.G002",
            "regionCode": "KR",
            "zoneCode": "KR-1",
            "vpcNo": "12345678",
            "subnetNo": "23456789",
            "isPublicSubnet": false,
            "dataStorageType": {
              "code": "SSD",
              "codeName": "SSD"
            },
            "isStorageEncryption": false,
            "dataStorageSize": 10737418240,
            "cpuCount": 2,
            "memorySize": 4294967296,
            "createDate": "2026-06-09T18:40:14+0900"
          }
        ]
      }
    ],
    "requestId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "returnCode": "0",
    "returnMessage": "success"
  }
}