調用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阻止公用訪問的配置資訊。
|
樣本
請求樣本
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的資訊。 |