Billing:Get Bucket Billing Sample

Search (SHIFT+S)




New in this release

Get Bucket Billing Sample

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

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

namespaceNamespace containing the bucket

Query Parameters

start_timeStarting time (inclusive) for the sample(s) in ISO-8601 minute format. Must be a multiple of 5 minutes or an error will be returned.
end_timeEnding time (exclusive) for the sample(s) in ISO-8601 minute format. Must be a multiple of 5 minutes or an error will be returned.
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_sample_infos>
<bucket_billing_sample_info>     0-* Elements
<namespace> Namespace String
<name> Bucket name String
<vpool_id> Replication group identifier String
<sample_start_time> Sample start time String
<sample_end_time> Sample end time String
<objects_created> Number of objects created Long
<objects_deleted> Number of objects deleted Long
<bytes_delta> Bytes delta Long
<total_size> Total size Long
<total_size_unit> Total size unit String
<total_objects> Total objects Long
<ingress> Ingress Long
<egress> Egress Long
<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>
<next_marker> Next marker String
</bucket_billing_sample_info>      
</bucket_billing_sample_infos>

Examples

Request
GET https://192.168.0.0:4443/object/billing/buckets/s3/sample?start_time=2015-01-16T22:20&end_time=2015-04-16T22:20&sizeunit=KB

HTTP/1.1
Content-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_sample_infos>
    <bucket_billing_sample_info>
        <namespace>s3</namespace>
        <name>standalone-bucket</name>
        <vpool_id>urn:storageos:ReplicationGroupInfo:b3bf2d47-d732-457c-bb9b-d260eb53a76a:global</vpool_id>
        <sample_start_time>2015-08-30T02:00:00Z</sample_start_time>
        <sample_end_time>2015-08-30T23:00:00Z</sample_end_time>
        <objects_created>0</objects_created>
        <objects_deleted>0</objects_deleted>
        <bytes_delta>0</bytes_delta>
        <total_size>0</total_size>
        <total_size_unit>KB</total_size_unit>
        <total_objects>2</total_objects>
        <ingress>0</ingress>
        <egress>0</egress>
    </bucket_billing_sample_info>
    <bucket_billing_sample_info>
        <namespace>s3</namespace>
        <name>standalone-bucket-1</name>
        <vpool_id>urn:storageos:ReplicationGroupInfo:b3bf2d47-d732-457c-bb9b-d260eb53a76a:global</vpool_id>
        <sample_start_time>2015-08-30T02:00:00Z</sample_start_time>
        <sample_end_time>2015-08-30T23:00:00Z</sample_end_time>
        <objects_created>0</objects_created>
        <objects_deleted>0</objects_deleted>
        <bytes_delta>0</bytes_delta>
        <total_size>107</total_size>
        <total_size_unit>KB</total_size_unit>
        <total_objects>6</total_objects>
        <ingress>0</ingress>
        <egress>0</egress>
    </bucket_billing_sample_info>
</bucket_billing_sample_infos>
Notes: