Skip to content
Internal API Catalog
/
Backup and Recovery API
/
API reference
/
v1beta1
/
Protection Store Gateway
/
Get a list of the Protection Store Gateways that are registered with DSCC

Backup and Recovery API (1.1.0)

Backup and Recovery API

Download OpenAPI description
backup-recovery-api.json
backup-recovery-api.yaml
Overview
License

HPE End User License Agreement

Languages
Servers
Mock server

https://stage-developer-portal-hpe.redocly.app/_mock/docs/greenlake/services/backup-recovery/public/openapi/backup-recovery-public-v1beta1/backup-recovery-api/

https://us-west.api.greenlake.hpe.com/

https://eu-west.api.greenlake.hpe.com/

https://eu-central.api.greenlake.hpe.com/

https://ap-northeast.api.greenlake.hpe.com/

Protection Store Gateway

Protection Store Gateway APIs

Operations

Returns the resource requirements that would be needed for a Protection Store Gateway.

Request

Returns the resource requirements that would be needed for a Protection Store Gateway. This API doesn't create the Protection Store Gateway. To create the Protection Store Gateway a call to POST /protection-store-gateways should be made.

Security
bearer
Bodyapplication/jsonrequired
maxInCloudDailyProtectedDataInTiBnumber

The maximum total size of the assets that is expected to be protected each day in the Cloud Protection Stores.

Example: 2
maxInCloudRetentionDaysnumber

The maximum retention period for cloud backups in days.

Example: 2
maxOnPremDailyProtectedDataInTiBnumber

The maximum total size of the assets that is expected to be protected each day in the On-Prem Protection Store.

Example: 2
maxOnPremRetentionDaysnumber

The maximum retention period for local backups in days.

Example: 2
curl -i -X POST \
  https://stage-developer-portal-hpe.redocly.app/_mock/docs/greenlake/services/backup-recovery/public/openapi/backup-recovery-public-v1beta1/backup-recovery-api/backup-recovery/v1beta1/protection-store-gateway-sizer \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{}'

Responses

OK

Bodyapplication/json
iopsnumber

IOPs that the underlying storage system must support to achieve the desired throughput.

Example: 2
ramInGiBnumber

Amount of RAM in GiB required.

Example: 2
storageInTiBnumber

Total size (TiB) of datastores that the Protection Store Gateway requires.

Example: 2
vCpunumber

Number of vCPU cores required.

Example: 2
Response
application/json
{
  "iops": 2,
  "ramInGiB": 2,
  "storageInTiB": 2,
  "vCpu": 2
}

Get a list of the Protection Store Gateways that are registered with DSCC

Request

Gets the list of available Protection Store Gateways

Security
bearer
Query
offsetinteger

The number of items to skip before starting to collect the result set

limitinteger<= 2000

The numbers of items to return

Default 10
filterstring

The filter query parameter is used to filter the set of resources returned in the response.

The returned set of resources will match the criteria in the filter query parameter.

A comparison compares a property name to a literal. The comparisons supported are the following:

  • “eq” : Is a property equal to value. Valid for number, boolean and string properties
  • “gt” : Is a property greater than a value. Valid for number or string timestamp properties
  • “lt” : Is a property less than a value. Valid for number or string timestamp properties
  • “in” : Is a value in a property (that is an array of strings)

Filters are supported on following attributes:

  • state
  • health/state
  • health/status

Examples:

  • GET ./protection-store-gateways?filter=state eq'PSG_STATE_REGISTERING'
  • GET ./protection-store-gateways?filter=health/state eq 'PSG_HEALTH_STATE_UNKNOWN'
  • GET ./protection-store-gateways?filter=health/status eq 'PSG_HEALTH_STATUS_CONNECTED'
sortstring

Comma separated list of properties defining the sort order

selectstring

The select query parameter is used to limit the properties returned in the GET response.

Multiple properties can be specified to be returned. The server will only return the set of properties requested by the client.

Example:

GET ./protection-store-gateways?select=displayName,state'

curl -i -X GET \
  https://stage-developer-portal-hpe.redocly.app/_mock/docs/greenlake/services/backup-recovery/public/openapi/backup-recovery-public-v1beta1/backup-recovery-api/backup-recovery/v1beta1/protection-store-gateways \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

OK

Bodyapplication/json
itemsArray of objects(ProtectionStoreGateway)required
items[].​idstring(uuid)read-onlyrequired

An identifier for the resource, usually a UUID.

items[].​typestringread-onlyrequired

The type of resource.

items[].​generationinteger(int64)read-onlyrequired

A monotonically increasing value. This value updates when the resource is updated and can be used as a short way to determine if a resource has changed or which of two different copies of a resource is more up to date.

items[].​createdAtstring(date-time)required
items[].​updatedAtstring(date-time)required
items[].​resourceUristringread-onlyrequired

The self reference for this resource.

items[].​customerIdstringread-onlyrequired

The customer application identifier

items[].​namestring

A system specified name for the resource.

items[].​adminUserCiphertextstring
items[].​consoleUristring

URI for the console screen that displays this resource

items[].​dataOrchestratorIdstring

The id of the Data Orchestrator this Protection Store Gateway is associated with

items[].​datastoresInfoArray of objects(PSGDatastoreInfo)
items[].​displayNamestring

The display name of this Protection Store Gateway

items[].​healthobject

Health of Protection Store Gateway.

items[].​networkobject

Network of Protection Store Gateway.

items[].​overrideobject

User supplied parameters used to override automatic VM resource configuration with a fixed configuration. If 0 is returned for the values then no override has been configured.

items[].​remoteAccessEnabledboolean
items[].​remoteAccessStationIdstring

The station ID (SID) that is required for remote desktop access

items[].​serialNumberstring

The serial number of this Protection Store Gateway

items[].​sizeobject

User supplied parameters used to size the Protection Store Gateway.

items[].​softwareVersionstring

Software version of the Protection Store Gateway

items[].​statestring

State of Protection Store Gateway.

Enum"PSG_STATE_QUERYING_CATALOGUE""PSG_STATE_DEPLOYING""PSG_STATE_DEPLOYED"
items[].​supportUserCiphertextstring
items[].​vmIdstring

Id of the VM

countintegerrequired

Number of items in the response (for paginated responses)

limitinteger

The limit specified in the query parameter.

Example: 1
offsetinteger

The offset specified in the query parameter.

Example: 0
totalinteger

The total count of objects in the result set.

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

Create a new Protection Store Gateway within DSCC

Request

Create a Protection Store Gateway

Security
bearer
Bodyapplication/jsonrequired
hypervisorManagerIdstringrequired

Unique identifier, UUID.

Example: "aa1974ec-3b28-406f-8d84-85528d590a6b"
namestringrequired

The name of the Protection Store Gateway

Example: "EG-172.31.57.71"
vmConfigobject(VMConfig)required
Example: {"datastoreIds":["70968004-886c-582e-b09a-c98396d0db68","098c18ff-ae3d-55a7-8967-00869c1ac71c"],"hostId":"234f54ab-e93c-5bc7-9daa-3dcd93fc0ae0","maxInCloudDailyProtectedDataInTiB":90,"maxInCloudRetentionDays":90,"maxOnPremDailyProtectedDataInTiB":5,"maxOnPremRetentionDays":5,"network":{"dns":[{"networkAddress":"172.31.56.9"},{"networkAddress":"172.31.56.10"},{"networkAddress":"172.31.35.101"}],"gateway":"172.31.63.254","name":"dvportgroup-30","networkAddress":"172.31.57.71","networkType":"STATIC","subnetMask":"255.255.248.0"}}
vmConfig.​clusterIdstring

Id of the cluster. Only required if host or resource pool is not given

vmConfig.​contentLibraryIdstring

Id of the datastore for the content library

vmConfig.​datastoreIdsArray of strings(uuid)
Example: ["70968004-886c-582e-b09a-c98396d0db68","098c18ff-ae3d-55a7-8967-00869c1ac71c"]
vmConfig.​folderIdstring

Id of the folder

vmConfig.​hostIdstring

Id of the Host. Only required if cluster or resource pool is not given

Example: "234f54ab-e93c-5bc7-9daa-3dcd93fc0ae0"
vmConfig.​networkobject
Example: {"dns":[{"networkAddress":"172.31.56.9"},{"networkAddress":"172.31.56.10"},{"networkAddress":"172.31.35.101"}],"gateway":"172.31.63.254","name":"dvportgroup-30","networkAddress":"172.31.57.71","networkType":"STATIC","subnetMask":"255.255.248.0"}
vmConfig.​overrideobject

Override automatic VM resource configuration with a fixed configuration.

vmConfig.​resourcePoolIdstring

Id of the resource pool. Only required if cluster or host is not given

vmConfig.​maxInCloudDailyProtectedDataInTiBnumber

The maximum total size of the assets that is expected to be protected each day in the Cloud Protection Stores.

Example: 90
vmConfig.​maxInCloudRetentionDaysnumber

The maximum retention period for cloud backups in days.

Example: 90
vmConfig.​maxOnPremDailyProtectedDataInTiBnumber

The maximum total size of the assets that is expected to be protected each day in the On-Prem Protection Store.

Example: 5
vmConfig.​maxOnPremRetentionDaysnumber

The maximum retention period for local backups in days.

Example: 5
curl -i -X POST \
  https://stage-developer-portal-hpe.redocly.app/_mock/docs/greenlake/services/backup-recovery/public/openapi/backup-recovery-public-v1beta1/backup-recovery-api/backup-recovery/v1beta1/protection-store-gateways \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "hypervisorManagerId": "aa1974ec-3b28-406f-8d84-85528d590a6b",
    "name": "EG-172.31.57.71",
    "vmConfig": {
      "datastoreIds": [
        "70968004-886c-582e-b09a-c98396d0db68",
        "098c18ff-ae3d-55a7-8967-00869c1ac71c"
      ],
      "hostId": "234f54ab-e93c-5bc7-9daa-3dcd93fc0ae0",
      "maxInCloudDailyProtectedDataInTiB": 90,
      "maxInCloudRetentionDays": 90,
      "maxOnPremDailyProtectedDataInTiB": 5,
      "maxOnPremRetentionDays": 5,
      "network": {
        "dns": [
          {
            "networkAddress": "172.31.56.9"
          },
          {
            "networkAddress": "172.31.56.10"
          },
          {
            "networkAddress": "172.31.35.101"
          }
        ],
        "gateway": "172.31.63.254",
        "name": "dvportgroup-30",
        "networkAddress": "172.31.57.71",
        "networkType": "STATIC",
        "subnetMask": "255.255.248.0"
      }
    }
  }'

Responses

Accepted

Headers
Locationstring

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

Bodyapplication/json
object(EmptyResponse)
Response
application/json
{}

StoreOnce

StoreOnce APIs

Operations

application-hosts

The Application Hosts API allows the registration and management of Application Hosts.

Operations

data-orchestrators

APIs for managing Data Orchestrator operations.

Operations

datastores

The datastores API allows the data management operations on datastores.

Operations

mssql-database-backups

The MSSQL database backups API allows the creation and management of MSSQL database backups.

Operations

mssql-database-protection-groups

The MSSQL database Protection Groups API allows management of MSSQL database Protection Groups.

Operations

mssql-database-snapshots

The MSSQL database snapshots API allows the creation and management of MSSQL database snapshots.

Operations

mssql-databases

The MSSQL Databases API allows management of MSSQL databases.

Operations

mssql-instances

The MSSQL Instances API allows management of MSSQL instances.

Operations

protection-jobs

The Protection Jobs API allows the creation and management of Protection Jobs.

Operations

protection-policies

The Protection Policies API allows the creation and management of Protection Policies.

Operations

protection-stores

This API allows the creation and management of Protection Stores that represents the backup target for the copies.

Operations

virtual-machine-protection-groups

The virtual machine Protection Groups API allows the creation and management of virtual machine Protection Groups (Group of Virtual Machines, Datastores or Folder for Protection).

Operations

virtual-machines

The virtual machines API allows the data management operations on virtual machines.

Operations

volume-protection-groups

The Volume Protection Groups API allows the creation and management of Volume Protection Groups (Group of Volumes for Protection).

Operations

datastore-backups

Operations

datastore-snapshots

Operations

virtual-machine-backups

Operations

virtual-machine-snapshots

Operations

volume-protection-group-backups

Operations

volume-protection-group-snapshots

Operations