Billing:Get Namespace Billing Sample

Search (SHIFT+S)




New in this release

Get Namespace Billing Sample

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

Gets billing details for the specified namespace, interval and, optionally, buckets. This method will return one and only one time sample. If the start_time and end_time do not align with a sampled time period, the matching samples will be aggregated.

Check the response for the actual time period sampled. Due to the fact that sampling all buckets in a namespace takes some time, it is possible that sum of the bucket values will not equal the corresponding namespace value.

namespaceNamespace to get information about

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.
include_bucket_detailOptional (default=false). If true, include information about all the buckets owned by this namespace.
markerOptional, Used to continue a truncated response. Omit this parameter on the first request.
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


Response Body

The response contains the billing information for the given time period for the namespace and its buckets.

Field Description Type Notes
<namespace_billing_sample>
<namespace> Namespace 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> get total provisioned capacity. Long
<total_size_unit> gets unit of total provisioned capacity. String
<total_objects> Total objects Long
<ingress> Total ingress Long
<egress> Long
<bucket_billing_sample>     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
<tags>
<tag>     0-* Elements
<name> Name String
<ingress> Ingress Long
<egress> Egress Long
</tag>      
</tags>
<next_marker> Next marker String
</bucket_billing_sample>      
<next_marker> Next marker String
</namespace_billing_sample>

Examples

Request
GET https://192.168.0.0:4443/object/billing/namespace/s31/sample?start_time=2015-04-05T01:05&end_time=2015-04-13T08:30&include_bucket_detail=true&auth-redirected  HTTP/1.1

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

<namespace_billing_sample>
	<namespace>s31</namespace>
	<sample_start_time>2015-04-05T01:05:00Z</sample_start_time>
	<sample_end_time>2015-04-13T08:30:00Z</sample_end_time>
	<objects_created>81</objects_created>
	<objects_deleted>0</objects_deleted>
	<bytes_delta>81</bytes_delta>
	<total_size_in_gb>0.0</total_size_in_gb>
	<total_objects>81</total_objects>
	<ingress>1073741975</ingress>
	<egress>40</egress>
	<bucket_billing_sample>
		<namespace>s31</namespace>
		<name>ab111_1</name>
		<vpool_id>
			urn:storageos:ReplicationGroupInfo:caaa9c2c-3d72-43e4-8bd1-cc0eb188aa3c:global
		</vpool_id>
		<sample_start_time>2015-04-05T01:05:00Z</sample_start_time>
		<sample_end_time>2015-04-13T08:30:00Z</sample_end_time>
		<objects_created>71</objects_created>
		<objects_deleted>0</objects_deleted>
		<bytes_delta>71</bytes_delta>
		<total_size_in_gb>0.0</total_size_in_gb>
		<total_objects>71</total_objects>
		<ingress>100</ingress>
		<egress>30</egress>
		</bucket_billing_sample>
	<bucket_billing_sample>
		<namespace>s31</namespace>
		<name>ac_111_1</name>
		<vpool_id>
			urn:storageos:ReplicationGroupInfo:caaa9c2c-3d72-43e4-8bd1-cc0eb188aa3c:global
		</vpool_id>
		<sample_start_time>2015-04-05T01:05:00Z</sample_start_time>
		<sample_end_time>2015-04-13T08:30:00Z</sample_end_time>
		<objects_created>10</objects_created>
		<objects_deleted>0</objects_deleted>
		<bytes_delta>10</bytes_delta>
		<total_size_in_gb>0.0</total_size_in_gb>
		<total_objects>10</total_objects>
		<ingress>1073741875</ingress>
		<egress>10</egress>
		</bucket_billing_sample>
	<next_marker/>
</namespace_billing_sample>
Notes: