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.

getCloudPostgresqlInstanceList

Prev Next

Available in VPC

Get the list of Cloud DB for PostgreSQL instances.

Commands

The command statement is as follows.

ncloud vpostgresql getCloudPostgresqlInstanceList [regionCode] [zoneCode] [vpcNo] [subnetNo] [cloudPostgresqlServiceName] [cloudPostgresqlInstanceNoList] [cloudPostgresqlServerName] [cloudPostgresqlServerInstanceNoList] [pageNo] [pageSize] [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		 -
zoneCode String N Zone code
- zoneCode can be obtained through the getZoneList action.		 -
vpcNo String N VPC number
- vpcNo can be obtained through the getCloudPostgresqlTargetVpcList action		 -
subnetNo String N Subnet number
- SubnetNo can be obtained through the getCloudPostgresqlTargetSubnetList action		 -
cloudPostgresqlServiceName String N Cloud DB for PostgreSQL service name
- You can filter and search by Cloud DB for PostgreSQL service name
- cloudPostgresqlServiceName can be obtained through the getCloudPostgresqlInstanceList action		 -
cloudPostgresqlInstanceNoList List<String> N Cloud DB for PostgreSQL instance number list
- You can filter and search by Cloud DB for PostgreSQL instance number
- cloudPostgresqlInstanceNoList can be obtained through the getCloudPostgresqlInstanceList action
- E.g., cloudPostgresqlInstanceNoList 1234 2345		 -
cloudPostgresqlServerName String N Cloud DB for PostgreSQL server name
- You can filter and search by Cloud DB for PostgreSQL server name
- cloudPostgresqlServerName can be obtained through the getCloudPostgresqlInstanceList action		 -
cloudPostgresqlServerInstanceNoList List<String> N Cloud DB for PostgreSQL server instance number list
- You can filter and search by Cloud DB for PostgreSQL server instance number
- cloudPostgresqlServerInstanceNoList can be obtained through the getCloudPostgresqlInstanceList action
- E.g., cloudPostgresqlServerInstanceNoList 1234 2345		 -
pageNo Integer N Page number of the paged results
- The results can be paged using pageNo and pageSize		 - Min: 0
pageSize Integer N Size of each page to be displayed when paging
- The results can be paged using pageNo and pageSize
- This field must be entered when pageNo is entered		 - Min: 1
output String N Format type of the response result
- Options: xml | json
- Default: json		 -

Response

Response data type

  • CloudPostgresqlInstanceList type
CloudPostgresqlInstanceList extends CommonResponse Description
private Integer totalRows; Total number of lists searched
private List<CloudPostgresqlInstance> cloudPostgresqlInstanceList = new ArrayList<>(); Cloud DB for PostgreSQL instance list
  • CloudPostgresqlInstance type
CloudPostgresqlInstance Description
private String cloudPostgresqlInstanceNo; Cloud DB for PostgreSQL instance number
private String cloudPostgresqlServiceName; Cloud DB for PostgreSQL service name
private String cloudPostgresqlInstanceStatusName; Cloud DB for PostgreSQL instance status name
- creating
- deleted
- deleting
- downgrading
- pending
- recovering
- reinstalling
- restarting
- running
- settingup
- shuttingdown
- stopped
- upgrading
private CommonCode cloudPostgresqlInstanceStatus; Cloud DB for PostgreSQL instance status code
- INIT (initiate)
- CREAT (created)
- DEL (deleted)
private CommonCode cloudPostgresqlInstanceOperation; Cloud DB for PostgreSQL instance operation code
- CREAT (create)
- DEL (delete)
- FO (failover)
- NULL (no operation)
- SETUP (setup)
- UPGD (upgrade)
- DWGD (downgrade)
- BKP (backup)
private String cloudPostgresqlImageProductCode; Cloud DB for PostgreSQL image product code
private String engineVersion; Cloud DB for PostgreSQL engine version
private String generationCode; Generation code
private String license; Cloud DB for PostgreSQL license
private Integer cloudPostgresqlPort; Cloud DB for PostgreSQL port
private Boolean isHa; High availability status
private Boolean isMultiZone; Multi-zone status
private Boolean isBackup; Backup status
private Integer backupFileRetentionPeriod; Backup file retention period
private String backupTime; Backup time
private Date createDate; Issuance date
private AccessControlGroupNoList accessControlGroupNoList; ACG number list
private CloudPostgresqlConfigList cloudPostgresqlConfigList; Cloud DB for PostgreSQL config list
private List<CloudPostgresqlServerInstance> cloudPostgresqlServerInstanceList; Cloud DB for PostgreSQL server instance list
  • AccessControlGroupNoList type
AccessControlGroupNoList Description
private List<String> accessControlGroupNoList = new ArrayList<>(); ACG number list
  • CloudPostgresqlConfigList type
CloudPostgresqlConfigList Description
private List<String> cloudPostgresqlConfigList = new ArrayList<>(); Cloud DB for PostgreSQL config list
  • CloudPostgresqlServerInstance type
CloudPostgresqlServerInstance Description
private String cloudPostgresqlServerInstanceNo; Cloud DB for PostgreSQL server instance number
private String cloudPostgresqlServerName; Cloud DB for PostgreSQL server name
private CommonCode cloudPostgresqlServerRole; Cloud DB for PostgreSQL server role
private String cloudPostgresqlServerInstanceStatusName; Cloud DB for PostgreSQL server instance status name
- creating
- deleted
- deleting
- downgrading
- pending
- recovering
- reinstalling
- restarting
- running
- settingup
- shuttingdown
- stopped
- upgrading
- downgrading
private CommonCode cloudPostgresqlServerInstanceStatus; Cloud DB for PostgreSQL server instance status code
- DEL (deleted)
- PEND (pending)
- RUN (running)
- STOP (stopped)
- FSTOP (failure stopped)
private CommonCode cloudPostgresqlServerInstanceOperation; Cloud DB for PostgreSQL server instance operation code
- NOOP (no operation)
- CREAT (create)
- START (start)
- RSTRT (restart)
- SETUP (setup)
- STOP (stop)
- FO (failover)
- DEL (delete)
- UPGD (upgrade)
- DWGD (downgrade)
- RISTL (reinstall)
private String cloudPostgresqlProductCode; Cloud DB for PostgreSQL product code
private String regionCode; Region code
private String zoneCode; Zone code
private String vpcNo; VPC number
private String subnetNo; Subnet number
private Boolean isPublicSubnet; Public subnet status
private String publicDomain; Public domain name
private String privateDomain; Private domain name
private String privateIp; Private IP
private CommonCode dataStorageType; Data storage type
private Boolean isStorageEncryption; Data storage encryption status
private Long dataStorageSize; Data storage size
private Long usedDataStorageSize; Size of data storage in use
private Integer cpuCount; Number of CPUs
private Long memorySize; Memory size
private Date uptime; VM boot completion time
private Date createDate; Issuance date

Examples

It describes call and response examples.

Call examples

The following is a call example.

ncloud vpostgresql getCloudPostgresqlInstanceList --regionCode KR

Response example

The following is a sample example.

When the response result format type (output) is JSON

{
  "getCloudPostgresqlInstanceListResponse": {
    "requestId": "3c690190-a654-499e-8e00-7916d62ae416",
    "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"
        },
        "generationCode": "G2",
        "isHa": true,
        "isMultiZone": true,
        "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"
            },
            "regionCode": "KR",
            "zoneCode": "KR-1",
            "vpcNo": "****87",
            "subnetNo": "****49",
            "privateIp": "***.***.***.***",
            "dataStorageSize": 10737418240,
            "cpuCount": 2,
            "memorySize": 4294967296
          },
          {
            "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"
            },
            "regionCode": "KR",
            "zoneCode": "KR-2",
            "vpcNo": "****87",
            "subnetNo": "****51",
            "privateIp": "***.***.***.***",
            "dataStorageSize": 10737418240,
            "cpuCount": 2,
            "memorySize": 4294967296
          }
        ]
      }
    ]
  }
}

When the response result format type (output) is XML

<getCloudPostgresqlInstanceListResponse>
    <requestId>3c690190-a654-499e-8e00-7916d62ae416</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>
            <generationCode>G2</generationCode>
            <isHa>true</isHa>
            <isMultiZone>true</isMultiZone>
            <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>
                    <regionCode>KR</regionCode>
                    <zoneCode>KR-1</zoneCode>
                    <vpcNo>****87</vpcNo>
                    <subnetNo>****49</subnetNo>
                    <privateIp>***.***.***.***</privateIp>
                    <dataStorageSize>10737418240</dataStorageSize>
                    <cpuCount>2</cpuCount>
                    <memorySize>4294967296</memorySize>
                </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>
                    <regionCode>KR</regionCode>
                    <zoneCode>KR-2</zoneCode>
                    <vpcNo>****87</vpcNo>
                    <subnetNo>****51</subnetNo>
                    <privateIp>***.***.***.***</privateIp>
                    <dataStorageSize>10737418240</dataStorageSize>
                    <cpuCount>2</cpuCount>
                    <memorySize>4294967296</memorySize>
                </cloudPostgresqlServerInstance>
            </cloudPostgresqlServerInstanceList>
        </cloudPostgresqlInstance>
    </cloudPostgresqlInstanceList>
</getCloudPostgresqlInstanceListResponse>
Business Registration Number: 129-86-31394 E-commerce Permit Number:No. 2009-GyeonggiSeongnam-0510
CEO: Kim Yuwon Address: NAVER Green Factory 17th–26th Floors, Buljeong-ro 6, Bundang-gu, Seongnam-si, Gyeonggi-do 13561, Republic of Korea. Customer Support Number: 1544-5876
© NAVER Cloud Corp. All Rights Reserved.