getCloudMssqlFolderList

VPC環境で利用できます。

Object Storageフォルダリストを照会します。

リクエスト

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

メソッド	URI
GET \| POST	/vmssql/v2/getCloudMssqlFolderList

参考

ガイドは GETメソッドを基準に説明します。POSTメソッドの呼び出しテストは、NAVERクラウドプラットフォームコンソールの API Gatewayサービスの Swaggerで行えます。

リクエストヘッダ

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

リクエストクエリパラメータ

リクエストクエリパラメータの説明は次の通りです。

フィールド	タイプ	必須の有無	説明
`regionCode`	String	Optional	照会対象の Object Storageのリージョンコード getRegionListを参照 `getRegionList`照会結果の最初のリージョン(デフォルト)
`bucketName`	String	Required	フォルダリスト照会対象のバケット名 getCloudMssqlBucketListを参照
`prefix`	String	Optional	Object Storageフォルダの Prefixでフィルタリング
`responseFormatType`	String	Optional	レスポンス結果の形式 `xml`(デフォルト) \| `json`

リクエスト例

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

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}'

レスポンス

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

レスポンスボディ

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

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

Cloud DB for MSSQL (VPC) APIで共通して使用されるレスポンスステータスコードの詳細は、Cloud DB for MSSQL (VPC)のレスポンスステータスコードをご参照ください。

レスポンス例

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

responseFormatType=jsonの場合

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

responseFormatType=xml(デフォルト)の場合

<?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>