getCloudMongoDbBucketList

Prev Next

VPC環境で利用できます。

Cloud DB for MongoDbで使用できる Object Storageバケットリストを照会します。

コマンド

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

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

パラメータ

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

パラメータ タイプ 必須有無 説明 制限事項
regionCode String N リージョンコード
- regionCodeは、getRegionListアクションを通じて取得
- default: getRegionList照会結果の最初のリージョンを選択		 -
cloudMongoDbInstanceNo String Y Cloud DB for MongoDbのサーバインスタンス番号
- cloudMongoDbInstanceNoは、getCloudMongoDbInstanceListアクションを通じて取得
- 入力時にそのインスタンスからアクセスできる Object Storageバケットリストを照会		 -
output String N レスポンス結果のフォーマットタイプ
- options: xml | json
- default: json		 -

レスポンス

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

  • CloudMongoDbBucketListのタイプ
CloudMongoDbBucketList extends CommonResponse 説明
private Integer totalRows; 照会されたリストの総数
private List<CloudMongoDbBucket> cloudMongoDbBucketList = new ArrayList<>(); Cloud DB for MongoDbのバケットリスト
  • CloudMongoDbBucketのタイプ
CloudMongoDbBucket 説明
private String bucketName; Cloud DB for MongoDBのバケット

例

リクエスト例

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

レスポンス例

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

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

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

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