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

注意事项

请求语法

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

当您在OSS ON云盒中调用该接口时,您需要将Host替换为云盒Endpoint。更多信息,请参见云盒Endpoint

请求头

此接口仅涉及公共请求头。更多信息,请参见公共请求头(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 Bucket的外网域名。

父节点:BucketInfo.Bucket

IntranetEndpoint 字符串 oss-cn-hangzhou-internal.aliyuncs.com 同地域ECS访问Bucket的内网域名。

父节点:BucketInfo.Bucket

Location 字符串 oss-cn-hangzhou Bucket所在的地域。

父节点:BucketInfo.Bucket

StorageClass 字符串 Standard Bucket的存储类型。

有效值:StandardIAArchiveColdArchive

关于存储类型的更多信息,请参见存储类型介绍

Name 字符串 oss-example Bucket名称。

父节点: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权限。

有效值:privatepublic-readpublic-read-write

父节点:BucketInfo.Bucket.AccessControlList

DataRedundancyType 枚举字符串 LRS Bucket的数据容灾类型。

有效值:LRSZRS

父节点:BucketInfo.Bucket

Versioning 字符串 Enabled Bucket的版本控制状态。

有效值:EnabledSuspended

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

父节点:BucketInfo.Bucket

ServerSideEncryptionRule 容器 不涉及 服务器端加密方式的容器。

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

父节点:BucketInfo.Bucket

ApplyServerSideEncryptionByDefault 容器 不涉及 服务器端默认加密方式的容器。

父节点:BucketInfo.Bucket

SSEAlgorithm 字符串 KMS 显示服务器端默认加密方式。

有效值:KMSAES256

父节点:BucketInfo.Bucket

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

父节点:BucketInfo.Bucket

CrossRegionReplication 字符串 Disabled 显示Bucket的跨区域复制状态。

有效值:EnabledDisabled

父节点:BucketInfo.Bucket

TransferAcceleration 字符串 Disabled 显示Bucket的传输加速状态。

有效值:EnabledDisabled

父节点:BucketInfo.Bucket

AccessMonitor 字符串 Enabled 显示Bucket的访问跟踪状态。

有效值:EnabledDisabled

父节点:BucketInfo.Bucket

示例

请求示例

Get /?bucketInfo HTTP/1.1
Host: examplebucket.oss-cn-hangzhou.aliyuncs.com  
Date: Sat, 12 Sep 2015 07:51:28 GMT
Authorization: OSS qn6qrrqxo2oawuk53otf****: BuG4rRK+zNhH1AcF51NNHD39****                
返回示例
  • 成功获取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>
        <AccessMonitor>Enabled</AccessMonitor>
        <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>
        <Name>oss-example</Name>
        <Owner>
          <DisplayName>username</DisplayName>
          <ID>27183473914****</ID>
        </Owner>
        <AccessControlList>
          <Grant>private</Grant>
        </AccessControlList>  
        <Comment>test</Comment>    
      </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>
    </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的信息。