getCloudHadoopObjectList

Prev Next

VPC環境で利用できます。

Cloud Hadoopクラスタと連携されている Object Storageバケットのオブジェクトリストを照会します。

リクエスト

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

メソッド URI
GET | POST /vhadoop/v2/getCloudHadoopObjectList
参考

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

リクエストヘッダ

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

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

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

フィールド タイプ 必須の有無 説明
regionCode String Optional リージョンコード
  • getRegionListを参照
    • 照会結果の最初のリージョン(デフォルト)
bucketName String Required バケット名
prefix String Optional オブジェクト名の接頭辞
  • 接頭辞で始まるオブジェクトのみ絞り込み
delimiter String Optional 区切り文字
  • 区切り文字を含むオブジェクトは、レスポンスのcommonPrefixListに接頭辞のみ表示され、個々のオブジェクトリストから除外
maxKeys String Optional レスポンスに表示するファイルの最大数
marker String Optional レスポンスの開始点
  • 開始点以降のオブジェクトを UTF-8バイナリ順に表示
responseFormatType String Optional レスポンスデータの形式
  • xml(デフォルト) | json

リクエスト例

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

curl --location --request GET 'https://ncloud.apigw.ntruss.com/vhadoop/v2/getCloudHadoopObjectList?regionCode=KR&bucketName=bk4hadoop&prefix=CONFIG&delimiter=%2FV2&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}'

レスポンス

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

レスポンスボディ

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

フィールド タイプ 必須の有無 説明
getCloudHadoopObjectListResponse Object - レスポンスの結果
getCloudHadoopObjectListResponse.commonPrefixList Array - 共通の接頭辞を持つオブジェクトリスト
getCloudHadoopObjectListResponse.requestId String - リクエスト ID
  • UUID形式
getCloudHadoopObjectListResponse.returnCode String - レスポンスコード
getCloudHadoopObjectListResponse.returnMessage String - レスポンスメッセージ

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

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

レスポンス例

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

{
    "getCloudHadoopObjectListResponse": {
        "commonPrefixList": [
            "CONFIG-BACKUP/V2"
        ],
        "cloudHadoopObjectList": [
            {
                "key": "CONFIG-BACKUP/",
                "lastModified": "2025-02-25T10:03:37+0900",
                "size": 0
            },
            {
                "key": "CONFIG-BACKUP/V1/",
                "lastModified": "2025-02-28T09:26:39+0900",
                "size": 0
            },
            {
                "key": "CONFIG-BACKUP/V1/cluster01_2025-02-20-16-40-52_config.tar",
                "lastModified": "2025-02-28T09:26:52+0900",
                "size": 33660
            },
            {
                "key": "CONFIG-BACKUP/cluster01_2025-02-20-16-40-52_config.tar",
                "lastModified": "2025-02-20T16:41:00+0900",
                "size": 33660
            },
            {
                "key": "CONFIG-BACKUP/cluster01_2025-02-21-14-16-09_config.tar",
                "lastModified": "2025-02-21T14:16:14+0900",
                "size": 33652
            },
            {
                "key": "CONFIG-BACKUP/cluster01_2025-02-21-14-17-01_config.tar",
                "lastModified": "2025-02-21T14:17:07+0900",
                "size": 33662
            },
            {
                "key": "CONFIG-BACKUP/cluster01_2025-02-25-10-03-31_config.tar",
                "lastModified": "2025-02-25T10:03:37+0900",
                "size": 33653
            }
        ],
        "requestId": "e08df7b1-****-****-****-1f3cc3516a4a",
        "returnCode": "0",
        "returnMessage": "success"
    }
}