列举资源_API_Object Storage-文档中心

此接口用于批量列举对象存储平台中指定空间内的资源。

请求描述

请求格式

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

Header 描述

参数	是否必需	描述
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	否	上一次枚举返回的位置标记，作为本次继续枚举的起点信息，默认为空。

注意：

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	是	如果有剩余条目，返回非空字符串，作为下次列举时的参数传入。如果没有剩余条目，返回空字符串。
commonPrefixes	是	所有目录名称的数组。不指定 mode 参数时，该字段值为空。
items	是	所有返回条目的数组，没有剩余条目时为空数组。
key	是	资源名称。
putTime	是	上传时间，Unix格式，单位为毫秒。
fsize	是	资源内容的大小，单位为字节。
hash	是	资源内容的ETag值。
mimeType	是	资源内容的MIME类型。
expirationDate	是	文件过期时间，格式为YYYYMMDDhhmmss。注意：文件过期后实际清理的具体时间以服务器端任务执行为准，时间差异在一天内属正常。
storageClass	是	文件存储类型，如标准存储 - Standard，低频存储 - IA，归档存储 - Archive。

如果请求失败，将返回包含以下内容的 Json 字符串。

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

字段名称	是否必需	描述
code	是	HTTP请求响应代码，请参见 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

列举资源

请求描述

响应描述

示例

目录