小白接口

1507 阿里云OSS 列举文件 App.OSS_Aliyun.ListObjects

接口地址:http://open.phalapi.net/?s=App.OSS_Aliyun.ListObjects

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

接口标签:免费(每月最高10万次)付费(包月/按量/私服)验签

请求协议
HTTP/HTTPS
请求方式
GET/POST(推荐POST)
编码格式
UTF-8
返回格式
JSON

在线测试    添加收藏    直接访问接口    我要调整此接口


接口参数 若无特殊说明,接口参数同时支持GET和POST传递;推荐:查询/删除用GET,创建/更新用POST。

参数名字参数类型是否必须默认值备注参数说明
app_key字符串必须最小:32公共参数 开发者应用的app_key,查看我的app_key,如果还没有,可免费注册开通。
sign字符串可选公共参数 动态签名,签名生成算法请见:如何生成签名,或直接使用封装好的SDK开发包
如果不需要签名,可进入小白开放平台接口签名设置关闭或开启签名。通过在线测试工具可进行签名的对比和调试。 企业版支持专属签名算法定制。
uuid字符串可选最大:32公共参数 UUID,当前登录的应用会员ID,即全局唯一用户ID,查看我的应用会员。传递此参数后,可以在开放平台查看每日活跃会员统计图表。
token字符串可选最小:64;最大:64公共参数 当前登录会员的会话凭证,可通过会员登录接口获得。
return_data字符串可选0公共参数 数据返回结构,其中:
  • return_data=0,返回完整的接口结果,示例:{"ret":200,"data":{"err_code":0,"err_msg":"","title":"Hi YesApi,欢迎使用小白开放接口!"},"msg":"V3.1.0 YesApi App.Hello.World"}
  • return_data=1,返回简洁的接口结果,只返回data字段,结构简化一级,更扁平,示例:{"err_code":0,"err_msg":"V3.1.0 YesApi App.Hello.World","title":"Hi YesApi,欢迎使用小白开放接口!"}
delimiter字符串可选对文件名称进行分组的一个字符。CommonPrefixes是以delimiter结尾,并有共同前缀的文件集合。
prefix字符串可选本次查询结果的前缀。需要匹配的文件名前缀
num字符串可选100最小:1;最大:1000分页数量,列举文件的最大个数。默认为100,最大值为1000。
marker字符串可选标明本次列举文件的起点。可用于分页取下一页。

在线测试

参数是否必填
s 必须
uuid 可选
token 可选
return_data 可选
delimiter 可选
prefix 可选
num 可选
marker 可选

客户端请求示例

查看我的接口域名、app_key和app_secrect 客户端接入指南(如何生成签名) 开启/关闭签名

// 请求
{你的接口域名}/?s=App.OSS_Aliyun.ListObjects&num=2&app_key={你的app_key}&sign={动态签名}

// 返回
{
    "ret": 200,
    "data": {
        "err_code": 0,
        "err_msg": "",
        "items": {
            "objects": [
            {
                "key": "144727_b9fb6f9574acb734b19984ccf94fd255.jpg",
                "lastModified": "2020-06-30T06:47:30.000Z",
                "eTag": "\"3752122B3E0D4AE5803B3AECE46EF58C\"",
                "type": "Normal",
                "size": 232039,
                "storageClass": "Standard"
            },
            {
                "key": "144812_954c0e9a4333ae7f92b4ff9a6e194fab.jpg",
                "lastModified": "2020-06-30T06:48:13.000Z",
                "eTag": "\"3752122B3E0D4AE5803B3AECE46EF58C\"",
                "type": "Normal",
                "size": 232039,
                "storageClass": "Standard"
            }
            ],
            "next_marker": "144812_954c0e9a4333ae7f92b4ff9a6e194fab.jpg",
            "prefix": []
        }
    },
    "msg": "V3.3.0 YesApi App.OSS_Aliyun.ListObjects"
}

// 请求(下一页)
{你的接口域名}/?s=App.OSS_Aliyun.ListObjects&num=2&marker=144812_954c0e9a4333ae7f92b4ff9a6e194fab.jpg&app_key={你的app_key}&sign={动态签名}

// 返回
{
    "ret": 200,
    "data": {
        "err_code": 0,
        "err_msg": "",
        "items": {
            "objects": [
            {
                "key": "145317_fb6919d84a43fa1b8915b755f36538a5.jpg",
                "lastModified": "2020-06-30T06:53:18.000Z",
                "eTag": "\"3752122B3E0D4AE5803B3AECE46EF58C\"",
                "type": "Normal",
                "size": 232039,
                "storageClass": "Standard"
            },
            {
                "key": "145352_b0831abe10c206f79837e37200b40e81.jpg",
                "lastModified": "2020-06-30T06:53:53.000Z",
                "eTag": "\"3752122B3E0D4AE5803B3AECE46EF58C\"",
                "type": "Normal",
                "size": 232039,
                "storageClass": "Standard"
            }
            ],
            "next_marker": "145352_b0831abe10c206f79837e37200b40e81.jpg",
            "prefix": []
        }
    },
    "msg": "V3.3.0 YesApi App.OSS_Aliyun.ListObjects"
}

接口使用帮助说明

小白君正在拼命补充中……

返回结构说明

返回字段类型说明
ret整型接口状态码,200表示成功,4xx表示客户端非法请求,5xx表示服务端异常,查看异常错误码
data.objects字符串列举的文件
data.next_marker字符串用于获取下一页
data.prefix字符串前缀
msg字符串提示信息,面向技术人员的帮助或错误提示信息

ret异常错误码

错误码错误类型错误描述信息解决方法
ret = 200成功请求成功
ret = 400客户端非法请求表示客户端参数错误1、根据接口文档的接口参数,提供正确的参数
ret = 404客户端非法请求表示接口服务不存在1、查看小白接口大全,确保接口服务名称拼写正确
ret = 500小白接口异常表示服务端内部错误1、进入QQ交流群897815708,反馈问题;2、或者提交工单,一天内回复

常见问题FAQ

Q1 问:出现 414 Request-URI Too Large 时怎么解决?答:对于全部参数,改用POST方式传递,并且从GET链接里面去掉。