getCloudMssqlBackupList

Prev Next

VPC環境で利用できます。

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

リクエスト

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

メソッド URI
GET, POST /getCloudMssqlBackupList

リクエストヘッダ

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

リクエストパラメータ

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

フィールド タイプ 必須の有無 説明
regionCode String Optional 照会対象の Cloud DB for MSSQLインスタンスのリージョンコード
  • getRegionListを通じて確認
  • getRegionList照会結果の最初のリージョン(デフォルト)
pageNo Integer Optional ページングされた結果のページ番号
  • pageNopageSizeを利用してページング処理
  • 0 (最小)
pageSize Integer Conditional ページごとに表示する結果数
  • pageNopageSizeを利用してページング処理
  • pageNo入力時、必須
  • 1~1000
responseFormatType String Optional レスポンス結果の形式
  • xml(デフォルト) | json

リクエスト例

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

curl --location --request GET 'https://ncloud.apigw.ntruss.com/vmssql/v2/getCloudMssqlBackupList
?regionCode=KR
&pageNo=1
&pageSize=1
&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}'

レスポンス

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

レスポンスボディ

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

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

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

レスポンス例

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

  • responseFormetType=jsonの場合

    {
        "getCloudMssqlBackupListResponse": {
            "totalRows": 1,
            "cloudMssqlBackupList": [
                {
                    "cloudMssqlInstanceNo": 2517****,
                    "cloudMssqlServiceName": "mssql002",
                    "backupFileRetentionPeriod": 2,
                    "backupTime": "02:00",
                    "totalBackupDataSize": 8288626,
                    "fullBackupDataSize": 8288626,
                    "logBackupDataSize": 0,
                    "logBackupCount": 0
                }
            ],
            "requestId": "abb9ca6f-****-****-****-e37d8878085b",
            "returnCode": "0",
            "returnMessage": "success"
        }
    }
    
  • responseFormetType=xml(デフォルト)の場合

    <?xml version="1.0" encoding="UTF-8"?>
    <getCloudMssqlBackupListResponse>
        <requestId>abb9ca6f-****-****-****-e37d8878085b</requestId>
        <returnCode>0</returnCode>
        <returnMessage>success</returnMessage>
        <totalRows>1</totalRows>
        <cloudMssqlBackupList>
            <cloudMssqlBackup>
                <cloudMssqlInstanceNo>2517****</cloudMssqlInstanceNo>
                <cloudMssqlServiceName>mssql002</cloudMssqlServiceName>
                <backupFileRetentionPeriod>2</backupFileRetentionPeriod>
                <backupTime>02:00</backupTime>
                <totalBackupDataSize>8288626</totalBackupDataSize>
                <fullBackupDataSize>8288626</fullBackupDataSize>
                <logBackupDataSize>0</logBackupDataSize>
                <logBackupCount>0</logBackupCount>
            </cloudMssqlBackup>
        </cloudMssqlBackupList>
    </getCloudMssqlBackupListResponse>