Skip to content
/buckets

Object Storage REST APIs. (1.0.0)

Object Storage REST APIs.

Download OpenAPI description
object-storage-api.json
object-storage-api.yaml
Overview
License

HPE End User License Agreement

Languages
Servers

https://eu1.data.cloud.hpe.com/

https://us1.data.cloud.hpe.com/

https://jp1.data.cloud.hpe.com/

Mock server

https://developer.greenlake.hpe.com/_mock/docs/greenlake/services/object-storage/public/openapi/object-storage-public-v1alpha1/object-storage-api/

access-policies

The Access Policies API provides endpoints for creating, managing, and configuring access policies.

Operations

buckets

The Buckets API provides endpoints for creating, managing, and configuring storage buckets. Buckets are containers for organizing and storing data, and this API allows full control over their lifecycle, including creation, updates, retrieval, and deletion.

Operations

Get all buckets for HPE Alletra Storage MP X10000 ObjectStore

Request

Retrieves a list of buckets associated with a specific HPE Alletra Storage MP X10000 ObjectStore. The results can be filtered, sorted, and paginated using query parameters to customize the response based on your requirements.

Security
bearer
Path
systemIdstringrequired

A unique identifier assigned to each object service device

Example: 8UW0002928
Query
filterstring

oData query to filter bucket by Key.

Example: filter=id eq "abc"
limitinteger[ 0 .. 5000 ]

Number of items to return at a time

Default 100
Example: limit=10
offsetinteger[ 0 .. 100000 ]

The offset of the first item in the collection to return

Default 0
Example: offset=5
selectstring

A query to retrieve only the specified parameters. Use . to denote nested fields.

Example: select=id
sortstring

A list of properties defining the sort order. This takes a single property name followed by the direction to sort in, separated by a space. The supported properties are systemUid, id and generation. If not specified, the default behaviour is to sort by generation. The supported directions are asc and desc for ascending and descending respectively.

Default "generation desc"
Example: sort=id desc
curl -i -X GET \
  https://eu1.data.cloud.hpe.com/object-storage/v1alpha1/devtype7-storage-systems/8UW0002928/buckets \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Success

Bodyapplication/json
countintegerrequired

Number of items in this response.

offsetintegerrequired

The offset query parameter from the request.

itemsArray of objects(Buckets)required
items[].​idstringrequired

id of the bucket

Example: "id1"
items[].​typestringrequired

Type of resource

items[].​bucketTagsArray of objects or null(BucketTags)
items[].​commonResourceAttributesobject or null(CommonResourceAttributes)
items[].​compressionboolean

Field to check if compression is enabled or disabled

Example: false
items[].​createdAtstring
items[].​customerIdstring

The customer application identifier

Example: "fc5f41652a53497e88cdcebc715cc1sd"
items[].​generationinteger(Uint64)
items[].​namestring

Name of the bucket

Example: "myBucketName"
items[].​systemUidstring

systemUid where the bucket is created

Example: "system1"
totalinteger

Total number of items matching the filter parameter in the request.

Response
application/json
{
  "count": 0,
  "offset": 0,
  "total": 0,
  "items": [
    { … }
  ]
}

Create new bucket in HPE Alletra Storage MP X10000 ObjectStore

Request

Create new bucket in HPE Alletra Storage MP X10000 ObjectStore identified by {systemId}

Security
bearer
Path
systemIdstringrequired

A unique identifier assigned to each object service device

Example: 8UW0002928
Bodyapplication/json
namestringrequired

Name of the bucket to be created

Example: "myBucketName"
bucketTagsArray of objects or null(BucketTags)
compressionstring

Field to enable or disable compression for the bucket

Enum"ENABLED""DISABLED"
Example: "DISABLED"
curl -i -X POST \
  https://eu1.data.cloud.hpe.com/object-storage/v1alpha1/devtype7-storage-systems/8UW0002928/buckets \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "myBucketName"
  }'

Responses

Accepted

Headers
Locationstring

This contains the URI of the task used to monitor the request

Bodyapplication/json
taskUristringrequired

Task URI which can be used to monitor the status of the operation.

Example: "/rest/vega/v1/tasks/4969a568-6fed-4915-bcd5-e4566a75e00c"
messagestring

Task Message.

Example: "Successfully submitted"
statusstring

Status of the task.

Example: "SUBMITTED"
Response
application/json
{
  "message": "Successfully submitted",
  "status": "SUBMITTED",
  "taskUri": "/rest/vega/v1/tasks/4969a568-6fed-4915-bcd5-e4566a75e00c"
}

Delete bucket from HPE Alletra Storage MP X10000 ObjectStore

Request

Delete bucket from HPE Alletra Storage MP X10000 ObjectStore identified by {bucketId}

Security
bearer
Path
systemIdstringrequired

A unique identifier assigned to each object service device

Example: 8UW0002928
bucketIdstringrequired

A unique identifier assigned to each bucket created in the ObjectStore

Example: bucket1
curl -i -X DELETE \
  https://eu1.data.cloud.hpe.com/object-storage/v1alpha1/devtype7-storage-systems/8UW0002928/buckets/bucket1 \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Accepted

Headers
Locationstring

This contains the URI of the task used to monitor the request

Bodyapplication/json
taskUristringrequired

Task URI which can be used to monitor the status of the operation.

Example: "/rest/vega/v1/tasks/4969a568-6fed-4915-bcd5-e4566a75e00c"
messagestring

Task Message.

Example: "Successfully submitted"
statusstring

Status of the task.

Example: "SUBMITTED"
Response
application/json
{
  "message": "Successfully submitted",
  "status": "SUBMITTED",
  "taskUri": "/rest/vega/v1/tasks/4969a568-6fed-4915-bcd5-e4566a75e00c"
}

Get single HPE Alletra Storage MP X10000 ObjectStore bucket

Request

Get HPE Alletra Storage MP X10000 ObjectStore bucket identified by {bucketId}

Security
bearer
Path
systemIdstringrequired

A unique identifier assigned to each object service device

Example: 8UW0002928
bucketIdstringrequired

A unique identifier assigned to each bucket created in the ObjectStore

Example: bucket1
Query
selectstring

A query to retrieve only the specified parameters. Use . to denote nested fields.

Example: select=id
curl -i -X GET \
  https://eu1.data.cloud.hpe.com/object-storage/v1alpha1/devtype7-storage-systems/8UW0002928/buckets/bucket1 \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Success

Bodyapplication/json
idstringrequired

id of the bucket

Example: "id1"
typestringrequired

Type of resource

bucketTagsArray of objects or null(BucketTags)
commonResourceAttributesobject or null(CommonResourceAttributes)
compressionboolean

Field to check if compression is enabled or disabled

Example: false
createdAtstring
customerIdstring

The customer application identifier

Example: "fc5f41652a53497e88cdcebc715cc1sd"
generationinteger(Uint64)
namestring

Name of the bucket

Example: "myBucketName"
systemUidstring

systemUid where the bucket is created

Example: "system1"
Response
application/json
{
  "bucketTags": [
    { … }
  ],
  "commonResourceAttributes": {
    "cloudState": "CONNECTED",
    "errCode": "E01",
    "errMessage": "This storage system is not actively monitored in the cloud portal. Data Services Cloud Console proactively disabled monitoring and management of storage system with serial number {systemId} for sending excessive cloud events or for not responding to requests."
  },
  "compression": false,
  "createdAt": "string",
  "customerId": "fc5f41652a53497e88cdcebc715cc1sd",
  "generation": 0,
  "id": "id1",
  "name": "myBucketName",
  "systemUid": "system1",
  "type": "string"
}

Edit the properties of an existing bucket in HPE Alletra Storage MP X10000 ObjectStore

Request

Edit bucket properties in HPE Alletra Storage MP X10000 ObjectStore identified by {systemId} and {bucketId}

Security
bearer
Path
systemIdstringrequired

A unique identifier assigned to each object service device

Example: 8UW0002928
bucketIdstringrequired

A unique identifier assigned to each bucket created in the ObjectStore

Example: bucket1
Bodyapplication/jsonrequired
bucketTagsArray of objects or null(BucketTags)
compressionstring

Field to enable or disable compression for the bucket

Enum"ENABLED""DISABLED"
Example: "DISABLED"
curl -i -X PUT \
  https://eu1.data.cloud.hpe.com/object-storage/v1alpha1/devtype7-storage-systems/8UW0002928/buckets/bucket1 \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{}'

Responses

Accepted

Headers
Locationstring

This contains the URI of the task used to monitor the request

Bodyapplication/json
taskUristringrequired

Task URI which can be used to monitor the status of the operation.

Example: "/rest/vega/v1/tasks/4969a568-6fed-4915-bcd5-e4566a75e00c"
messagestring

Task Message.

Example: "Successfully submitted"
statusstring

Status of the task.

Example: "SUBMITTED"
Response
application/json
{
  "message": "Successfully submitted",
  "status": "SUBMITTED",
  "taskUri": "/rest/vega/v1/tasks/4969a568-6fed-4915-bcd5-e4566a75e00c"
}

Get capacity trend data of buckets

Request

Get capacity trend data of buckets

Security
bearer
Path
systemIdstringrequired

A unique identifier assigned to each object service device

Example: 8UW0002928
bucketIdstringrequired

A unique identifier assigned to each bucket created in the ObjectStore

Example: bucket1
Query
rangestring

The range specifies the start and end time for executing the query.

Example: range=startTime eq 1605063600 and endTime eq 1605186000
time-interval-mininteger

It defines granularity in minutes.

Enum5601440
curl -i -X GET \
  https://eu1.data.cloud.hpe.com/object-storage/v1alpha1/devtype7-storage-systems/8UW0002928/buckets/bucket1/capacity-history \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Success

Bodyapplication/json
countintegerrequired

Number of items in this response.

offsetintegerrequired

The offset query parameter from the request.

itemsArray of objects or null(BucketCapacityHistory)required
items[].​idstringrequired

ID of the bucket

Example: "bucket1"
items[].​typestringrequired

Type of the resource

Example: "bucket"
items[].​capacityDataobject or null(BucketsCapacityHistoricalMetricData)
items[].​endTimeinteger or null

End time for historical data.

Example: 162564271
items[].​startTimeinteger or null

Start time for historical data.

Example: 1625556314
totalinteger

Total number of items matching the filter parameter in the request.

Response
application/json
{
  "count": 0,
  "offset": 0,
  "total": 0,
  "items": [
    { … }
  ]
}

groups

The Groups API provides endpoints for creating, managing, and configuring groups.

Operations

users

The Users API provides endpoints for creating, managing, and configuring users.

Operations