csp-machine-instance-types

csp-machine-images

Operations on cloud service provider (CSP) machine images.

Operations

csp-machine-instance-types

Operations on cloud service provider (CSP) machine instance types.

Operations

Get a list of CSP machine instance types

Request

Returns a list of cloud service provider (CSP) machine instance types based on the query parameters for paging, filtering, and sorting.

Security

bearer

Query

offsetinteger

The number of items to omit from the beginning of the result set. Use offset in conjunction with limit for pagination, for example "offset=30&limit=10" indicates the fourth page of 10 items.

Example: offset=30

limitinteger(int32)[ 1 .. 1000 ]

The maximum number of items to include in the response. Use offset in conjunction with limit for pagination, for example "offset=30&limit=10" indicates the fourth page of 10 items.

Default 20

Example: limit=10

filterstring

An expression to filter the results.

Filtering is supported with following attributes:

cspInfo.region
cspInfo.freeTierEligible
cspInfo.processorInfo.supportedArchitectures
cspInfo.supportedVirtualizationTypes
cspInfo.cspInfo.supportedRootDeviceTypes
cspInfo.hypervisor
cspInfo.ebsInfo.encryptionSupport
cspInfo.networkInfo.enaSupport
cspType

Example: filter=filter=hypervisor eq 'hvm' and region eq 'eu-west-3'

sortstring

A comma separated list of properties to sort by, followed by a direction indicator ("asc" or "desc").

Default "asc"

Example: sort=name asc

selectstring

A list of properties to include in the response.

Example: select=id,name,state

curl -i -X GET \
  https://developer.greenlake.hpe.com/_mock/docs/greenlake/services/virtualization/public/openapi/virtualization-public-v1beta1/virtualization/v1beta1/csp-machine-instance-types \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

List of CSP machine instance types

Bodyapplication/json

countintegerrequired

Number of items in this response.

offsetintegerrequired

The offset query parameter from the request.

itemsArray of objects(CSPMachineInstanceType)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[].consoleUristringread-only

URI for the console screen that displays this resource

items[].cspInfoCSPMachineInstanceTypeAWSCSPInfo (object) or CSPMachineInstanceTypeAzureCSPInfo (object)

One of:

items[].cspTypestring

The cloud service provider type

Default "AWS"

Enum"AWS""AZURE"

Example: "AWS"

totalinteger

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

Response

application/json

{
  "count": 0,
  "offset": 0,
  "total": 0,
  "items": [
    { … }
  ]
}

Get details of a CSP machine instance type

Request

Returns details of a specified cloud service provider (CSP) machine instance type.

Security

bearer

Path

idstring(uuid)required

Unique identifier of a CSP machine instance type

curl -i -X GET \
  'https://developer.greenlake.hpe.com/_mock/docs/greenlake/services/virtualization/public/openapi/virtualization-public-v1beta1/virtualization/v1beta1/csp-machine-instance-types/{id}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Details of a CSP machine instance type

Bodyapplication/json

idstring(uuid)read-onlyrequired

An identifier for the resource, usually a UUID.

typestringread-onlyrequired

The type of resource.

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.

createdAtstring(date-time)required

updatedAtstring(date-time)required

resourceUristringread-onlyrequired

The self reference for this resource.

customerIdstringread-onlyrequired

The customer application identifier

namestring

A system specified name for the resource.

consoleUristringread-only

URI for the console screen that displays this resource

cspInfoCSPMachineInstanceTypeAWSCSPInfo (object) or CSPMachineInstanceTypeAzureCSPInfo (object)

One of:

cspTypestring

The cloud service provider type

Default "AWS"

Enum"AWS""AZURE"

Example: "AWS"

Response

application/json

{
  "createdAt": "2019-08-24T14:15:22Z",
  "customerId": "string",
  "generation": 0,
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "name": "string",
  "resourceUri": "string",
  "type": "string",
  "updatedAt": "2019-08-24T14:15:22Z",
  "consoleUri": "string",
  "cspInfo": {
    "autoRecoverySupported": true,
    "bareMetal": true,
    "burstablePerformanceSupported": false,
    "currentGeneration": true,
    "dedicatedHostsSupported": true,
    "ebsInfo": { … },
    "freeTierEligible": true,
    "hibernationSupported": false,
    "hypervisor": "xen",
    "instanceStorageSupported": false,
    "instanceType": "t2.2xlarge",
    "memoryInfo": { … },
    "networkInfo": { … },
    "placementGroupInfo": { … },
    "processorInfo": { … },
    "region": "eu-west-3",
    "supportedRootDeviceTypes": [ … ],
    "supportedUsageClasses": [ … ],
    "supportedVirtualizationTypes": [ … ],
    "vCpuInfo": { … }
  },
  "cspType": "AWS"
}

csp-machine-instances

Operations on cloud service provider (CSP) machine instances.

Operations

datastores

The datastores API allows the registration and management of datastores.

Operations

hypervisor-clusters

The hypervisor clusters API enables you to get the details of the hypervisor clusters in a hypervisor manager.

Operations

hypervisor-folders

The hypervisor folders API enables you to get the details of the hypervisor folders in a hypervisor manager.

Operations

hypervisor-hosts

The hypervisor hosts API enables you to get the details of the hypervisor hosts in a hypervisor manager.

Operations

hypervisor-managers

The hypervisor managers API allows the registration and management of hypervisor managers.

Operations

hypervisor-networks

The hypervisor networks API enables you to get the details of the hypervisor networks in a hypervisor manager.

Operations

hypervisor-tags

The hypervisor tags API enables you to get the details of the hypervisor tags in a hypervisor manager.

Operations

resource-pools

The resource pool API enables you to get the details of the hypervisor resource pools in a hypervisor manager.

Operations

virtual-machines

The virtual machines API allows the registration and management of virtual machines.

Operations

Virtualization API (1.2.0)

csp-machine-images