buckets

获取空间列表

请求地址

https://api.upyun.com/buckets/

HTTP请求方法

GET

是否需要登陆授权

是，关于登录授权，参见授权机制

请求参数

必选 数据类型及范围 说明
since false int 点击上一页时，将值设置为上次请求接口返回的 since 值即可。没有则为空
max false int 点击下一页时，将值设置为上次请求接口返回的 max 值即可。没有则为空
limit false int 每次最大的请求条数
name false string 空间名
type false enum(file,cdn,live) 可以多个类型用逗号分隔一起查询。file 返回存储类服务， cdn 返回自主源站类服务， live 返回直播类服务。
visible false bool 外链是否开启
bucket_name false string 根据服务名模糊搜索

说明

当有name字段时只返回与此字段匹配的空间，忽略其他的字段信息。返回的的数据格式与下方返回格式相同。

返回结果

{
    pager: {
        since: null,
        max: 123456,
        limit: 25,
        name : 'test'
    },
    buckets: [
        {
            "bucket_name": 'upyun',
            "type": 'image',
            "visible" :'true'/'false',
            "form_api_status":'true'/'false',
            "quota": 0,
            "https":'enabled'/'disabled',
            "domains": [
               {"domain": "www.upyun.com", "status": "NORMAL"}
             ],
             "status": "NORMAL" //NORMAL DISABLED  READONLY
        },
        ...
    ]
}
错误返回值与错误代码，参见错误代码说明

返回字段说明

返回值字段 字段类型 字段说明
bucket_name string
type string 空间类型
visible string 是否可见（当用户未实名认证时，始终不可见）
form_api_status string
quota integer 空间存储配额
https string https功能是否开启
since string 下页请求开始时起始id
domains array 每个服务下所绑定的域名（正常，拒绝，审核中）以及默认域名
max string 下次请求时最大的起始id
limit int 每页条数

如何实现分页

第一页时接口返回的 page 示例： 

{
  "limit": 20
  "max": 71122
  "since": null
}
返回值的since为空表示没有上一页，max不为空表示存在下一页。

请求第二页（下一页）时，接口增加 max=71122参数即可，则接口会返回下一页的值，示例如下： 

"limit": 20
"max": 71101
"since": 71121
此时max和since都存在，如果要返回第一页则增加since=71121即可。继续下一页则传max=71101
Last edited by hubiao, 2016-03-29 14:18:32