Skip to content

HPE Greenlake For Object Storage REST APIs. (1.2.0)

HPE Greenlake For 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

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

bucket-performance

Operations

protectionPolicy

Operations

Get all protection policy for HPE Alletra Storage MP X10000 ObjectStore

Request

Get all protection policy for HPE Alletra Storage MP X10000 ObjectStore

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/protection-policies \
  -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(ProtectionPolicies)required
items[].​idstringrequired

Id of the Protection policy. Filter, Sort

Example: "id1"
items[].​typestringrequired

Type of resource

items[].​commonResourceAttributesobject or null(CommonResourceAttributes)
items[].​creationTimeMsstring
items[].​customerIdstring

The customer application identifier

Example: "fc5f41652a53497e88cdcebc715cc1sd"
items[].​destinationBucketstring

Destination bucket name. Filter, Sort

Example: "buck1"
items[].​destinationBucketUuidstring

Destination bucket UUID. Filter

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

A number that changes every time the resource is modified. This can be used to determine if the local representation of a resource is more up to date. Filter, Sort

items[].​modificationTimeMsstring
items[].​namestring

Name of the Protection policy. Filter, Sort

Example: "myPolicyName"
items[].​partnerstring

Partner system name to which the destination bucket belongs. Filter, Sort

Example: "sys1"
items[].​protectionConfigTypestring

Type of protection configuration

Example: "s3"
items[].​s3Configurationobject or null(s3ConfigStatus)
items[].​sourceBucketstring

Source bucket name for which the protection policy is created. Filter, Sort

Example: "buck1"
items[].​sourceBucketUuidstring

Source bucket UUID for which the protection policy is created. Filter

Example: "buck1"
items[].​systemUidstring

systemUid where the protection policy 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 protection policies in HPE Alletra Storage MP X10000 ObjectStore

Request

Create new protection policies 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 Protection Policy to be created

Example: "mypolicy1"
sourceBucketstringrequired

Source bucket name for which the protection policy needs to be created

Example: "mybuck"
destinationBucketstringrequired

Destination bucket name

Example: "mybuck1"
partnerstringrequired

Name of the Partner system to which the destination bucket belongs

Example: "hf-system1"
typestringrequired

Type of the protection policy. 'Possible values: s3'

Example: "s3"
s3Configurationobject or null(s3ConfigStatusInput)
curl -i -X POST \
  https://eu1.data.cloud.hpe.com/object-storage/v1alpha1/devtype7-storage-systems/8UW0002928/protection-policies \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "destinationBucket": "mybuck1",
    "name": "mypolicy1",
    "partner": "hf-system1",
    "sourceBucket": "mybuck",
    "type": "s3"
  }'

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 protection policy from HPE Alletra Storage MP X10000 ObjectStore

Request

Delete protection policy from HPE Alletra Storage MP X10000 ObjectStore identified by {protectionPolicyId}

Security
bearer
Path
systemIdstringrequired

A unique identifier assigned to each object service device

Example: 8UW0002928
policyIdstringrequired

ID unique to every Protection Policy created in objectstore

Example: policy1
curl -i -X DELETE \
  https://eu1.data.cloud.hpe.com/object-storage/v1alpha1/devtype7-storage-systems/8UW0002928/protection-policies/policy1 \
  -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 protection policy

Request

Get HPE Alletra Storage MP X10000 ObjectStore protection policy identified by {protectionPolicyId}

Security
bearer
Path
systemIdstringrequired

A unique identifier assigned to each object service device

Example: 8UW0002928
policyIdstringrequired

ID unique to every Protection Policy created in objectstore

Example: policy1
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/protection-policies/policy1 \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Success

Bodyapplication/json
idstringrequired

id of the Protection policy. Filter, Sort

Example: "id1"
typestringrequired

Type of resource

commonResourceAttributesobject or null(CommonResourceAttributes)
creationTimeMsstring
customerIdstring

The customer application identifier

Example: "fc5f41652a53497e88cdcebc715cc1sd"
destinationBucketstring

Destination bucket name. Filter, Sort

Example: "buck1"
destinationBucketUuidstring

Destination bucket UUID. Filter

Example: "buck1"
generationinteger(Uint64)

A number that changes every time the resource is modified. This can be used to determine if the local representation of a resource is more up to date. Filter, Sort

modificationTimeMsstring
namestring

Name of the Protection policy. Filter, Sort

Example: "myPolicyName"
partnerstring

Partner system name to which the destination bucket belongs. Filter, Sort

Example: "sys1"
protectionConfigTypestring

Type of protection configuration

Example: "s3"
s3Configurationobject or null(s3ConfigStatus)
sourceBucketstring

Source bucket name for which the protection policy is created. Filter, Sort

Example: "buck1"
sourceBucketUuidstring

Source bucket UUID for which the protection policy is created. Filter

Example: "buck1"
systemUidstring

systemUid where the protection policy is created

Example: "system1"
Response
application/json
{
  "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."
  },
  "creationTimeMs": "string",
  "customerId": "fc5f41652a53497e88cdcebc715cc1sd",
  "destinationBucket": "buck1",
  "destinationBucketUuid": "buck1",
  "generation": 0,
  "id": "id1",
  "modificationTimeMs": "string",
  "name": "myPolicyName",
  "partner": "sys1",
  "protectionConfigType": "s3",
  "s3Configuration": {
    "deleteMarkerReplication": false,
    "deleteReplication": false
  },
  "sourceBucket": "buck1",
  "sourceBucketUuid": "buck1",
  "systemUid": "system1",
  "type": "string"
}

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

Request

Edit protection policy properties in HPE Alletra Storage MP X10000 ObjectStore identified by {systemId} and {protectionPolicyId}

Security
bearer
Path
systemIdstringrequired

A unique identifier assigned to each object service device

Example: 8UW0002928
policyIdstringrequired

ID unique to every Protection Policy created in objectstore

Example: policy1
Bodyapplication/jsonrequired
s3Configurationobject or null(s3ConfigStatusInput)
typestring

Type of the protection policy. 'Possible values: s3'

Example: "s3"
curl -i -X PUT \
  https://eu1.data.cloud.hpe.com/object-storage/v1alpha1/devtype7-storage-systems/8UW0002928/protection-policies/policy1 \
  -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"
}

objectstore-identities

Operations