getCloudPostgresqlInstanceDetail

Available in VPC

Get Cloud DB for PostgreSQL instance details.

Syntax

The getCloudPostgresqlInstanceDetail syntax is as follows:

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

Options

This section describes the options available when running getCloudPostgresqlInstanceDetail.

Required options

The following options are required for getCloudPostgresqlInstanceDetail.

Common options

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

Examples

If the request to retrieve detailed information about a Cloud DB for PostgreSQL instance is successful, the instance's configuration information and details for each server instance are returned.

Command

The command example is as follows:

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

Output

The output example is as follows:

{
  "getCloudPostgresqlInstanceDetailResponse": {
    "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": 132707685,
            "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": 65447221,
            "cpuCount": 2,
            "memorySize": 4294967296,
            "uptime": "2026-06-09T18:22:56+0900",
            "createDate": "2026-06-09T18:17:31+0900"
          }
        ]
      }
    ],
    "requestId": "c3d4e5f6-a7b8-9012-cdef-345678901234",
    "returnCode": "0",
    "returnMessage": "success"
  }
}