doc-exports/docs/obs/api-ref/obs_04_0054.html
Jawei, Li f1cb839979 OBS api-ref 2.0.38.SP5
Reviewed-by: gtema <artem.goncharov@gmail.com>
Co-authored-by: Jawei, Li <lijiawei5@huawei.com>
Co-committed-by: Jawei, Li <lijiawei5@huawei.com>
2022-11-03 11:54:51 +00:00

7.7 KiB

Querying Information About Used Space in a Bucket

Functions

This operation queries the number of bucket objects and the space occupied by the objects. The size of the object space is a positive integer, measured by bytes.

The OBS bucket storage statistics is measured in the background, and the storage data is not updated in real time. Therefore, you are not advised to perform real-time verification on the storage information.

Request Syntax

1
2
3
4
GET /?storageinfo HTTP/1.1 
Host: bucketname.obs.region.example.com
Date: date
Authorization: authorization

Request Parameters

This request contains no parameters.

Request Headers

This request uses common headers. For details, see Table 3.

Request Elements

This request contains no elements.

Response Syntax

1
2
3
4
5
6
7
8
9
HTTP/1.1 status_code
Date: date
Content-Type: type
Content-Length: length
<?xml version="1.0" encoding="UTF-8" standalone="yes"?> 
<GetBucketStorageInfoResult xmlns="http://obs.region.example.com/doc/2015-06-30/">
<Size>size</Size> 
<ObjectNumber>number</ObjectNumber> 
</GetBucketStorageInfoResult>

Response Headers

The response to the request uses common headers. For details, see Table 1.

Response Elements

This response contains elements of information about the used storage capacity of a bucket. Table 1 describes the elements.

Table 1 Response elements

Element

Description

GetBucketStorageInfoResult

Request result that saves bucket storage information, including the stored data size and the number of objects

Type: XML

Size

Size of stored data

Type: integer

ObjectNumber

Number of objects returned

Type: integer

Error Responses

No special error responses are returned. For details about error responses, see Table 2.

Sample Request

1
2
3
4
5
6
GET /?storageinfo HTTP/1.1
User-Agent: curl/7.29.0
Host: examplebucket.obs.region.example.com
Accept: */*
Date: WED, 01 Jul 2015 03:31:18 GMT
Authorization: OBS H4IPJX0TQTHTHEBQQCEC:bLcdeJGYWw/eEEjMhPZx2MK5R9U=

Sample Response

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
HTTP/1.1 200 OK
Server: OBS
x-obs-request-id: BF260000016435DD2958BFDCDB86B55E
x-obs-id-2: 32AAAQAAEAABAAAQAAEAABAAAQAAEAABCSitZctaPYVnat49fVMd1O+OWIP1yrg3
Content-Type: application/xml
WED, 01 Jul 2015 03:31:18 GMT
Content-Length: 206

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<GetBucketStorageInfoResult xmlns="http://obs.example.com/doc/2015-06-30/">
  <Size>25490</Size>
  <ObjectNumber>24</ObjectNumber>
</GetBucketStorageInfoResult>