getCloudMongoDbBucketList

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 buckets available in Cloud DB for MongoDB.

Commands

The command syntax is as follows:

ncloud vmongodb getCloudMongoDbBucketList [regionCode] [cloudMongoDbInstanceNo] [output]

Parameter

Descriptions of parameters are as follows:

Parameter	Type	Required	Description	Restrictions
regionCode	String	N	Region code - regionCode can be obtained via the getRegionList action - default: selects the first region of the getRegionList search results	-
cloudMongoDbInstanceNo	String	Y	Cloud DB for MongoDB server instance number - cloudMongoDbInstanceNo can be obtained via the getCloudMongoDbInstanceList action -When entered, view Object Storage bucket lists accessible from the instance	-
output	String	N	Format type of the response - options: xml \| json - default: json	-

Responses

Response data type

CloudMongoDbBucketList type

CloudMongoDbBucketList extends CommonResponse	Description
private Integer totalRows;	Total number of items viewed
private List<CloudMongoDbBucket> cloudMongoDbBucketList = new ArrayList<>();	Cloud DB for MongoDb bucket list

CloudMongoDbBucket type

CloudMongoDbBucket	Description
private String bucketName;	Cloud DB for MongoDb bucket

Examples

Request examples

ncloud vMongoDb getCloudMongoDbBucketList --regionCode KR --cloudMongoDbInstanceNo ****891

Response examples

The following are examples of responses:

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

{
  "getCloudMongoDbBucketListResponse": {
    "requestId": "40cb968e-72ef-42d3-adc3-e392e8f7cc99",
    "returnCode": "0",
    "returnMessage": "success",
    "totalRows": 2,
    "cloudMongoDbBucketList": [
      {
        "bucketName": "bucket***"
      },
      {
        "bucketName": "bucket***"
      }
    ]
  }
}

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


<getCloudMongoDbBucketListResponse>
    <requestId>40cb968e-72ef-42d3-adc3-e392e8f7cc99</requestId>
    <returnCode>0</returnCode>
    <returnMessage>success</returnMessage>
    <totalRows>2</totalRows>
    <cloudMongoDbBucketList>
        <cloudMongoDbBucket>
            <bucketName>bucket***</bucketName>
        </cloudMongoDbBucket>
        <cloudMongoDbBucket>
            <bucketName>bucket***</bucketName>
        </cloudMongoDbBucket>
    </cloudMongoDbBucketList>
</getCloudMongoDbBucketListResponse>

Documentation Index