OkayAPI Docs


API Path: /api/App/OSS_Aliyun/ListObjects

API Description: 阿里云OSS对象存储,列举指定存储空间(Bucket)下的所有文件或者符合条件的文件(Object)。

1
API Traffic
HTTP/HTTPS
Protocol
GET/POST
Method
UTF-8
Charset
JSON
Response

API Debug   


API Params

ParameterTypeRequiredDefaultNoteDescription
HTTP_APPKEYStringRequiredMIN: 32Common Put Your APPKEY
delimiterStringOptaion对文件名称进行分组的一个字符。CommonPrefixes是以delimiter结尾,并有共同前缀的文件集合。
prefixStringOptaion本次查询结果的前缀。需要匹配的文件名前缀
numStringOptaion100MIN: 1;MAX: 1000分页数量,列举文件的最大个数。默认为100,最大值为1000。
markerStringOptaion标明本次列举文件的起点。可用于分页取下一页。

API Debug

KEYREQUIREDVALUE
app_key *Required
delimiter Option
prefix Option
num Option
marker Option

API Response

KEYTypeDescription
objectsArray列举的文件
next_markerString用于获取下一页
prefixString前缀

HTTP Response Code

HTTP Status CodeDescription
Http Status = 200Success
Http Status = 400表示客户端参数错误
Http Status = 404表示接口服务不存在
Http Status = 500表示服务端内部错误