getCloudPostgresqlBackupList

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

명령어

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

ncloud vpostgresql getCloudPostgresqlBackupList [regionCode] [pageNo] [pageSize] [output]

파라미터

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

파라미터	타입	필수 여부	설명	제약 사항
regionCode	String	N	리전 코드 - regionCode는 getRegionList 액션을 통해서 획득 - default: getRegionList 조회 결과의 첫 번째 리전을 선택	-
pageNo	Integer	N	페이징 된 결과의 페이지 번호 - 결괏값을 pageNo, pageSize를 이용하여 페이징 처리 가능	- Min: 0
pageSize	Integer	N	페이징 시 보여줄 각 페이지 사이즈 - 결괏값을 pageNo, pageSize를 이용하여 페이징 처리 가능 - pageNo 입력 시 반드시 입력	- Min: 1 - Max: 1000
output	String	N	응답 결과의 포맷 타입 - options: xml \| json - default: json	-

응답

응답 데이터 타입

CloudPostgresqlBackupList 타입

CloudPostgresqlBackupList extends CommonResponse	설명
private Integer totalRows;	조회된 목록의 총 개수
private List<CloudPostgresqlBackup> cloudPostgresqlBackupList = new ArrayList<>();	Cloud DB for PostgreSQL 백업 목록

CloudPostgresqlBackup 타입

CloudPostgresqlBackup	설명
private String cloudPostgresqlInstanceNo;	Cloud DB for PostgreSQL 인스턴스 번호
private String cloudPostgresqlServiceName;	Cloud DB for PostgreSQL 서비스 이름
private String backupType;	백업 유형
private Integer backupRetention;	백업 파일 보관 기간
private String backupTime;	백업 시간
private Long backupSize;	백업 사이즈
private Date lastBackupDate;	마지막 백업일시
private Integer backupFileStorageCount;	백업 파일 보관 개수

예시

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

호출 예시

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

ncloud vpostgresql getCloudPostgresqlBackupList --regionCode FKR

응답 예시

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

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

{
  "getCloudPostgresqlBackupListResponse": {
    "requestId": "2086d40d-d152-49a7-aa26-effaecb5a616",
    "returnCode": "0",
    "returnMessage": "success",
    "totalRows": "1",
    "cloudPostgresqlBackupList": [
      {
        "cloudPostgresqlInstanceNo": "****890",
        "cloudPostgresqlServiceName": "test-****",
        "backupType": "USER",
        "backupRetention": "10",
        "backupTime": "02:00",
        "backupSize": "571482767",
        "lastBackupDate": "2021-05-28T02:10:00+0900",
        "backupFileStorageCount": 5
      }
    ]
  }
}

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

<getCloudPostgresqlBackupListResponse>
    <requestId>2086d40d-d152-49a7-aa26-effaecb5a616</requestId>
    <returnCode>0</returnCode>
    <returnMessage>success</returnMessage>
    <totalRows>1</totalRows>
    <cloudPostgresqlBackupList>
        <cloudPostgresqlBackup>
            <cloudPostgresqlInstanceNo>****890</cloudPostgresqlInstanceNo>
            <cloudPostgresqlServiceName>test-****</cloudPostgresqlServiceName>
            <backupType>USER</backupType>
            <backupRetention>10</backupRetention>
            <backupTime>02:00</backupTime>
            <backupSize>571482767</backupSize>
            <lastBackupDate>2021-05-28T02:10:00+0900</lastBackupDate>
            <backupFileStorageCount>5</backupFileStorageCount>
        </cloudPostgresqlBackup>
    </cloudPostgresqlBackupList>
</getCloudPostgresqlBackupListResponse>