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
任意

フィールドと順序のソート (例: ‘id DESC’)

Validations:

  • Must be a String

page
任意

1 から始まるページ番号

Validations:

  • Must be a number.

per_page
任意

戻されるページごとの結果数

Validations:

  • Must be a number.

検索フィールド

フィールド名 タイプ 設定可能な値
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]
任意 , nil可

プロバイダーに が含まれます

Validations:

  • Must be a String

compute_resource[url]
任意 , nil可

Libvirt, oVirt and OpenStack の URL

Validations:

  • Must be a String

compute_resource[description]
任意 , nil可

Validations:

  • Must be a String

compute_resource[user]
任意 , nil可

oVirt、EC2、VMware、OpenStack のユーザー名。EC2 のアクセスキー。

Validations:

  • Must be a String

compute_resource[password]
任意 , nil可

oVirt、EC2、VMware、OpenStack のパスワード。EC2 のシークレットキー

Validations:

  • Must be a String

compute_resource[datacenter]
任意 , nil可

oVirt、VMware Datacenter の場合

Validations:

  • Must be a String

compute_resource[use_v4]
任意 , nil可

oVirt の場合のみ

Validations:

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

compute_resource[ovirt_quota]
任意 , nil可

for oVirt only, ID or Name of quota to use

Validations:

  • Must be a String

compute_resource[public_key]
任意 , nil可

oVirt の場合のみ

Validations:

  • Must be a String

compute_resource[region]
任意 , nil可

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]
任意 , nil可

for OpenStack and AzureRm only

Validations:

  • Must be a String

compute_resource[domain]
任意 , nil可

for OpenStack (v3) only

Validations:

  • Must be a String

compute_resource[project_domain_name]
任意 , nil可

for OpenStack (v3) only

Validations:

  • Must be a String

compute_resource[project_domain_id]
任意 , nil可

for OpenStack (v3) only

Validations:

  • Must be a String

compute_resource[server]
任意 , nil可

VMware の場合

Validations:

  • Must be a String

compute_resource[set_console_password]
任意 , nil可

Libvirt および VMware の場合のみ

Validations:

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

compute_resource[display_type]
任意 , nil可

for Libvirt and oVirt only

Validations:

  • Must be one of: VNC, SPICE.

compute_resource[keyboard]
任意 , nil可

oVirt の場合のみ

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]
任意 , nil可

VMware 専用キャッシュの有効化

Validations:

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

compute_resource[project]
任意 , nil可

Project id for GCE only

Validations:

  • Must be a String

compute_resource[email]
任意 , nil可

Email for GCE only

Validations:

  • Must be a String

compute_resource[key_path]
任意 , nil可

Certificate path for GCE only

Validations:

  • Must be a String

compute_resource[zone]
任意 , nil可

for GCE only

Validations:

  • Must be a String

compute_resource[location_ids]
任意 , nil可

ロケーションを指定された ID に置き換えます

Validations:

  • Must be an array of any type

compute_resource[organization_ids]
任意 , nil可

組織を指定された 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]
任意 , nil可

プロバイダーに が含まれます

Validations:

  • Must be a String

compute_resource[url]
任意 , nil可

Libvirt, oVirt and OpenStack の URL

Validations:

  • Must be a String

compute_resource[description]
任意 , nil可

Validations:

  • Must be a String

compute_resource[user]
任意 , nil可

oVirt、EC2、VMware、OpenStack のユーザー名。EC2 のアクセスキー。

Validations:

  • Must be a String

compute_resource[password]
任意 , nil可

oVirt、EC2、VMware、OpenStack のパスワード。EC2 のシークレットキー

Validations:

  • Must be a String

compute_resource[datacenter]
任意 , nil可

oVirt、VMware Datacenter の場合

Validations:

  • Must be a String

compute_resource[use_v4]
任意 , nil可

oVirt の場合のみ

Validations:

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

compute_resource[ovirt_quota]
任意 , nil可

for oVirt only, ID or Name of quota to use

Validations:

  • Must be a String

compute_resource[public_key]
任意 , nil可

oVirt の場合のみ

Validations:

  • Must be a String

compute_resource[region]
任意 , nil可

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]
任意 , nil可

for OpenStack and AzureRm only

Validations:

  • Must be a String

compute_resource[domain]
任意 , nil可

for OpenStack (v3) only

Validations:

  • Must be a String

compute_resource[project_domain_name]
任意 , nil可

for OpenStack (v3) only

Validations:

  • Must be a String

compute_resource[project_domain_id]
任意 , nil可

for OpenStack (v3) only

Validations:

  • Must be a String

compute_resource[server]
任意 , nil可

VMware の場合

Validations:

  • Must be a String

compute_resource[set_console_password]
任意 , nil可

Libvirt および VMware の場合のみ

Validations:

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

compute_resource[display_type]
任意 , nil可

for Libvirt and oVirt only

Validations:

  • Must be one of: VNC, SPICE.

compute_resource[keyboard]
任意 , nil可

oVirt の場合のみ

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]
任意 , nil可

VMware 専用キャッシュの有効化

Validations:

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

compute_resource[project]
任意 , nil可

Project id for GCE only

Validations:

  • Must be a String

compute_resource[email]
任意 , nil可

Email for GCE only

Validations:

  • Must be a String

compute_resource[key_path]
任意 , nil可

Certificate path for GCE only

Validations:

  • Must be a String

compute_resource[zone]
任意 , nil可

for GCE only

Validations:

  • Must be a String

compute_resource[location_ids]
任意 , nil可

ロケーションを指定された ID に置き換えます

Validations:

  • Must be an array of any type

compute_resource[organization_ids]
任意 , nil可

組織を指定された 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
コンピュートリソースキャッシュの更新

パラメーター

パラメーター名 記述
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.