createCloudPostgresqlReadReplicaInstance

Available in VPC

Add a read replica server instance to the Cloud DB for PostgreSQL instance.

Syntax

The createCloudPostgresqlReadReplicaInstance syntax is as follows:

./ncloud vpostgresql createCloudPostgresqlReadReplicaInstance \
    --cloudPostgresqlInstanceNo <instance-no> \
    [--subnetNo <subnet-no>] \
    [--regionCode <KR|SGN|JPN>] \
    [--output <json|xml>]

Options

This section describes the options available when running createCloudPostgresqlReadReplicaInstance.

Required options

The following options are required for createCloudPostgresqlReadReplicaInstance.

Options	Type	Required	Description
`--cloudPostgresqlInstanceNo`	String	Required	Cloud DB for PostgreSQL instance number See getCloudPostgresqlInstanceList.
`--subnetNo`	String	Conditional	Subnet number of the default network interface to be used in the Cloud DB for PostgreSQL instance Required for a Cloud DB for PostgreSQL instance configured with multi-zone. If not multi-zone, the `subnetNo` entry is ignored and it is created in the existing subnet. NoSubnet migrations are not available after creating the Cloud DB for PostgreSQL read replica server instance. See getCloudPostgresqlTargetSubnetList.

Common options

For information about the options common to all vpostgresql subcommands, see Cloud DB for PostgreSQL (VPC) options.

Examples

If the request to add a read replica server instance is successful, the server configuration of the Cloud DB for PostgreSQL instance and the creation status of the added read replica server are returned.

Command

The command example is as follows:

./ncloud vpostgresql createCloudPostgresqlReadReplicaInstance \
    --cloudPostgresqlInstanceNo 34567890 \
    --regionCode KR \
    --output json

Output

The output example is as follows:

{
  "createCloudPostgresqlReadReplicaInstanceResponse": {
    "totalRows": 1,
    "cloudPostgresqlInstanceList": [
      {
        "cloudPostgresqlInstanceNo": "34567890",
        "cloudPostgresqlServiceName": "test-pgsql",
        "cloudPostgresqlInstanceStatusName": "running",
        "cloudPostgresqlInstanceStatus": {
          "code": "CREAT",
          "codeName": "CLOUD DATABASE (VPC) Created status"
        },
        "cloudPostgresqlInstanceOperation": {
          "code": "NULL",
          "codeName": "CLOUD DATABASE(VPC) Null 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:17:31+0900",
        "accessControlGroupNoList": [
          "67890123"
        ],
        "cloudPostgresqlConfigList": [],
        "cloudPostgresqlServerInstanceList": [
          {
            "cloudPostgresqlServerInstanceNo": "34567891",
            "cloudPostgresqlServerName": "testpg-001-98b4",
            "cloudPostgresqlServerRole": {
              "code": "M",
              "codeName": "Primary"
            },
            "cloudPostgresqlServerInstanceStatusName": "running",
            "cloudPostgresqlServerInstanceStatus": {
              "code": "RUN",
              "codeName": "CLOUD DATABASE (VPC) server Running status"
            },
            "cloudPostgresqlServerInstanceOperation": {
              "code": "NOOP",
              "codeName": "CLOUD DATABASE (VPC) server null OP"
            },
            "cloudPostgresqlProductCode": "SVR.VPGSL.DBSVR.HICPU.C002.M004.NET.SSD.B050.G002",
            "regionCode": "KR",
            "zoneCode": "KR-1",
            "vpcNo": "12345678",
            "subnetNo": "23456789",
            "isPublicSubnet": false,
            "privateDomain": "pg-****.vpc-cdb-kr.ntruss.com",
            "privateIp": "10.0.0.7",
            "dataStorageType": {
              "code": "SSD",
              "codeName": "SSD"
            },
            "isStorageEncryption": false,
            "dataStorageSize": 10737418240,
            "usedDataStorageSize": 166268430,
            "cpuCount": 2,
            "memorySize": 4294967296,
            "uptime": "2026-06-09T18:23:53+0900",
            "createDate": "2026-06-09T18:17:31+0900"
          },
          {
            "cloudPostgresqlServerInstanceNo": "34567892",
            "cloudPostgresqlServerName": "testpg-002-98b5",
            "cloudPostgresqlServerRole": {
              "code": "H",
              "codeName": "Secondary"
            },
            "cloudPostgresqlServerInstanceStatusName": "running",
            "cloudPostgresqlServerInstanceStatus": {
              "code": "RUN",
              "codeName": "CLOUD DATABASE (VPC) server Running status"
            },
            "cloudPostgresqlServerInstanceOperation": {
              "code": "NOOP",
              "codeName": "CLOUD DATABASE (VPC) server null OP"
            },
            "cloudPostgresqlProductCode": "SVR.VPGSL.DBSVR.HICPU.C002.M004.NET.SSD.B050.G002",
            "regionCode": "KR",
            "zoneCode": "KR-1",
            "vpcNo": "12345678",
            "subnetNo": "23456789",
            "isPublicSubnet": false,
            "privateDomain": "pg-****.vpc-cdb-kr.ntruss.com",
            "privateIp": "10.0.0.8",
            "dataStorageType": {
              "code": "SSD",
              "codeName": "SSD"
            },
            "isStorageEncryption": false,
            "dataStorageSize": 10737418240,
            "usedDataStorageSize": 99006632,
            "cpuCount": 2,
            "memorySize": 4294967296,
            "uptime": "2026-06-09T18:22:56+0900",
            "createDate": "2026-06-09T18:17:31+0900"
          },
          {
            "cloudPostgresqlServerName": "testpg-003-98b9",
            "cloudPostgresqlServerRole": {
              "code": "S",
              "codeName": "Read Replica"
            },
            "cloudPostgresqlServerInstanceStatusName": "creating",
            "cloudPostgresqlServerInstanceStatus": {
              "code": "PEND",
              "codeName": "CLOUD DATABASE (VPC) server Pending status"
            },
            "cloudPostgresqlServerInstanceOperation": {
              "code": "CREAT",
              "codeName": "CLOUD DATABASE (VPC) server 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-09T19:05:08+0900"
          }
        ]
      }
    ],
    "requestId": "d4e5f6a7-b8c9-0123-defa-456789012345",
    "returnCode": "0",
    "returnMessage": "success"
  }
}