Instance

Instances represent an entity that is runnable in the cloud.

An instance of type "next" is a container of information that expresses how to configure a future instance when we decide to launch or start it. A "next" instance generally only exists in the RightScale realm, and usually doesn't have any corresponding representation existing in the cloud. However, if an instance is not of type "next", it will generally represent an existing running (or provisioned) virtual machine existing in the cloud.

Content-Types

Content type

application/vnd.rightscale.instance

Relationships

alert_specs

Associated alert specs

alerts

Associated alerts

cloud

Associated Cloud

datacenter

Associated datacenter

deployment

Associated Deployment

image

Associated image

inputs

List of configuration inputs

instance_type

Associated instance type

kernel_image

Associated kernel image

lock_user

Href of the user who has locked this instance

monitoring_metrics

Associated monitoring metrics

multi_cloud_image

Associated multi cloud image

parent

Parent Object (Server/ServerArray)

placement_group

Associated placement group

ramdisk_image

Associated ramdisk image

self

Href of itself

server_template

Associated ServerTemplate

ssh_key

Associated ssh key

volume_attachments

Associated volume attachments

Actions

launch

Launches this instance with the current configuration

lock

Locks a running instance

reboot

Reboots a running instance

run_executable

Runs a script or recipe on the instance

start

Starts an instance that has been stopped, resuming it to its previously saved volume state.

stop

Stores the instance's current volume state to resume later using the 'start' action.

terminate

Terminates the instance

unlock

Unlocks a running instance

Attributes

actions

 

admin_password

 

associate_public_ip_address

 

cloud_specific_attributes

 

created_at

 

description

 

inherited_sources

 

inputs

 

ip_forwarding_enabled

 

links

 

locked

 

monitoring_collector_http

The hostname used to GET from or POST to the monitoring system.

monitoring_collector_udp

The hostname used to push the data to the monitoring system i.e. collectd udp protocol.

monitoring_id

 

monitoring_server

The name of the monitoring server

name

 

os_platform

 

pricing_type

 

private_dns_names

 

private_ip_addresses

 

public_dns_names

 

public_ip_addresses

 

resource_uid

 

rs_provisioned

 

security_groups

 

state

 

subnets

 

terminated_at

 

updated_at

 

user_data