Cloud Enterprise Object Storage REST API
Search (SHIFT+S)
ECS Management API
ECS Object Service API
ECS API Changes
Modified since last release

Get Namespace Billing Sample

POST /object/billing/namespace/sample

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

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.
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

Response Body

Field Description Type Notes
namespace_billing_sample_infos
namespace_billing_sample_info     0-* Elements
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
POST https://192.168.0.0:4443/object/billing/namespace/sample?start_time=2015-04-05T01:05&end_time=2015-04-13T08:30&include_bucket_detail=true

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_sample_infos>
    <namespace_billing_sample_info>
        <namespace>s3</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>0</objects_created>
        <objects_deleted>0</objects_deleted>
        <bytes_delta>0</bytes_delta>
        <total_size>107.0</total_size>
        <total_size_unit>KB</total_size_unit>
        <total_objects>8</total_objects>
        <total_mpu_size>0.0</total_mpu_size>
        <total_mpu_parts>0</total_mpu_parts>
        <ingress>0</ingress>
        <egress>0</egress>
        <bucket_billing_sample>
            <namespace>s3</namespace>
            <name>standalone-bucket</name>
            <vpool_id>urn:storageos:ReplicationGroupInfo:b3bf2d47-d732-457c-bb9b-d260eb53a76a: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>0</objects_created>
            <objects_deleted>0</objects_deleted>
            <bytes_delta>0</bytes_delta>
            <total_size>0.0</total_size>
            <total_size_unit>KB</total_size_unit>
            <total_objects>2</total_objects>
	    <total_mpu_size>0.0</total_mpu_size>
	    <total_mpu_parts>0</total_mpu_parts>
            <ingress>0</ingress>
            <egress>0</egress>
	    <uptodate_till>2017-10-02T03:30:21Z</uptodata_till>
        </bucket_billing_sample>
        <bucket_billing_sample>
            <namespace>s3</namespace>
            <name>standalone-bucket-1</name>
            <vpool_id>urn:storageos:ReplicationGroupInfo:b3bf2d47-d732-457c-bb9b-d260eb53a76a: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>0</objects_created>
            <objects_deleted>0</objects_deleted>
            <bytes_delta>0</bytes_delta>
            <total_size>107.0</total_size>
            <total_size_unit>KB</total_size_unit>
            <total_objects>6</total_objects>
	    <total_mpu_size>0.0</total_mpu_size>
	    <total_mpu_parts>0</total_mpu_parts>
            <ingress>0</ingress>
            <egress>0</egress>
	    <uptodate_till>2017-10-02T03:30:21Z</uptodata_till>
        </bucket_billing_sample>
        <next_marker></next_marker>
    </namespace_billing_sample_info>
</namespace_billing_sample_infos>
Cloud Enterprise Object Storage REST API v3.6.0.0.126369.160d4eb