getCloudPostgresqlInstanceList

Prev Next

Cloud DB for PostgreSQL 인스턴스 목록을 조회합니다.

명령어

명령어 구문은 다음과 같습니다.

ncloud vpostgresql getCloudPostgresqlInstanceList [regionCode] [zoneCode] [vpcNo] [subnetNo] [cloudPostgresqlServiceName] [cloudPostgresqlInstanceNoList] [cloudPostgresqlServerName] [cloudPostgresqlServerInstanceNoList] [pageNo] [pageSize] [output]

파라미터

파라미터에 대한 설명은 다음과 같습니다.

파라미터 타입 필수 여부 설명 제약 사항
regionCode String N 리전 코드
- regionCode는 getRegionList 액션을 통해 획득
- default: getRegionList 조회 결과의 첫 번째 리전을 선택
-
zoneCode String N Zone 코드
- zoneCode는 getZoneList 액션을 통해 획득
-
vpcNo String N VPC 번호
- vpcNo는 getCloudPostgresqlTargetVpcList 액션을 통해서 획득
-
subnetNo String N Subnet 번호
- SubnetNo는 getCloudPostgresqlTargetSubnetList 액션을 통해서 획득
-
cloudPostgresqlServiceName String N Cloud DB for PostgreSQL 서비스 이름
- Cloud DB for PostgreSQL 서비스 이름으로 필터링하여 검색 가능
- cloudPostgresqlServiceName은 getCloudPostgresqlInstanceList 액션을 통해 획득
-
cloudPostgresqlInstanceNoList List<String> N Cloud DB for PostgreSQL 인스턴스 번호 목록
- Cloud DB for PostgreSQL 인스턴스 번호로 필터링하여 검색 가능
- cloudPostgresqlInstanceNoList는 getCloudPostgresqlInstanceList 액션을 통해 획득
- ex) cloudPostgresqlInstanceNoList 1234 2345
-
cloudPostgresqlServerName String N Cloud DB for PostgreSQL 서버 이름
- Cloud DB for PostgreSQL 서버 이름으로 필터링하여 검색 가능
- cloudPostgresqlServerName은 getCloudPostgresqlInstanceList 액션을 통해 획득
-
cloudPostgresqlServerInstanceNoList List<String> N Cloud DB for PostgreSQL 서버 인스턴스 번호 목록
- Cloud DB for PostgreSQL 서버 인스턴스 번호로 필터링하여 검색 가능
- cloudPostgresqlServerInstanceNoList getCloudPostgresqlInstanceList 액션을 통해 획득
- ex) cloudPostgresqlServerInstanceNoList 1234 2345
-
pageNo Integer N 페이징 된 결과의 페이지 번호
- 결괏값을 pageNo, pageSize를 이용하여 페이징 처리 가능
- Min: 0
pageSize Integer N 페이징 시 보여줄 각 페이지 사이즈
- 결괏값을 pageNo, pageSize를 이용하여 페이징 처리 가능
- pageNo 입력 시 반드시 입력
- Min: 1
output String N 응답 결과의 포맷 타입
- options: xml | json
- default: json
-

응답

응답 데이터 타입

  • CloudPostgresqlInstanceList 타입
CloudPostgresqlInstanceList extends CommonResponse 설명
private Integer totalRows; 조회된 목록의 총 개수
private List<CloudPostgresqlInstance> cloudPostgresqlInstanceList = new ArrayList<>(); Cloud DB for PostgreSQL 인스턴스 목록
  • CloudPostgresqlInstance 타입
CloudPostgresqlInstance 설명
private String cloudPostgresqlInstanceNo; Cloud DB for PostgreSQL 인스턴스 번호
private String cloudPostgresqlServiceName; Cloud DB for PostgreSQL 서비스 이름
private String cloudPostgresqlInstanceStatusName; Cloud DB for PostgreSQL 인스턴스 상태 이름
- creating
- deleted
- deleting
- downgrading
- pending
- recovering
- reinstalling
- restarting
- running
- settingup
- shuttingdown
- stopped
- upgrading
private CommonCode cloudPostgresqlInstanceStatus; Cloud DB for PostgreSQL 인스턴스 상태 코드
- INIT (initiate)
- CREAT (created)
- DEL (deleted)
private CommonCode cloudPostgresqlInstanceOperation; Cloud DB for PostgreSQL 인스턴스 Operation 코드
- CREAT (create)
- DEL (delete)
- FO (failover)
- NULL (no operation)
- SETUP (setup)
- UPGD (upgrade)
- DWGD (downgrade)
- BKP (backup)
private String cloudPostgresqlImageProductCode; Cloud DB for PostgreSQL 이미지 상품 코드
private String engineVersion; Cloud DB for PostgreSQL 엔진 버전
private String generationCode; 세대코드
private String license; Cloud DB for PostgreSQL 라이선스
private Integer cloudPostgresqlPort; Cloud DB for PostgreSQL 포트
private Boolean isHa; 고가용성 여부
private Boolean isMultiZone; 멀티존 여부
private Boolean isBackup; 백업 여부
private Integer backupFileRetentionPeriod; 백업 파일 보관 기간
private String backupTime; 백업 시간
private Date createDate; 생성일자
private AccessControlGroupNoList accessControlGroupNoList; ACG 번호 목록
private CloudPostgresqlConfigList cloudPostgresqlConfigList; Cloud DB for PostgreSQL Config 목록
private List<CloudPostgresqlServerInstance> cloudPostgresqlServerInstanceList; Cloud DB for PostgreSQL 서버 인스턴스 목록
  • AccessControlGroupNoList 타입
AccessControlGroupNoList 설명
private List<String> accessControlGroupNoList = new ArrayList<>(); ACG 번호 목록
  • CloudPostgresqlConfigList 타입
CloudPostgresqlConfigList 설명
private List<String> cloudPostgresqlConfigList = new ArrayList<>(); Cloud DB for PostgreSQL Config 목록
  • CloudPostgresqlServerInstance 타입
CloudPostgresqlServerInstance 설명
private String cloudPostgresqlServerInstanceNo; Cloud DB for PostgreSQL 서버 인스턴스 번호
private String cloudPostgresqlServerName; Cloud DB for PostgreSQL 서버 이름
private CommonCode cloudPostgresqlServerRole; Cloud DB for PostgreSQL 서버 역할
private String cloudPostgresqlServerInstanceStatusName; Cloud DB for PostgreSQL 서버 인스턴스 상태 이름
- creating
- deleted
- deleting
- downgrading
- pending
- recovering
- reinstalling
- restarting
- running
- settingup
- shuttingdown
- stopped
- upgrading
- downgrading
private CommonCode cloudPostgresqlServerInstanceStatus; Cloud DB for PostgreSQL 서버 인스턴스 상태 코드
- DEL (deleted)
- PEND (pending)
- RUN (running)
- STOP (stopped)
- FSTOP (failure stopped)
private CommonCode cloudPostgresqlServerInstanceOperation; Cloud DB for PostgreSQL 서버 인스턴스 Operation 코드
- 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 상품 코드
private String regionCode; 리전 코드
private String zoneCode; Zone 코드
private String vpcNo; VPC 번호
private String subnetNo; Subnet 번호
private Boolean isPublicSubnet; Public Subnet 여부
private String publicDomain; 공인 도메인명
private String privateDomain; 사설 도메인명
private String privateIp; 사설 IP
private CommonCode dataStorageType; 데이터 스토리지 타입
private Boolean isStorageEncryption; 데이터 스토리지 암호화 여부
private Long dataStorageSize; 데이터 스토리지 사이즈
private Long usedDataStorageSize; 사용중인 데이터 스토리지 사이즈
private Integer cpuCount; CPU 개수
private Long memorySize; 메모리 사이즈
private Date uptime; VM 부팅 완료 시간
private Date createDate; 생성일자

예시

호출과 응답 예시를 설명합니다.

호출 예시

호출 예시는 다음과 같습니다.

ncloud vpostgresql getCloudPostgresqlInstanceList --regionCode FKR

응답 예시

응답 예시는 다음과 같습니다.

응답 결과 포맷 타입(output)이 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": "FKR",
            "zoneCode": "FKR-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": "FKR",
            "zoneCode": "FKR-2",
            "vpcNo": "****87",
            "subnetNo": "****51",
            "privateIp": "***.***.***.***",
            "dataStorageSize": 10737418240,
            "cpuCount": 2,
            "memorySize": 4294967296
          }
        ]
      }
    ]
  }
}

응답 결과 포맷 타입(output)이 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>FKR</regionCode>
                    <zoneCode>FKR-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>FKR</regionCode>
                    <zoneCode>FKR-2</zoneCode>
                    <vpcNo>****87</vpcNo>
                    <subnetNo>****51</subnetNo>
                    <privateIp>***.***.***.***</privateIp>
                    <dataStorageSize>10737418240</dataStorageSize>
                    <cpuCount>2</cpuCount>
                    <memorySize>4294967296</memorySize>
                </cloudPostgresqlServerInstance>
            </cloudPostgresqlServerInstanceList>
        </cloudPostgresqlInstance>
    </cloudPostgresqlInstanceList>
</getCloudPostgresqlInstanceListResponse>