getCloudMssqlBackupDetailList

Article Summary

Share feedback

Thanks for sharing your feedback!

Available in VPC

Querying a list of available Cloud DB for MSSQL backup details.

Requests

Request Parameters

Parameter	Type	Requirement Status	Description	Restrictions
regionCode	String	N	Region code - regionCode can be obtained via the getRegionList action - default: Selects the first region of the getRegionList query results	-
cloudMssqlInstanceNo	String	Y	Cloud DB for MSSQL instance number of which backup details are to be viewed - cloudMssqlInstanceNo can be obtained via the getCloudMssqlInstanceList action	-
pageNo	Integer	N	Page number of paged results - The results can be paged using pageNo and pageSize	- Min: 0
pageSize	Integer	N	Size of each page to be shown during paging - The results can be paged using pageNo and pageSize - Must be entered when entering pageNo	- Min: 1
responseFormatType	String	N	Format type of the response result - options: xml \| json - default: xml	-

Responses

Response bodies

For response bodies, refer to CloudMssqlBackupDetailList.

Examples

Request Examples

The following is an example of a request body.

GET {API_URL}/getCloudMssqlBackupDetailList
?cloudMssqlInstanceNo=***890
&regionCode=KR

Response examples

The following are examples of responses.

If the response shows that format type (responseFormatType) is json

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

If the response shows that format type (responseFormatType) is xml

<getCloudMssqlBackupDetailListResponse>
    <requestId>f3bda8a3-978a-42d3-b52f-123b096e0f45</requestId>
    <returnCode>0</returnCode>
    <returnMessage>success</returnMessage>
    <totalRows>4</totalRows>
    <cloudMssqlBackupDetailList>
        <CloudMssqlBackupDetail>
            <databaseName>master</databaseName>
            <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>
            <databaseName>msdb</databaseName>
            <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>
            <databaseName>master</databaseName>
            <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>
            <databaseName>msdb</databaseName>
            <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>

Was this article helpful?

What's Next

getCloudMssqlBackupList

Table of contents

Requests
Responses
Examples