全部产品
存储与CDN 数据库 安全 应用服务 数加·人工智能 数加·大数据基础服务 互联网中间件 视频服务 开发者工具 解决方案 物联网
对象存储 OSS

GetService (ListBuckets)

更新时间:2017-11-17 14:54:10

GetService (ListBuckets)

对于服务地址作Get请求可以返回请求者拥有的所有Bucket,其中“/”表示根目录。

请求语法

  1. GET / HTTP/1.1
  2. Host: oss.aliyuncs.com
  3. Date: GMT Date
  4. Authorization: SignatureValue

请求参数

GetService(ListBuckets)时,可以通过prefix,marker和max-keys对list做限定,返回部分结果。

名称 是否必须 描述
prefix 限定返回的bucket name必须以prefix作为前缀,可以不设定,不设定时不过滤前缀信息
数据类型:字符串
默认值:无
marker 设定结果从marker之后按字母排序的第一个开始返回,可以不设定,不设定时从头开始返回
数据类型:字符串
默认值:无
max-keys 限定此次返回bucket的最大数,如果不设定,默认为100,max-keys取值不能大于1000
数据类型:字符串
默认值:100

响应元素(Response Elements)

名称 描述
ListAllMyBucketsResult 保存Get Service请求结果的容器。
类型:容器
子节点: Owner, Buckets
父节点:None
Prefix 本次查询结果的前缀,当bucket未全部返回时才有此节点
类型:字符串
父节点:ListAllMyBucketsResult
Marker 标明这次GetService(ListBuckets)的起点,当bucket未全部返回时才有此节点
类型:字符串
父节点:ListAllMyBucketsResult
MaxKeys 响应请求内返回结果的最大数目,当bucket未全部返回时才有此节点
类型:字符串
父节点:ListAllMyBucketsResult
IsTruncated 指明是否所有的结果都已经返回:“true”表示本次没有返回全部结果;“false”表示本次已经返回了全部结果。当bucket未全部返回时才有此节点。
类型:枚举字符串
有效值:true、false
父节点:ListAllMyBucketsResult
NextMarker 表示下一次GetService(ListBuckets)可以以此为marker,将未返回的结果返回。当bucket未全部返回时才有此节点。
类型:字符串
父节点:ListAllMyBucketsResult
Owner 用于存放Bucket拥有者信息的容器。
类型:容器
父节点:ListAllMyBucketsResult
ID Bucket拥有者的用户ID。
类型:字符串
父节点:ListAllMyBucketsResult.Owner
DisplayName Bucket拥有者的名称 (目前和ID一致)。
类型:字符串
父节点:ListAllMyBucketsResult.Owner
Buckets 保存多个Bucket信息的容器。
类型:容器
子节点:Bucket
父节点:ListAllMyBucketsResult
Bucket 保存bucket信息的容器.
类型:容器
子节点:Name, CreationDate, Location
父节点:ListAllMyBucketsResult.Buckets
Name Bucket名称。
类型:字符串
父节点:ListAllMyBucketsResult.Buckets.Bucket
CreateDate Bucket创建时间
类型:时间 (格式:yyyy-mm-ddThh:mm:ss.timezone, e.g., 2011-12-01T12:27:13.000Z)
父节点:ListAllMyBucketsResult.Buckets.Bucket
Location Bucket所在的数据中心
类型:字符串
父节点:ListAllMyBucketsResult.Buckets.Bucket
ExtranetEndpoint Bucket访问的外网域名
类型:字符串
父节点:ListAllMyBucketsResult.Buckets.Bucket
IntranetEndpoint 同区域ECS访问Bucket的内网域名
类型:字符串
父节点:ListAllMyBucketsResult.Buckets.Bucket
StorageClass Bucket存储类型,支持“Standard”、“IA”、“Archive”。(目前只有部分区域支持“Archive”类型)
类型:字符串
父节点:ListAllMyBucketsResult.Buckets.Bucket

细节分析

  1. GetService这个API只对验证通过的用户有效。
  2. 如果请求中没有用户验证信息(即匿名访问),返回403 Forbidden。错误码:AccessDenied。
  3. 当所有的bucket都返回时,返回的xml中不包含Prefix、Marker、MaxKeys、IsTruncated、NextMarker节点,如果还有部分结果未返回,则增加上述节点,其中NextMarker用于继续查询时给marker赋值。

示例

请求示例Ⅰ

  1. GET / HTTP/1.1
  2. Date: Thu, 15 May 2014 11:18:32 GMT
  3. Host: oss-cn-hangzhou.aliyuncs.com
  4. Authorization: OSS nxj7dtl1c24jwhcyl5hpvnhi:COS3OQkfQPnKmYZTEHYv2qUl5jI=

返回示例Ⅰ

  1. HTTP/1.1 200 OK
  2. Date: Thu, 15 May 2014 11:18:32 GMT
  3. Content-Type: application/xml
  4. Content-Length: 556
  5. Connection: keep-alive
  6. Server: AliyunOSS
  7. x-oss-request-id: 5374A2880232A65C23002D74
  8. <?xml version="1.0" encoding="UTF-8"?>
  9. <ListAllMyBucketsResult>
  10. <Owner>
  11. <ID>51264</ID>
  12. <DisplayName>51264</DisplayName>
  13. </Owner>
  14. <Buckets>
  15. <Bucket>
  16. <CreationDate>2015-12-17T18:12:43.000Z</CreationDate>
  17. <ExtranetEndpoint>oss-cn-shanghai.aliyuncs.com</ExtranetEndpoint>
  18. <IntranetEndpoint>oss-cn-shanghai-internal.aliyuncs.com</IntranetEndpoint>
  19. <Location>oss-cn-shanghai</Location>
  20. <Name>app-base-oss</Name>
  21. <StorageClass>Standard</StorageClass>
  22. </Bucket>
  23. <Bucket>
  24. <CreationDate>2014-12-25T11:21:04.000Z</CreationDate>
  25. <ExtranetEndpoint>oss-cn-hangzhou.aliyuncs.com</ExtranetEndpoint>
  26. <IntranetEndpoint>oss-cn-hangzhou-internal.aliyuncs.com</IntranetEndpoint>
  27. <Location>oss-cn-hangzhou</Location>
  28. <Name>atestleo23</Name>
  29. <StorageClass>IA</StorageClass>
  30. </Bucket>
  31. </Buckets>
  32. </ListAllMyBucketsResult>

请求示例Ⅱ

  1. GET /?prefix=xz02tphky6fjfiuc&max-keys=1 HTTP/1.1
  2. Date: Thu, 15 May 2014 11:18:32 GMT
  3. Host: oss-cn-hangzhou.aliyuncs.com
  4. Authorization: OSS nxj7dtl1c24jwhcyl5hpvnhi:COS3OQkfQPnKmYZTEHYv2qUl5jI=

返回示例Ⅱ

  1. HTTP/1.1 200 OK
  2. Date: Thu, 15 May 2014 11:18:32 GMT
  3. Content-Type: application/xml
  4. Content-Length: 545
  5. Connection: keep-alive
  6. Server: AliyunOSS
  7. x-oss-request-id: 5374A2880232A65C23002D75
  8. <?xml version="1.0" encoding="UTF-8"?>
  9. <ListAllMyBucketsResult>
  10. <Prefix>xz02tphky6fjfiuc</Prefix>
  11. <Marker></Marker>
  12. <MaxKeys>1</MaxKeys>
  13. <IsTruncated>true</IsTruncated>
  14. <NextMarker>xz02tphky6fjfiuc0</NextMarker>
  15. <Owner>
  16. <ID>ut_test_put_bucket</ID>
  17. <DisplayName>ut_test_put_bucket</DisplayName>
  18. </Owner>
  19. <Buckets>
  20. <Bucket>
  21. <CreationDate>2014-05-15T11:18:32.000Z</CreationDate>
  22. <ExtranetEndpoint>oss-cn-hangzhou.aliyuncs.com</ExtranetEndpoint>
  23. <IntranetEndpoint>oss-cn-hangzhou-internal.aliyuncs.com</IntranetEndpoint>
  24. <Location>oss-cn-hangzhou</Location>
  25. <Name>xz02tphky6fjfiuc0</Name>
  26. <StorageClass>Standard</StorageClass>
  27. </Bucket>
  28. </Buckets>
  29. </ListAllMyBucketsResult>
本文导读目录