List Resources_API_Object Storage-CDNetworks ドキュメント

このインターフェースは、オブジェクトストレージプラットフォーム上で指定したスペース内のリソースをバッチで列挙取得（リスト化）する機能を提供します。

リクエスト説明

リクエスト形式

GET /list?bucket=<bucket>&limit=<limit>&prefix=<Urlsafe_Base64_Encoded_Prefix>&mode=<mode>&marker=<marker>
Host:<MgrDomain>
Authorization:<AccessToken>

ヘッダー項目説明

パラメータ	必須	説明
Host	はい	管理ドメイン名。コンソールのバケット概要画面で確認可能。
Authorization	はい	管理認証情報。

パラメータ説明

パラメータ	必須	説明
bucket	はい	対象スペース名（バケット名）
limit	いいえ	列挙（リスト化）する件数。1〜1000の範囲。デフォルトは1000。
prefix	いいえ	プレフィックス（先頭一致）。指定時、ファイル名がこれに一致するリソースのみ列挙。空欄時は全て。値はURLセーフBase64エンコードが必要。
startTime	いいえ	ファイルアップロードの開始時刻（ミリ秒単位のタイムスタンプ。例：1526745600000＝2015/5/20 00:00:00）
endTime	いいえ	ファイルアップロードの終了時刻（ミリ秒単位のタイムスタンプ。例：1527609600000＝2015/5/30 00:00:00）
mode	いいえ	リストの並び替え方法指定。0：ディレクトリ内ファイル優先、1：ディレクトリ内フォルダ優先。指定なしの場合はサブディレクトリ内も含めkey順で全ファイル列挙。
marker	いいえ	前回列挙時の続きを示すマーカー。ページングのために利用。空欄時は1ページ目から。

注意：

modeパラメータはファイルシステムを擬似的に再現するためのものです。

mode指定時は、prefixで検索ディレクトリを指定します（この場合prefixのあいまい検索不可）。

mode未指定時は、prefixのあいまい検索が可能です。

レスポンス説明

リクエスト成功時、下記形式のJSON文字列が返却されます。

{
    "marker": "<marker string>",
    "commonPrefixes": [
        "xxx",
        "yyy"
    ],
    "items": [
        {
            "key":     "<key string>",
            "putTime":   <filePutTime long>,
            "hash":     "<fileETag string>",
            "fsize":     <fileSize string>,
            "mimeType": "<mimeType string>",
            "expirationDate":   "<expirationDate string>",
            "storageClass": "<storageClass>"
        },
        ...
    ]
}

フィールド名	必須	説明
marker	はい	さらに取得できるエントリがある場合、非空のストリングとして返却。次回列挙時のmarkerパラメータとして利用。以降がない場合は空文字。
commonPrefixes	はい	ディレクトリ名配列。mode未指定時は空配列。
items	はい	取得された全リソースの配列。残りがなければ空配列。
key	はい	リソース名（ファイル名）。
putTime	はい	アップロード日時（ミリ秒のUnixタイムスタンプ）。
fsize	はい	リソースサイズ（バイト単位）。
hash	はい	リソース内容のETag値。
mimeType	はい	リソース内容のMIMEタイプ。
expirationDate	はい	ファイルの有効期限（書式: YYYYMMDDhhmmss）。注: 実際の削除タイミングはサーバの実行状況次第で、1日以内のズレが発生する場合があります。
storageClass	はい	ファイルのストレージ種別（Standard:通常, IA:低頻度, Archive:アーカイブなど）。

リクエスト失敗時、下記のJSON文字列が返却されます。

{
    "code":     "<code string>",
    "message":  "<message string>"
}

フィールド名	必須	説明
code	はい	HTTPリクエストステータスコード。詳細はこちら。
message	はい	リソース列挙失敗時のメッセージ。

実行例

curl -v -o filelist.json -H "Authorization:86622e227a50d49d858c2494a935bc2e4ac543a7:NTVjZWZmOThhYjUzMjhkMWQ3YzE3OGM0NTRhYzFmODc5MDQ0MWExNQ==" --url "http://mgrDomain/list?bucket=images&limit=10"

Media Delivery

Cloud Security

Web Performance

Enterprise Application

Storage

Edge Computing

Console Guide

API Docs

List Resources

リクエスト説明

レスポンス説明

実行例

目次