getCloudMssqlFolderList

Prev Next

Available in VPC

Get the list of Object Storage folders.

Request

The following describes the request format for the endpoint. The request format is as follows:

Method URI
GET, POST /getCloudMssqlFolderList

Request headers

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

Request parameter

The following describes the parameters.

Field Type Required Description
regionCode String Optional Region code of the Object Storage to view
  • Check through getRegionList
  • First Region of the getRegionList query result (default)
bucketName String Required Name of the bucket to view the folder list for
prefix String Optional Filter by prefix of the Object Storage folder
responseFormatType String Optional Format of the response result
  • xml (default) | json

Request example

The following is a sample request.

curl --location --request GET 'https://ncloud.apigw.ntruss.com/vmssql/v2/getCloudMssqlFolderList
?regionCode=KR
&bucketName=bucket
&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

The following describes the response format.

Response body

See CloudMssqlFolderList 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 following is a sample response.

  • If responseFormetType=json

    {
    "getCloudMssqlFolderListResponse": {
        "totalRows": 1,
        "cloudMssqlFolderList": [
            {
                "folderName": "CLA-20240621******/"
            }
        ],
        "requestId": "da263328-****-****-****-0c76c93ab811",
        "returnCode": "0",
        "returnMessage": "success"
    }
}

  • If responseFormetType=xml (default)

    <?xml version="1.0" encoding="UTF-8"?>
<getCloudMssqlFolderListResponse>
    <requestId>da263328-****-****-****-0c76c93ab811</requestId>
    <returnCode>0</returnCode>
    <returnMessage>success</returnMessage>
    <totalRows>1</totalRows>
    <cloudMssqlFolderList>
        <cloudMssqlFolder>
            <folderName>CLA-20240621******/</folderName>
        </cloudMssqlFolder>
    </cloudMssqlFolderList>
</getCloudMssqlFolderListResponse>