[an error occurred while processing this directive]
Billing:Get Namespace Billing Info

Search (SHIFT+S)




New in this release

Get Namespace Billing Info

POST /object/billing/namespace/info

Retrieves the billing details for a list of namespace's.


Query Parameters

include_bucket_detailOptional (default=false). If true, include information about all the buckets owned by this namespace.
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
<namespace_list>
<id> A list of namespace identifiers String 0-* Elements
</namespace_list>

Response Body

Field Description Type Notes
<namespace_billing_infos>
<namespace_billing_info>     0-* Elements
<bucket_billing_info>     0-* Elements
<name> Bucket name String
<namespace> Namespace String
<vpool_id> Replication group String
<total_size> Total size Long
<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
<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>
</bucket_billing_info>      
<next_marker> get total provisioned capacity. String
<total_size> get total provisioned capacity. Long
<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
</namespace_billing_info>      
</namespace_billing_infos>

Examples

Request
GET https://192.168.0.0:4443/object/billing/namespace/info?include_bucket_detail=true&sizeunit=KB

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

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<namespace_billing_infos>
    <namespace_billing_info>
        <namespace>s3</namespace>
        <total_size>107</total_size>
        <total_size_unit>KB</total_size_unit>
        <total_objects>8</total_objects>
        <sample_time>0</sample_time>
        <bucket_billing_info>
            <name>standalone-bucket</name>
            <vpool_id>urn:storageos:ReplicationGroupInfo:b3bf2d47-d732-457c-bb9b-d260eb53a76a:global</vpool_id>
            <total_size>0</total_size>
            <total_size_unit>KB</total_size_unit>
            <total_objects>2</total_objects>
        </bucket_billing_info>
        <bucket_billing_info>
            <name>standalone-bucket-1</name>
            <vpool_id>urn:storageos:ReplicationGroupInfo:b3bf2d47-d732-457c-bb9b-d260eb53a76a:global</vpool_id>
            <total_size>107</total_size>
            <total_size_unit>KB</total_size_unit>
            <total_objects>6</total_objects>
        </bucket_billing_info>
        <next_marker />
    </namespace_billing_info>
</namespace_billing_infos>
Notes:
[an error occurred while processing this directive]