getCloudMssqlLogBackupFileList

Prev Next

VPC環境で利用できます。

Cloud DB for MSSQLインスタンスのログバックアップファイルリストを照会します。

コマンド

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

ncloud vmssql getCloudMssqlLogBackupFileList [regionCode] [cloudMssqlInstanceNo] [databaseName] [backupSetId] [output]

パラメータ

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

パラメータ タイプ 必須の有無 説明 制限事項
regionCode String N リージョンコード
  • regionCodeはgetRegionListアクションを通じて取得
  • デフォルト: getRegionList照会結果の最初のリージョンを選択
 -
cloudMssqlInstanceNo String Y バックアップの詳細情報を照会する Cloud DB for MSSQLインスタンス番号 -
databaseName String Y DB名 -
backupSetId String Y バックアップ ID -
output String N レスポンス結果の形式タイプ
  • オプション: xml | json
  • デフォルト: json
 -

レスポンス

レスポンスデータタイプ

  • CloudMssqlLogBackupFileListタイプ

    CloudMssqlLogBackupFileList extends CommonResponse 説明
    private Integer totalRows; 照会されたリストの総数
    private List<cloudMssqlLogBackupFile> CloudMssqlLogBackupFileList = new ArrayList<>(); Cloud DB for MSSQLログのバックアップファイルリスト

  • cloudMssqlLogBackupFileタイプ

    cloudMssqlLogBackupFile 説明
    private String fileName; ファイル名
    private String fullFileName; fullファイル名
    private Date startTime; 開始日時
    private Date endTime; 終了日時
    private Long fileSize; ファイルサイズ

例

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

呼び出し例

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

ncloud vmssql getCloudMssqlLogBackupFileList --regionCode KR --cloudMssqlInstanceNo ***890 --databaseName msdb --backupSetId 12

レスポンス例

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

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

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

{
    "getCloudMssqlLogBackupFileListResponse": {
        "totalRows":1,
        "cloudMssqlLogBackupFileList": [
            {
                "fileName": "msdb_20240807_02****.full",
                "fullFileName": "Z:\\cmssql_backup\\user_idx_276****\\cmssql_10-0-2520_m-3***-001\\msdb_20240807_172525.log",
                "startTime": "2024-08-07T17:25:25+0900",
                "endTime": "2024-08-07T17:25:25+0900",
                "fileSize": 620280
            }
        ],
        "requestId": "93697d3d-****-****-****-953e20c67075",
        "returnCode": "0",
        "returnMessage": "success"
    }
}

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

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

<?xml version="1.0" encoding="UTF-8"?>
<getCloudMssqlLogBackupFileListResponse>
    <requestId>93697d3d-****-****-****-953e20c67075</requestId>
    <returnCode>0</returnCode>
    <returnMessage>success</returnMessage>
    <totalRows>1</totalRows>
    <cloudMssqlLogBackupFileList>
        <CloudMssqlLogBackupFile>
            <fileName>msdb_20240701_02****.full</fileName>
            <fullFileName>Z:\cmssql_backup\user_idx_276****\cmssql_10-0-2520_m-3***-001\msdb_20240807_172525.log</fullFileName>
            <startTime>2024-08-07T17:25:25+0900</startTime>
            <endTime>2024-08-07T17:25:25+0900</endTime>
            <fileSize>620280</fileSize>
        </CloudMssqlLogBackupFile>
    </cloudMssqlLogBackupFileList>
</getCloudMssqlLogBackupFileListResponse>