Billing:Get Bucket Billing Info

Search (SHIFT+S)




New in this release

Get Bucket Billing Info

GET /object/billing/buckets/{namespace}/{bucketName}/info

Gets billing details for the specified namespace and bucket name.

namespaceNamespace containing the bucket
bucketNameBucket name for which billing information needs to be retrieved

Query Parameters

sizeunitUnit to be used for calculating the size on disk (KB,MB and GB. GB is default value).

Required Roles

Requires one of the following roles:

  • SYSTEM_ADMIN

  • SYSTEM_MONITOR

  • NAMESPACE_ADMIN


Prerequisites

The following conditions must be met in order to call this operation.

  • Namespace and bucket must exist


Response Body

Billing information for the given Bucket and Namespace

Field Description Type Notes
<bucket_billing_info>
<name> Bucket name String
<namespace> Namespace String
<vpool_id> Replication group String
<total_size> Total size Long
<total_size_unit> Unit in which the total size is returned String
<total_objects> Total objects Long
<sample_time> Time at which these data collected using yyyy-MM-dd'T'HH:mm:ss'Z' format String
<TagSet> Tags - list of tags set for the Bucket
<Tag>     0-* Elements
<Key> The key of a tag String
<Value> The value of a tag String
</Tag>      
</TagSet>
</bucket_billing_info>

Examples

Request
GET https://192.168.0.0:4443/object/billing/buckets/s3/standalone-bucket/info?start_time=2015-01-16T22:20&end_time=2015-04-16T22:20 HTTP/1.1  

Concept-Type: application/xml 
X-SDS-AUTH-TOKEN: <AUTH_TOKEN>
Response
HTTP/1.1 200 OK
Content-Type: application/xml 

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<bucket_billing_info>
    <namespace>s3</namespace>
    <name>standalone-bucket</name>
    <vpool_id>urn:storageos:ReplicationGroupInfo:b3bf2d47-d732-457c-bb9b-d260eb53a76b:global</vpool_id>
    <total_size_in_gb>0.0</total_size_in_gb>
    <total_size_unit>0</total_size_unit>
    <total_objects>0</total_objects>
    <sample_time>0</sample_time>
</bucket_billing_info>
Notes: