getCloudMssqlBackupDetailList

Prev Next

VPC環境で利用できます。

使用可能な Cloud DB for MSSQLバックアップ詳細情報リストを照会します。

コマンド

コマンド構文は次の通りです。

ncloud vmssql getCloudMssqlBackupDetailList [regionCode] [cloudMssqlInstanceNo] [pageNo] [pageSize] [output]

パラメータ

パラメータの説明は次の通りです。

パラメータ タイプ 必須の有無 説明 制限事項
regionCode String N リージョンコード
  • regionCodeはgetRegionListアクションを通じて取得
  • デフォルト: getRegionList照会結果の最初のリージョンを選択
-
cloudMssqlInstanceNo String Y バックアップの詳細情報を照会する Cloud DB for MSSQLインスタンス番号 -
pageNo Integer N ページングされた結果のページ番号
  • 結果値を pageNo、pageSizeを利用してページング処理可能
- 最小: 0
pageSize Integer N ページング時に表示する各ページサイズ
  • 結果値を pageNo、pageSizeを利用してページング処理可能
  • pageNo入力時、必ず入力
- 最小: 1
output String N レスポンス結果の形式タイプ
  • オプション: xml | json
  • デフォルト: json
-

レスポンス

レスポンスデータタイプ

  • CloudMssqlBackupDetailListタイプ

    CloudMssqlBackupDetailList extends CommonResponse 説明
    private Integer totalRows; 照会されたリストの総数
    private List<CloudMssqlBackupDetail> cloudMssqlBackupDetailList = new ArrayList<>(); Cloud DB for MSSQLバックアップの詳細リスト
  • CloudMssqlBackupDetailタイプ

    CloudMssqlBackupDetail 説明
    private Integer backupSetId; バックアップ ID
    private String databaseName; DB名
    private String fileName; ファイル名
    private String fullFileName; fullファイル名
    private Long fullBackupSize; FullBackupデータサイズ
    private Long logBackupCount; 関連したLog Backup数
    private Long logBackupSize; 関連したLog Backupデータサイズ
    private Date startTime; バックアップ開始日時
    private Date endTime; バックアップ終了日時

呼び出しとレスポンスの例を説明します。

呼び出し例

呼び出しのサンプルコードは次の通りです。

ncloud vmssql getCloudMssqlBackupDetailList --regionCode KR --cloudMssqlInstanceNo ***890

レスポンス例

レスポンスのサンプルコードは次の通りです。

レスポンス結果の形式タイプ(output)が jsonの場合

レスポンス結果の形式タイプ(output)が jsonの場合は次の通りです。

{
  "getCloudMssqlBackupDetailListResponse": {
    "requestId": "f3bda8a3-978a-42d3-b52f-123b096e0f45",
    "returnCode": 0,
    "returnMessage": "success",
    "totalRows": 4,
    "cloudMssqlBackupDetailList": [
      {
        "backupSetId": 12,
        "databaseName": "master",
        "fileName": "sample.txt",
        "fullFileName": "D:\\sample.txt",        
        "fullBackupSize": 780145,
        "logBackupCount": 0,
        "logBackupSize": 0,
        "startTime": "2021-07-12T09:13:57+0900",
        "endTime": "2021-07-12T09:13:57+0900"
      },
      {
        "backupSetId": 13,
        "databaseName": "msdb",
        "fileName": "sample1.txt",
        "fullFileName": "D:\\sample1.txt",        
        "fullBackupSize": 2590649,
        "logBackupCount": 0,
        "logBackupSize": 0,
        "startTime": "2021-07-12T09:13:51+0900",
        "endTime": "2021-07-12T09:13:51+0900"
      },
      {
        "backupSetId": 14,
        "databaseName": "master",
        "fileName": "sample2.txt",
        "fullFileName": "D:\\sample2.txt",        
        "fullBackupSize": 780204,
        "logBackupCount": 0,
        "logBackupSize": 0,
        "startTime": "2021-07-11T09:14:18+0900",
        "endTime": "2021-07-11T09:14:18+0900"
      },
      {
        "backupSetId": 15,
        "databaseName": "msdb",
        "fileName": "sample3.txt",
        "fullFileName": "D:\\sample3.txt",        
        "fullBackupSize": 2589526,
        "logBackupCount": 0,
        "logBackupSize": 0,
        "startTime": "2021-07-11T09:14:12+0900",
        "endTime": "2021-07-11T09:14:13+0900"
      }
    ]
  }
}

レスポンス結果の形式タイプ(responseFormatType)が xmlの場合

レスポンス結果の形式タイプ(responseFormatType)が xmlの場合は次の通りです。

<getCloudMssqlBackupDetailListResponse>
    <requestId>f3bda8a3-978a-42d3-b52f-123b096e0f45</requestId>
    <returnCode>0</returnCode>
    <returnMessage>success</returnMessage>
    <totalRows>4</totalRows>
    <cloudMssqlBackupDetailList>
        <CloudMssqlBackupDetail>
            <backupSetId>12</backupSetId>
            <databaseName>master</databaseName>
            <fileName>sample.txt</fileName>
            <fullFileName>D:\\sample.txt</fullFileName>
            <fullBackupSize>780145</fullBackupSize>
            <logBackupCount>0</logBackupCount>
            <logBackupSize>0</logBackupSize>
            <startTime>2021-07-12T09:13:57+0900</startTime>
            <endTime>2021-07-12T09:13:57+0900</endTime>
        </CloudMssqlBackupDetail>
        <CloudMssqlBackupDetail>
            <backupSetId>13</backupSetId>
            <databaseName>msdb</databaseName>
            <fileName>sample1.txt</fileName>
            <fullFileName>D:\\sample1.txt</fullFileName>
            <fullBackupSize>2590649</fullBackupSize>
            <logBackupCount>0</logBackupCount>
            <logBackupSize>0</logBackupSize>
            <startTime>2021-07-12T09:13:51+0900</startTime>
            <endTime>2021-07-12T09:13:51+0900</endTime>
        </CloudMssqlBackupDetail>
        <CloudMssqlBackupDetail>
            <backupSetId>14</backupSetId>
            <databaseName>master</databaseName>
            <fileName>sample2.txt</fileName>
            <fullFileName>D:\\sample2.txt</fullFileName>
            <fullBackupSize>780204</fullBackupSize>
            <logBackupCount>0</logBackupCount>
            <logBackupSize>0</logBackupSize>
            <startTime>2021-07-11T09:14:18+0900</startTime>
            <endTime>2021-07-11T09:14:18+0900</endTime>
        </CloudMssqlBackupDetail>
        <CloudMssqlBackupDetail>
            <backupSetId>15</backupSetId>
            <databaseName>msdb</databaseName>
            <fileName>sample3.txt</fileName>
            <fullFileName>D:\\sample3.txt</fullFileName>
            <fullBackupSize>2589526</fullBackupSize>
            <logBackupCount>0</logBackupCount>
            <logBackupSize>0</logBackupSize>
            <startTime>2021-07-11T09:14:12+0900</startTime>
            <endTime>2021-07-11T09:14:13+0900</endTime>
        </CloudMssqlBackupDetail>
    </cloudMssqlBackupDetailList>
</getCloudMssqlBackupDetailListResponse>