租户端 存储 对象存储（COS） COS API参考

查询存储桶列表

最近更新时间: 2024-06-12 15:06:00

功能描述

GET Service 接口是用来获取请求者名下的所有存储空间列表（Bucket list）。

请求

请求示例

GET / HTTP/1.1
Host: <Endpoint>
Date: GMT Date
Authorization: Auth String

Authorization: Auth String (详情参见请求签名章节)

Host：查询特定地域下的存储桶列表

请求头

公共头部

该请求操作的实现使用公共请求头，了解公共请求头详情请参见 公共请求头部 章节。

非公共头部

该请求操作无特殊的请求头部信息。

请求体

该请求的请求体为空。

响应

响应头

公共响应头

该响应使用公共响应头，了解公共响应头详情请参见 公共响应头部 章节。

特有响应头

该请求操作无特殊的响应头部信息。

响应体

查询成功，返回 application/xml 数据，包含 Bucket 中的对象信息。

<?xml version="1.0" encoding="UTF-8" ?>
<ListAllMyBucketsResult>
  <Owner>
    <ID>string</ID>
    <DisplayName>string</DisplayName>
  </Owner>
  <Buckets>
    <Bucket>
      <Name>string</Name>
      <Location>string</Location>
      <CreateDate>string</CreateDate>
    </Bucket>
    <Bucket>
      <Name>string</Name>
      <Location>string</Location>
      <CreateDate>string</CreateDate>
    </Bucket>
  </Buckets>
</ListAllMyBucketsResult>

具体的数据描述如下：

节点名称（关键字） 父节点 描述 类型 必选
ListAllMyBucketsResult 无 说明本次响应的所有信息 Container 是

Container 节点 ListAllMyBucketsResult 的内容：

节点名称（关键字） 父节点 描述 类型 必选
Owner ListAllMyBucketsResult 说明 Bucket 持有者的信息 Container 是
Buckets ListAllMyBucketsResult 说明本次响应的所有 Bucket 列表信息 Container 是

Container 节点 Owner 的内容：

节点名称（关键字） 父节点 描述 类型 必选
ID ListAllMyBucketsResult.Owner Bucket 所有者的 ID string 是
DisplayName ListAllMyBucketsResult.Owner Bucket 所有者的名字信息 string 是

Container 节点 Buckets 的内容：

节点名称（关键字） 父节点 描述 类型 必选
Bucket ListAllMyBucketsResult.Buckets 单个 Bucket 的信息 Container 是

Container 节点 Bucket 的内容：

节点名称（关键字） 父节点 描述 类型 必选
Name ListAllMyBucketsResult.Buckets.Bucket Bucket 的名称 string 是
Location ListAllMyBucketsResult.Buckets.Bucket Bucket 所在地域。枚举值参见可用地域文档，如：ap-beijing, ap-hongkong, eu-frankfurt 等 string 是
CreateDate ListAllMyBucketsResult.Buckets.Bucket Bucket 创建时间。ISO8601 格式，例如 2016-11-09T08:46:32.000Z string 是

错误码

错误码 描述 HTTP 状态码
InvalidBucketName Bucket 名称不合法 400 Bad Request
SignatureDoesNotMatch 提供的签名不符合规则，返回该错误码 403 Forbidden
NoSuchBucket Bucket 不存在，返回该错误码 404 Not Found

实际案例

请求

GET / HTTP/1.1
Host: <Endpoint>
Date: Fri, 24 May 2019 11:59:51 GMT
Authorization: q-sign-algorithm=sha1&q-ak=AKID8A0fBVtYFrNm02oY1g1JQQF0c3JO****&q-sign-time=1558699191;1558706391&q-key-time=1558699191;1558706391&q-header-list=date;host&q-url-param-list=&q-signature=c3f55f4ce2800fb343cf85ff536a9185a0c1****
Connection: close

响应

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: 495
Connection: close
Date: Fri, 24 May 2019 11:59:51 GMT
Server: tencent-cos
x-cos-request-id: NWNlN2RjYjdfZjhjODBiMDlfOWNlNF9hYzc2****

<ListAllMyBucketsResult>
    <Owner>
        <ID>qcs::cam::uin/100000000001:uin/100000000001</ID>
        <DisplayName>100000000001</DisplayName>
    </Owner>
    <Buckets>
        <Bucket>
            <Name>examplebucket1-1250000000</Name>
            <Location>ap-beijing</Location>
            <CreationDate>2019-05-24T11:49:50Z</CreationDate>
        </Bucket>
        <Bucket>
            <Name>examplebucket2-1250000000</Name>
            <Location>ap-beijing</Location>
            <CreationDate>2019-05-24T11:51:50Z</CreationDate>
        </Bucket>
    </Buckets>
</ListAllMyBucketsResult>