Billing:Get Bucket Billing Sample

Search (SHIFT+S)

Modified since last release

Get Bucket Billing Sample

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

Gets billing details for the specified namespace, interval and bucket details. By default, buckets are sampled every 5 minutes. If the requested time range includes multiple samples, the data will be aggregated.

namespace	Namespace containing the bucket
bucketName	Bucket name

Query Parameters

start_time	Starting time for the sample(s) in ISO-8601 minute format. Time must be a multiple of 5 minutes or an error will be returned.
end_time	Ending time for the sample(s) in ISO-8601 minute format. Time must be a multiple of 5 minutes or an error will be returned.
sizeunit	Unit 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 should exist

Response Body

The bucket's usage for the requested time period.

Field	Description	Type	Notes
bucket_billing_sample
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
uptodate_till	Consistent Time. This has an unexpected value during data reconstruction.	String
objects_created	Number of objects created	Long
objects_deleted	Number of objects deleted	Long
bytes_delta	Bytes delta	Long
total_size	Total size	Double
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
next_marker	Next marker	String
total_mpu_size	Total MPU size	Double
total_mpu_parts	Total MPU parts	Long
billingStats	This is invoked when the media type is XML. WARNING:This method should not be used outside this class.Instead use toMap() method	JAXBElement	0-* Elements

Examples

Request

GET https://192.168.0.0:4443/object/billing/buckets/s3/standalone-bucket/sample?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_sample>
    <namespace>s3</namespace>
    <name>standalone-bucket</name>
    <vpool_id>urn:storageos:ReplicationGroupInfo:b3bf2d47-d732-457c-bb9b-d260eb53a76b:global</vpool_id>
    <sample_start_time>2015-01-16T22:20:00Z</sample_start_time>
    <sample_end_time>2015-04-16T22:20:00Z</sample_end_time>
    <objects_created>12</objects_created>
    <objects_deleted>0</objects_deleted>
    <bytes_delta>2581000</bytes_delta>
    <total_size>0.0024</total_size>
    <total_objects>12</total_objects>
    <total_mpu_size>0.0</total_mpu_size>
    <total_mpu_parts>0</total_mpu_parts>
    <ingress>2581000</ingress>
    <egress>0</egress>
    <TagSet/>
    <uptodate_till>2017-10-02T03:30:21Z</uptodate_till>
    <bytes_deleted>0.0</bytes_deleted>
    <total_size_deleted>0.0</total_size_deleted>
    <total_objects_deleted>0</total_objects_deleted>
</bucket_billing_sample>

Request

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

Content-Type: application/json
X-SDS-AUTH-TOKEN: <AUTH_TOKEN>

Response

HTTP/1.1 200 OK 
Content-Type: application/json 

{
  "bucket_billing_sample": {
    "namespace": "s3",
    "name": "standalone-bucket",
    "vpool_id": "urn:storageos:ReplicationGroupInfo:b3bf2d47-d732-457c-bb9b-d260geteb53a76b:global",
    "sample_start_time": "2015-01-16T22:20:00Z",
    "sample_end_time": "2015-04-16T22:20:00Z",
    "objects_created": "12",
    "objects_deleted": "0",
    "bytes_delta": "2581000",
    "total_size": "0.0024",
    "total_objects": "12",
    "total_mpu_size":"0.0",
    "total_mpu_parts":0,
    "ingress":2581000,
    "egress":0,
    "TagSet":[],
    "uptodate_till":"2017-10-02T03:33:08Z",
    "bytes_deleted": "0.0",
    "total_objects_deleted": "0",
    "total_size_deleted": "0.0"
  }
}

Request

curl -H $token -H "Content-Type: application/xml" -X GET https://$nodeIp:4443/object/billing/buckets/s3/standalone-bucket/sample?start_time=2015-01-16T22:20&end_time=2015-04-16T22:20

Response

HTTP/1.1 200 OK
Content-Type: application/xml 

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<bucket_billing_sample>
    <namespace>s3</namespace>
    <name>standalone-bucket</name>
    <vpool_id>urn:storageos:ReplicationGroupInfo:b3bf2d47-d732-457c-bb9b-d260eb53a76b:global</vpool_id>
    <sample_start_time>2015-01-16T22:20:00Z</sample_start_time>
    <sample_end_time>2015-04-16T22:20:00Z</sample_end_time>
    <objects_created>12</objects_created>
    <objects_deleted>0</objects_deleted>
    <bytes_delta>2581000</bytes_delta>
    <total_size>0.0024</total_size>
    <total_objects>12</total_objects>
    <total_mpu_size>0.0</total_mpu_size>
    <total_mpu_parts>0</total_mpu_parts>
    <ingress>2581000</ingress>
    <egress>0</egress>
    <TagSet/>
    <uptodate_till>2017-10-02T03:30:21Z</uptodate_till>
    <bytes_deleted>0.0</bytes_deleted>
    <total_size_deleted>0.0</total_size_deleted>
    <total_objects_deleted>0</total_objects_deleted>
</bucket_billing_sample>