getCloudPostgresqlDatabaseList

Prev Next

VPC 환경에서 이용 가능합니다.

Cloud DB for PostgreSQL Database 목록을 조회합니다.

명령어

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

ncloud vpostgresql getCloudPostgresqlDatabaseList [regionCode] [cloudPostgresqlInstanceNo] [output]

파라미터

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

파라미터 타입 필수 여부 설명 제약사항
regionCode String N 리전 코드
- regionCode는 getRegionList 액션을 통해서 획득
- default: getRegionList 조회 결과의 첫 번째 리전을 선택
-
cloudPostgresqlInstanceNo String Y Cloud DB for PostgreSQL 인스턴스 번호
- cloudPostgresqlInstanceNo는 getCloudPostgresqlInstanceList 액션을 통해서 획득
-
output String N 응답 결과의 포맷 타입
- options: xml | json
- default: json
-

응답

응답 데이터 타입

  • CloudPostgresqlDatabaseList 타입
CloudPostgresqlDatabaseList extends CommonResponse 설명
private Integer totalRows; 조회된 목록의 총 개수
private List<CloudPostgresqlDatabase> cloudPostgresqlDatabaseList = new ArrayList<>(); Cloud DB for PostgreSQL Database 목록
  • CloudPostgresqlDatabase 타입
CloudPostgresqlDatabase 설명
private String databaseName; Database 이름
private String owner; Database 소유자 User ID

예시

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

호출 예시

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

ncloud vpostgresql getCloudPostgresqlDatabaseList --regionCode KR --cloudPostgresqlInstanceNo ****890

응답 예시

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

응답 결과 포맷 타입(output)이 json일 때

{
  "getCloudPostgresqlDatabaseListResponse": {
    "requestId": "32993542-96c8-4899-91d8-3a273960b79c",
    "returnCode": 0,
    "returnMessage": "success",
    "totalRows": 1,
    "cloudPostgresqlDatabaseList": [
      {
        "databaseName": "pgtest",
        "owner": "testuser"
      }
    ]
  }
}

응답 결과 포맷 타입(output)이 xml일 때

<getCloudPostgresqlDatabaseListResponse>
  <requestId>32993542-96c8-4899-91d8-3a273960b79c</requestId>
  <returnCode>0</returnCode>
  <returnMessage>success</returnMessage>
  <totalRows>1</totalRows>
  <cloudPostgresqlDatabaseList>
    <cloudPostgresqlDatabase>
      <databaseName>pgtest</databaseName>
      <owner>testuser</owner>
    </cloudPostgresqlDatabase>
  </cloudPostgresqlDatabaseList>
</getCloudPostgresqlDatabaseListResponse>