getCloudPostgresqlInstanceDetail

The latest service changes have not yet been reflected in this content. We will update the content as soon as possible. Please refer to the Korean version for information on the latest updates.

Available in VPC

Get Cloud DB for PostgreSQL instance details.

Commands

The command statement is as follows.

ncloud vpostgresql getCloudPostgresqlInstanceDetail [regionCode] [cloudPostgresqlInstanceNo] [output]

Parameter

The following describes the parameters.

Parameter	Type	Required	Description	Restrictions
regionCode	String	N	Region code - regionCode can be obtained through the getRegionList action - Default: Select the first Region of the getRegionList search result	-
cloudPostgresqlInstanceNo	String	Y	Cloud DB for PostgreSQL instance number - cloudPostgresqlInstanceNo can be obtained through the getCloudPostgresqlInstanceList action.	-
output	String	N	Format type of the response result - Options: xml \| json - Default: json	-

Response

Response data type

CloudPostgresqlInstanceList type

CloudPostgresqlInstanceList extends CommonResponse
private Integer totalRows;
private List<CloudPostgresqlInstance> cloudPostgresqlInstanceList = new ArrayList<>();

CloudPostgresqlInstance type

CloudPostgresqlInstance
private String cloudPostgresqlInstanceNo;
private String cloudPostgresqlServiceName;
private String cloudPostgresqlInstanceStatusName;
private CommonCode cloudPostgresqlInstanceStatus;
private CommonCode cloudPostgresqlInstanceOperation;
private String cloudPostgresqlImageProductCode;
private String engineVersion;
private String generationCode;
private String license;
private Integer cloudPostgresqlPort;
private Boolean isHa;
private Boolean isMultiZone;
private Boolean isBackup;
private Integer backupFileRetentionPeriod;
private String backupTime;
private Date createDate;
private AccessControlGroupNoList accessControlGroupNoList;
private CloudPostgresqlConfigList cloudPostgresqlConfigList;
private List<CloudPostgresqlServerInstance> cloudPostgresqlServerInstanceList;

AccessControlGroupNoList type

AccessControlGroupNoList
private List<String> accessControlGroupNoList = new ArrayList<>();

CloudPostgresqlConfigList type

CloudPostgresqlConfigList
private List<String> cloudPostgresqlConfigList = new ArrayList<>();

CloudPostgresqlServerInstance type

CloudPostgresqlServerInstance
private String cloudPostgresqlServerInstanceNo;
private String cloudPostgresqlServerName;
private CommonCode cloudPostgresqlServerRole;
private String cloudPostgresqlServerInstanceStatusName;
private CommonCode cloudPostgresqlServerInstanceStatus;
private CommonCode cloudPostgresqlServerInstanceOperation;
private String cloudPostgresqlProductCode;
private String regionCode;
private String zoneCode;
private String vpcNo;
private String subnetNo;
private Boolean isPublicSubnet;
private String publicDomain;
private String privateDomain;
private String privateIp;
private CommonCode dataStorageType;
private Boolean isStorageEncryption;
private Long dataStorageSize;
private Long usedDataStorageSize;
private Integer cpuCount;
private Long memorySize;
private Date uptime;
private Date createDate;

Examples

It describes call and response examples.

Call examples

The following is a call example.

ncloud vpostgresql getCloudPostgresqlInstanceDetail --regionCode KR --cloudPostgresqlInstanceNo ****925

Response example

The following is a sample example.

When the response result format type (output) is JSON

{
  "getCloudPostgresqlInstanceDetailResponse": {
    "requestId": "15ec23ff-2e64-43d1-b6a2-733bf5c3d3e1",
    "returnCode": 0,
    "returnMessage": "success",
    "totalRows": 1,
    "cloudPostgresqlInstanceList": [
      {
        "cloudPostgresqlInstanceNo": "****925",
        "cloudPostgresqlServiceName": "test-****",
        "cloudPostgresqlInstanceStatusName": "running",
        "cloudPostgresqlInstanceStatus": {
          "code": "CREAT",
          "codeName": "CLOUD DATABASE(VPC) Created State"
        },
        "cloudPostgresqlInstanceOperation": {
          "code": "NULL",
          "codeName": "CLOUD DATABASE(VPC) Null OP"
        },
        "cloudPostgresqlImageProductCode": "SW.VPGSL.OS.LNX64.CNTOS.0708.PGSQL.133.B050",
        "engineVersion": "PostgreSQL 13.3",
        "generationCode": "G2",
        "license": "PostgreSQL License",
        "cloudPostgresqlPort": 15432,
        "isHa": true,
        "isMultiZone": true,
        "isBackup": true,
        "backupFileRetentionPeriod": 10,
        "backupTime": "02:00",
        "createDate": "2021-08-30T18:00:00+0900",
        "accessControlGroupNoList": [
          "****48"
        ],
        "cloudPostgresqlConfigList": [
            "sample_config=sample_value"
        ],
        "cloudPostgresqlServerInstanceList": [
          {
            "cloudPostgresqlServerInstanceNo": "****926",
            "cloudPostgresqlServerName": "test-****-001-gcb",
            "cloudPostgresqlServerRole": {
              "code": "M",
              "codeName": "Primary"
            },
            "cloudPostgresqlServerInstanceStatusName": "running",
            "cloudPostgresqlServerInstanceStatus": {
              "code": "RUN",
              "codeName": "CLOUD DATABASE(VPC) Server Running State"
            },
            "cloudPostgresqlServerInstanceOperation": {
              "code": "NOOP",
              "codeName": "CLOUD DATABASE(VPC) Server Null OP"
            },
            "cloudPostgresqlProductCode": "SVR.VPGSL.DBSVR.STAND.C002.M004.NET.SSD.B050.G001",
            "regionCode": "KR",
            "zoneCode": "KR-1",
            "vpcNo": "****87",
            "subnetNo": "****49",
            "isPublicSubnet": true,
            "privateDomain": "pg-****.vpc-cdb-kr.ntruss.com",
            "privateIp": "***.***.***.***",
            "dataStorageType": {
              "code": "SSD",
              "codeName": "SSD"
            },
            "isStorageEncryption": true,
            "dataStorageSize": 10737418240,
            "usedDataStorageSize": 4365680640,
            "cpuCount": 2,
            "memorySize": 4294967296,
            "uptime": "2021-08-30T18:10:00+0900",
            "createDate": "2021-08-30T18:00:00+0900"
          },
          {
            "cloudPostgresqlServerInstanceNo": "****932",
            "cloudPostgresqlServerName": "test-****-002-gcc",
            "cloudPostgresqlServerRole": {
              "code": "H",
              "codeName": "Secondary"
            },
            "cloudPostgresqlServerInstanceStatusName": "running",
            "cloudPostgresqlServerInstanceStatus": {
              "code": "RUN",
              "codeName": "CLOUD DATABASE(VPC) Server Running State"
            },
            "cloudPostgresqlServerInstanceOperation": {
              "code": "NOOP",
              "codeName": "CLOUD DATABASE(VPC) Server Null OP"
            },
            "cloudPostgresqlProductCode": "SVR.VPGSL.DBSVR.STAND.C002.M004.NET.SSD.B050.G001",
            "regionCode": "KR",
            "zoneCode": "KR-2",
            "vpcNo": "****87",
            "subnetNo": "****51",
            "isPublicSubnet": true,
            "privateDomain": "pg-****.vpc-cdb-kr.ntruss.com",
            "privateIp": "***.***.***.***",
            "dataStorageType": {
              "code": "SSD",
              "codeName": "SSD"
            },
            "isStorageEncryption": true,
            "dataStorageSize": 10737418240,
            "usedDataStorageSize": 3291672576,
            "cpuCount": 2,
            "memorySize": 4294967296,
            "uptime": "2021-08-30T18:10:00+0900",
            "createDate": "2021-08-30T18:00:00+0900"
          }
        ]
      }
    ]
  }
}

When the response result format type (output) is XML

<getCloudPostgresqlInstanceDetailResponse>
    <requestId>15ec23ff-2e64-43d1-b6a2-733bf5c3d3e1</requestId>
    <returnCode>0</returnCode>
    <returnMessage>success</returnMessage>
    <totalRows>1</totalRows>
    <cloudPostgresqlInstanceList>
        <cloudPostgresqlInstance>
            <cloudPostgresqlInstanceNo>****925</cloudPostgresqlInstanceNo>
            <cloudPostgresqlServiceName>test-****</cloudPostgresqlServiceName>
            <cloudPostgresqlInstanceStatusName>running</cloudPostgresqlInstanceStatusName>
            <cloudPostgresqlInstanceStatus>
                <code>CREAT</code>
                <codeName>CLOUD DATABASE(VPC) Created State</codeName>
            </cloudPostgresqlInstanceStatus>
            <cloudPostgresqlInstanceOperation>
                <code>NULL</code>
                <codeName>CLOUD DATABASE(VPC) Null OP</codeName>
            </cloudPostgresqlInstanceOperation>
            <cloudPostgresqlImageProductCode>SW.VPGSL.OS.LNX64.CNTOS.0708.PGSQL.133.B050</cloudPostgresqlImageProductCode>
            <engineVersion>PostgreSQL 13.3</engineVersion>
            <generationCode>G2</generationCode>
            <license>PostgreSQL License</license>
            <cloudPostgresqlPort>15432</cloudPostgresqlPort>
            <isHa>true</isHa>
            <isMultiZone>true</isMultiZone>
            <isBackup>true</isBackup>
            <backupFileRetentionPeriod>10</backupFileRetentionPeriod>
            <backupTime>02:00</backupTime>
            <createDate>2021-08-30T18:00:00+0900</createDate>
            <accessControlGroupNoList>
                <accessControlGroupNo>****48</accessControlGroupNo>
            </accessControlGroupNoList>
            <cloudPostgresqlConfigList>
                <cloudPostgresqlConfig>sample_config=sample_value</cloudPostgresqlConfig>
            </cloudPostgresqlConfigList>
            <cloudPostgresqlServerInstanceList>
                <cloudPostgresqlServerInstance>
                    <cloudPostgresqlServerInstanceNo>****926</cloudPostgresqlServerInstanceNo>
                    <cloudPostgresqlServerName>test-****-001-gcb</cloudPostgresqlServerName>
                    <cloudPostgresqlServerRole>
                        <code>M</code>
                        <codeName>Primary</codeName>
                    </cloudPostgresqlServerRole>
                    <cloudPostgresqlServerInstanceStatusName>running</cloudPostgresqlServerInstanceStatusName>
                    <cloudPostgresqlServerInstanceStatus>
                        <code>RUN</code>
                        <codeName>CLOUD DATABASE(VPC) Server Running State</codeName>
                    </cloudPostgresqlServerInstanceStatus>
                    <cloudPostgresqlServerInstanceOperation>
                        <code>NOOP</code>
                        <codeName>CLOUD DATABASE(VPC) Server Null OP</codeName>
                    </cloudPostgresqlServerInstanceOperation>
                    <cloudPostgresqlProductCode>SVR.VPGSL.DBSVR.STAND.C002.M004.NET.SSD.B050.G001</cloudPostgresqlProductCode>
                    <regionCode>KR</regionCode>
                    <zoneCode>KR-1</zoneCode>
                    <vpcNo>****87</vpcNo>
                    <subnetNo>****49</subnetNo>
                    <isPublicSubnet>true</isPublicSubnet>
                    <privateDomain>pg-****.vpc-cdb-kr.ntruss.com</privateDomain>
                    <privateIp>***.***.***.***</privateIp>
                    <dataStorageType>
                        <code>SSD</code>
                        <codeName>SSD</codeName>
                    </dataStorageType>
                    <isStorageEncryption>true</isStorageEncryption>
                    <dataStorageSize>10737418240</dataStorageSize>
                    <usedDataStorageSize>4365680640</usedDataStorageSize>
                    <cpuCount>2</cpuCount>
                    <memorySize>4294967296</memorySize>
                    <uptime>2021-08-30T18:10:00+0900</uptime>
                    <createDate>2021-08-30T18:00:00+0900</createDate>
                </cloudPostgresqlServerInstance>
                <cloudPostgresqlServerInstance>
                    <cloudPostgresqlServerInstanceNo>****932</cloudPostgresqlServerInstanceNo>
                    <cloudPostgresqlServerName>test-****-002-gcc</cloudPostgresqlServerName>
                    <cloudPostgresqlServerRole>
                        <code>H</code>
                        <codeName>Secondary</codeName>
                    </cloudPostgresqlServerRole>
                    <cloudPostgresqlServerInstanceStatusName>running</cloudPostgresqlServerInstanceStatusName>
                    <cloudPostgresqlServerInstanceStatus>
                        <code>RUN</code>
                        <codeName>CLOUD DATABASE(VPC) Server Running State</codeName>
                    </cloudPostgresqlServerInstanceStatus>
                    <cloudPostgresqlServerInstanceOperation>
                        <code>NOOP</code>
                        <codeName>CLOUD DATABASE(VPC) Server Null OP</codeName>
                    </cloudPostgresqlServerInstanceOperation>
                    <cloudPostgresqlProductCode>SVR.VPGSL.DBSVR.STAND.C002.M004.NET.SSD.B050.G001</cloudPostgresqlProductCode>
                    <regionCode>KR</regionCode>
                    <zoneCode>KR-2</zoneCode>
                    <vpcNo>****87</vpcNo>
                    <subnetNo>****51</subnetNo>
                    <isPublicSubnet>true</isPublicSubnet>
                    <privateDomain>pg-****.vpc-cdb-kr.ntruss.com</privateDomain>
                    <privateIp>***.***.***.***</privateIp>
                    <dataStorageType>
                        <code>SSD</code>
                        <codeName>SSD</codeName>
                    </dataStorageType>
                    <isStorageEncryption>true</isStorageEncryption>
                    <dataStorageSize>10737418240</dataStorageSize>
                    <usedDataStorageSize>3291672576</usedDataStorageSize>
                    <cpuCount>2</cpuCount>
                    <memorySize>4294967296</memorySize>
                    <uptime>2021-08-30T18:10:00+0900</uptime>
                    <createDate>2021-08-30T18:00:00+0900</createDate>
                </cloudPostgresqlServerInstance>
            </cloudPostgresqlServerInstanceList>
        </cloudPostgresqlInstance>
    </cloudPostgresqlInstanceList>
</getCloudPostgresqlInstanceDetailResponse>