getCloudMssqlBackupDetailList
    • PDF

    getCloudMssqlBackupDetailList

    • PDF

    Article summary

    Available in VPC

    Get Cloud DB for MSSQL instance backup details in a list.

    Request

    This section describes the request format. The method and URI are as follows:

    MethodURI
    GET, POST/getCloudMssqlBackupDetailList

    Request headers

    For information about the headers common to all Cloud DB for MSSQL (VPC) APIs, see Cloud DB for MSSQL (VPC) request headers.

    Request parameters

    The following describes the parameters.

    FieldTypeRequiredDescription
    regionCodeStringOptionalRegion code of the Cloud DB for MSSQL instance to view
    • Check through getRegionList
    • First Region of the getRegionList query result (default)
    cloudMssqlInstanceNoStringRequiredCloud DB for MSSQL instance number
    pageNoIntegerOptionalPage numbers in paged results
    • Page the result values using pageNo and pageSize
    • 0 (minimum)
    pageSizeIntegerConditionalNumber of results to display on a page
    • Page the result values using pageNo and pageSize
    • Required when entering pageNo
    • 1 - 1000
    responseFormatTypeStringOptionalFormat of the response result
    • xml (default) | json

    Request example

    The request example is as follows:

    curl --location --request GET 'https://ncloud.apigw.ntruss.com/vmssql/v2/getCloudMssqlBackupDetailList
    ?regionCode=KR
    &cloudMssqlInstanceNo=2517****
    &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}'
    

    Response

    This section describes the response format.

    Response body

    See CloudMssqlBackupDetailList for the response body.

    Response status codes

    For response status codes common to NAVER Cloud Platform, see Ncloud API response status codes.

    Response example

    The response example is as follows:

    • If responseFormetType=json

      {
          "getCloudMssqlBackupDetailListResponse": {
              "totalRows":1,
              "cloudMssqlBackupDetailList": [
                  {
                      "backupSetId": 52,
                      "databaseName": "msdb",
                      "fileName": "msdb_20240701_02****.full",
                      "fullFileName": "Z:\\cmssql_backup\\user_idx_276****\\cmssql_10-0-252-15_m-2517****-001\\msdb_20240701_02****.full",
                      "fullBackupSize": 3249515,
                      "logBackupCount": 0,
                      "logBackupSize": 0,
                      "startTime": "2024-07-01T02:00:02+0900",
                      "endTime": "2024-07-01T02:00:02+0900"
                  }
              ],
              "requestId": "93697d3d-****-****-****-953e20c67075",
              "returnCode": "0",
              "returnMessage": "success"
          }
      }
      
    • If responseFormetType=xml (default)

      <?xml version="1.0" encoding="UTF-8"?>
      <getCloudMssqlBackupDetailListResponse>
          <requestId>93697d3d-****-****-****-953e20c67075</requestId>
          <returnCode>0</returnCode>
          <returnMessage>success</returnMessage>
          <totalRows>1</totalRows>
          <cloudMssqlBackupDetailList>
              <cloudMssqlBackupDetail>
                  <backupSetId>52</backupSetId>
                  <databaseName>msdb</databaseName>
                  <fileName>msdb_20240701_02****.full</fileName>
                  <fullFileName>Z:\cmssql_backup\user_idx_276****\cmssql_10-0-252-15_m-2517****-001\msdb_20240701_02****.full</fullFileName>
                  <fullBackupSize>3249515</fullBackupSize>
                  <logBackupCount>0</logBackupCount>
                  <logBackupSize>0</logBackupSize>
                  <startTime>2024-07-01T02:00:02+0900</startTime>
                  <endTime>2024-07-01T02:00:02+0900</endTime>
              </cloudMssqlBackupDetail>
          </cloudMssqlBackupDetailList>
      </getCloudMssqlBackupDetailListResponse>
      

    Was this article helpful?

    Changing your password will log you out immediately. Use the new password to log back in.
    First name must have atleast 2 characters. Numbers and special characters are not allowed.
    Last name must have atleast 1 characters. Numbers and special characters are not allowed.
    Enter a valid email
    Enter a valid password
    Your profile has been successfully updated.