getCloudMssqlFolderList

The latest service changes have not yet been reflected in this content. We will update the content as soon as possible. Please refer to the Korean version for information on the latest updates.

Available in VPC

View a list of object storage folders.

Commands

The text of the command is as follows:

ncloud vmssql getCloudMssqlFolderList [regionCode] [prefix] [output]

Parameter

The following is a description on parameters.

Parameter	Type	Required	Description	Restrictions
regionCode	String	N	- regionCode can be obtained via the getRegionList action - default: Selects the first region of the getRegionList query results	-
bucketName	String	Y	BucketName - The space within object storage for data storage - BucketName can be obtained via the getCloudMssqlBucketList action	-
prefix	String	N	Prefix of the object storage folder	-
output	String	N	Format type of the response - options: xml \| json - default: json	-

Responses

Response data type

CloudMssqlBucketList type

CloudMssqlFolderList extends CommonResponse	Description
private Integer totalRows;	Total number of items viewed
private List<CloudMssqlFolder> cloudMssqlFolderList = new ArrayList<>();	Object storage folder list

CloudMssqlFolder type

CloudMssqlFolder	Description
private String folderName;	Folder name

Examples

Describes examples of recalls and responses.

Recall examples

The following are examples of recalls.

ncloud vmssql getCloudMssqlFolderList --regionCode KR --bucketName *****

Response examples

The following are examples of responses.

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

{
  "getCloudMssqlFolderListResponse": {
    "requestId": "d5e980a0-15b5-4c77-8b12-a70b8673142c",
    "returnCode": 0,
    "returnMessage": "success",
    "totalRows": 1,
    "cloudMssqlFolderList": [
      {
        "folderName": "*****"
      }
    ]
  }
}

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

<getCloudMssqlFolderListResponse>
    <requestId>d5e980a0-15b5-4c77-8b12-a70b8673142c</requestId>
    <returnCode>0</returnCode>
    <returnMessage>success</returnMessage>
    <totalRows>1</totalRows>
    <cloudMssqlFolderList>
        <cloudMssqlFolder>
            <folderName>*****</folderName>
        </cloudMssqlFolder>
    </cloudMssqlFolderList>
</getCloudMssqlFolderListResponse>

Documentation Index