列举该账户下桶的详细信息

此GET操作返回请求者拥有的Bucket,并展示Bucket的详细信息。

  • 请求的url中需要包含接口标识符“details”,否则执行“列举该账户下所有桶”接口;
  • 请求中可以指定需要列举的页码“pageNo”、每页中包含Bucket的数量“pageSize”以及Bucket名称的过滤关键词“filterKey”;
  • 返回信息中除Name、Owner、CreationDate外,增加了StorageClass、AccessControlList、Location、ExtranetEndpoint、IntranetEndpoint参数以及Bucket的总数TotalCount;
  • 需要使用AccessKey来验证请求,匿名请求不会返回bucket列表,并且你也无法得到不属于你的bucket的列表。

请求

  • 请求语法

    • 内容

        GET /?details&filterKey={filterKey}&pageNo={pageNo}&pageSize={pageSize} HTTP/1.1 
        Host: {Endpoint}
        Date: {date}
        Authorization: {SignatureValue}
      
    • 描述

        Endpoint:参考与region地域的关系 
        SignatureValue:参考签名算法
      
  • 请求参数

名称 类型 是否必须 描述
details 字符串 接口标识符
filterKey 字符串 桶名称过滤关键词,默认值为空
pageNo 字符串 需要列举的页码,默认值:1
pageSize 字符串 每页包含桶的个数,默认值:20
  • 非公共请求头

  • 请求体

响应

  • 非公共响应头

  • 响应体

名称 类型 描述
ListAllMyBucketsResult 容器 响应信息容器
子节点:Owner、 Buckets、FilterKey、PageNo、PageSize、TotalCount
父节点:无
Owner 容器 包含bucket拥有者信息的容器
子节点:ID,DisplayName
父节点:ListAllMyBucketsResult
ID 字符串 Bucket拥有者的用户ID
父节点:ListAllMyBucketsResult.Owner
DisplayName 字符串 Bucket拥有者的名称
父节点:ListAllMyBucketsResult.Owner
Buckets 容器 包含一个或多个bucket的容器
子节点:Bucket
父节点:ListAllMyBucketsResult
Bucket 容器 包含bucket信息的容器
子节点:Name,StorageClass,AccessControlList,Location,ExtranetEndpoint,IntranetEndpoint, CreationDate
父节点:ListAllMyBucketsResult.Buckets
Name 字符串 Bucket的名字
父节点:ListAllMyBucketsResult.Buckets.Bucket
StorageClass 字符串 Bucket的存储类型
父节点:ListAllMyBucketsResult.Buckets.Bucket
AccessControlList 容器 Bucket的ACL
子节点:Grant
父节点:ListAllMyBucketsResult.Buckets.Bucket
Grant 容器 包含被授权者和其权限信息。
子节点:Grantee、Permission
父节点:ListAllMyBucketsResult.Buckets.Bucket.AccessControlList
Grantee 字符串 被授权者。
父节点:ListAllMyBucketsResult.Buckets.Bucket.AccessControlList.Grant
Permission 字符串 指明授予被授权者的权限信息(FULL_CONTROL,READ,WRITE)。
父节点:ListAllMyBucketsResult.Buckets.Bucket.AccessControlList.Grant
Location 字符串 Bucket的域
父节点:ListAllMyBucketsResult.Buckets.Bucket
ExtranetEndpoint 字符串 Bucket的外网域名
父节点:ListAllMyBucketsResult.Buckets.Bucket
IntranetEndpoint 字符串 Bucket的内网域名
父节点:ListAllMyBucketsResult.Buckets.Bucket
CreationDate 时间(格式:yyyy-mm-ddThh:mm:ss.timezone, e.g., 2011-12-01T12:27:13.000Z) bucket的创建日期
父节点:ListAllMyBucketsResult.Buckets.Bucket
FilterKey 字符串 请求中指定的桶名称过滤关键词,默认值为:无
父节点:ListAllMyBucketsResult
PageNo 字符串 当前列举的页数,默认值为:1
父节点:ListAllMyBucketsResult
PageSize 字符串 当前每页列举桶的数量,默认值为:20
父节点:ListAllMyBucketsResult
TotalCount 字符串 符合“FilterKey”的桶的总数
父节点:ListAllMyBucketsResult

示例

  • 请求
    GET /?details&filterKey=example&pageNo=1&pageSize=2 HTTP/1.1
    Host: oss.inspurcloud.com
    Date: Wed, 01 Jan  2014 12:00:00 GMT
    Authorization: authorization string
  • 响应
    <ListAllMyBucketsResult>
        <Owner>
            <ID>ID-example</ID>
            <DisplayName>DisplayName-example</DisplayName>
        </Owner>
        <Buckets>
            <Bucket>
                <Name>Bucket1-example</Name>
                <StorageClass>STANDARD_IA</StorageClass>
                <AccessControlList>
                    <Grant>
                        <Grantee
                            xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="Group">
                            <URI>http://acs.amazonaws.com/groups/global/AllUsers</URI>
                        </Grantee>
                        <Permission>READ</Permission>
                    </Grant>
                    <Grant>
                        <Grantee
                           xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="Group">
                            <URI>http://acs.amazonaws.com/groups/global/AllUsers</URI>
                        </Grantee>
                        <Permission>WRITE</Permission>
                    </Grant>
                    <Grant>
                        <Grantee
                             xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="CanonicalUser">
                            <ID>ID-example</ID>
                            <DisplayName>DisplayName-example</DisplayName>
                        </Grantee>
                        <Permission>FULL_CONTROL</Permission>
                    </Grant>
                </AccessControlList>
                <Location>cn-north-3</Location>
                <ExtranetEndpoint>Bucket1-example.oss.cn-north-3.devops.inspur.com</ExtranetEndpoint>
                <IntranetEndpoint>Bucket1-example.oss.cn-north-3-innet.devops.inspur.com</IntranetEndpoint>
                <CreationDate>2020-01-07T02:50:14.464Z</CreationDate>
            </Bucket>
            <Bucket>
                <Name>Bucket2-example</Name>
                <StorageClass>default-placement</StorageClass>
                <AccessControlList>
                    <Grant>
                        <Grantee
                            xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="CanonicalUser">
                            <ID>ID-example</ID>
                            <DisplayName>DisplayName-example</DisplayName>
                        </Grantee>
                        <Permission>FULL_CONTROL</Permission>
                    </Grant>
                </AccessControlList>
                <Location>cn-south-1</Location>
                <ExtranetEndpoint>Bucket2-example.oss.cn-south-1.devops.inspur.com</ExtranetEndpoint>
                <IntranetEndpoint>Bucket2-example.oss.cn-south-1-innet.devops.inspur.com</IntranetEndpoint>
                <CreationDate>2020-01-07T06:16:15.136Z</CreationDate>
            </Bucket>
        </Buckets>
        <FilterKey>example</FilterKey>
        <PageNo>1</PageNo>
        <PageSize>2</PageSize>
        <TotalCount>10</TotalCount>
    </ListAllMyBucketsResult>

错误码

错误码 描述 状态码 描述
AccessDenied 拒绝访问 403 原因及排除请参看权限问题及排查
InvalidArgument 参数错误 400 PageNo或者PageSize值小于等于0