Billing:Get Namespace Billing Sample

Search (SHIFT+S)

Modified since last 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.

namespace	Namespace to get information about

Query Parameters

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

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.	Double
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
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
next_marker	Next marker	String
total_mpu_size	Total MPU size	Double
total_mpu_parts	Total MPU parts	Long
uptodate_till	Time till which the data is consistent. This has an unexpected value during data reconstruction.	String
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/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>0.0</total_size>
	<total_objects>81</total_objects>
	<total_mpu_size>0.0</total_mpu_size>
    <total_mpu_parts>0</total_mpu_parts>
	<ingress>1073741975</ingress>
	<egress>40</egress>
	<bytes_deleted>0.0</bytes_deleted>
    <total_size_deleted>0.0</total_size_deleted>
    <total_objects_deleted>0</total_objects_deleted>
	<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>0.0</total_size>
		<total_objects>71</total_objects>
		<total_mpu_size>0.0</total_mpu_size>
        <total_mpu_parts>0</total_mpu_parts>
		<ingress>100</ingress>
		<egress>30</egress>
		<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>
	<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>0.0</total_size>
		<total_objects>10</total_objects>
		<total_mpu_size>0.0</total_mpu_size>
	    <total_mpu_parts>0</total_mpu_parts>
		<ingress>1073741875</ingress>
		<egress>10</egress>
		<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>
	<next_marker/>
	<uptodate_till>2017-10-02T03:30:21Z</uptodate_till>
</namespace_billing_sample>

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.json HTTP/1.1 

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

Response

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

{
  "namespace_billing_sample": {
    "namespace": "s31",
    "sample_start_time": "2015-04-05T01:05:00Z",
    "sample_end_time": "2015-04-13T08:30:00Z",
    "objects_created": "81",
    "objects_deleted": "0",
    "bytes_delta": "81",
    "total_size": "0.0",
    "total_objects": "81",
    "total_mpu_size":"0.0",
    "total_mpu_parts":"0",
    "ingress": "1073741975",
    "egress": "40",
    "uptodate_till":"2015-04-13T08:30:00Z",
    "bytes_deleted": "0.0",
    "total_objects_deleted": "0",
    "total_size_deleted": "0.0"
    "bucket_billing_sample": [
      {
        "namespace": "s31",
        "name": "ab111_1",
        "vpool_id": "
			urn:storageos:ReplicationGroupInfo:caaa9c2c-3d72-43e4-8bd1-cc0eb188aa3c:global
		",
        "sample_start_time": "2015-04-05T01:05:00Z",
        "sample_end_time": "2015-04-13T08:30:00Z",
        "objects_created": "71",
        "objects_deleted": "0",
        "bytes_delta": "71",
        "total_size": "0.0",
        "total_objects": "71",
        "total_mpu_size":"0",
        "total_mpu_parts":"0",
        "ingress": "100",
        "egress": "30",
        "uptodate_till":"2015-04-13T08:30:00Z",
        "bytes_deleted": "0.0",
        "total_objects_deleted": "5",
        "total_size_deleted": "50"
      },
      {
        "namespace": "s31",
        "name": "ac_111_1",
        "vpool_id": "
			urn:storageos:ReplicationGroupInfo:caaa9c2c-3d72-43e4-8bd1-cc0eb188aa3c:global
		",
        "sample_start_time": "2015-04-05T01:05:00Z",
        "sample_end_time": "2015-04-13T08:30:00Z",
        "objects_created": "10",
        "objects_deleted": "0",
        "bytes_delta": "10",
        "total_size": "0.0",
        "total_objects": "10",
        "total_mpu_size":"0",
        "total_mpu_parts":"0",
        "ingress": "1073741875",
        "egress": "10",
        "uptodate_till":"2015-04-13T08:30:00Z",
        "bytes_deleted": "0.0",
        "total_objects_deleted": "5",
        "total_size_deleted": "50"
      }
    ]
  }
}

Request

curl -H $token -H "Content-Type: application/xml" -X GET https://$nodeIp:4443/object/billing/namespace/s31/sample?start_time=2015-04-05T01:05&end_time=2015-04-13T08:30&include_bucket_detail=true&auth-redirected

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>0.0</total_size>
	<total_objects>81</total_objects>
	<total_mpu_size>0.0</total_mpu_size>
    <total_mpu_parts>0</total_mpu_parts>
	<ingress>1073741975</ingress>
	<egress>40</egress>
	<bytes_deleted>0.0</bytes_deleted>
    <total_size_deleted>0.0</total_size_deleted>
    <total_objects_deleted>0</total_objects_deleted>
	<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>0.0</total_size>
		<total_objects>71</total_objects>
		<total_mpu_size>0.0</total_mpu_size>
        <total_mpu_parts>0</total_mpu_parts>
		<ingress>100</ingress>
		<egress>30</egress>
		<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>
	<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>0.0</total_size>
		<total_objects>10</total_objects>
		<total_mpu_size>0.0</total_mpu_size>
	    <total_mpu_parts>0</total_mpu_parts>
		<ingress>1073741875</ingress>
		<egress>10</egress>
		<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>
	<next_marker/>
	<uptodate_till>2017-10-02T03:30:21Z</uptodate_till>
</namespace_billing_sample>