getCloudHadoopBucketList

Prev Next

Classic環境で利用できます。

Cloud Hadoopで使用可能な Object Storageバケットリストを照会します。

リクエスト

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

メソッド URI
GET | POST /hadoop/v2/getCloudHadoopBucketList
参考

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

リクエストヘッダ

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

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

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

フィールド タイプ 必須の有無 説明
regionNo String Optional リージョン番号
responseFormatType String Optional レスポンスデータの形式
  • xml(デフォルト) | json

リクエスト例

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

curl --location --request GET 'https://ncloud.apigw.ntruss.com/hadoop/v2/getCloudHadoopBucketList?regionNo=1&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}' \
--header 'x-ncp-apigw-api-key: {API Key}'

レスポンス

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

レスポンスボディ

レスポンスボディの説明は次の通りです。

フィールド タイプ 必須の有無 説明
getCloudHadoopBucketListResponse Object - レスポンス結果
getCloudHadoopBucketListResponse.totalRows Integer - レスポンス結果数
getCloudHadoopBucketListResponse.bucketList Array - Object Storageバケットリスト
getCloudHadoopBucketListResponse.requestId String - リクエスト ID
  • UUID形式
getCloudHadoopBucketListResponse.returnCode String - レスポンスコード
getCloudHadoopBucketListResponse.returnMessage String - レスポンスメッセージ

getCloudHadoopBucketListResponse.bucketList

getCloudHadoopBucketListResponse.bucketListの説明は次の通りです。

フィールド タイプ 必須の有無 説明
bucketName String - Object Storageバケット名

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

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

レスポンス例

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

{
    "getCloudHadoopBucketListResponse": {
        "totalRows": 2,
        "bucketList": [
            {
                "bucketName": "nb001"
            },
            {
                "bucketName": "nb002"
            }
        ],
        "requestId": "21b00176-****-****-****-29c1ad84f1d2",
        "returnCode": "0",
        "returnMessage": "success"
    }
}