Dell Technologies ECS REST API

Search (SHIFT+S)




Modified since last release

Get Bucket Billing Info

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

Gets billing details for the specified namespace and bucket name.

namespaceNamespace containing the bucket
bucketNameBucket name for which billing information needs to be retrieved

Query Parameters

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


Prerequisites

The following conditions must be met in order to call this operation.

  • Namespace and bucket must exist


Response Body

Billing information for the given Bucket and Namespace

Field Description Type Notes
bucket_billing_info
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

Examples

Request
GET https://192.168.0.0:4443/object/billing/buckets/s3/standalone-bucket/info?sizeunit=KB 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"?>
<bucket_billing_info>
    <namespace>s3</namespace>
    <name>standalone-bucket</name>
    <vpool_id>urn:storageos:ReplicationGroupInfo:b3bf2d47-d732-457c-bb9b-d260eb53a76b:global</vpool_id>
    <total_size>12.4549</total_size>
    <total_size_unit>KB</total_size_unit>
    <total_objects>12</total_objects>
    <sample_time>2017-10-02T01:25:51Z</sample_time>
    <total_mpu_size>0.0</total_mpu_size>
    <total_mpu_parts>0</total_mpu_parts>
    <TagSet/>
    <uptodate_till>2017-10-02T01:20:51Z</uptodate_till>
    <total_size_deleted>0.0</total_size_deleted>
    <total_objects_deleted>0</total_objects_deleted>
</bucket_billing_info>