getCloudMssqlFolderList

Prev Next

VPC環境で利用できます。

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

コマンド

コマンド構文は、次の通りです。

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

パラメータ

パラメータについての説明は、次の通りです。

パラメータ タイプ 必須有無 説明 制限事項
regionCode String N リージョンコード
- regionCodeは、getRegionListアクションを通じて取得
- default: getRegionList照会結果の最初のリージョンを選択
-
bucketName String Y バケット名
- Object Storageにデータを保存するためのスペースを意味
- bucketNameは、getCloudMssqlBucketListアクションを通じて取得可能
-
prefix String N Object Storageフォルダの prefix -
output String N レスポンス結果のフォーマットタイプ
- options: xml | json
- default: json
-

レスポンス

レスポンスデータのタイプ

  • CloudMssqlFolderListのタイプ
CloudMssqlFolderList extends CommonResponse 説明
private Integer totalRows; 照会されたリストの総数
private List<CloudMssqlFolder> cloudMssqlFolderList = new ArrayList<>(); Object Storageフォルダリスト
  • CloudMssqlFolderタイプ
CloudMssqlFolder 説明
private String folderName; フォルダ名

呼び出しとレスポンス例を説明します。

呼び出し例

呼び出し例は、次の通りです。

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

レスポンス例

レスポンス例は、次の通りです。

レスポンス結果フォーマットタイプ(output)が jsonの場合

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

レスポンス結果のフォーマットタイプ(responseFormatType)が 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>