GET /api/compute_resources
列出所有運算資源

參數

參數名字 描述
location_id
選填

位置範圍

Validations:

  • Must be a Integer

organization_id
選填

組織範圍

Validations:

  • Must be a Integer

search
選填

篩選結果

Validations:

  • Must be a String

order
選填

Sort field and order, eg. ‘id DESC’

Validations:

  • Must be a String

page
選填

頁數,從 1 開始

Validations:

  • Must be a number.

per_page
選填

每頁要傳回的結果數量

Validations:

  • Must be a number.

Search fields

Field name 類型 Possible values
id
location
location_id
name
organization
organization_id
type

GET /api/compute_resources/:id
顯示運算資源

參數

參數名字 描述
location_id
選填

Set the current location context for the request

Validations:

  • Must be a Integer

organization_id
選填

Set the current organization context for the request

Validations:

  • Must be a Integer

id
必填

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
建立運算資源

參數

參數名字 描述
location_id
選填

Set the current location context for the request

Validations:

  • Must be a Integer

organization_id
選填

Set the current organization context for the request

Validations:

  • Must be a Integer

compute_resource
必填

Validations:

  • Must be a Hash

compute_resource[name]
必填

Validations:

  • Must be a String

compute_resource[provider]
選填 , 允許空值

供應者包含了

Validations:

  • Must be a String

compute_resource[url]
選填 , 允許空值

URL for Libvirt, oVirt and OpenStack

Validations:

  • Must be a String

compute_resource[description]
選填 , 允許空值

Validations:

  • Must be a String

compute_resource[user]
選填 , 允許空值

oVirt、EC2、VMware、OpenStack 的使用者名稱。EC2 的存取金鑰。

Validations:

  • Must be a String

compute_resource[password]
選填 , 允許空值

Ovirt、EC2、Vmware、Openstack 的密碼。EC2 的祕密金鑰

Validations:

  • Must be a String

compute_resource[datacenter]
選填 , 允許空值

適用於 Ovirt、Vmware Datacenter

Validations:

  • Must be a String

compute_resource[use_v4]
選填 , 允許空值

for oVirt only

Validations:

  • Must be one of: true, false, 1, 0.

compute_resource[ovirt_quota]
選填 , 允許空值

for oVirt only, ID or Name of quota to use

Validations:

  • Must be a String

compute_resource[public_key]
選填 , 允許空值

for oVirt only

Validations:

  • Must be a String

compute_resource[region]
選填 , 允許空值

for AzureRm eg. 'eastus' and for EC2 only. Use 'us-gov-west-1' for EC2 GovCloud region

Validations:

  • Must be a String

compute_resource[tenant]
選填 , 允許空值

for OpenStack and AzureRm only

Validations:

  • Must be a String

compute_resource[domain]
選填 , 允許空值

for OpenStack (v3) only

Validations:

  • Must be a String

compute_resource[project_domain_name]
選填 , 允許空值

for OpenStack (v3) only

Validations:

  • Must be a String

compute_resource[project_domain_id]
選填 , 允許空值

for OpenStack (v3) only

Validations:

  • Must be a String

compute_resource[server]
選填 , 允許空值

適用於 Vmware

Validations:

  • Must be a String

compute_resource[set_console_password]
選填 , 允許空值

僅適用於 Libvirt 和 VMware

Validations:

  • Must be one of: true, false, 1, 0.

compute_resource[display_type]
選填 , 允許空值

for Libvirt and oVirt only

Validations:

  • Must be one of: VNC, SPICE.

compute_resource[keyboard]
選填 , 允許空值

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]
選填 , 允許空值

enable caching, for VMware only

Validations:

  • Must be one of: true, false, 1, 0.

compute_resource[project]
選填 , 允許空值

Project id for GCE only

Validations:

  • Must be a String

compute_resource[email]
選填 , 允許空值

Email for GCE only

Validations:

  • Must be a String

compute_resource[key_path]
選填 , 允許空值

Certificate path for GCE only

Validations:

  • Must be a String

compute_resource[zone]
選填 , 允許空值

for GCE only

Validations:

  • Must be a String

compute_resource[location_ids]
選填 , 允許空值

將位置取代為特定 ID

Validations:

  • Must be an array of any type

compute_resource[organization_ids]
選填 , 允許空值

將組織取代為特定 ID。

Validations:

  • Must be an array of any type


PUT /api/compute_resources/:id
更新運算資源

參數

參數名字 描述
location_id
選填

Set the current location context for the request

Validations:

  • Must be a Integer

organization_id
選填

Set the current organization context for the request

Validations:

  • Must be a Integer

id
必填

Validations:

  • Must be a String

compute_resource
必填

Validations:

  • Must be a Hash

compute_resource[name]
選填

Validations:

  • Must be a String

compute_resource[provider]
選填 , 允許空值

供應者包含了

Validations:

  • Must be a String

compute_resource[url]
選填 , 允許空值

URL for Libvirt, oVirt and OpenStack

Validations:

  • Must be a String

compute_resource[description]
選填 , 允許空值

Validations:

  • Must be a String

compute_resource[user]
選填 , 允許空值

oVirt、EC2、VMware、OpenStack 的使用者名稱。EC2 的存取金鑰。

Validations:

  • Must be a String

compute_resource[password]
選填 , 允許空值

Ovirt、EC2、Vmware、Openstack 的密碼。EC2 的祕密金鑰

Validations:

  • Must be a String

compute_resource[datacenter]
選填 , 允許空值

適用於 Ovirt、Vmware Datacenter

Validations:

  • Must be a String

compute_resource[use_v4]
選填 , 允許空值

for oVirt only

Validations:

  • Must be one of: true, false, 1, 0.

compute_resource[ovirt_quota]
選填 , 允許空值

for oVirt only, ID or Name of quota to use

Validations:

  • Must be a String

compute_resource[public_key]
選填 , 允許空值

for oVirt only

Validations:

  • Must be a String

compute_resource[region]
選填 , 允許空值

for AzureRm eg. 'eastus' and for EC2 only. Use 'us-gov-west-1' for EC2 GovCloud region

Validations:

  • Must be a String

compute_resource[tenant]
選填 , 允許空值

for OpenStack and AzureRm only

Validations:

  • Must be a String

compute_resource[domain]
選填 , 允許空值

for OpenStack (v3) only

Validations:

  • Must be a String

compute_resource[project_domain_name]
選填 , 允許空值

for OpenStack (v3) only

Validations:

  • Must be a String

compute_resource[project_domain_id]
選填 , 允許空值

for OpenStack (v3) only

Validations:

  • Must be a String

compute_resource[server]
選填 , 允許空值

適用於 Vmware

Validations:

  • Must be a String

compute_resource[set_console_password]
選填 , 允許空值

僅適用於 Libvirt 和 VMware

Validations:

  • Must be one of: true, false, 1, 0.

compute_resource[display_type]
選填 , 允許空值

for Libvirt and oVirt only

Validations:

  • Must be one of: VNC, SPICE.

compute_resource[keyboard]
選填 , 允許空值

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]
選填 , 允許空值

enable caching, for VMware only

Validations:

  • Must be one of: true, false, 1, 0.

compute_resource[project]
選填 , 允許空值

Project id for GCE only

Validations:

  • Must be a String

compute_resource[email]
選填 , 允許空值

Email for GCE only

Validations:

  • Must be a String

compute_resource[key_path]
選填 , 允許空值

Certificate path for GCE only

Validations:

  • Must be a String

compute_resource[zone]
選填 , 允許空值

for GCE only

Validations:

  • Must be a String

compute_resource[location_ids]
選填 , 允許空值

將位置取代為特定 ID

Validations:

  • Must be an array of any type

compute_resource[organization_ids]
選填 , 允許空值

將組織取代為特定 ID。

Validations:

  • Must be an array of any type


DELETE /api/compute_resources/:id
刪除運算資源

參數

參數名字 描述
location_id
選填

Set the current location context for the request

Validations:

  • Must be a Integer

organization_id
選填

Set the current organization context for the request

Validations:

  • Must be a Integer

id
必填

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
列出運算資源的可用映像檔

參數

參數名字 描述
location_id
選填

Set the current location context for the request

Validations:

  • Must be a Integer

organization_id
選填

Set the current organization context for the request

Validations:

  • Must be a Integer

id
必填

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
列出運算資源的可用叢集

參數

參數名字 描述
location_id
選填

Set the current location context for the request

Validations:

  • Must be a Integer

organization_id
選填

Set the current organization context for the request

Validations:

  • Must be a Integer

id
必填

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
列出運算資源的可用選擇

參數

參數名字 描述
location_id
選填

Set the current location context for the request

Validations:

  • Must be a Integer

organization_id
選填

Set the current organization context for the request

Validations:

  • Must be a Integer

id
必填

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
列出運算資源的可用資料夾

參數

參數名字 描述
location_id
選填

Set the current location context for the request

Validations:

  • Must be a Integer

organization_id
選填

Set the current organization context for the request

Validations:

  • Must be a Integer

id
必填

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
列出運算資源的可用區域

參數

參數名字 描述
location_id
選填

Set the current location context for the request

Validations:

  • Must be a Integer

organization_id
選填

Set the current organization context for the request

Validations:

  • Must be a Integer

id
必填

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
列出運算資源的可用網路

GET /api/compute_resources/:id/available_clusters/:cluster_id/available_networks
列出運算資源叢集的可用網路

參數

參數名字 描述
location_id
選填

Set the current location context for the request

Validations:

  • Must be a Integer

organization_id
選填

Set the current organization context for the request

Validations:

  • Must be a Integer

id
必填

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
選填

Validations:

  • Must be a String


GET /api/compute_resources/:id/available_clusters/:cluster_id/available_resource_pools
列出運算資源叢集的資源集區

參數

參數名字 描述
location_id
選填

Set the current location context for the request

Validations:

  • Must be a Integer

organization_id
選填

Set the current organization context for the request

Validations:

  • Must be a Integer

id
必填

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
必填

Validations:

  • Must be a String


GET /api/compute_resources/:id/storage_domains/:storage_domain_id
列出某個儲存區域的屬性

參數

參數名字 描述
location_id
選填

Set the current location context for the request

Validations:

  • Must be a Integer

organization_id
選填

Set the current organization context for the request

Validations:

  • Must be a Integer

id
必填

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
必填

Validations:

  • Must be a String


GET /api/compute_resources/:id/available_storage_domains
列出運算資源的儲存區域

GET /api/compute_resources/:id/available_storage_domains/:storage_domain
列出某個儲存區域的屬性

GET /api/compute_resources/:id/available_clusters/:cluster_id/available_storage_domains
列出運算資源的儲存區域

參數

參數名字 描述
location_id
選填

Set the current location context for the request

Validations:

  • Must be a Integer

organization_id
選填

Set the current organization context for the request

Validations:

  • Must be a Integer

id
必填

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
選填

Validations:

  • Must be a String

storage_domain
選填

Validations:

  • Must be a String


GET /api/compute_resources/:id/storage_pods/:storage_pod_id
列出某個儲存容器的屬性

參數

參數名字 描述
location_id
選填

Set the current location context for the request

Validations:

  • Must be a Integer

organization_id
選填

Set the current organization context for the request

Validations:

  • Must be a Integer

id
必填

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
必填

Validations:

  • Must be a String


GET /api/compute_resources/:id/available_storage_pods
列出運算資源的儲存容器

GET /api/compute_resources/:id/available_storage_pods/:storage_pod
列出某個儲存容器的屬性

GET /api/compute_resources/:id/available_clusters/:cluster_id/available_storage_pods
列出運算資源的儲存容器

參數

參數名字 描述
location_id
選填

Set the current location context for the request

Validations:

  • Must be a Integer

organization_id
選填

Set the current organization context for the request

Validations:

  • Must be a Integer

id
必填

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
選填

Validations:

  • Must be a String

storage_pod
選填

Validations:

  • Must be a String


GET /api/compute_resources/:id/available_security_groups
列出運算資源的可用安全群組

參數

參數名字 描述
location_id
選填

Set the current location context for the request

Validations:

  • Must be a Integer

organization_id
選填

Set the current organization context for the request

Validations:

  • Must be a Integer

id
必填

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
將 VM 與主機建立關連

參數

參數名字 描述
location_id
選填

Set the current location context for the request

Validations:

  • Must be a Integer

organization_id
選填

Set the current organization context for the request

Validations:

  • Must be a Integer

id
必填

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

參數

參數名字 描述
location_id
選填

Set the current location context for the request

Validations:

  • Must be a Integer

organization_id
選填

Set the current organization context for the request

Validations:

  • Must be a Integer

id
必填

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

參數

參數名字 描述
location_id
選填

Set the current location context for the request

Validations:

  • Must be a Integer

organization_id
選填

Set the current organization context for the request

Validations:

  • Must be a Integer

id
必填

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

參數

參數名字 描述
location_id
選填

Set the current location context for the request

Validations:

  • Must be a Integer

organization_id
選填

Set the current organization context for the request

Validations:

  • Must be a Integer

id
必填

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
必填

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

參數

參數名字 描述
location_id
選填

Set the current location context for the request

Validations:

  • Must be a Integer

organization_id
選填

Set the current organization context for the request

Validations:

  • Must be a Integer

id
必填

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
必填

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

參數

參數名字 描述
location_id
選填

Set the current location context for the request

Validations:

  • Must be a Integer

organization_id
選填

Set the current organization context for the request

Validations:

  • Must be a Integer

id
必填

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
必填

Validations:

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