List Utilizations¶

Overview¶

Return the daily storage associated with the account.

The data size to be charged is the total of PaddedStorageSizeBytes, MetadataStorageSizeBytes, DeletedStorageSizeBytes, and MinStorageChargeBytes.

Classification¶

List

API Operation Object¶

Wasabi Utilization

Synchronous / Asynchronous¶

Synchronous

Request¶

HTTP Request Method¶

HTTP Request Path¶

If the acct_num in the Request Parameter is unknown, it can be obtained using the List Accounts API.

{api_endpoint}/tenants/{tenant_id}/accounts/{acct_num}/utilizations?from={from}&to={to}&include_regional_utilizations={include_regional_utilizations}

HTTP Request Header¶

Accept: application/json
X-Auth-Token: <token>

Request Parameter¶

Data can be retrieved as far back as the first day of the month 12 months ago.

item	datatype	required/optional	description	format	example
from	String	required	Start Date	YYYY-MM-DD	2021-01-01
to	String	required	End Date	YYYY-MM-DD	2021-02-01
include_regional_utilizations	String	optional	Region Details		true

HTTP Request Body¶

None

Response¶

HTTP Response Header¶

Format¶

HTTP/1.1 200 OK

<response_code>: see "HTTP Responses" section
<message>: message based on the response code

Response Code¶

response code	condition
400	Some content in the request was invalid
401	User must authenticate before making a request
403	Policy does not allow current user to do this operation
404	The requested resource could not be found

HTTP Response Body¶

Format¶

[
  {
    "AcctNum": "<AcctNum>"
    "StartTime": "<StartTime>",
    "EndTime": "<EndTime>",
    "CreateTime": "<CreateTime>",
    "RawStorageSizeBytes": <RawStorageSizeBytes>,
    "PaddedStorageSizeBytes": <PaddedStorageSizeBytes>,
    "MetadataStorageSizeBytes": <MetadataStorageSizeBytes>,
    "DeletedStorageSizeBytes": <DeletedStorageSizeBytes>,
    "MinStorageChargeBytes": <MinStorageChargeBytes>,
    "UploadBytes": <UploadBytes>,
    "DownloadBytes": <DownloadBytes>
    "RegionalUtilizations": [
      {
        "Region": "<Region>",
        "RawStorageSizeBytes": <RawStorageSizeBytes>,
        "PaddedStorageSizeBytes": <PaddedStorageSizeBytes>,
        "MetadataStorageSizeBytes": <MetadataStorageSizeBytes>,
        "DeletedStorageSizeBytes": <DeletedStorageSizeBytes>,
        "UploadBytes": <UploadBytes>,
        "DownloadBytes": <DownloadBytes>
      }
    ]
  }
]

Response Parameter¶

item	datatype	description	example
AcctNum	String	Account Number	12345
StartTime	String	Utilization Start Time	2021-01-01T00:00:00.000Z
EndTime	String	Utilization End Time	2021-01-02T00:00:00.000Z
CreateTime	String	Utilization Create Time	2021-01-02T02:32:23.000Z
RawStorageSizeBytes	Bigint	RawStorageSizeBytes is the number of bytes for all non-deleted objects in the account/bucket	105081
PaddedStorageSizeBytes	Bigint	PaddedStorageSizeBytes is the number of bytes for all non-deleted objects in the account/bucket but with the minimum object size restriction enforced	109167
MetadataStorageSizeBytes	Bigint	MetadataStorageSizeBytes is the number of bytes associated with any metadata about the object that is stored in our databases	294
DeletedStorageSizeBytes	Bigint	DeletedStorageSizeBytes is the number of padded bytes for all deleted objects in the account/bucket	0
MinStorageChargeBytes	Bigint	MinimumBytesSize is the number of bytes that a user should be charged because they are under the 1 TB minimum storage requirement	1099511518315
UploadBytes	Bigint	Uploaded bytes for a given day	4957
DownloadBytes	Bigint	Downloaded bytes for a given day	95822

Sample Request and Response¶

Sample API Request¶

Request URI¶

https://{api_endpoint}/ecl-objectstorage/tenants/{tenant id}/accounts/12345/utilizations?from=2021-01-01&to=2021-01-02&include_regional_utilizations=true

Request Header¶

Content-Type: application/json
Accept: application/json
X-Auth-Token: bf8558c3f5374e25a892c9e0c63a2340

Request Body¶

None

Sample API Response¶

Response Header¶

HTTP/1.1 200 OK
Content-Type: application/json
Date: Thu, 17 Jul 2014 04:21:06 GMT

Response Body¶

[
  {
    "AcctNum": 12345,
    "StartTime": "2021-01-01T00:00:00.000Z",
    "EndTime": "2021-01-02T00:00:00.000Z",
    "CreateTime": "2021-01-02T02:32:23.000Z",
    "RawStorageSizeBytes": 105081,
    "PaddedStorageSizeBytes": 109167,
    "MetadataStorageSizeBytes": 294,
    "DeletedStorageSizeBytes": 0,
    "MinStorageChargeBytes": 1099511518315,
    "UploadBytes": 4957,
    "DownloadBytes": 95822,
    "RegionalUtilizations": [
      {
        "Region": "ap_northeast_1",
        "RawStorageSizeBytes": 105081,
        "PaddedStorageSizeBytes": 109167,
        "MetadataStorageSizeBytes": 294,
        "DeletedStorageSizeBytes": 0,
        "UploadBytes": 4957,
        "DownloadBytes": 95822
      }
    ]
  }
]

2.3. Utilizations API

3. Revision History