getCloudMssqlLogBackupFileList

Prev Next

VPC環境で利用できます。

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

リクエスト

リクエスト形式を説明します。リクエスト形式は次の通りです。

メソッド URI
GET, POST /getCloudMssqlLogBackupFileList

リクエストヘッダ

Cloud DB for MSSQL (VPC) APIで共通して使用されるヘッダの詳細は、Cloud DB for MSSQL (VPC)のリクエストヘッダをご参照ください。

リクエストパラメータ

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

フィールド タイプ 必須の有無 説明
regionCode String Optional 照会対象の Cloud DB for MSSQLインスタンスのリージョンコード
  • getRegionListを通じて確認
  • getRegionList照会結果の最初のリージョン(デフォルト)
cloudMssqlInstanceNo String Required Cloud DB for MSSQLインスタンス番号
databaseName String Required DB名
backupSetId String Required バックアップ ID
responseFormatType String Optional レスポンス結果の形式
  • xml(デフォルト) | json

リクエスト例

リクエストのサンプルコードは次の通りです。

curl --location --request GET 'https://ncloud.apigw.ntruss.com/vmssql/v2/getCloudMssqlLogBackupFileList
?regionCode=KR
&cloudMssqlInstanceNo=2517****
&databaseName=msdb
&backupSetId=12
&responseFormatType=json'
--header 'x-ncp-apigw-timestamp: {Timestamp}'
--header 'x-ncp-iam-access-key: {Access Key}'
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}'

レスポンス

レスポンス形式を説明します。

レスポンスボディ

レスポンスボディの詳細は、CloudMssqlLogBackupFileListをご参照ください。

レスポンスステータスコード

NAVERクラウドプラットフォームで共通して使用されるレスポンスステータスコードの詳細は、Ncloud APIのレスポンスステータスコードをご参照ください。

レスポンス例

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

  • responseFormetType=jsonの場合

    {
        "getCloudMssqlLogBackupFileListResponse": {
            "totalRows":1,
            "cloudMssqlBackupDetailList": [
                {
                    "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"
        }
    }
    
  • responseFormetType=xml(デフォルト)の場合

    <?xml version="1.0" encoding="UTF-8"?>
    <getCloudMssqlLogBackupFileListResponse>
        <requestId>93697d3d-****-****-****-953e20c67075</requestId>
        <returnCode>0</returnCode>
        <returnMessage>success</returnMessage>
        <totalRows>1</totalRows>
        <cloudMssqlLogBackupFileList>
            <CloudMssqlLogBackupFile>
                <databaseName>msdb</databaseName>
                <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>