getCloudMssqlBackupList

Prev Next

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

사용 가능한 Cloud DB for MSSQL 백업 목록을 조회합니다.

명령어

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

ncloud vmssql getCloudMssqlBackupList [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
output String N 응답 결과의 포맷 타입
- options: xml | json
- default: json
-

응답

응답 데이터 타입

  • CloudMssqlBackupList 타입
CloudMssqlBackupList extends CommonResponse 설명
private Integer totalRows; 조회된 목록의 총 개수
private List<CloudMssqlBackup> cloudMssqlBackupList = new ArrayList<>(); Cloud DB for MSSQL 백업 목록
  • CloudMssqlBackup 타입
CloudMssqlBackup 설명
private Integer cloudMssqlInstanceNo; Cloud DB for MSSQL 인스턴스 번호
private String cloudMssqlServiceName; Cloud DB for MSSQL 서비스 이름
private Integer backupFileRetentionPeriod; 백업 파일 보관 기간
private String backupTime; FullBackup 시작 시간
private Long totalBackupDataSize; 보관중인 Backup 데이터 사이즈
private Long fullBackupDataSize; FullBackup 데이터 사이즈
private Long logBackupDataSize; Log Backup 데이터 사이즈
private Long logBackupCount; Log Backup 수

예시

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

호출 예시

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

ncloud vmssql getCloudMssqlBackupList --regionCode KR

응답 예시

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

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

{
  "getCloudMssqlBackupListResponse": {
    "requestId": "d5e980a0-15b5-4c77-8b12-a70b8673142c",
    "returnCode": 0,
    "returnMessage": "success",
    "totalRows": 1,
    "cloudMssqlBackupList": [
      {
        "cloudMssqlInstanceNo": "****890",
        "cloudMssqlServiceName": "test-****",
        "backupDurationDay": 3,
        "backupTime": "17:00",
        "totalBackupDataSize": 20252685,
        "fullBackupDataSize": 20252685,
        "logBackupDataSize": 0,
        "logBackupCount": 0
      }
    ]
  }
}

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

<getCloudMssqlBackupListResponse>
    <requestId>d5e980a0-15b5-4c77-8b12-a70b8673142c</requestId>
    <returnCode>0</returnCode>
    <returnMessage>success</returnMessage>
    <totalRows>1</totalRows>
    <cloudMssqlBackupList>
        <CloudMssqlBackup>
            <cloudMssqlInstanceNo>****890</cloudMssqlInstanceNo>
            <cloudMssqlServiceName>test-****</cloudMssqlServiceName>
            <backupDurationDay>3</backupDurationDay>
            <backupTime>17:00</backupTime>
            <totalBackupDataSize>20252685</totalBackupDataSize>
            <fullBackupDataSize>20252685</fullBackupDataSize>
            <logBackupDataSize>0</logBackupDataSize>
            <logBackupCount>0</logBackupCount>
        </CloudMssqlBackup>
    </cloudMssqlBackupList>
</getCloudMssqlBackupListResponse>