Billing:Get Bucket Billing Info

Search (SHIFT+S)




New in this release

Get Bucket Billing Info

POST /object/billing/buckets/{namespace}/info

Gets the billing details for a list of buckets within a specified namespace.

namespaceNamespace containing the bucket

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


Request Payload

All parameters are required unless otherwise stated.

Field Description Type Notes
<bucket_list>
<id> A list of bucket identifiers String 0-* Elements
</bucket_list>

Response Body

Field Description Type Notes
<bucket_billing_infos>
<bucket_billing_info>     0-* Elements
<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>      
</bucket_billing_infos>

Examples

Request
POST https://192.168.0.0:4443/object/billing/buckets/s3/sample?sizeunit=KB

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

<?xml version="1.0" encoding="UTF-8" standalone="yes" ?>
<bucket_billing_infos>
    <bucket_billing_info>
        <namespace>s3</namespace>
        <name>standalone-bucket</name>
        <sample_time>0</sample_time>
        <vpool_id>urn:storageos:ReplicationGroupInfo:b3bf2d47-d732-457c-bb9b-d260eb53a76a:global</vpool_id>
        <total_size>0</total_size>
        <total_size_unit>KB</total_size_unit>
        <total_objects>2</total_objects>
    </bucket_billing_info>
    <bucket_billing_info>
        <namespace>s3</namespace>
        <name>standalone-bucket-1</name>
        <sample_time>0</sample_time>
        <vpool_id>urn:storageos:ReplicationGroupInfo:b3bf2d47-d732-457c-bb9b-d260eb53a76a:global</vpool_id>
        <total_size>107</total_size>
        <total_size_unit>KB</total_size_unit>
        <total_objects>6</total_objects>
    </bucket_billing_info>
</bucket_billing_infos>
Notes: