csp-machine-images

Operations on cloud service provider (CSP) machine images.

Operations

Get a list of CSP machine images

Request

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

Security

bearer

Query

offsetinteger>= 0

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.

Default 0

Example: offset=30

limitinteger(int32)[ 0 .. 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:

name
cspInfo.id
cspInfo.region
cspInfo.architecture
cspInfo.state
cspInfo.hypervisor
cspInfo.rootDeviceType
cspInfo.rootDeviceName
cspInfo.virtualizationType
cspType
cspInfo.location
cspInfo.ownerId

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 "name 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://stage-developer-portal-hpe.redocly.app/_mock/docs/greenlake/services/virtualization/public/openapi/virtualization-public-v1beta1/virtualization-api/virtualization/v1beta1/csp-machine-images \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

List of CSP machine images

Bodyapplication/json

countintegerrequired

Number of items in this response.

offsetintegerrequired

The offset query parameter from the request.

itemsArray of objects(CSPMachineImage)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[].cspInfoCSPMachineImageAWSCSPInfo (object) or CSPMachineImageAzureCSPInfo (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 image

Request

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

Security

bearer

Path

idstring(uuid)required

Unique identifier of a CSP machine image

curl -i -X GET \
  'https://stage-developer-portal-hpe.redocly.app/_mock/docs/greenlake/services/virtualization/public/openapi/virtualization-public-v1beta1/virtualization-api/virtualization/v1beta1/csp-machine-images/{id}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Details of a CSP machine image

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

cspInfoCSPMachineImageAWSCSPInfo (object) or CSPMachineImageAzureCSPInfo (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": {
    "architecture": "x86_64",
    "blockDeviceMappings": [ … ],
    "description": "string",
    "enaSupport": true,
    "hypervisor": "xen",
    "id": "ami-0000025f7c02a13b2",
    "imageType": "machine",
    "location": "amazon/amzn-ami-hvm-2018.03.0.20200716.0-x86_64-ebs",
    "ownerAlias": "amazon",
    "ownerId": "137112412989",
    "platformDetails": "Linux/UNIX",
    "public": true,
    "region": "eu-west-3",
    "rootDeviceName": "/dev/sda1",
    "rootDeviceType": "ebs",
    "sriovNetSupport": "simple",
    "state": "available",
    "usageOperation": "RunInstances",
    "virtualizationType": "hvm"
  },
  "cspType": "AWS"
}

csp-machine-instance-types

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

Operations

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)