ListObjects

Prev Next

Classic/VPC環境で利用できます。

Ncloud Storageバケットに保存されているオブジェクトリストを照会します。

参考

最新バージョンのListObjectsV2 APIの使用をお勧めします。

リクエスト

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

メソッド URI
GET -

リクエストヘッダ

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

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

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

フィールド タイプ 必須の有無 説明
marker String Optional 照会開始の基準
  • 以前のレスポンス結果のNextMarkerまたは任意の文字列を入力
max-keys String Optional ページごとの項目数
  • 1~1,000
prefix String Optional オブジェクト名の接頭辞

リクエスト例

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

GET /?marker=object.csv&max-keys=1 HTTP/1.1
Host: bucket.kr.ncloudstorage.com

レスポンス

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

レスポンスヘッダ

Ncloud Storage APIで共通して使用されるヘッダの詳細は、Ncloud Storageのレスポンスヘッダをご参照ください。

レスポンスボディ

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

フィールド タイプ 必須の有無 説明
ListBucketResult Object - オブジェクトリスト照会の結果
ListBucketResult.Name String - バケット名
ListBucketResult.Prefix String - オブジェクト名の接頭辞
  • prefixを入力した場合、入力値を表示
ListBucketResult.Marker String - 照会開始の基準
ListBucketResult.NextMarker String - 次の照会基準
  • IsTruncatedがtrueの場合、次のリクエストのmarkerにこの値を入力
ListBucketResult.MaxKeys Integer - ページごとの項目数
ListBucketResult.IsTruncated Boolean - 以降のページは存在するかどうか
  • true | false
    • true: 存在する
    • false: 存在しない
ListBucketResult.Contents Array - オブジェクトリスト

Contents

Contentsの説明は次の通りです。

フィールド タイプ 必須の有無 説明
Key String - オブジェクト名
LastModified String - 最終更新日時
  • ISO 8601形式
ETag String - オブジェクトの固有 ID(Entity Tag)
Size Integer - オブジェクトのサイズ(Byte)
StorageClass String - ストレージクラス
  • STANDARD | DEEP_ARCHIVE
    • STANDARD: Standard Class
    • DEEP_ARCHIVE: Archive Class

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

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

レスポンス例

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

HTTP/1.1 200 OK

<?xml version="1.0" encoding="UTF-8"?>
<ListBucketResult>
    <Name>bucket000</Name>
    <Prefix></Prefix>
    <Marker>object000.csv</Marker>
    <NextMarker>object001.csv</NextMarker>
    <MaxKeys>1</MaxKeys>
    <IsTruncated>true</IsTruncated>
    <Contents>
        <Key>object001.csv</Key>
        <LastModified>2025-04-23T01:55:37Z</LastModified>
        <ETag>&#34;2ecf9f32d97***********39aed87829&#34;</ETag>
        <Size>464</Size>
        <StorageClass>STANDARD</StorageClass>
    </Contents>
</ListBucketResult>