全部产品
Search

搜索本产品

    对象存储 OSS：GetBucketInfo

    文档中心

    对象存储 OSS：GetBucketInfo

    更新时间：Nov 28, 2024

    调用GetBucketInfo接口查看存储空间（Bucket）的相关信息。

    注意事项

    • 该请求可以从任何一个OSS的Endpoint发起。

    • 阿里云账号默认拥有查看Bucket相关信息的权限。如果您需要通过RAM用户或者STS的方式进行查看，您必须拥有oss:GetBucketInfo权限。具体操作，请参见为RAM用户授权自定义的权限策略。

    请求语法

    GET /?bucketInfo HTTP/1.1
Host: BucketName.oss-cn-hangzhou.aliyuncs.com
Date: GMT Date
Authorization: SignatureValue

    请求头

    此接口仅涉及公共请求头。更多信息，请参见公共请求头（Common Request Headers）。

    响应头

    此接口仅涉及公共响应头。更多信息，请参见公共响应头（Common Response Headers）。

    响应元素

    名称

    类型

    示例值

    描述

    BucketInfo

    容器

    不涉及

    保存Bucket信息的容器。

    子节点：Bucket

    父节点：无

    Bucket

    容器

    不涉及

    保存Bucket信息的容器。

    父节点：BucketInfo

    CreationDate

    时间

    2013-07-31T10:56:21.000Z

    Bucket的创建时间，格式为UTC时间。

    父节点：BucketInfo.Bucket

    ExtranetEndpoint

    字符串

    oss-cn-hangzhou.aliyuncs.com

    外网Endpoint。

    父节点：BucketInfo.Bucket

    IntranetEndpoint

    字符串

    oss-cn-hangzhou-internal.aliyuncs.com

    内网Endpoint。

    父节点：BucketInfo.Bucket

    Location

    字符串

    oss-cn-hangzhou

    Bucket所在地域，格式为OSS专用Region ID。

    父节点：BucketInfo.Bucket

    StorageClass

    字符串

    Standard

    Bucket的存储类型。

    有效值：Standard、IA、Archive和ColdArchive

    关于存储类型的更多信息，请参见存储类型概述。

    Name

    字符串

    oss-example

    Bucket名称。

    父节点：BucketInfo.Bucket

    ResourceGroupId

    字符串

    rg-aek27tc********

    Bucket所属的资源组ID。

    如果Bucket属于默认资源组，则返回值为rg-default-id。

    父节点：BucketInfo.Bucket

    Owner

    容器

    不涉及

    存放Bucket拥有者信息的容器。

    父节点：BucketInfo.Bucket

    ID

    字符串

    27183473914****

    Bucket拥有者的用户ID。

    父节点：BucketInfo.Bucket.Owner

    DisplayName

    字符串

    username

    Bucket拥有者的名称（目前和用户ID一致）。

    父节点：BucketInfo.Bucket.Owner

    AccessControlList

    容器

    不涉及

    存放Bucket读写权限（ACL）信息的容器。

    关于Bucket ACL的更多信息，请参见设置Bucket ACL。

    父节点：BucketInfo.Bucket

    Grant

    枚举字符串

    private

    Bucket的ACL权限。

    有效值：private、public-read、public-read-write

    父节点：BucketInfo.Bucket.AccessControlList

    DataRedundancyType

    枚举字符串

    LRS

    Bucket的数据容灾类型。

    有效值：LRS、ZRS

    父节点：BucketInfo.Bucket

    Versioning

    字符串

    Enabled

    Bucket的版本控制状态。

    有效值：Enabled、Suspended

    关于版本控制状态的更多信息，请参见PutBucketVersioning。

    父节点：BucketInfo.Bucket

    ServerSideEncryptionRule

    容器

    不涉及

    服务器端加密方式的容器。

    关于服务器端加密方式的更多信息，请参见服务器端加密。

    父节点：BucketInfo.Bucket

    SSEAlgorithm

    字符串

    KMS

    显示服务器端默认加密方式。

    有效值：KMS、AES256

    父节点：BucketInfo.Bucket.ServerSideEncryptionRule

    KMSMasterKeyID

    字符串

    ******

    显示当前使用的KMS密钥ID。仅当SSEAlgorithm为KMS，且指定了密钥ID时返回取值。其他情况下，返回为空。

    父节点：BucketInfo.Bucket.ServerSideEncryptionRule

    KMSDataEncryption

    字符串

    SM4

    指定 Object 的加密算法。如果未指定此选项，表明 Object 使用 AES256 加密算法。此选项仅当 SSEAlgorithm 取值为 KMS 有效。

    父节点：BucketInfo.Bucket.ServerSideEncryptionRule

    CrossRegionReplication

    字符串

    Disabled

    显示Bucket的跨区域复制状态。

    有效值：Enabled、Disabled

    父节点：BucketInfo.Bucket

    TransferAcceleration

    字符串

    Disabled

    显示Bucket的传输加速状态。

    有效值：Enabled、Disabled

    父节点：BucketInfo.Bucket

    HierarchicalNamespace

    字符串

    Enabled

    显示Bucket的分层命名空间状态。

    有效值：Enabled

    父节点：BucketInfo.Bucket

    AccessMonitor

    字符串

    Enabled

    显示Bucket的访问跟踪状态。

    有效值：Enabled、Disabled

    父节点：BucketInfo.Bucket

    BucketPolicy

    容器

    不涉及

    存放日志信息的容器。

    父节点：BucketInfo.Bucket

    LogBucket

    字符串

    examplebucket

    存储日志记录的Bucket名称。

    父节点：BucketInfo.Bucket.BucketPolicy

    LogPrefix

    字符串

    log/

    存储日志文件的目录。

    父节点：BucketInfo.Bucket.BucketPolicy

    BlockPublicAccess

    布尔值

    true

    获取Bucket阻止公共访问的配置信息。

    • true：开启阻止公共访问。

    • false：关闭阻止公共访问。

    示例

    请求示例 

    Get /?bucketInfo HTTP/1.1
Host: examplebucket.oss-cn-hangzhou.aliyuncs.com  
Date: Sat, 12 Sep 2015 07:51:28 GMT
Authorization: OSS qn6q**************:77Dv****************

    返回示例

    • 成功获取Bucket信息的返回示例

      HTTP/1.1 200
x-oss-request-id: 534B371674E88A4D8906****
Date: Sat, 12 Sep 2015 07:51:28 GMT
Connection: keep-alive
Content-Length: 531  
Server: AliyunOSS
<?xml version="1.0" encoding="UTF-8"?>
<BucketInfo>
  <Bucket>
    <CreationDate>2013-07-31T10:56:21.000Z</CreationDate>
    <ExtranetEndpoint>oss-cn-hangzhou.aliyuncs.com</ExtranetEndpoint>
    <IntranetEndpoint>oss-cn-hangzhou-internal.aliyuncs.com</IntranetEndpoint>
    <Location>oss-cn-hangzhou</Location>
    <StorageClass>Standard</StorageClass>
    <TransferAcceleration>Disabled</TransferAcceleration>
    <CrossRegionReplication>Disabled</CrossRegionReplication>
    <HierarchicalNamespace>Enabled</HierarchicalNamespace>
    <Name>oss-example</Name>
    <ResourceGroupId>rg-aek27tc********</ResourceGroupId>
    <Owner>
      <DisplayName>username</DisplayName>
      <ID>27183473914****</ID>
    </Owner>
    <AccessControlList>
      <Grant>private</Grant>
    </AccessControlList>  
    <Comment>test</Comment>
    <BucketPolicy>
      <LogBucket>examplebucket</LogBucket>
      <LogPrefix>log/</LogPrefix>
    </BucketPolicy>
  </Bucket>
</BucketInfo>

    • 获取不存在的Bucket信息的返回示例 

      HTTP/1.1 404 
x-oss-request-id: 534B371674E88A4D8906****
Date: Sat, 12 Sep 2015 07:51:28 GMT
Connection: keep-alive
Content-Length: 308  
Server: AliyunOSS
<?xml version="1.0" encoding="UTF-8"?>
<Error>
  <Code>NoSuchBucket</Code>
  <Message>The specified bucket does not exist.</Message>
  <RequestId>568D547F31243C673BA1****</RequestId>
  <HostId>nosuchbucket.oss.aliyuncs.com</HostId>
  <BucketName>nosuchbucket</BucketName>
  <EC>0015-00000101</EC>
</Error>

    • 获取没有权限访问的Bucket信息的返回示例 

      HTTP/1.1 403
x-oss-request-id: 534B371674E88A4D8906****
Date: Sat, 12 Sep 2015 07:51:28 GMT
Connection: keep-alive
Content-Length: 209  
Server: AliyunOSS
<?xml version="1.0" encoding="UTF-8"?>
<Error>
  <Code>AccessDenied</Code>
  <Message>AccessDenied</Message>
  <RequestId>568D5566F2D0F89F5C0E****</RequestId>
  <HostId>test.oss.aliyuncs.com</HostId>
</Error>

    SDK

    此接口对应的各语言SDK如下：

    错误码

    错误码

    HTTP状态码

    描述

    NoSuchBucket

    404

    目标Bucket不存在。

    AccessDenied

    403

    没有查看该Bucket信息的权限。只有Bucket的拥有者才能查看Bucket的信息。