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の場合

レスポンス結果フォーマットタイプ(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の場合

レスポンス結果フォーマットタイプ(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>