IBM Cloud Object Storage System

https://www.ibm.com/docs/en/coss/3.20.0
Admin
IBM Cloud Object Storage System is a scalable, highly available object storage solution that...
Tokens:760,461
Snippets:8,969
Trust Score:10
Update:4 months ago
Show doc for...
Tokens:
Raw
### Sample GET Request

Source: https://www.ibm.com/docs/en/coss/3.20.0?topic=objects-download-object

An example of a GET request to download an object, including necessary headers like Authorization and Host.

```http
GET /example-bucket/worker-bee HTTP/1.1
Authorization: {authorization-string}
x-amz-date: 20160825T183244Z
Host: 67.228.254.193
```

--------------------------------

### JSON Response Example for Install Upgrade Repository

Source: https://www.ibm.com/docs/en/coss/3.20.0?topic=software-install-upgrade-repository

This is an example of the JSON response received after executing the Install Upgrade Repository API. It includes system upgrade state, repository version, signature verification status, and management device upgrade information.

```json
{
    "responseStatus": "ok",
    "responseHeader": {
        "now": 1517517422962,
        "status": "ok",
        "requestId": "WnN6bqwTDyEAABys3dgAAABl"
    },
    "responseData": {
        "system": {
            "state": "managerUpgradeRequired",
            "repoVersion": "3.13.1",
            "repoSignatureVerified" : true,
            "managementDevices": [
                {
                    "uuid": "5d597d4c-6424-74a1-11ab-825f86979143",
                    "hostname": "vm-eqx20421l-mgr-02",
                    "deviceType": "manager",
                    "deviceHealth": "ok",
                    "version": "3.13.1",
                    "upgradeStatus": null
                }
            ]
        }
    }
}

```

--------------------------------

### Example Request and Response for Account Creation

Source: https://www.ibm.com/docs/en/coss/3.20.0?topic=overview-account-creation

A concrete example showing the request headers and the resulting HTTP response for creating a storage account.

```http
Request
PUT <accesser>:8338/accounts/731fc6f265cd486d900f16e84c5cb594
x-account-sysmeta-tagid: "82443531-09ed-4184-b790-3607543ae79f",
x-account-meta-name: "Company Account"   
x-account-max-container-count: "1000" 

Response
HTTP/1.1 201 CREATED
Content-Length: 63
Content-Type: application/json; charset=utf-8
X-Trans-Id: tx8ea13a3a835544d8bebf1-0056eb522a
X-Account-Max-Container-Count: 1000
Date: Fri, 18 Mar 2016 00:56:10 GMT
X-Timestamp: 1458262564.22774

{    
    "account": {
```

--------------------------------

### Sample GET request for bucket website configuration

Source: https://www.ibm.com/docs/en/coss/3.20.0?topic=buckets-retrieve-bucket-website-configuration

Example of a raw HTTP GET request to retrieve website configuration for a specific container.

```http
GET /testcontainer?website HTTP/1.1
Host: 10.137.13.35
User-Agent: curl/7.64.1
Accept: */*
Date: Thu, 02 Jul 2020 16:03:19 +0000
Authorization: AWS P54EBrPQltNxWl8y0dMD:JpJqfWIWaDkAzA7Rb+X4aZyB8DA=
Content-MD5: 1B2M2Y8AsgTpgAmY7PhCfg==
```

--------------------------------

### Example Output

Source: https://www.ibm.com/docs/en/coss/3.20.0?topic=credential-common-response-parameters

Provides an example of a request and its expected output for creating credentials.

```APIDOC
## Example Output

### Request
```
POST <accesser>:8338/credentials/
{
    "credential": {
        "project_id": "731fc6f265cd486d900f16e84c5cb594",
        "type": "ec2",
        "subject_ibm_id": "IBMid-61KR43CAFF",
        "user_id": "bb5476fd12884539b41d5a88f838d773"
    }
}
```
```

--------------------------------

### Example Account Listing Request and Response

Source: https://www.ibm.com/docs/en/coss/3.20.0?topic=overview-account-listing

This example shows a typical GET request to the accounts endpoint and the corresponding JSON response containing a list of storage account IDs. The response includes standard HTTP headers and a body with an 'accounts' array.

```http
Request

GET <accesser>:8338/accounts

Response
HTTP/1.1 200 OK
Content-Length: 176
Accept-Ranges: bytes
Content-Type: application/json; charset=utf-8
X-Trans-Id: tx8ea13a3a835544d8bebf1-0056eb522a
Date: Fri, 18 Mar 2016 00:56:10 GMT
{
"accounts": [
        {
            "id" : "32af68f229914e328d6e4a5e3ff612cb"
        },
        {
            "id" : "72af68f229914e328d6e4a5e3ff6FFcb"
        }
    ]
}
```

--------------------------------

### Sample request for bucket versioning

Source: https://www.ibm.com/docs/en/coss/3.20.0?topic=buckets-check-if-versioning-is-enabled-bucket

Example of an HTTP GET request to check the versioning status of a bucket named example-bucket.

```http
GET /example-bucket?versioning HTTP/1.1
Host: 67.228.254.193
X-Amz-Date: 20160822T225156Z
Authorization: {authorization-string}
```

--------------------------------

### Create Site JSON Response Example

Source: https://www.ibm.com/docs/en/coss/3.20.0?topic=management-create-site

This is an example of a successful JSON response when creating a site. It includes the response status and the ID of the newly created site.

```JSON
{
  "responseStatus":"ok",
  "responseHeader":{
    "status":"ok",
    "now":{milliseconds from the UNIX epoch},
    "requestId":"U2qeIsCoDicAACV9Ad8AAACH"
  },
  "responseData":{
    "id":9
  }

}
```

--------------------------------

### Create bucket with advanced configuration

Source: https://www.ibm.com/docs/en/coss/3.20.0?topic=management-create-bucket

Demonstrates creating a bucket with ACLs, firewall rules, notifications, and hard quotas.

```HTTP
{
   "storage_location":"us-south", 
   "service_instance":"731fc6f265cd486d900f16e84c5cb594", 
   "acl":[
      { 
       "grantee":"user1", 
       "permission":"WRITE"
      }
   ], 
   "hard_quota":107374182400, 
   "firewall":{ 
       "allowed_ip":[ "192.168.28.100/24", "192.168.25.200/32" ], 
       "denied_ip":[ "192.169.10.100/30" ] 
   },
   "notifications":{ 
      "topic":"my-bucket_topic" 
   }
}
```

```HTTP
HTTP/1.1 201 CREATED 
Content-Length: 263 
Content-Type: application/JSON; charset=utf-8 
X-Trans-Id: tx8ea13a3a835544d8bebf1-0056eb522a 
Date: Fri, 12 Apr 2019 00:56:10 GMT 
X-Timestamp: 1555083117.22774 
{ 
   "storage_location":"us-south", 
   "name":"my-bucket", 
   "service_instance":"731fc6f265cd486d900f16e84c5cb594", 
   "acl":{ 
      "user1":[ "WRITE" ] 
    }, 
   "retention_policy":{ 
      "status":"DISABLED" 
    }, 
   "hard_quota":107374182400, 
   "firewall":{ 
     "allowed_ip":[ "192.168.28.100/24", "192.168.25.200/32" ], 
     "denied_ip":[ "192.169.10.100/30" ] 
    }, 
    "notifications":{ 
        "topic": "my-bucket_topic" 
    },
    "time_created":"2019-04-12T00:56:10Z", 
    "time_updated":"2019-04-12T00:56:10Z" 
}
```

--------------------------------

### Sample Request to List Bucket Objects

Source: https://www.ibm.com/docs/en/coss/3.20.0?topic=buckets-list-versioned-objects-in-bucket

This sample demonstrates a GET request to list objects within the 'example-bucket'. Ensure to replace placeholders with your actual values and include necessary headers like 'Host', 'X-Amz-Date', and 'Authorization'.

```http
GET /example-bucket?versions HTTP/1.1
Content-Type: text/plain
Host: 67.228.254.193
X-Amz-Date: 20160822T225156Z
Authorization: {authorization-string}
```

--------------------------------

### Retrieve access credentials via GET request

Source: https://www.ibm.com/docs/en/coss/3.20.0?topic=credentials-common-response-parameters

Example of a GET request to retrieve credentials for a specific project ID and the corresponding JSON response.

```http
Request
-------
GET <accesser>:8338/credentials/?project_id=6e01855f345f4c59812999b5e459137d

Response
--------
HTTP/1.1 200 OK
Content-Length: 786
Accept-Ranges: bytes
Content-Type: application/json; charset=utf-8
X-Timestamp: 1458262564.22774
X-Trans-Id: tx8ea13a3a835544d8bebf1-0056eb522a
Date: Fri, 18 Mar 2016 00:56:10 GMT
{
    "credentials": [
        {
            "user_id": "bb5476fd12884539b41d5a88f838d773",
            "blob": {"access": "a42a27755ce6442596b049bd7dd8a563", 
                     "secret": "71faf1d40bb24c82b479b1c6fbbd9f0c", 
                     "status": "Active"
            },
            "project_id": "6e01855f345f4c59812999b5e459137d",
            "type": "ec2",
            "subject_ibm_id": "IBMid-61KR43CAFF",
            "id": "a42a27755ce6442596b049bd7dd8a563"
        },
        {
            "user_id": "6f556708d04b4ea6bc72d7df2296b71a",
            "blob": {"access": "7da79ff0aa364e1396f067e352b9b79a", 
                     "secret": "7a18d68ba8834b799d396f3ff6f1e98c", 
                     "status": "Active"
            },
            "project_id": "1a1d14690f3c4ec5bf5f321c5fde3c16",
            "type": "ec2",
            "id": "7da79ff0aa364e1396f067e352b9b79a"
        }
    ]
}
```

--------------------------------

### Example: Slot device with ID 3 into slot 5 of cabinet 4

Source: https://www.ibm.com/docs/en/coss/3.20.0?topic=management-edit-cabinet

This example shows how to rack a specific device (ID 3) into a particular slot (5) of a given cabinet (4).

```console
id=4&slots[5]=device:3
```

--------------------------------

### Prefix Filter Example

Source: https://www.ibm.com/docs/en/coss/3.20.0?topic=buckets-create-bucket-replication-configuration

This filter matches objects whose names start with the specified prefix 'abc/'.

```xml
<Filter>
  <Prefix>abc/</Prefix>
</Filter>
```

--------------------------------

### Example: Rack device 4 and device 5 to slots 6 and 7 or cabinet 8

Source: https://www.ibm.com/docs/en/coss/3.20.0?topic=management-edit-cabinet

This example illustrates how to rack multiple devices (ID 4 and 5) into specific slots (6 and 7) within cabinet 8 simultaneously.

```console
id=8&slots[6]=device:4&slots[7]=device:5
```

--------------------------------

### Sample list objects request

Source: https://www.ibm.com/docs/en/coss/3.20.0?topic=buckets-list-objects-in-given-bucket

Example of a GET request to list objects within a specific bucket.

```http
GET /example-bucket HTTP/1.1
Content-Type: text/plain
Host: 67.228.254.193
X-Amz-Date: 20160822T225156Z
Authorization: {authorization-string}
```

--------------------------------

### Sample Request for Listing Buckets with Pagination

Source: https://www.ibm.com/docs/en/coss/3.20.0?topic=account-list-buckets-pagination-extended-metadata

A sample HTTP request demonstrating how to list buckets with pagination and a marker.

```HTTP
GET 10.132.11.153/?pagination&marker=quota HTTP/1.1
```

--------------------------------

### Sample GET Request

Source: https://www.ibm.com/docs/en/coss/3.20.0?topic=operations-list-buckets-belonging-account

This sample demonstrates the structure of a GET request to list buckets, including necessary headers like Content-Type, Host, X-Amz-Date, and Authorization.

```http
GET 10.132.11.153/ HTTP/1.1
Content-Type: text/plain
Host: 67.228.254.193
X-Amz-Date: 20160822T030815Z
Authorization: {authorization-string}
```

--------------------------------

### Sample Request for Object Legal Hold Status

Source: https://www.ibm.com/docs/en/coss/3.20.0?topic=objects-read-object-lock-legal-hold-status-object

An example of a complete HTTP GET request to check the legal hold status of an object, including Host and Authorization headers.

```http
GET /BucketName/ObjectName?legal-hold&versionId=<VersionID> 
HTTP/1.1 Host: myBucket.mydsNet.corp.com
Date: Wed, 8 Feb 2017 17:50:00 GMT
Authorization: authorization string 
```

--------------------------------

### S3 GET Operation Log Example

Source: https://www.ibm.com/docs/en/coss/3.20.0?topic=specification-http-request-latency-statistics

This JSON object represents a log entry for an S3 GET operation. It includes details such as request type, URI, method, timestamps, status, response length, user agent, request latency, and detailed statistics like pre-transfer, post-transfer, and total transfer times.

```json
{
  "type": "http",
  "principals": {},
  "vault_name": "SmokeS3",
  "request_type": "REST.GET.OBJECT",
  "interface_type": "s3",
  "request_uri": "/s3/SmokeS3/2ed0296fef7e405ba571de44965694620000",
  "request_method": "GET",
  "time_finish": "29/Jan/2016:03:06:17 +0000",
  "time_start": "29/Jan/2016:03:06:17 +0000",
  "timestamp_finish": "1454036777989",
  "timestamp_start": "1454036777901",
  "remote_address": "127.0.0.1",
  "server_name": "localhost",
  "protocol": "HTTP/1.1",
  "status": 200,
  "response_length": "1572864",
  "user_agent": "aws-sdk-java/1.7.5 Linux/3.14.0-0.clevos.1-amd64 OpenJDK_64-Bit_Server_VM/25.45-
    b02/1.8.0_45-internal",
  "request_latency": "88",
  "request_id": "a16df7d2-b7c6-49d2-ac7e-47b3606db760",
  "stat": {
    "post_transfer": 0.052,
    "pre_transfer": 32.931,
    "total_transfer": 54.11,
    "turn_around_time": 84.977,
    "client_wait": 1.281,
    "storage_wait": 52.796
  },
"object_length": "1572864"
}
```

--------------------------------

### HTTP Request and Response Example

Source: https://www.ibm.com/docs/en/coss/3.20.0?topic=servlet-response

Demonstrates a successful HTTP GET request to a status endpoint and its corresponding JSON response. This includes status headers and a detailed body with permit information.

```http
Request  

 GET 10.132.11.153:8337/status

Response 

HTTP/1.1 200 OK

Date: Mon, 13 Feb 2017 19:41:22 GMT

X-Status-Version: 3.0

X-Status-Health: 0

X-Status-Online: true

Content-Length: 35

Server: Jetty(9.2.10.v20150310)

{

  "health": 0,

  "online": true
  "write_permits": {
    "current": "0",
    "max": "98",
    "is_over_threshold": false
  },
  "read_permits": {
    "current": "0",
    "max": "98",
    "is_over_threshold": false
  },
  "query_permits": {
    "current": "0",
    "max": "98",
    "is_over_threshold": false
   },
   "on_heap_permits": {
    "current": "52245298",
    "max": "286418534",
    "is_over_threshold": false
  },
  "off_heap_permits": {
    "current": "131072000",
    "max": "524288000",
    "is_over_threshold": false
  }

}
```

--------------------------------

### Example: Slot generic device called PowerSupply to slot 23 of cabinet 4

Source: https://www.ibm.com/docs/en/coss/3.20.0?topic=management-edit-cabinet

This example demonstrates how to rack a generic device named 'PowerSupply' into slot 23 of cabinet 4.

```console
id=4&slots[23]=generic:PowerSupply
```

--------------------------------

### View System Configuration API Endpoint

Source: https://www.ibm.com/docs/en/coss/3.20.0?topic=administration-view-system-configuration

This section details how to call the View System Configuration API using HTTP GET requests. It includes information on authentication, parameters, and request examples.

```APIDOC
## GET /manager/api/{apiResponseType}/1.0/viewSystemConfiguration.adm

### Description
Retrieves system configuration details for a specified entity type and ID, with options to include related items.

### Method
GET

### Endpoint
`/manager/api/{apiResponseType}/1.0/viewSystemConfiguration.adm`

### Parameters
#### Query Parameters
- **itemType** (string) - Optional - Specifies the type of entity to retrieve configuration for. Valid values include: accesspool, account, cabinet, device, dsnet, group, mirror, site, storagepool, storagepoolgroup, tag, vault, fileserverpool, filesystem, share. If excluded, all default data is returned.
- **id** (long) - Optional - The ID of the item to request. Multiple IDs can be provided for complex relationships.
- **rel** (String) - Optional - Used to query relationships between elements. Format is ITEM.RELATED_ITEMS, e.g., site.devices.

### Request Example
```
curl -u {admin}:{password} \
     -k "https://{manager.dsnet}/manager/api/{apiResponseType}/1.0/viewSystemConfiguration.adm" \
     -d "itemType={type}&id={id}&rel={item}.{relatedItem}"
```

### Response
#### Success Response (200)
- **(Response structure not detailed in source)**

#### Response Example
**(Response example not detailed in source)**
```

--------------------------------

### JSON Example of System Configuration

Source: https://www.ibm.com/docs/en/coss/3.20.0?topic=administration-view-system-configuration

This JSON snippet illustrates a sample configuration for various system services, including authentication, SMTP, backup, LDAP, log collection, device-level API, reports, Cleversafe Insight, and alert forwarding. It shows the structure and typical values for these settings.

```json
{
    "username": "",
    "password": "",
    "tlsEnabled": false,
    "certificatePEM": "",
    "assignments": [
        {
            "item": {
                "type": "vault",
                "uuid": "a3d9e1d4-46c5-7d51-00fd-4b47f6e04c80"
            },
            "topic": "topic3"
        }
    ]
},
"smtp": {
    "creationDate": "Sat, 31 Oct 2015 13:52:28 -0500",
    "timestamp":"1448934321000",
    "enabled": true,
    "host": "mail.company.com",
    "port": 25,
    "from": "test@company.com",
    "secure": false,
    "authenticated": false,
    "username": null,
    "testAddress": "admin@company.com"
},
"backup": {
    "creationDate": "Tue, 22 Sep 2015 21:05:17 -0500",
    "timestamp":"1448934321000", 
    "backupPassword": "password",
    "safekeepEnabled": true,
    "scheduled": false,
    "schedule": null,
    "protocol": null,
    "hostname": null,
    "username": null,
    "path": null,
    "filenamePattern": "dsnet-manager"
},
"ldap": {
    "creationDate": "Mon, 30 Nov 2015 19:51:05 -0600",
    "timestamp":"1448934321000",
    "ldapType": "activeDirectory",
    "domain": "company.com",
    "providerUrl": "ldaps://123.company.com",
    "enabled": true,
    "bindWithUsername": true,
    "searchAuthenticated": false,
    "searchBindUsername": null,
    "searchBindPassword": null,
    "accountClass": "person",
    "searchBase": "DC=company,DC=com",
    "searchUsernameAttribute": "userPrincipalName",
    "searchUsernameAttributeHasDomain": true,
    "displayNameAttribute": "displayName",
    "emailAttribute": "mail",
    "groupEnabled": true,
    "groupsOnAttribute": true,
    "groupsAttributeName": "memberOf",
    "groupClass": "group",
    "groupMemberAttribute": "member",
    "groupSearchBase": "DC=company,DC=com",
    "groupMemberValueDN": true,
    "certificates": [
        1
    ]
},
"logCollection": {
    "logProtocol": "http",
    "logHostname": "logs.company.com",
    "logUsername": null,
    "logPath": "/Logs/alex/",
    "httpPort": 80,
    "httpSecure": false,
    "httpAuthenticated": false,
    "httpProxyEnabled": false,
    "isManagerProxy": false,
    "httpProxyHostname": null,
    "httpProxyAuthenticated": false,
    "httpProxyUsername": null,
    "httpProxyPort": 80,
    "logScheduled": false,
    "logSchedule": null,
    "categories": []
},
"deviceLevelAPI": {
    "enabled": true,
    "deviceTypes": [
        {
            "deviceType": "manager"
        },
        {
            "deviceType": "accesser"
        },
        {
            "deviceType": "slicestor"
        }
    ]
},
"reports": {
    "reportScheduled": false,
    "reportSchedule": null
},
"httpAuth": null,
"cleversafeInsight": {
    "enabled": true,
    "schedule": "0 0 1 * * ?",
    "proxyEnabled": false,
    "anonymizationEnabled": true
},
"alertForward": {
    "enabled": true,
    "deviceTypes": [
        {
            "deviceType": "manager"
        },
        {
            "deviceType": "accesser"
        }
    ],
    "snmpNotificationType": "inform",
    "snmpVersion": "v3",
    "usmUser": {
       "securityLevel": "authPriv",
       "username": "user1",
       "authenticationProtocol": "SHA1",
       "authenticationPassword": "password",
       "privacyProtocol": "AES256",
       "privacyPassword": "password"
     },
    "alertCommunityString": null,
    "ipHostnameSnmpNotification": [
        {
}
```

--------------------------------

### Sample Request for Incomplete Multipart Uploads

Source: https://www.ibm.com/docs/en/coss/3.20.0?topic=buckets-list-canceledincomplete-multipart-uploads-bucket

Example of an HTTP GET request to retrieve all current canceled and incomplete multipart uploads for a bucket. Ensure proper authorization and host headers are included.

```http
GET /example-bucket?uploads= HTTP/1.1
Authorization: {authorization-string}
x-amz-date: 20161011T190354Z
Host: 67.228.254.193
```

--------------------------------

### Example account listing request and response

Source: https://www.ibm.com/docs/en/coss/3.20.0?topic=overview-specific-account-listing

A sample request and the corresponding JSON response for a specific storage account.

```http
Request
GET <accesser>:8338/accounts/731fc6f265cd486d900f16e84c5cb594

Response
HTTP/1.1 200 OK
Content-Length: 158
Accept-Ranges: bytes
X-Account-Object-Count: 0
X-Timestamp: 1458262564.22774
X-Account-Bytes-Used: 0
X-Account-Container-Count: 3
X-Account-Max-Container-Count: 1000
X-Account-Status: ENABLED
Content-Type: application/json; charset=utf-8
X-Trans-Id: txa214ce1fb3614b6aa15e1-0056ec0f3c
Date: Fri, 18 Mar 2016 14:22:52 GMT
{
    "account": {
        "storage_location": [
            {
```

--------------------------------

### Rebuilder Adaptive System Behavior Example

Source: https://www.ibm.com/docs/en/coss/3.20.0?topic=agents-rebuild

Illustrates the adaptive behavior of the Rebuilder, showing how its activity decreases in response to increased client I/O and increases when client I/O reduces, without negatively impacting client operations. The Rebuilder samples performance frequently to adapt to changes.

```text
Example: Rebuilder Adaptive System Behavior

The Rebuilder’s adaptive behavior changes in response to client I/O operations (indicated 
in green). When client operations increase, the Rebuilder decreases. When client 
operations reduces activity, the Rebuilder increases its activity as much as possible 
without negatively impacting to client operations. The Rebuilder samples performance 
many times a second to respond to changes in client operations.

In the figure below, when I/O increases suddenly, the rebuilding rate decreases rapidly, 
to enable the client activity to achieve its maximum level of I/O.

```

--------------------------------

### Sample Request for Object Lock Retention

Source: https://www.ibm.com/docs/en/coss/3.20.0?topic=objects-read-object-lock-retention-object

An example of a complete HTTP GET request to fetch Object Lock retention details for an object, including necessary headers like Host, Date, and Authorization.

```http
GET /BucketName/ObjectName?retention&versionId=<VersionID> 
HTTP/1.1 Host: myBucket.mydsNet.corp.com
Date: Wed, 8 Feb 2017 17:50:00 GMT
Authorization: authorization string 
```

--------------------------------

### Example Configure Accesser API Request

Source: https://www.ibm.com/docs/en/coss/3.20.0?topic=administration-configure-accesser-api

This example demonstrates a POST request to the configureAccesserAPI endpoint. It includes setting the global protocol type to S3 and specific protocols for devices 3 and 188. It also shows how to configure access service ports for HTTP and HTTPS.

```http
POST /manager/api/json/1.0/configureAccesserAPI.adm HTTP/1.1
Host: http://localhost:8080

globalAccesserProtocolType=s3
&individualAccesserProtocolType[3]=openstack
&individualAccesserProtocolType[188]=s3
&accessServicePorts[http]=80
&accessServicePorts[http]=8080
&accessServicePorts[https]=443
&accessServicePorts[https]=8443
```

--------------------------------

### Get Historic Usage by Storage Account

Source: https://www.ibm.com/docs/en/coss/3.20.0?topic=management-historic-usage-by-storage-account

Retrieves daily usage metrics for a storage account between a specified start and end date. The response includes total byte hours and object hours, as well as a breakdown by storage location.

```APIDOC
## GET /storage/account/usage

### Description
Retrieves historic usage metrics for a specified storage account within a given date range. The response includes daily usage metrics, total byte hours, total object hours, and a breakdown of usage by storage location.

### Method
GET

### Endpoint
/storage/account/usage

### Parameters
#### Query Parameters
- **account_name** (string) - Required - The name of the storage account.
- **start_date** (Date) - Required - The earliest date for which to retrieve usage data in YYYY-MM-DD format.
- **end_date** (Date) - Required - The latest date for which to retrieve usage data in YYYY-MM-DD format.

### Response
#### Success Response (200 OK)
- **account_name** (string) - The name of the storage account.
- **start_date** (Date) - The earliest date included in the response.
- **end_date** (Date) - The latest date included in the response.
- **daily_usage_metrics** (List of Daily Usage Metrics) - A list of daily usage metrics for the specified storage account. Each entry corresponds to a day with available historic usage data. An empty list indicates no historic usage data was found within the specified date range. Historic usage is not reported for the current date.

##### Daily Usage Metrics Structure:
- **date** (Date) - The day (YYYY-MM-DD format) for this entry. Midnight-aligned in UTC.
- **total_byte_hours** (Integer) - The total byte hours across all containers for the specified storage account. This number is unbounded.
- **total_object_hours** (Integer) - The total object hours across all containers for the specified storage account. This number is unbounded.
- **storage_location_specific_usage** (List of Storage Location Specific Usage) - A list of historic usage broken down by Container Vault.

###### Storage Location Specific Usage Structure:
- **storage_location_id** (UUID) - The UUID of the container vault for this entry.
- **byte_hours** (Integer) - The byte hours for containers owned by the given storage account and belonging to the specified storage_location_id. This number is unbounded.
- **object_hours** (Integer) - The object hours for containers owned by the given storage account and belonging to the specified storage_location_id. This number is unbounded.

#### Error Response (400 Bad Request)
- Description: There is a syntax or semantic error with the request. Please see the response body for the specifics.

#### Error Response (403 Forbidden)
- Description: The user does not have the proper permissions to access the Service API.

#### Error Response (404 Not Found)
- Description: The specified account was not found on the system.
```

--------------------------------

### S3 DELETE Operation Log Example

Source: https://www.ibm.com/docs/en/coss/3.20.0?topic=specification-http-request-latency-statistics

This JSON object illustrates a log entry for an S3 DELETE operation. It contains similar fields to the GET operation log, including request details, timestamps, status, and latency, along with specific fields for delete operations like delete_marker and version information.

```json
{
  "type": "http",
  "principals": {},
  "vault_name": "SmokeS3",
  "request_type": "REST.DELETE.OBJECT",
  "object_name": "463ea6aa89ac41668adb69108d2f9b570000",
  "delete_marker": false,
  "version_transient": true,
  "version_name": "b8ad7307-81b0-4487-8f06-8aed2459b7ba",
  "interface_type": "s3",
  "request_uri": "/s3/SmokeS3/463ea6aa89ac41668adb69108d2f9b570000",
  "request_method": "DELETE",
  "time_finish": "29/Jan/2016:04:00:55 +0000",
  "time_start": "29/Jan/2016:04:00:55 +0000",
  "timestamp_finish": "1454040055733",
  "timestamp_start": "1454040055570",
  "remote_address": "127.0.0.1",
  "server_name": "localhost",
  "protocol": "HTTP/1.1",  
  "status": 204,
  "response_length": "0",
  "user_agent": "aws-sdk-java/1.7.5 Linux/3.14.0-0.clevos.1-amd64 OpenJDK_64-Bit_Server_VM/25.45-
    b02/1.8.0_45-internal",
  "request_latency": "163",
  "request_id": "9474592e-b2f9-477f-8a0b-843b4ae5f4bf",
  "stat": {
    "post_transfer": 0.04,
    "pre_transfer": 0.072,
    "total_transfer": 162.841,
    "turn_around_time": 162.882,
    "commit": 162.841,
    "digest": 0,
    "storage_wait": 0,
    "client_wait": 0
  },
"object_length": "1572864"
}
```

--------------------------------

### Sample Request to Enable Versioning

Source: https://www.ibm.com/docs/en/coss/3.20.0?topic=buckets-set-up-bucket-versioning

This sample demonstrates the HTTP request to enable versioning on a bucket. Ensure all required headers, including Authorization and Content-SHA256, are correctly provided.

```http
PUT /example-bucket?versioning HTTP/1.1
Authorization: {authorization-string}
x-amz-date: 20161011T190354Z
Host: 67.228.254.193
x-amz-content-sha256: f4edcce17375eba17a48c19e272604dfcfb6723c04eb18bc4aa4ce8567c196a2
Content-Type: text/plain; charset=utf-8
Content-Length: 124
```

```xml
<VersioningConfiguration xmlns="http://s3.amazonaws.com/doc/2006-03-01/">
  <Status>Enabled</Status>
</VersioningConfiguration>
```
Tokens:
Raw