Billing:Get Namespace Billing Info

Search (SHIFT+S)

Modified since last release

Get Namespace Billing Info

GET /object/billing/namespace/{namespace}/info

Gets billing details for the specified namespace and bucket details. 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

include_bucket_detail	Optional (default=false). If true, include information about all the buckets owned by this namespace. When bucket details are included, the total size on disk can be different to the total size without bucket details. This is due to bucket size being rounded and summed to give the total size.
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 information about a namespace and its buckets.

Field	Description	Type	Notes
namespace_billing_info
bucket_billing_info			0-* Elements
name	Bucket name	String
namespace	Namespace	String
vpool_id	Replication group	String
total_size	Total size	Double
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
uptodate_till	Time till which the data is consistent. This has an unexpected value during data reconstruction.	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
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	get total provisioned capacity.	String
total_size	get total provisioned capacity.	Double
total_size_unit	gets unit of total provisioned capacity.	String
total_objects	get total provisioned capacity.	Long
namespace	Namespace	String
sample_time	Time at which these data collected using yyyy-MM-dd'T'HH:mm:ss'Z' format	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
valid_namespace	Namespace is valid	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/s3/info 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"?>
<namespace_billing_info>
    <namespace>s3</namespace>
    <total_size>12.4549</total_size>
    <total_objects>-27</total_objects>
    <sample_time>2015-03-01T23:52:49Z</sample_time>
    <total_mpu_size>0.0</total_mpu_size>
    <total_mpu_parts>0</total_mpu_parts>
    <next_marker/>
    <uptodate_till>2017-10-02T03:30:21Z</uptodate_till>
    <total_size_deleted>0.0</total_size_deleted>
    <total_objects_deleted>0</total_objects_deleted>
</namespace_billing_info>

Request

GET https://192.168.0.0:4443/object/billing/namespace/s3/info.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": "s3",
    "total_size": .0024,
    "total_objects": 12,
    "total_mpu_size":"0.0",
    "total_mpu_parts":"0",
    "sample_time": "2015-03-01T23:55:05Z",
    "bucket_billing_info": [],
    "next_marker": ""
    "uptodate_till":"2015-03-01T23:55:05Z",
    "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/namespace/s3/info

Response

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

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<namespace_billing_info>
    <namespace>s3</namespace>
    <total_size>12.4549</total_size>
    <total_objects>-27</total_objects>
    <sample_time>2015-03-01T23:52:49Z</sample_time>
    <total_mpu_size>0.0</total_mpu_size>
    <total_mpu_parts>0</total_mpu_parts>
    <next_marker/>
    <uptodate_till>2017-10-02T03:30:21Z</uptodate_till>
    <total_size_deleted>0.0</total_size_deleted>
    <total_objects_deleted>0</total_objects_deleted>
</namespace_billing_info>