This page covers configuration and management of View storage pool objects.
Object Overview
Storage pools define where physical data written to object storage buckets resides.
Endpoint, URL, and Supported Methods
Objects are managed via the storage server API at [http|https]://[hostname]:[port]/v1.0/tenants/[tenant-guid]/pools
.
By default, the storage server is accessible on port 8001
for the View REST API, and 8002
for the S3-compatible API. Note: storage pools are not manageable via the S3 API.
Supported methods include: GET
HEAD
PUT
DELETE
Structure
Storage pool objects can have one of many structures depending on the type of storage pool. Currently, local disk, Amazon S3, and Azure BLOB storage pools can be configured. For assistance with configuring an Amazon S3 storage pool or an Azure BLOB storage pool, contact support.
A fully populated storage pool using local disk is shown below.:
{
"GUID": "default",
"TenantGUID": "default",
"Name": "default",
"Provider": "Disk",
"WriteMode": "GUID",
"UseSsl": false,
"DiskDirectory": "./disk/",
"Compress": "None",
"EnableReadCaching": false,
"CreatedUtc": "2024-07-10T05:09:32.000000Z"
}
Properties:
GUID
string
globally unique identifier for the objectTenantGUID
string
globally unique identifier for the tenantName
string
name of the objectProvider
enum
provider of the storage pool; this value should beDisk
UseSsl
bool
used by Amazon S3 and Azure BLOB storage poolsDiskDirectory
string
relative or full path to the disk repository where data should be storedCompress
enum
the type of compression to apply; this value should beNone
EnableReadCaching
bool
enable or disable read caching; this value should befalse
CreatedUtc
datetime
timestamp from creation, in UTC time
Create
To create, call PUT /v1.0/tenants/[tenant-guid]/pools
with the properties of the storage pool as defined above, using the storage server.
Note: once a storage pool has been written, it cannot be updated.
curl -X PUT http://localhost:8001/v1.0/tenants/[tenant-guid]/pools \
-H "Content-Type: application/json" \
-H "Authorization: Bearer [accesskey]" \
-d '
{
"Name": "My disk storage pool",
"Provider": "Disk",
"WriteMode": "GUID",
"UseSsl": false,
"DiskDirectory": "./disk/",
"Compress": "None",
"EnableReadCaching": false
}'
Read
To read an object by GUID, call GET /v1.0/tenants/[tenant-guid]/pools/[pool-guid]
which will return a singleton. To read all, call GET /v1.0/tenants/[tenant-guid]/pools
which will return an array.
If the object exists, it will be returned as a JSON object in the response body. If it does not exist, a 404 will be returned with a NotFound
error response.
[
{
"GUID": "default",
"TenantGUID": "default",
"Name": "default",
"Provider": "Disk",
"WriteMode": "GUID",
"UseSsl": false,
"DiskDirectory": "./disk/",
"Compress": "None",
"EnableReadCaching": false,
"CreatedUtc": "2024-07-10T05:09:32.000000Z"
}
]
Note: the HEAD
method can be used as an alternative to get to simply check the existence of the object. HEAD
requests return either a 200/OK
in the event the object exists, or a 404/Not Found
if not. No response body is returned with a HEAD
request.
Delete
To delete an object by GUID, call DELETE /v1.0/tenants/[tenant-guid]/pools/[pools-guid]