Compute resources

>>>

GET /api/compute_resources
Llista tots els recursos computacionals

Params

Param Name Description
location_id
Optional

Abast per ubicacions

Validations:

  • Must be a Integer
organization_id
Optional

Abast per organitzacions

Validations:

  • Must be a Integer
search
Optional

filtra els resultats

Validations:

  • Must be a String
order
Optional

Sort field and order, eg. ‘id DESC’

Validations:

  • Must be a String
page
Optional

Page number, starting at 1

Validations:

  • Must be a number.
per_page
Optional

Nombre de resultats per pàgina a retornar

Validations:

  • Must be a number.

Search fields

Field name Tipus Possible values
id integer
location string
location_id integer
name string
organization string
organization_id integer
type string
>>>

GET /api/compute_resources/:id
Mostra un recurs computacional

Params

Param Name Description
location_id
Optional

Set the current location context for the request

Validations:

  • Must be a Integer
organization_id
Optional

Set the current organization context for the request

Validations:

  • Must be a Integer
id
Required

Validations:

  • Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.
>>>

POST /api/compute_resources
Crea un recurs computacional

Params

Param Name Description
location_id
Optional

Set the current location context for the request

Validations:

  • Must be a Integer
organization_id
Optional

Set the current organization context for the request

Validations:

  • Must be a Integer
compute_resource
Required

Validations:

  • Must be a Hash
compute_resource[name]
Required

Validations:

  • Must be a String
compute_resource[provider]
Optional , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span>

Els proveïdors inclouen Kubevirt

Validations:

  • Must be a String
compute_resource[url]
Optional , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span>

URL per Libvirt, oVirt, OpenStack and Rackspace

Validations:

  • Must be a String
compute_resource[description]
Optional , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span>

Validations:

  • Must be a String
compute_resource[user]
Optional , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span>

Nom d'usuari per a oVirt, EC2, VMware i OpenStack. Clau d'accés per a EC2.

Validations:

  • Must be a String
compute_resource[password]
Optional , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span>

Contrasenya per a oVirt, EC2, VMware i OpenStack. Clau secreta per a EC2.

Validations:

  • Must be a String
compute_resource[datacenter]
Optional , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span>

per a oVirt, VMware Datacenter

Validations:

  • Must be a String
compute_resource[use_v4]
Optional , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span>

for oVirt only

Validations:

  • Must be one of: true, false, 1, 0.
compute_resource[ovirt_quota]
Optional , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span>

for oVirt only, ID or Name of quota to use

Validations:

  • Must be a String
compute_resource[public_key]
Optional , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span>

for oVirt only

Validations:

  • Must be a String
compute_resource[region]
Optional , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span>

for EC2 only, use 'us-gov-west-1' for GovCloud region

Validations:

  • Must be a String
compute_resource[tenant]
Optional , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span>

for OpenStack and AzureRM only

Validations:

  • Must be a String
compute_resource[domain]
Optional , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span>

for OpenStack (v3) only

Validations:

  • Must be a String
compute_resource[project_domain_name]
Optional , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span>

for OpenStack (v3) only

Validations:

  • Must be a String
compute_resource[project_domain_id]
Optional , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span>

for OpenStack (v3) only

Validations:

  • Must be a String
compute_resource[server]
Optional , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span>

per a VMware

Validations:

  • Must be a String
compute_resource[set_console_password]
Optional , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span>

només per a Libvirt i VMware

Validations:

  • Must be one of: true, false, 1, 0.
compute_resource[display_type]
Optional , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span>

for Libvirt and oVirt only

Validations:

  • Must be one of: VNC, SPICE.
compute_resource[keyboard]
Optional , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span>

for oVirt only

Validations:

  • Must be one of: ar, de-ch, es, fo, fr-ca, hu, ja, mk, no, pt-br, sv, da, en-gb, et, fr, fr-ch, is, lt, nl, pl, ru, th, de, en-us, fi, fr-be, hr, it, lv, nl-be, pt, sl, tr.
compute_resource[caching_enabled]
Optional , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span>

enable caching, for VMware only

Validations:

  • Must be one of: true, false, 1, 0.
compute_resource[project]
Optional , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span>

Project id for GCE only

Validations:

  • Must be a String
compute_resource[email]
Optional , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span>

Email for GCE only

Validations:

  • Must be a String
compute_resource[key_path]
Optional , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span>

Certificate path for GCE only

Validations:

  • Must be a String
compute_resource[zone]
Optional , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span>

for GCE only

Validations:

  • Must be a String
compute_resource[location_ids]
Optional , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span>

SUBSTITUEIX les ubicacions amb els ID donats

Validations:

  • Must be an array of any type
compute_resource[organization_ids]
Optional , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span>

SUBSTITUEIX les organitzacions amb els ID donats.

Validations:

  • Must be an array of any type
compute_resource[token]
Optional

Token for KubeVirt only

Validations:

  • Must be a String
compute_resource[hostname]
Optional

Host name for KubeVirt only

Validations:

  • Must be a String
compute_resource[namespace]
Optional

Namespace for KubeVirt only

Validations:

  • Must be a String
compute_resource[ca_crt]
Optional

CA crt for KubeVirt only

Validations:

  • Must be a String
compute_resource[api_port]
Optional

API port for KubeVirt only

Validations:

  • Must be a String
>>>

PUT /api/compute_resources/:id
Actualitza un recurs computacional

Params

Param Name Description
location_id
Optional

Set the current location context for the request

Validations:

  • Must be a Integer
organization_id
Optional

Set the current organization context for the request

Validations:

  • Must be a Integer
id
Required

Validations:

  • Must be a String
compute_resource
Required

Validations:

  • Must be a Hash
compute_resource[name]
Optional

Validations:

  • Must be a String
compute_resource[provider]
Optional , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span>

Els proveïdors inclouen Kubevirt

Validations:

  • Must be a String
compute_resource[url]
Optional , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span>

URL per Libvirt, oVirt, OpenStack and Rackspace

Validations:

  • Must be a String
compute_resource[description]
Optional , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span>

Validations:

  • Must be a String
compute_resource[user]
Optional , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span>

Nom d'usuari per a oVirt, EC2, VMware i OpenStack. Clau d'accés per a EC2.

Validations:

  • Must be a String
compute_resource[password]
Optional , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span>

Contrasenya per a oVirt, EC2, VMware i OpenStack. Clau secreta per a EC2.

Validations:

  • Must be a String
compute_resource[datacenter]
Optional , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span>

per a oVirt, VMware Datacenter

Validations:

  • Must be a String
compute_resource[use_v4]
Optional , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span>

for oVirt only

Validations:

  • Must be one of: true, false, 1, 0.
compute_resource[ovirt_quota]
Optional , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span>

for oVirt only, ID or Name of quota to use

Validations:

  • Must be a String
compute_resource[public_key]
Optional , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span>

for oVirt only

Validations:

  • Must be a String
compute_resource[region]
Optional , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span>

for EC2 only, use 'us-gov-west-1' for GovCloud region

Validations:

  • Must be a String
compute_resource[tenant]
Optional , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span>

for OpenStack and AzureRM only

Validations:

  • Must be a String
compute_resource[domain]
Optional , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span>

for OpenStack (v3) only

Validations:

  • Must be a String
compute_resource[project_domain_name]
Optional , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span>

for OpenStack (v3) only

Validations:

  • Must be a String
compute_resource[project_domain_id]
Optional , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span>

for OpenStack (v3) only

Validations:

  • Must be a String
compute_resource[server]
Optional , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span>

per a VMware

Validations:

  • Must be a String
compute_resource[set_console_password]
Optional , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span>

només per a Libvirt i VMware

Validations:

  • Must be one of: true, false, 1, 0.
compute_resource[display_type]
Optional , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span>

for Libvirt and oVirt only

Validations:

  • Must be one of: VNC, SPICE.
compute_resource[keyboard]
Optional , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span>

for oVirt only

Validations:

  • Must be one of: ar, de-ch, es, fo, fr-ca, hu, ja, mk, no, pt-br, sv, da, en-gb, et, fr, fr-ch, is, lt, nl, pl, ru, th, de, en-us, fi, fr-be, hr, it, lv, nl-be, pt, sl, tr.
compute_resource[caching_enabled]
Optional , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span>

enable caching, for VMware only

Validations:

  • Must be one of: true, false, 1, 0.
compute_resource[project]
Optional , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span>

Project id for GCE only

Validations:

  • Must be a String
compute_resource[email]
Optional , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span>

Email for GCE only

Validations:

  • Must be a String
compute_resource[key_path]
Optional , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span>

Certificate path for GCE only

Validations:

  • Must be a String
compute_resource[zone]
Optional , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span>

for GCE only

Validations:

  • Must be a String
compute_resource[location_ids]
Optional , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span>

SUBSTITUEIX les ubicacions amb els ID donats

Validations:

  • Must be an array of any type
compute_resource[organization_ids]
Optional , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span>

SUBSTITUEIX les organitzacions amb els ID donats.

Validations:

  • Must be an array of any type
compute_resource[token]
Optional

Token for KubeVirt only

Validations:

  • Must be a String
compute_resource[hostname]
Optional

Host name for KubeVirt only

Validations:

  • Must be a String
compute_resource[namespace]
Optional

Namespace for KubeVirt only

Validations:

  • Must be a String
compute_resource[ca_crt]
Optional

CA crt for KubeVirt only

Validations:

  • Must be a String
compute_resource[api_port]
Optional

API port for KubeVirt only

Validations:

  • Must be a String
>>>

DELETE /api/compute_resources/:id
Suprimeix un recurs computacional

Params

Param Name Description
location_id
Optional

Set the current location context for the request

Validations:

  • Must be a Integer
organization_id
Optional

Set the current organization context for the request

Validations:

  • Must be a Integer
id
Required

Validations:

  • Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.
>>>

GET /api/compute_resources/:id/available_images
Llista de les imatges disponibles per a un recurs computacional

Params

Param Name Description
location_id
Optional

Set the current location context for the request

Validations:

  • Must be a Integer
organization_id
Optional

Set the current organization context for the request

Validations:

  • Must be a Integer
id
Required

Validations:

  • Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.
>>>

GET /api/compute_resources/:id/available_clusters
Llista dels clústers disponibles per a un recurs computacional

Params

Param Name Description
location_id
Optional

Set the current location context for the request

Validations:

  • Must be a Integer
organization_id
Optional

Set the current organization context for the request

Validations:

  • Must be a Integer
id
Required

Validations:

  • Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.
>>>

GET /api/compute_resources/:id/available_flavors
Llista dels gusts disponibles per a un recurs computacional

Params

Param Name Description
location_id
Optional

Set the current location context for the request

Validations:

  • Must be a Integer
organization_id
Optional

Set the current organization context for the request

Validations:

  • Must be a Integer
id
Required

Validations:

  • Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.
>>>

GET /api/compute_resources/:id/available_folders
Llista de les carpetes disponibles per a un recurs computacional

Params

Param Name Description
location_id
Optional

Set the current location context for the request

Validations:

  • Must be a Integer
organization_id
Optional

Set the current organization context for the request

Validations:

  • Must be a Integer
id
Required

Validations:

  • Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.
>>>

GET /api/compute_resources/:id/available_zones
Llista de les zones disponibles per a un recurs computacional

Params

Param Name Description
location_id
Optional

Set the current location context for the request

Validations:

  • Must be a Integer
organization_id
Optional

Set the current organization context for the request

Validations:

  • Must be a Integer
id
Required

Validations:

  • Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.
>>>

GET /api/compute_resources/:id/available_networks
Llista de les xarxes disponibles per a un recurs computacional

GET /api/compute_resources/:id/available_clusters/:cluster_id/available_networks
Llista de les xarxes disponibles per a un clúster de recursos computacionals

Params

Param Name Description
location_id
Optional

Set the current location context for the request

Validations:

  • Must be a Integer
organization_id
Optional

Set the current organization context for the request

Validations:

  • Must be a Integer
id
Required

Validations:

  • Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.
cluster_id
Optional

Validations:

  • Must be a String
>>>

GET /api/compute_resources/:id/available_clusters/:cluster_id/available_resource_pools
Llista de les reserves de recursos per a un clúster de recursos computacionals

Params

Param Name Description
location_id
Optional

Set the current location context for the request

Validations:

  • Must be a Integer
organization_id
Optional

Set the current organization context for the request

Validations:

  • Must be a Integer
id
Required

Validations:

  • Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.
cluster_id
Required

Validations:

  • Must be a String
>>>

GET /api/compute_resources/:id/storage_domains/:storage_domain_id
Llista dels atributs per a un domini d'emmagatzematge donat

Params

Param Name Description
location_id
Optional

Set the current location context for the request

Validations:

  • Must be a Integer
organization_id
Optional

Set the current organization context for the request

Validations:

  • Must be a Integer
id
Required

Validations:

  • Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.
storage_domain_id
Required

Validations:

  • Must be a String
>>>

GET /api/compute_resources/:id/available_storage_domains
Llista els dominis d'emmagatzemament per a un recurs computacional

GET /api/compute_resources/:id/available_storage_domains/:storage_domain
Llista dels atributs per a un domini d'emmagatzematge donat

GET /api/compute_resources/:id/available_clusters/:cluster_id/available_storage_domains
Llista els dominis d'emmagatzemament per a un recurs computacional

Params

Param Name Description
location_id
Optional

Set the current location context for the request

Validations:

  • Must be a Integer
organization_id
Optional

Set the current organization context for the request

Validations:

  • Must be a Integer
id
Required

Validations:

  • Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.
cluster_id
Optional

Validations:

  • Must be a String
storage_domain
Optional

Validations:

  • Must be a String
>>>

GET /api/compute_resources/:id/storage_pods/:storage_pod_id
List attributes for a given storage pod

Params

Param Name Description
location_id
Optional

Set the current location context for the request

Validations:

  • Must be a Integer
organization_id
Optional

Set the current organization context for the request

Validations:

  • Must be a Integer
id
Required

Validations:

  • Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.
storage_pod_id
Required

Validations:

  • Must be a String
>>>

GET /api/compute_resources/:id/available_storage_pods
List storage pods for a compute resource

GET /api/compute_resources/:id/available_storage_pods/:storage_pod
List attributes for a given storage pod

GET /api/compute_resources/:id/available_clusters/:cluster_id/available_storage_pods
List storage pods for a compute resource

Params

Param Name Description
location_id
Optional

Set the current location context for the request

Validations:

  • Must be a Integer
organization_id
Optional

Set the current organization context for the request

Validations:

  • Must be a Integer
id
Required

Validations:

  • Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.
cluster_id
Optional

Validations:

  • Must be a String
storage_pod
Optional

Validations:

  • Must be a String
>>>

GET /api/compute_resources/:id/available_security_groups
Llista dels grups de seguretat disponibles per a un recurs computacional

Params

Param Name Description
location_id
Optional

Set the current location context for the request

Validations:

  • Must be a Integer
organization_id
Optional

Set the current organization context for the request

Validations:

  • Must be a Integer
id
Required

Validations:

  • Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.
>>>

PUT /api/compute_resources/:id/associate
Les MV associades als amfitrions

Params

Param Name Description
location_id
Optional

Set the current location context for the request

Validations:

  • Must be a Integer
organization_id
Optional

Set the current organization context for the request

Validations:

  • Must be a Integer
id
Required

Validations:

  • Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.
>>>

PUT /api/compute_resources/:id/refresh_cache
Refresh Compute Resource Cache

Params

Param Name Description
location_id
Optional

Set the current location context for the request

Validations:

  • Must be a Integer
organization_id
Optional

Set the current organization context for the request

Validations:

  • Must be a Integer
id
Required

Validations:

  • Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.
>>>

GET /api/compute_resources/:id/available_virtual_machines
List available virtual machines for a compute resource

Params

Param Name Description
location_id
Optional

Set the current location context for the request

Validations:

  • Must be a Integer
organization_id
Optional

Set the current organization context for the request

Validations:

  • Must be a Integer
id
Required

Validations:

  • Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.
>>>

GET /api/compute_resources/:id/available_virtual_machines/:vm_id
Show a virtual machine

Params

Param Name Description
location_id
Optional

Set the current location context for the request

Validations:

  • Must be a Integer
organization_id
Optional

Set the current organization context for the request

Validations:

  • Must be a Integer
id
Required

Validations:

  • Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.
vm_id
Required

Validations:

  • Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.
>>>

PUT /api/compute_resources/:id/available_virtual_machines/:vm_id/power
Power a Virtual Machine

Params

Param Name Description
location_id
Optional

Set the current location context for the request

Validations:

  • Must be a Integer
organization_id
Optional

Set the current organization context for the request

Validations:

  • Must be a Integer
id
Required

Validations:

  • Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.
vm_id
Required

Validations:

  • Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.
>>>

DELETE /api/compute_resources/:id/available_virtual_machines/:vm_id
Delete a Virtual Machine

Params

Param Name Description
location_id
Optional

Set the current location context for the request

Validations:

  • Must be a Integer
organization_id
Optional

Set the current organization context for the request

Validations:

  • Must be a Integer
id
Required

Validations:

  • Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.
vm_id
Required

Validations:

  • Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.