Cloud Management API 1.5
Instances
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.
Actions
- index
- show
- create
- update
- launch
- lock
- multi_run_executable
- multi_terminate
- reboot
- run_executable
- start
- stop
- terminate
- unlock
index
Lists instances of a given cloud, server array.
Using the available filters, it is possible to craft powerful queries about which instances to retrieve. For example, one can easily list: * instances that have names that contain "app" * all instances of a given deployment * instances belonging to a given server array (i.e., have the same parent_url)
To see the instances of a server array including the next_instance, use the URL "/api/clouds/:cloud_id/instances" with the filter "parent_href==/api/server_arrays/XX". To list only the running instances of a server array, use the URL "/api/server_arrays/:server_array_id/current_instances"
The 'full_inputs_2_0' view is for retrieving inputs in 2.0 serialization (for more details please see Inputs#index.)
- URLs
- GET /api/clouds/:cloud_id/instances
- GET /api/server_arrays/:server_array_id/current_instances
- HTTP response code
- 200 OK
- Content-type
- application/vnd.rightscale.instance;type=collection
Required roles
- observer||instance
Parameters
| name | required | type | values | regexp | blank? | description |
|---|---|---|---|---|---|---|
| filter | no | Array | * | * | no | See below for valid filter parameters. |
| view | no | String | default, extended, full, full_inputs_2_0, tiny, sensitive | * | no | Specifies how many attributes and/or expanded nested relationships to include. |
Filters
| name | partial_match? | description |
|---|---|---|
| datacenter_href | no | The href of the datacenter to filter on. |
| deployment_href | no | The href of the deployment to filter on. |
| name | yes | Name of the Instance to filter on. |
| os_platform | yes | The OS platform to filter on. |
| parent_href | no | The href of the parent to filter on. |
| placement_group_href | no | The href of the placement group to filter on. |
| private_dns_name | yes | The private dns name to filter on. |
| private_ip_address | yes | The private ip address to filter on. |
| public_dns_name | yes | The public dns name to filter on. |
| public_ip_address | yes | The public ip address to filter on. |
| resource_uid | no | Resource Unique IDentifier for the Instance to filter on. |
| server_template_href | no | The href of the ServerTemplate to filter on. |
| state | no | The state of Instances to filter on. |
Example Responses
Click on a format below to see an example response for the 'default' view:
JSON XML[{
"name": "NAME_409940392",
"created_at": "2023/10/09 11:06:01 +0000",
"updated_at": "2023/10/09 11:06:01 +0000",
"resource_uid": "RESOURCE_2014175382",
"links": [
{"rel":"self","href":"/api/clouds/888/instances/RESOURCE_2014175382;RAND"},
{"rel":"cloud","href":"/api/clouds/888"},
{"rel":"deployment","href":"/api/deployments/2"},
{"rel":"server_template","href":"/api/server_templates/1"},
{"rel":"multi_cloud_image","href":"/api/multi_cloud_images/1","inherited_source":"server_template"},
{"rel":"parent","href":"/api/servers/1"},
{"rel":"volume_attachments","href":"/api/clouds/888/instances/RESOURCE_2014175382;RAND/volume_attachments"},
{"rel":"inputs","href":"/api/clouds/888/instances/RESOURCE_2014175382;RAND/inputs"},
{"rel":"monitoring_metrics","href":"/api/clouds/888/instances/RESOURCE_2014175382;RAND/monitoring_metrics"},
{"rel":"alerts","href":"/api/clouds/888/instances/RESOURCE_2014175382;RAND/alerts"},
{"rel":"alert_specs","href":"/api/clouds/888/instances/RESOURCE_2014175382;RAND/alert_specs"}
],
"cloud_specific_attributes": {
},
"associate_public_ip_address": true,
"actions": [
{
"rel": "terminate"
},
{
"rel": "reboot"
},
{
"rel": "run_executable"
},
{
"rel": "lock"
},
{
"rel": "unlock"
}
],
"public_ip_addresses": [
"184.9.35.124"
],
"private_ip_addresses": [
"9.6.9.2"
],
"pricing_type": "fixed",
"locked": false,
"state": "operational"
},{
"name": "NAME_3851102770",
"created_at": "2023/10/09 11:06:02 +0000",
"updated_at": "2023/10/09 11:06:02 +0000",
"resource_uid": "RESOURCE_1620899759",
"links": [
{"rel":"self","href":"/api/clouds/888/instances/RESOURCE_1620899759;RAND"},
{"rel":"cloud","href":"/api/clouds/888"},
{"rel":"deployment","href":"/api/deployments/8"},
{"rel":"server_template","href":"/api/server_templates/5"},
{"rel":"multi_cloud_image","href":"/api/multi_cloud_images/2","inherited_source":"server_template"},
{"rel":"parent","href":"/api/servers/3"},
{"rel":"volume_attachments","href":"/api/clouds/888/instances/RESOURCE_1620899759;RAND/volume_attachments"},
{"rel":"inputs","href":"/api/clouds/888/instances/RESOURCE_1620899759;RAND/inputs"},
{"rel":"monitoring_metrics","href":"/api/clouds/888/instances/RESOURCE_1620899759;RAND/monitoring_metrics"},
{"rel":"alerts","href":"/api/clouds/888/instances/RESOURCE_1620899759;RAND/alerts"},
{"rel":"alert_specs","href":"/api/clouds/888/instances/RESOURCE_1620899759;RAND/alert_specs"}
],
"cloud_specific_attributes": {
},
"associate_public_ip_address": true,
"actions": [
{
"rel": "terminate"
},
{
"rel": "reboot"
},
{
"rel": "run_executable"
},
{
"rel": "lock"
},
{
"rel": "unlock"
}
],
"public_ip_addresses": [
"108.180.119.149"
],
"private_ip_addresses": [
"5.2.2.6"
],
"pricing_type": "fixed",
"locked": false,
"state": "operational"
}]<?xml version="1.0" encoding="UTF-8"?>
<instances>
<instance>
<name>NAME_409940392</name>
<created_at>2023/10/09 11:06:01 +0000</created_at>
<updated_at>2023/10/09 11:06:01 +0000</updated_at>
<resource_uid>RESOURCE_2014175382</resource_uid>
<links>
<link rel="self" href="/api/clouds/888/instances/RESOURCE_2014175382;RAND"/>
<link rel="cloud" href="/api/clouds/888"/>
<link rel="deployment" href="/api/deployments/2"/>
<link rel="server_template" href="/api/server_templates/1"/>
<link rel="multi_cloud_image" href="/api/multi_cloud_images/1" inherited_source="server_template"/>
<link rel="parent" href="/api/servers/1"/>
<link rel="volume_attachments" href="/api/clouds/888/instances/RESOURCE_2014175382;RAND/volume_attachments"/>
<link rel="inputs" href="/api/clouds/888/instances/RESOURCE_2014175382;RAND/inputs"/>
<link rel="monitoring_metrics" href="/api/clouds/888/instances/RESOURCE_2014175382;RAND/monitoring_metrics"/>
<link rel="alerts" href="/api/clouds/888/instances/RESOURCE_2014175382;RAND/alerts"/>
<link rel="alert_specs" href="/api/clouds/888/instances/RESOURCE_2014175382;RAND/alert_specs"/>
</links>
<cloud_specific_attributes/>
<associate_public_ip_address>true</associate_public_ip_address>
<actions>
<action rel="terminate"/>
<action rel="reboot"/>
<action rel="run_executable"/>
<action rel="lock"/>
<action rel="unlock"/>
</actions>
<public_ip_addresses>
<public_ip_address>184.9.35.124</public_ip_address>
</public_ip_addresses>
<private_ip_addresses>
<private_ip_address>9.6.9.2</private_ip_address>
</private_ip_addresses>
<pricing_type>fixed</pricing_type>
<locked>false</locked>
<state>operational</state>
</instance>
<instance>
<name>NAME_3851102770</name>
<created_at>2023/10/09 11:06:02 +0000</created_at>
<updated_at>2023/10/09 11:06:02 +0000</updated_at>
<resource_uid>RESOURCE_1620899759</resource_uid>
<links>
<link rel="self" href="/api/clouds/888/instances/RESOURCE_1620899759;RAND"/>
<link rel="cloud" href="/api/clouds/888"/>
<link rel="deployment" href="/api/deployments/8"/>
<link rel="server_template" href="/api/server_templates/5"/>
<link rel="multi_cloud_image" href="/api/multi_cloud_images/2" inherited_source="server_template"/>
<link rel="parent" href="/api/servers/3"/>
<link rel="volume_attachments" href="/api/clouds/888/instances/RESOURCE_1620899759;RAND/volume_attachments"/>
<link rel="inputs" href="/api/clouds/888/instances/RESOURCE_1620899759;RAND/inputs"/>
<link rel="monitoring_metrics" href="/api/clouds/888/instances/RESOURCE_1620899759;RAND/monitoring_metrics"/>
<link rel="alerts" href="/api/clouds/888/instances/RESOURCE_1620899759;RAND/alerts"/>
<link rel="alert_specs" href="/api/clouds/888/instances/RESOURCE_1620899759;RAND/alert_specs"/>
</links>
<cloud_specific_attributes/>
<associate_public_ip_address>true</associate_public_ip_address>
<actions>
<action rel="terminate"/>
<action rel="reboot"/>
<action rel="run_executable"/>
<action rel="lock"/>
<action rel="unlock"/>
</actions>
<public_ip_addresses>
<public_ip_address>108.180.119.149</public_ip_address>
</public_ip_addresses>
<private_ip_addresses>
<private_ip_address>5.2.2.6</private_ip_address>
</private_ip_addresses>
<pricing_type>fixed</pricing_type>
<locked>false</locked>
<state>operational</state>
</instance>
</instances>
Click on a format below to see an example response for the 'extended' view:
JSON XML[{
"name": "NAME_409940392",
"created_at": "2023/10/09 11:06:01 +0000",
"updated_at": "2023/10/09 11:06:01 +0000",
"resource_uid": "RESOURCE_2014175382",
"links": [
{"rel":"self","href":"/api/clouds/888/instances/RESOURCE_2014175382;RAND"},
{"rel":"cloud","href":"/api/clouds/888"},
{"rel":"deployment","href":"/api/deployments/2"},
{"rel":"server_template","href":"/api/server_templates/1"},
{"rel":"multi_cloud_image","href":"/api/multi_cloud_images/1","inherited_source":"server_template"},
{"rel":"parent","href":"/api/servers/1"},
{"rel":"volume_attachments","href":"/api/clouds/888/instances/RESOURCE_2014175382;RAND/volume_attachments"},
{"rel":"inputs","href":"/api/clouds/888/instances/RESOURCE_2014175382;RAND/inputs"},
{"rel":"monitoring_metrics","href":"/api/clouds/888/instances/RESOURCE_2014175382;RAND/monitoring_metrics"},
{"rel":"alerts","href":"/api/clouds/888/instances/RESOURCE_2014175382;RAND/alerts"},
{"rel":"alert_specs","href":"/api/clouds/888/instances/RESOURCE_2014175382;RAND/alert_specs"},
{"rel":"image","href":"/api/clouds/888/images/RS_ID_3851540459"},
{"rel":"ramdisk_image","href":"/api/clouds/888/images/RS_ID_4246755185"},
{"rel":"kernel_image","href":"/api/clouds/888/images/RS_ID_2514725657"},
{"rel":"instance_type","href":"/api/clouds/888/instance_types/ABC2184952124DEF"},
{"rel":"ssh_key","href":"/api/clouds/888/ssh_keys/ABC1282514156DEF"},
{"rel":"placement_group","href":"/api/placement_groups/ABC273108500DEF"},
{"rel":"datacenter","href":"/api/clouds/888/datacenters/ABC2088339203DEF"}
],
"cloud_specific_attributes": {
},
"associate_public_ip_address": true,
"actions": [
{
"rel": "terminate"
},
{
"rel": "reboot"
},
{
"rel": "run_executable"
},
{
"rel": "lock"
},
{
"rel": "unlock"
}
],
"public_ip_addresses": [
"184.9.35.124"
],
"private_ip_addresses": [
"9.6.9.2"
],
"pricing_type": "fixed",
"locked": false,
"state": "operational",
"description": null,
"terminated_at": null,
"os_platform": null,
"monitoring_server": "tss9",
"monitoring_collector_http": "tss9.test.rightscale.com",
"monitoring_collector_udp": "tss-collectd9.test.rightscale.com",
"monitoring_id": "monitoring2545513424",
"public_dns_names": [
"test_publicdns_1265186551.com"
],
"private_dns_names": [
"test_privatedns_123756966.com"
],
"rs_provisioned": false,
"user_data": "ud_2426115256",
"security_groups": [
{
"href": "/api/clouds/888/security_groups/ABC2703541362DEF"
}
]
},{
"name": "NAME_3851102770",
"created_at": "2023/10/09 11:06:02 +0000",
"updated_at": "2023/10/09 11:06:02 +0000",
"resource_uid": "RESOURCE_1620899759",
"links": [
{"rel":"self","href":"/api/clouds/888/instances/RESOURCE_1620899759;RAND"},
{"rel":"cloud","href":"/api/clouds/888"},
{"rel":"deployment","href":"/api/deployments/8"},
{"rel":"server_template","href":"/api/server_templates/5"},
{"rel":"multi_cloud_image","href":"/api/multi_cloud_images/2","inherited_source":"server_template"},
{"rel":"parent","href":"/api/servers/3"},
{"rel":"volume_attachments","href":"/api/clouds/888/instances/RESOURCE_1620899759;RAND/volume_attachments"},
{"rel":"inputs","href":"/api/clouds/888/instances/RESOURCE_1620899759;RAND/inputs"},
{"rel":"monitoring_metrics","href":"/api/clouds/888/instances/RESOURCE_1620899759;RAND/monitoring_metrics"},
{"rel":"alerts","href":"/api/clouds/888/instances/RESOURCE_1620899759;RAND/alerts"},
{"rel":"alert_specs","href":"/api/clouds/888/instances/RESOURCE_1620899759;RAND/alert_specs"},
{"rel":"image","href":"/api/clouds/888/images/RS_ID_3646160098"},
{"rel":"ramdisk_image","href":"/api/clouds/888/images/RS_ID_4006670444"},
{"rel":"kernel_image","href":"/api/clouds/888/images/RS_ID_3807354873"},
{"rel":"instance_type","href":"/api/clouds/888/instance_types/ABC2635552027DEF"},
{"rel":"ssh_key","href":"/api/clouds/888/ssh_keys/ABC1746116948DEF"},
{"rel":"placement_group","href":"/api/placement_groups/ABC16707556DEF"},
{"rel":"datacenter","href":"/api/clouds/888/datacenters/ABC814479979DEF"}
],
"cloud_specific_attributes": {
},
"associate_public_ip_address": true,
"actions": [
{
"rel": "terminate"
},
{
"rel": "reboot"
},
{
"rel": "run_executable"
},
{
"rel": "lock"
},
{
"rel": "unlock"
}
],
"public_ip_addresses": [
"108.180.119.149"
],
"private_ip_addresses": [
"5.2.2.6"
],
"pricing_type": "fixed",
"locked": false,
"state": "operational",
"description": null,
"terminated_at": null,
"os_platform": null,
"monitoring_server": "tss9",
"monitoring_collector_http": "tss9.test.rightscale.com",
"monitoring_collector_udp": "tss-collectd9.test.rightscale.com",
"monitoring_id": "monitoring35216752",
"public_dns_names": [
"test_publicdns_4144881270.com"
],
"private_dns_names": [
"test_privatedns_3246063355.com"
],
"rs_provisioned": false,
"user_data": "ud_2357180185",
"security_groups": [
{
"href": "/api/clouds/888/security_groups/ABC1961895334DEF"
}
]
}]<?xml version="1.0" encoding="UTF-8"?>
<instances>
<instance>
<name>NAME_409940392</name>
<created_at>2023/10/09 11:06:01 +0000</created_at>
<updated_at>2023/10/09 11:06:01 +0000</updated_at>
<resource_uid>RESOURCE_2014175382</resource_uid>
<links>
<link rel="self" href="/api/clouds/888/instances/RESOURCE_2014175382;RAND"/>
<link rel="cloud" href="/api/clouds/888"/>
<link rel="deployment" href="/api/deployments/2"/>
<link rel="server_template" href="/api/server_templates/1"/>
<link rel="multi_cloud_image" href="/api/multi_cloud_images/1" inherited_source="server_template"/>
<link rel="parent" href="/api/servers/1"/>
<link rel="volume_attachments" href="/api/clouds/888/instances/RESOURCE_2014175382;RAND/volume_attachments"/>
<link rel="inputs" href="/api/clouds/888/instances/RESOURCE_2014175382;RAND/inputs"/>
<link rel="monitoring_metrics" href="/api/clouds/888/instances/RESOURCE_2014175382;RAND/monitoring_metrics"/>
<link rel="alerts" href="/api/clouds/888/instances/RESOURCE_2014175382;RAND/alerts"/>
<link rel="alert_specs" href="/api/clouds/888/instances/RESOURCE_2014175382;RAND/alert_specs"/>
<link rel="image" href="/api/clouds/888/images/RS_ID_3851540459"/>
<link rel="ramdisk_image" href="/api/clouds/888/images/RS_ID_4246755185"/>
<link rel="kernel_image" href="/api/clouds/888/images/RS_ID_2514725657"/>
<link rel="instance_type" href="/api/clouds/888/instance_types/ABC2184952124DEF"/>
<link rel="ssh_key" href="/api/clouds/888/ssh_keys/ABC1282514156DEF"/>
<link rel="placement_group" href="/api/placement_groups/ABC273108500DEF"/>
<link rel="datacenter" href="/api/clouds/888/datacenters/ABC2088339203DEF"/>
</links>
<cloud_specific_attributes/>
<associate_public_ip_address>true</associate_public_ip_address>
<actions>
<action rel="terminate"/>
<action rel="reboot"/>
<action rel="run_executable"/>
<action rel="lock"/>
<action rel="unlock"/>
</actions>
<public_ip_addresses>
<public_ip_address>184.9.35.124</public_ip_address>
</public_ip_addresses>
<private_ip_addresses>
<private_ip_address>9.6.9.2</private_ip_address>
</private_ip_addresses>
<pricing_type>fixed</pricing_type>
<locked>false</locked>
<state>operational</state>
<description/>
<terminated_at/>
<os_platform/>
<monitoring_server>tss9</monitoring_server>
<monitoring_collector_http>tss9.test.rightscale.com</monitoring_collector_http>
<monitoring_collector_udp>tss-collectd9.test.rightscale.com</monitoring_collector_udp>
<monitoring_id>monitoring2545513424</monitoring_id>
<public_dns_names>
<public_dns_name>test_publicdns_1265186551.com</public_dns_name>
</public_dns_names>
<private_dns_names>
<private_dns_name>test_privatedns_123756966.com</private_dns_name>
</private_dns_names>
<rs_provisioned>false</rs_provisioned>
<user_data>ud_2426115256</user_data>
<security_groups>
<security_group href="/api/clouds/888/security_groups/ABC2703541362DEF"/>
</security_groups>
</instance>
<instance>
<name>NAME_3851102770</name>
<created_at>2023/10/09 11:06:02 +0000</created_at>
<updated_at>2023/10/09 11:06:02 +0000</updated_at>
<resource_uid>RESOURCE_1620899759</resource_uid>
<links>
<link rel="self" href="/api/clouds/888/instances/RESOURCE_1620899759;RAND"/>
<link rel="cloud" href="/api/clouds/888"/>
<link rel="deployment" href="/api/deployments/8"/>
<link rel="server_template" href="/api/server_templates/5"/>
<link rel="multi_cloud_image" href="/api/multi_cloud_images/2" inherited_source="server_template"/>
<link rel="parent" href="/api/servers/3"/>
<link rel="volume_attachments" href="/api/clouds/888/instances/RESOURCE_1620899759;RAND/volume_attachments"/>
<link rel="inputs" href="/api/clouds/888/instances/RESOURCE_1620899759;RAND/inputs"/>
<link rel="monitoring_metrics" href="/api/clouds/888/instances/RESOURCE_1620899759;RAND/monitoring_metrics"/>
<link rel="alerts" href="/api/clouds/888/instances/RESOURCE_1620899759;RAND/alerts"/>
<link rel="alert_specs" href="/api/clouds/888/instances/RESOURCE_1620899759;RAND/alert_specs"/>
<link rel="image" href="/api/clouds/888/images/RS_ID_3646160098"/>
<link rel="ramdisk_image" href="/api/clouds/888/images/RS_ID_4006670444"/>
<link rel="kernel_image" href="/api/clouds/888/images/RS_ID_3807354873"/>
<link rel="instance_type" href="/api/clouds/888/instance_types/ABC2635552027DEF"/>
<link rel="ssh_key" href="/api/clouds/888/ssh_keys/ABC1746116948DEF"/>
<link rel="placement_group" href="/api/placement_groups/ABC16707556DEF"/>
<link rel="datacenter" href="/api/clouds/888/datacenters/ABC814479979DEF"/>
</links>
<cloud_specific_attributes/>
<associate_public_ip_address>true</associate_public_ip_address>
<actions>
<action rel="terminate"/>
<action rel="reboot"/>
<action rel="run_executable"/>
<action rel="lock"/>
<action rel="unlock"/>
</actions>
<public_ip_addresses>
<public_ip_address>108.180.119.149</public_ip_address>
</public_ip_addresses>
<private_ip_addresses>
<private_ip_address>5.2.2.6</private_ip_address>
</private_ip_addresses>
<pricing_type>fixed</pricing_type>
<locked>false</locked>
<state>operational</state>
<description/>
<terminated_at/>
<os_platform/>
<monitoring_server>tss9</monitoring_server>
<monitoring_collector_http>tss9.test.rightscale.com</monitoring_collector_http>
<monitoring_collector_udp>tss-collectd9.test.rightscale.com</monitoring_collector_udp>
<monitoring_id>monitoring35216752</monitoring_id>
<public_dns_names>
<public_dns_name>test_publicdns_4144881270.com</public_dns_name>
</public_dns_names>
<private_dns_names>
<private_dns_name>test_privatedns_3246063355.com</private_dns_name>
</private_dns_names>
<rs_provisioned>false</rs_provisioned>
<user_data>ud_2357180185</user_data>
<security_groups>
<security_group href="/api/clouds/888/security_groups/ABC1961895334DEF"/>
</security_groups>
</instance>
</instances>
Click on a format below to see an example response for the 'full' view:
JSON XML[{
"name": "NAME_409940392",
"created_at": "2023/10/09 11:06:01 +0000",
"updated_at": "2023/10/09 11:06:01 +0000",
"resource_uid": "RESOURCE_2014175382",
"links": [
{"rel":"self","href":"/api/clouds/888/instances/RESOURCE_2014175382;RAND"},
{"rel":"cloud","href":"/api/clouds/888"},
{"rel":"deployment","href":"/api/deployments/2"},
{"rel":"server_template","href":"/api/server_templates/1"},
{"rel":"multi_cloud_image","href":"/api/multi_cloud_images/1","inherited_source":"server_template"},
{"rel":"parent","href":"/api/servers/1"},
{"rel":"volume_attachments","href":"/api/clouds/888/instances/RESOURCE_2014175382;RAND/volume_attachments"},
{"rel":"inputs","href":"/api/clouds/888/instances/RESOURCE_2014175382;RAND/inputs"},
{"rel":"monitoring_metrics","href":"/api/clouds/888/instances/RESOURCE_2014175382;RAND/monitoring_metrics"},
{"rel":"alerts","href":"/api/clouds/888/instances/RESOURCE_2014175382;RAND/alerts"},
{"rel":"alert_specs","href":"/api/clouds/888/instances/RESOURCE_2014175382;RAND/alert_specs"},
{"rel":"image","href":"/api/clouds/888/images/RS_ID_3851540459"},
{"rel":"ramdisk_image","href":"/api/clouds/888/images/RS_ID_4246755185"},
{"rel":"kernel_image","href":"/api/clouds/888/images/RS_ID_2514725657"},
{"rel":"instance_type","href":"/api/clouds/888/instance_types/ABC2184952124DEF"},
{"rel":"ssh_key","href":"/api/clouds/888/ssh_keys/ABC1282514156DEF"},
{"rel":"placement_group","href":"/api/placement_groups/ABC273108500DEF"},
{"rel":"datacenter","href":"/api/clouds/888/datacenters/ABC2088339203DEF"}
],
"cloud_specific_attributes": {
},
"associate_public_ip_address": true,
"actions": [
{
"rel": "terminate"
},
{
"rel": "reboot"
},
{
"rel": "run_executable"
},
{
"rel": "lock"
},
{
"rel": "unlock"
}
],
"public_ip_addresses": [
"184.9.35.124"
],
"private_ip_addresses": [
"9.6.9.2"
],
"pricing_type": "fixed",
"locked": false,
"state": "operational",
"description": null,
"terminated_at": null,
"os_platform": null,
"monitoring_server": "tss9",
"monitoring_collector_http": "tss9.test.rightscale.com",
"monitoring_collector_udp": "tss-collectd9.test.rightscale.com",
"monitoring_id": "monitoring2545513424",
"public_dns_names": [
"test_publicdns_1265186551.com"
],
"private_dns_names": [
"test_privatedns_123756966.com"
],
"rs_provisioned": false,
"user_data": "ud_2426115256",
"security_groups": [
{
"href": "/api/clouds/888/security_groups/ABC2703541362DEF"
}
],
"inputs": [
{
"name": "FOO",
"value": "text:"
},
{
"name": "input_definition_3604220013",
"value": "text:"
},
{
"name": "input_definition_422628238",
"value": "text:"
}
]
},{
"name": "NAME_3851102770",
"created_at": "2023/10/09 11:06:02 +0000",
"updated_at": "2023/10/09 11:06:02 +0000",
"resource_uid": "RESOURCE_1620899759",
"links": [
{"rel":"self","href":"/api/clouds/888/instances/RESOURCE_1620899759;RAND"},
{"rel":"cloud","href":"/api/clouds/888"},
{"rel":"deployment","href":"/api/deployments/8"},
{"rel":"server_template","href":"/api/server_templates/5"},
{"rel":"multi_cloud_image","href":"/api/multi_cloud_images/2","inherited_source":"server_template"},
{"rel":"parent","href":"/api/servers/3"},
{"rel":"volume_attachments","href":"/api/clouds/888/instances/RESOURCE_1620899759;RAND/volume_attachments"},
{"rel":"inputs","href":"/api/clouds/888/instances/RESOURCE_1620899759;RAND/inputs"},
{"rel":"monitoring_metrics","href":"/api/clouds/888/instances/RESOURCE_1620899759;RAND/monitoring_metrics"},
{"rel":"alerts","href":"/api/clouds/888/instances/RESOURCE_1620899759;RAND/alerts"},
{"rel":"alert_specs","href":"/api/clouds/888/instances/RESOURCE_1620899759;RAND/alert_specs"},
{"rel":"image","href":"/api/clouds/888/images/RS_ID_3646160098"},
{"rel":"ramdisk_image","href":"/api/clouds/888/images/RS_ID_4006670444"},
{"rel":"kernel_image","href":"/api/clouds/888/images/RS_ID_3807354873"},
{"rel":"instance_type","href":"/api/clouds/888/instance_types/ABC2635552027DEF"},
{"rel":"ssh_key","href":"/api/clouds/888/ssh_keys/ABC1746116948DEF"},
{"rel":"placement_group","href":"/api/placement_groups/ABC16707556DEF"},
{"rel":"datacenter","href":"/api/clouds/888/datacenters/ABC814479979DEF"}
],
"cloud_specific_attributes": {
},
"associate_public_ip_address": true,
"actions": [
{
"rel": "terminate"
},
{
"rel": "reboot"
},
{
"rel": "run_executable"
},
{
"rel": "lock"
},
{
"rel": "unlock"
}
],
"public_ip_addresses": [
"108.180.119.149"
],
"private_ip_addresses": [
"5.2.2.6"
],
"pricing_type": "fixed",
"locked": false,
"state": "operational",
"description": null,
"terminated_at": null,
"os_platform": null,
"monitoring_server": "tss9",
"monitoring_collector_http": "tss9.test.rightscale.com",
"monitoring_collector_udp": "tss-collectd9.test.rightscale.com",
"monitoring_id": "monitoring35216752",
"public_dns_names": [
"test_publicdns_4144881270.com"
],
"private_dns_names": [
"test_privatedns_3246063355.com"
],
"rs_provisioned": false,
"user_data": "ud_2357180185",
"security_groups": [
{
"href": "/api/clouds/888/security_groups/ABC1961895334DEF"
}
],
"inputs": [
{
"name": "FOO",
"value": "text:"
},
{
"name": "input_definition_440612151",
"value": "text:"
},
{
"name": "input_definition_744357030",
"value": "text:"
}
]
}]<?xml version="1.0" encoding="UTF-8"?>
<instances>
<instance>
<name>NAME_409940392</name>
<created_at>2023/10/09 11:06:01 +0000</created_at>
<updated_at>2023/10/09 11:06:01 +0000</updated_at>
<resource_uid>RESOURCE_2014175382</resource_uid>
<links>
<link rel="self" href="/api/clouds/888/instances/RESOURCE_2014175382;RAND"/>
<link rel="cloud" href="/api/clouds/888"/>
<link rel="deployment" href="/api/deployments/2"/>
<link rel="server_template" href="/api/server_templates/1"/>
<link rel="multi_cloud_image" href="/api/multi_cloud_images/1" inherited_source="server_template"/>
<link rel="parent" href="/api/servers/1"/>
<link rel="volume_attachments" href="/api/clouds/888/instances/RESOURCE_2014175382;RAND/volume_attachments"/>
<link rel="inputs" href="/api/clouds/888/instances/RESOURCE_2014175382;RAND/inputs"/>
<link rel="monitoring_metrics" href="/api/clouds/888/instances/RESOURCE_2014175382;RAND/monitoring_metrics"/>
<link rel="alerts" href="/api/clouds/888/instances/RESOURCE_2014175382;RAND/alerts"/>
<link rel="alert_specs" href="/api/clouds/888/instances/RESOURCE_2014175382;RAND/alert_specs"/>
<link rel="image" href="/api/clouds/888/images/RS_ID_3851540459"/>
<link rel="ramdisk_image" href="/api/clouds/888/images/RS_ID_4246755185"/>
<link rel="kernel_image" href="/api/clouds/888/images/RS_ID_2514725657"/>
<link rel="instance_type" href="/api/clouds/888/instance_types/ABC2184952124DEF"/>
<link rel="ssh_key" href="/api/clouds/888/ssh_keys/ABC1282514156DEF"/>
<link rel="placement_group" href="/api/placement_groups/ABC273108500DEF"/>
<link rel="datacenter" href="/api/clouds/888/datacenters/ABC2088339203DEF"/>
</links>
<cloud_specific_attributes/>
<associate_public_ip_address>true</associate_public_ip_address>
<actions>
<action rel="terminate"/>
<action rel="reboot"/>
<action rel="run_executable"/>
<action rel="lock"/>
<action rel="unlock"/>
</actions>
<public_ip_addresses>
<public_ip_address>184.9.35.124</public_ip_address>
</public_ip_addresses>
<private_ip_addresses>
<private_ip_address>9.6.9.2</private_ip_address>
</private_ip_addresses>
<pricing_type>fixed</pricing_type>
<locked>false</locked>
<state>operational</state>
<description/>
<terminated_at/>
<os_platform/>
<monitoring_server>tss9</monitoring_server>
<monitoring_collector_http>tss9.test.rightscale.com</monitoring_collector_http>
<monitoring_collector_udp>tss-collectd9.test.rightscale.com</monitoring_collector_udp>
<monitoring_id>monitoring2545513424</monitoring_id>
<public_dns_names>
<public_dns_name>test_publicdns_1265186551.com</public_dns_name>
</public_dns_names>
<private_dns_names>
<private_dns_name>test_privatedns_123756966.com</private_dns_name>
</private_dns_names>
<rs_provisioned>false</rs_provisioned>
<user_data>ud_2426115256</user_data>
<security_groups>
<security_group href="/api/clouds/888/security_groups/ABC2703541362DEF"/>
</security_groups>
<inputs>
<input>
<name>FOO</name>
<value>text:</value>
</input>
<input>
<name>input_definition_3604220013</name>
<value>text:</value>
</input>
<input>
<name>input_definition_422628238</name>
<value>text:</value>
</input>
</inputs>
</instance>
<instance>
<name>NAME_3851102770</name>
<created_at>2023/10/09 11:06:02 +0000</created_at>
<updated_at>2023/10/09 11:06:02 +0000</updated_at>
<resource_uid>RESOURCE_1620899759</resource_uid>
<links>
<link rel="self" href="/api/clouds/888/instances/RESOURCE_1620899759;RAND"/>
<link rel="cloud" href="/api/clouds/888"/>
<link rel="deployment" href="/api/deployments/8"/>
<link rel="server_template" href="/api/server_templates/5"/>
<link rel="multi_cloud_image" href="/api/multi_cloud_images/2" inherited_source="server_template"/>
<link rel="parent" href="/api/servers/3"/>
<link rel="volume_attachments" href="/api/clouds/888/instances/RESOURCE_1620899759;RAND/volume_attachments"/>
<link rel="inputs" href="/api/clouds/888/instances/RESOURCE_1620899759;RAND/inputs"/>
<link rel="monitoring_metrics" href="/api/clouds/888/instances/RESOURCE_1620899759;RAND/monitoring_metrics"/>
<link rel="alerts" href="/api/clouds/888/instances/RESOURCE_1620899759;RAND/alerts"/>
<link rel="alert_specs" href="/api/clouds/888/instances/RESOURCE_1620899759;RAND/alert_specs"/>
<link rel="image" href="/api/clouds/888/images/RS_ID_3646160098"/>
<link rel="ramdisk_image" href="/api/clouds/888/images/RS_ID_4006670444"/>
<link rel="kernel_image" href="/api/clouds/888/images/RS_ID_3807354873"/>
<link rel="instance_type" href="/api/clouds/888/instance_types/ABC2635552027DEF"/>
<link rel="ssh_key" href="/api/clouds/888/ssh_keys/ABC1746116948DEF"/>
<link rel="placement_group" href="/api/placement_groups/ABC16707556DEF"/>
<link rel="datacenter" href="/api/clouds/888/datacenters/ABC814479979DEF"/>
</links>
<cloud_specific_attributes/>
<associate_public_ip_address>true</associate_public_ip_address>
<actions>
<action rel="terminate"/>
<action rel="reboot"/>
<action rel="run_executable"/>
<action rel="lock"/>
<action rel="unlock"/>
</actions>
<public_ip_addresses>
<public_ip_address>108.180.119.149</public_ip_address>
</public_ip_addresses>
<private_ip_addresses>
<private_ip_address>5.2.2.6</private_ip_address>
</private_ip_addresses>
<pricing_type>fixed</pricing_type>
<locked>false</locked>
<state>operational</state>
<description/>
<terminated_at/>
<os_platform/>
<monitoring_server>tss9</monitoring_server>
<monitoring_collector_http>tss9.test.rightscale.com</monitoring_collector_http>
<monitoring_collector_udp>tss-collectd9.test.rightscale.com</monitoring_collector_udp>
<monitoring_id>monitoring35216752</monitoring_id>
<public_dns_names>
<public_dns_name>test_publicdns_4144881270.com</public_dns_name>
</public_dns_names>
<private_dns_names>
<private_dns_name>test_privatedns_3246063355.com</private_dns_name>
</private_dns_names>
<rs_provisioned>false</rs_provisioned>
<user_data>ud_2357180185</user_data>
<security_groups>
<security_group href="/api/clouds/888/security_groups/ABC1961895334DEF"/>
</security_groups>
<inputs>
<input>
<name>FOO</name>
<value>text:</value>
</input>
<input>
<name>input_definition_440612151</name>
<value>text:</value>
</input>
<input>
<name>input_definition_744357030</name>
<value>text:</value>
</input>
</inputs>
</instance>
</instances>
Click on a format below to see an example response for the 'full_inputs_2_0' view:
JSON XML[{
"name": "NAME_409940392",
"created_at": "2023/10/09 11:06:01 +0000",
"updated_at": "2023/10/09 11:06:01 +0000",
"resource_uid": "RESOURCE_2014175382",
"links": [
{"rel":"self","href":"/api/clouds/888/instances/RESOURCE_2014175382;RAND"},
{"rel":"cloud","href":"/api/clouds/888"},
{"rel":"deployment","href":"/api/deployments/2"},
{"rel":"server_template","href":"/api/server_templates/1"},
{"rel":"multi_cloud_image","href":"/api/multi_cloud_images/1","inherited_source":"server_template"},
{"rel":"parent","href":"/api/servers/1"},
{"rel":"volume_attachments","href":"/api/clouds/888/instances/RESOURCE_2014175382;RAND/volume_attachments"},
{"rel":"inputs","href":"/api/clouds/888/instances/RESOURCE_2014175382;RAND/inputs"},
{"rel":"monitoring_metrics","href":"/api/clouds/888/instances/RESOURCE_2014175382;RAND/monitoring_metrics"},
{"rel":"alerts","href":"/api/clouds/888/instances/RESOURCE_2014175382;RAND/alerts"},
{"rel":"alert_specs","href":"/api/clouds/888/instances/RESOURCE_2014175382;RAND/alert_specs"},
{"rel":"image","href":"/api/clouds/888/images/RS_ID_3851540459"},
{"rel":"ramdisk_image","href":"/api/clouds/888/images/RS_ID_4246755185"},
{"rel":"kernel_image","href":"/api/clouds/888/images/RS_ID_2514725657"},
{"rel":"instance_type","href":"/api/clouds/888/instance_types/ABC2184952124DEF"},
{"rel":"ssh_key","href":"/api/clouds/888/ssh_keys/ABC1282514156DEF"},
{"rel":"placement_group","href":"/api/placement_groups/ABC273108500DEF"},
{"rel":"datacenter","href":"/api/clouds/888/datacenters/ABC2088339203DEF"}
],
"cloud_specific_attributes": {
},
"associate_public_ip_address": true,
"actions": [
{
"rel": "terminate"
},
{
"rel": "reboot"
},
{
"rel": "run_executable"
},
{
"rel": "lock"
},
{
"rel": "unlock"
}
],
"public_ip_addresses": [
"184.9.35.124"
],
"private_ip_addresses": [
"9.6.9.2"
],
"pricing_type": "fixed",
"locked": false,
"state": "operational",
"description": null,
"terminated_at": null,
"os_platform": null,
"monitoring_server": "tss9",
"monitoring_collector_http": "tss9.test.rightscale.com",
"monitoring_collector_udp": "tss-collectd9.test.rightscale.com",
"monitoring_id": "monitoring2545513424",
"public_dns_names": [
"test_publicdns_1265186551.com"
],
"private_dns_names": [
"test_privatedns_123756966.com"
],
"rs_provisioned": false,
"user_data": "ud_2426115256",
"security_groups": [
{
"href": "/api/clouds/888/security_groups/ABC2703541362DEF"
}
],
"inputs": [
{
"name": "FOO",
"value": "blank"
},
{
"name": "input_definition_3604220013",
"value": "blank"
},
{
"name": "input_definition_422628238",
"value": "blank"
}
]
},{
"name": "NAME_3851102770",
"created_at": "2023/10/09 11:06:02 +0000",
"updated_at": "2023/10/09 11:06:02 +0000",
"resource_uid": "RESOURCE_1620899759",
"links": [
{"rel":"self","href":"/api/clouds/888/instances/RESOURCE_1620899759;RAND"},
{"rel":"cloud","href":"/api/clouds/888"},
{"rel":"deployment","href":"/api/deployments/8"},
{"rel":"server_template","href":"/api/server_templates/5"},
{"rel":"multi_cloud_image","href":"/api/multi_cloud_images/2","inherited_source":"server_template"},
{"rel":"parent","href":"/api/servers/3"},
{"rel":"volume_attachments","href":"/api/clouds/888/instances/RESOURCE_1620899759;RAND/volume_attachments"},
{"rel":"inputs","href":"/api/clouds/888/instances/RESOURCE_1620899759;RAND/inputs"},
{"rel":"monitoring_metrics","href":"/api/clouds/888/instances/RESOURCE_1620899759;RAND/monitoring_metrics"},
{"rel":"alerts","href":"/api/clouds/888/instances/RESOURCE_1620899759;RAND/alerts"},
{"rel":"alert_specs","href":"/api/clouds/888/instances/RESOURCE_1620899759;RAND/alert_specs"},
{"rel":"image","href":"/api/clouds/888/images/RS_ID_3646160098"},
{"rel":"ramdisk_image","href":"/api/clouds/888/images/RS_ID_4006670444"},
{"rel":"kernel_image","href":"/api/clouds/888/images/RS_ID_3807354873"},
{"rel":"instance_type","href":"/api/clouds/888/instance_types/ABC2635552027DEF"},
{"rel":"ssh_key","href":"/api/clouds/888/ssh_keys/ABC1746116948DEF"},
{"rel":"placement_group","href":"/api/placement_groups/ABC16707556DEF"},
{"rel":"datacenter","href":"/api/clouds/888/datacenters/ABC814479979DEF"}
],
"cloud_specific_attributes": {
},
"associate_public_ip_address": true,
"actions": [
{
"rel": "terminate"
},
{
"rel": "reboot"
},
{
"rel": "run_executable"
},
{
"rel": "lock"
},
{
"rel": "unlock"
}
],
"public_ip_addresses": [
"108.180.119.149"
],
"private_ip_addresses": [
"5.2.2.6"
],
"pricing_type": "fixed",
"locked": false,
"state": "operational",
"description": null,
"terminated_at": null,
"os_platform": null,
"monitoring_server": "tss9",
"monitoring_collector_http": "tss9.test.rightscale.com",
"monitoring_collector_udp": "tss-collectd9.test.rightscale.com",
"monitoring_id": "monitoring35216752",
"public_dns_names": [
"test_publicdns_4144881270.com"
],
"private_dns_names": [
"test_privatedns_3246063355.com"
],
"rs_provisioned": false,
"user_data": "ud_2357180185",
"security_groups": [
{
"href": "/api/clouds/888/security_groups/ABC1961895334DEF"
}
],
"inputs": [
{
"name": "FOO",
"value": "blank"
},
{
"name": "input_definition_440612151",
"value": "blank"
},
{
"name": "input_definition_744357030",
"value": "blank"
}
]
}]<?xml version="1.0" encoding="UTF-8"?>
<instances>
<instance>
<name>NAME_409940392</name>
<created_at>2023/10/09 11:06:01 +0000</created_at>
<updated_at>2023/10/09 11:06:01 +0000</updated_at>
<resource_uid>RESOURCE_2014175382</resource_uid>
<links>
<link rel="self" href="/api/clouds/888/instances/RESOURCE_2014175382;RAND"/>
<link rel="cloud" href="/api/clouds/888"/>
<link rel="deployment" href="/api/deployments/2"/>
<link rel="server_template" href="/api/server_templates/1"/>
<link rel="multi_cloud_image" href="/api/multi_cloud_images/1" inherited_source="server_template"/>
<link rel="parent" href="/api/servers/1"/>
<link rel="volume_attachments" href="/api/clouds/888/instances/RESOURCE_2014175382;RAND/volume_attachments"/>
<link rel="inputs" href="/api/clouds/888/instances/RESOURCE_2014175382;RAND/inputs"/>
<link rel="monitoring_metrics" href="/api/clouds/888/instances/RESOURCE_2014175382;RAND/monitoring_metrics"/>
<link rel="alerts" href="/api/clouds/888/instances/RESOURCE_2014175382;RAND/alerts"/>
<link rel="alert_specs" href="/api/clouds/888/instances/RESOURCE_2014175382;RAND/alert_specs"/>
<link rel="image" href="/api/clouds/888/images/RS_ID_3851540459"/>
<link rel="ramdisk_image" href="/api/clouds/888/images/RS_ID_4246755185"/>
<link rel="kernel_image" href="/api/clouds/888/images/RS_ID_2514725657"/>
<link rel="instance_type" href="/api/clouds/888/instance_types/ABC2184952124DEF"/>
<link rel="ssh_key" href="/api/clouds/888/ssh_keys/ABC1282514156DEF"/>
<link rel="placement_group" href="/api/placement_groups/ABC273108500DEF"/>
<link rel="datacenter" href="/api/clouds/888/datacenters/ABC2088339203DEF"/>
</links>
<cloud_specific_attributes/>
<associate_public_ip_address>true</associate_public_ip_address>
<actions>
<action rel="terminate"/>
<action rel="reboot"/>
<action rel="run_executable"/>
<action rel="lock"/>
<action rel="unlock"/>
</actions>
<public_ip_addresses>
<public_ip_address>184.9.35.124</public_ip_address>
</public_ip_addresses>
<private_ip_addresses>
<private_ip_address>9.6.9.2</private_ip_address>
</private_ip_addresses>
<pricing_type>fixed</pricing_type>
<locked>false</locked>
<state>operational</state>
<description/>
<terminated_at/>
<os_platform/>
<monitoring_server>tss9</monitoring_server>
<monitoring_collector_http>tss9.test.rightscale.com</monitoring_collector_http>
<monitoring_collector_udp>tss-collectd9.test.rightscale.com</monitoring_collector_udp>
<monitoring_id>monitoring2545513424</monitoring_id>
<public_dns_names>
<public_dns_name>test_publicdns_1265186551.com</public_dns_name>
</public_dns_names>
<private_dns_names>
<private_dns_name>test_privatedns_123756966.com</private_dns_name>
</private_dns_names>
<rs_provisioned>false</rs_provisioned>
<user_data>ud_2426115256</user_data>
<security_groups>
<security_group href="/api/clouds/888/security_groups/ABC2703541362DEF"/>
</security_groups>
<inputs>
<input>
<name>FOO</name>
<value>blank</value>
</input>
<input>
<name>input_definition_3604220013</name>
<value>blank</value>
</input>
<input>
<name>input_definition_422628238</name>
<value>blank</value>
</input>
</inputs>
</instance>
<instance>
<name>NAME_3851102770</name>
<created_at>2023/10/09 11:06:02 +0000</created_at>
<updated_at>2023/10/09 11:06:02 +0000</updated_at>
<resource_uid>RESOURCE_1620899759</resource_uid>
<links>
<link rel="self" href="/api/clouds/888/instances/RESOURCE_1620899759;RAND"/>
<link rel="cloud" href="/api/clouds/888"/>
<link rel="deployment" href="/api/deployments/8"/>
<link rel="server_template" href="/api/server_templates/5"/>
<link rel="multi_cloud_image" href="/api/multi_cloud_images/2" inherited_source="server_template"/>
<link rel="parent" href="/api/servers/3"/>
<link rel="volume_attachments" href="/api/clouds/888/instances/RESOURCE_1620899759;RAND/volume_attachments"/>
<link rel="inputs" href="/api/clouds/888/instances/RESOURCE_1620899759;RAND/inputs"/>
<link rel="monitoring_metrics" href="/api/clouds/888/instances/RESOURCE_1620899759;RAND/monitoring_metrics"/>
<link rel="alerts" href="/api/clouds/888/instances/RESOURCE_1620899759;RAND/alerts"/>
<link rel="alert_specs" href="/api/clouds/888/instances/RESOURCE_1620899759;RAND/alert_specs"/>
<link rel="image" href="/api/clouds/888/images/RS_ID_3646160098"/>
<link rel="ramdisk_image" href="/api/clouds/888/images/RS_ID_4006670444"/>
<link rel="kernel_image" href="/api/clouds/888/images/RS_ID_3807354873"/>
<link rel="instance_type" href="/api/clouds/888/instance_types/ABC2635552027DEF"/>
<link rel="ssh_key" href="/api/clouds/888/ssh_keys/ABC1746116948DEF"/>
<link rel="placement_group" href="/api/placement_groups/ABC16707556DEF"/>
<link rel="datacenter" href="/api/clouds/888/datacenters/ABC814479979DEF"/>
</links>
<cloud_specific_attributes/>
<associate_public_ip_address>true</associate_public_ip_address>
<actions>
<action rel="terminate"/>
<action rel="reboot"/>
<action rel="run_executable"/>
<action rel="lock"/>
<action rel="unlock"/>
</actions>
<public_ip_addresses>
<public_ip_address>108.180.119.149</public_ip_address>
</public_ip_addresses>
<private_ip_addresses>
<private_ip_address>5.2.2.6</private_ip_address>
</private_ip_addresses>
<pricing_type>fixed</pricing_type>
<locked>false</locked>
<state>operational</state>
<description/>
<terminated_at/>
<os_platform/>
<monitoring_server>tss9</monitoring_server>
<monitoring_collector_http>tss9.test.rightscale.com</monitoring_collector_http>
<monitoring_collector_udp>tss-collectd9.test.rightscale.com</monitoring_collector_udp>
<monitoring_id>monitoring35216752</monitoring_id>
<public_dns_names>
<public_dns_name>test_publicdns_4144881270.com</public_dns_name>
</public_dns_names>
<private_dns_names>
<private_dns_name>test_privatedns_3246063355.com</private_dns_name>
</private_dns_names>
<rs_provisioned>false</rs_provisioned>
<user_data>ud_2357180185</user_data>
<security_groups>
<security_group href="/api/clouds/888/security_groups/ABC1961895334DEF"/>
</security_groups>
<inputs>
<input>
<name>FOO</name>
<value>blank</value>
</input>
<input>
<name>input_definition_440612151</name>
<value>blank</value>
</input>
<input>
<name>input_definition_744357030</name>
<value>blank</value>
</input>
</inputs>
</instance>
</instances>
Click on a format below to see an example response for the 'tiny' view:
JSON XML[{
"name": "NAME_409940392",
"created_at": "2023/10/09 11:06:01 +0000",
"updated_at": "2023/10/09 11:06:01 +0000",
"resource_uid": "RESOURCE_2014175382",
"links": [
{"rel":"self","href":"/api/clouds/888/instances/RESOURCE_2014175382;RAND"}
]
},{
"name": "NAME_3851102770",
"created_at": "2023/10/09 11:06:02 +0000",
"updated_at": "2023/10/09 11:06:02 +0000",
"resource_uid": "RESOURCE_1620899759",
"links": [
{"rel":"self","href":"/api/clouds/888/instances/RESOURCE_1620899759;RAND"}
]
}]<?xml version="1.0" encoding="UTF-8"?>
<instances>
<instance>
<name>NAME_409940392</name>
<created_at>2023/10/09 11:06:01 +0000</created_at>
<updated_at>2023/10/09 11:06:01 +0000</updated_at>
<resource_uid>RESOURCE_2014175382</resource_uid>
<links>
<link rel="self" href="/api/clouds/888/instances/RESOURCE_2014175382;RAND"/>
</links>
</instance>
<instance>
<name>NAME_3851102770</name>
<created_at>2023/10/09 11:06:02 +0000</created_at>
<updated_at>2023/10/09 11:06:02 +0000</updated_at>
<resource_uid>RESOURCE_1620899759</resource_uid>
<links>
<link rel="self" href="/api/clouds/888/instances/RESOURCE_1620899759;RAND"/>
</links>
</instance>
</instances>
Click on a format below to see an example response for the 'sensitive' view:
JSON XML[{
"name": "NAME_409940392",
"created_at": "2023/10/09 11:06:01 +0000",
"updated_at": "2023/10/09 11:06:01 +0000",
"resource_uid": "RESOURCE_2014175382",
"links": [
{"rel":"self","href":"/api/clouds/888/instances/RESOURCE_2014175382;RAND"},
{"rel":"cloud","href":"/api/clouds/888"},
{"rel":"deployment","href":"/api/deployments/2"},
{"rel":"server_template","href":"/api/server_templates/1"},
{"rel":"multi_cloud_image","href":"/api/multi_cloud_images/1","inherited_source":"server_template"},
{"rel":"parent","href":"/api/servers/1"},
{"rel":"volume_attachments","href":"/api/clouds/888/instances/RESOURCE_2014175382;RAND/volume_attachments"},
{"rel":"inputs","href":"/api/clouds/888/instances/RESOURCE_2014175382;RAND/inputs"},
{"rel":"monitoring_metrics","href":"/api/clouds/888/instances/RESOURCE_2014175382;RAND/monitoring_metrics"},
{"rel":"alerts","href":"/api/clouds/888/instances/RESOURCE_2014175382;RAND/alerts"},
{"rel":"alert_specs","href":"/api/clouds/888/instances/RESOURCE_2014175382;RAND/alert_specs"}
],
"cloud_specific_attributes": {
},
"associate_public_ip_address": true,
"actions": [
{
"rel": "terminate"
},
{
"rel": "reboot"
},
{
"rel": "run_executable"
},
{
"rel": "lock"
},
{
"rel": "unlock"
}
],
"public_ip_addresses": [
"184.9.35.124"
],
"private_ip_addresses": [
"9.6.9.2"
],
"pricing_type": "fixed",
"locked": false,
"state": "operational"
},{
"name": "NAME_3851102770",
"created_at": "2023/10/09 11:06:02 +0000",
"updated_at": "2023/10/09 11:06:02 +0000",
"resource_uid": "RESOURCE_1620899759",
"links": [
{"rel":"self","href":"/api/clouds/888/instances/RESOURCE_1620899759;RAND"},
{"rel":"cloud","href":"/api/clouds/888"},
{"rel":"deployment","href":"/api/deployments/8"},
{"rel":"server_template","href":"/api/server_templates/5"},
{"rel":"multi_cloud_image","href":"/api/multi_cloud_images/2","inherited_source":"server_template"},
{"rel":"parent","href":"/api/servers/3"},
{"rel":"volume_attachments","href":"/api/clouds/888/instances/RESOURCE_1620899759;RAND/volume_attachments"},
{"rel":"inputs","href":"/api/clouds/888/instances/RESOURCE_1620899759;RAND/inputs"},
{"rel":"monitoring_metrics","href":"/api/clouds/888/instances/RESOURCE_1620899759;RAND/monitoring_metrics"},
{"rel":"alerts","href":"/api/clouds/888/instances/RESOURCE_1620899759;RAND/alerts"},
{"rel":"alert_specs","href":"/api/clouds/888/instances/RESOURCE_1620899759;RAND/alert_specs"}
],
"cloud_specific_attributes": {
},
"associate_public_ip_address": true,
"actions": [
{
"rel": "terminate"
},
{
"rel": "reboot"
},
{
"rel": "run_executable"
},
{
"rel": "lock"
},
{
"rel": "unlock"
}
],
"public_ip_addresses": [
"108.180.119.149"
],
"private_ip_addresses": [
"5.2.2.6"
],
"pricing_type": "fixed",
"locked": false,
"state": "operational"
}]<?xml version="1.0" encoding="UTF-8"?>
<instances>
<instance>
<name>NAME_409940392</name>
<created_at>2023/10/09 11:06:01 +0000</created_at>
<updated_at>2023/10/09 11:06:01 +0000</updated_at>
<resource_uid>RESOURCE_2014175382</resource_uid>
<links>
<link rel="self" href="/api/clouds/888/instances/RESOURCE_2014175382;RAND"/>
<link rel="cloud" href="/api/clouds/888"/>
<link rel="deployment" href="/api/deployments/2"/>
<link rel="server_template" href="/api/server_templates/1"/>
<link rel="multi_cloud_image" href="/api/multi_cloud_images/1" inherited_source="server_template"/>
<link rel="parent" href="/api/servers/1"/>
<link rel="volume_attachments" href="/api/clouds/888/instances/RESOURCE_2014175382;RAND/volume_attachments"/>
<link rel="inputs" href="/api/clouds/888/instances/RESOURCE_2014175382;RAND/inputs"/>
<link rel="monitoring_metrics" href="/api/clouds/888/instances/RESOURCE_2014175382;RAND/monitoring_metrics"/>
<link rel="alerts" href="/api/clouds/888/instances/RESOURCE_2014175382;RAND/alerts"/>
<link rel="alert_specs" href="/api/clouds/888/instances/RESOURCE_2014175382;RAND/alert_specs"/>
</links>
<cloud_specific_attributes/>
<associate_public_ip_address>true</associate_public_ip_address>
<actions>
<action rel="terminate"/>
<action rel="reboot"/>
<action rel="run_executable"/>
<action rel="lock"/>
<action rel="unlock"/>
</actions>
<public_ip_addresses>
<public_ip_address>184.9.35.124</public_ip_address>
</public_ip_addresses>
<private_ip_addresses>
<private_ip_address>9.6.9.2</private_ip_address>
</private_ip_addresses>
<pricing_type>fixed</pricing_type>
<locked>false</locked>
<state>operational</state>
</instance>
<instance>
<name>NAME_3851102770</name>
<created_at>2023/10/09 11:06:02 +0000</created_at>
<updated_at>2023/10/09 11:06:02 +0000</updated_at>
<resource_uid>RESOURCE_1620899759</resource_uid>
<links>
<link rel="self" href="/api/clouds/888/instances/RESOURCE_1620899759;RAND"/>
<link rel="cloud" href="/api/clouds/888"/>
<link rel="deployment" href="/api/deployments/8"/>
<link rel="server_template" href="/api/server_templates/5"/>
<link rel="multi_cloud_image" href="/api/multi_cloud_images/2" inherited_source="server_template"/>
<link rel="parent" href="/api/servers/3"/>
<link rel="volume_attachments" href="/api/clouds/888/instances/RESOURCE_1620899759;RAND/volume_attachments"/>
<link rel="inputs" href="/api/clouds/888/instances/RESOURCE_1620899759;RAND/inputs"/>
<link rel="monitoring_metrics" href="/api/clouds/888/instances/RESOURCE_1620899759;RAND/monitoring_metrics"/>
<link rel="alerts" href="/api/clouds/888/instances/RESOURCE_1620899759;RAND/alerts"/>
<link rel="alert_specs" href="/api/clouds/888/instances/RESOURCE_1620899759;RAND/alert_specs"/>
</links>
<cloud_specific_attributes/>
<associate_public_ip_address>true</associate_public_ip_address>
<actions>
<action rel="terminate"/>
<action rel="reboot"/>
<action rel="run_executable"/>
<action rel="lock"/>
<action rel="unlock"/>
</actions>
<public_ip_addresses>
<public_ip_address>108.180.119.149</public_ip_address>
</public_ip_addresses>
<private_ip_addresses>
<private_ip_address>5.2.2.6</private_ip_address>
</private_ip_addresses>
<pricing_type>fixed</pricing_type>
<locked>false</locked>
<state>operational</state>
</instance>
</instances>
show
Shows attributes of a single instance.
The 'full_inputs_2_0' view is for retrieving inputs in 2.0 serialization (for more details please see Inputs#index.)
- URLs
- GET /api/clouds/:cloud_id/instances/:id
- HTTP response code
- 200 OK
- Content-type
- application/vnd.rightscale.instance
Required roles
- observer||instance
Parameters
| name | required | type | values | regexp | blank? | description |
|---|---|---|---|---|---|---|
| view | no | String | default, extended, full, full_inputs_2_0, tiny, sensitive | * | no | Specifies how many attributes and/or expanded nested relationships to include. |
Example Responses
Click on a format below to see an example response for the 'default' view:
JSON XML{
"name": "NAME_409940392",
"created_at": "2023/10/09 11:06:01 +0000",
"updated_at": "2023/10/09 11:06:01 +0000",
"resource_uid": "RESOURCE_2014175382",
"links": [
{"rel":"self","href":"/api/clouds/888/instances/RESOURCE_2014175382;RAND"},
{"rel":"cloud","href":"/api/clouds/888"},
{"rel":"deployment","href":"/api/deployments/2"},
{"rel":"server_template","href":"/api/server_templates/1"},
{"rel":"multi_cloud_image","href":"/api/multi_cloud_images/1","inherited_source":"server_template"},
{"rel":"parent","href":"/api/servers/1"},
{"rel":"volume_attachments","href":"/api/clouds/888/instances/RESOURCE_2014175382;RAND/volume_attachments"},
{"rel":"inputs","href":"/api/clouds/888/instances/RESOURCE_2014175382;RAND/inputs"},
{"rel":"monitoring_metrics","href":"/api/clouds/888/instances/RESOURCE_2014175382;RAND/monitoring_metrics"},
{"rel":"alerts","href":"/api/clouds/888/instances/RESOURCE_2014175382;RAND/alerts"},
{"rel":"alert_specs","href":"/api/clouds/888/instances/RESOURCE_2014175382;RAND/alert_specs"}
],
"cloud_specific_attributes": {
},
"associate_public_ip_address": true,
"actions": [
{
"rel": "terminate"
},
{
"rel": "reboot"
},
{
"rel": "run_executable"
},
{
"rel": "lock"
},
{
"rel": "unlock"
}
],
"public_ip_addresses": [
"184.9.35.124"
],
"private_ip_addresses": [
"9.6.9.2"
],
"pricing_type": "fixed",
"locked": false,
"state": "operational"
}<?xml version="1.0" encoding="UTF-8"?>
<instance>
<name>NAME_409940392</name>
<created_at>2023/10/09 11:06:01 +0000</created_at>
<updated_at>2023/10/09 11:06:01 +0000</updated_at>
<resource_uid>RESOURCE_2014175382</resource_uid>
<links>
<link rel="self" href="/api/clouds/888/instances/RESOURCE_2014175382;RAND"/>
<link rel="cloud" href="/api/clouds/888"/>
<link rel="deployment" href="/api/deployments/2"/>
<link rel="server_template" href="/api/server_templates/1"/>
<link rel="multi_cloud_image" href="/api/multi_cloud_images/1" inherited_source="server_template"/>
<link rel="parent" href="/api/servers/1"/>
<link rel="volume_attachments" href="/api/clouds/888/instances/RESOURCE_2014175382;RAND/volume_attachments"/>
<link rel="inputs" href="/api/clouds/888/instances/RESOURCE_2014175382;RAND/inputs"/>
<link rel="monitoring_metrics" href="/api/clouds/888/instances/RESOURCE_2014175382;RAND/monitoring_metrics"/>
<link rel="alerts" href="/api/clouds/888/instances/RESOURCE_2014175382;RAND/alerts"/>
<link rel="alert_specs" href="/api/clouds/888/instances/RESOURCE_2014175382;RAND/alert_specs"/>
</links>
<cloud_specific_attributes/>
<associate_public_ip_address>true</associate_public_ip_address>
<actions>
<action rel="terminate"/>
<action rel="reboot"/>
<action rel="run_executable"/>
<action rel="lock"/>
<action rel="unlock"/>
</actions>
<public_ip_addresses>
<public_ip_address>184.9.35.124</public_ip_address>
</public_ip_addresses>
<private_ip_addresses>
<private_ip_address>9.6.9.2</private_ip_address>
</private_ip_addresses>
<pricing_type>fixed</pricing_type>
<locked>false</locked>
<state>operational</state>
</instance>
Click on a format below to see an example response for the 'extended' view:
JSON XML{
"name": "NAME_409940392",
"created_at": "2023/10/09 11:06:01 +0000",
"updated_at": "2023/10/09 11:06:01 +0000",
"resource_uid": "RESOURCE_2014175382",
"links": [
{"rel":"self","href":"/api/clouds/888/instances/RESOURCE_2014175382;RAND"},
{"rel":"cloud","href":"/api/clouds/888"},
{"rel":"deployment","href":"/api/deployments/2"},
{"rel":"server_template","href":"/api/server_templates/1"},
{"rel":"multi_cloud_image","href":"/api/multi_cloud_images/1","inherited_source":"server_template"},
{"rel":"parent","href":"/api/servers/1"},
{"rel":"volume_attachments","href":"/api/clouds/888/instances/RESOURCE_2014175382;RAND/volume_attachments"},
{"rel":"inputs","href":"/api/clouds/888/instances/RESOURCE_2014175382;RAND/inputs"},
{"rel":"monitoring_metrics","href":"/api/clouds/888/instances/RESOURCE_2014175382;RAND/monitoring_metrics"},
{"rel":"alerts","href":"/api/clouds/888/instances/RESOURCE_2014175382;RAND/alerts"},
{"rel":"alert_specs","href":"/api/clouds/888/instances/RESOURCE_2014175382;RAND/alert_specs"},
{"rel":"image","href":"/api/clouds/888/images/RS_ID_3851540459"},
{"rel":"ramdisk_image","href":"/api/clouds/888/images/RS_ID_4246755185"},
{"rel":"kernel_image","href":"/api/clouds/888/images/RS_ID_2514725657"},
{"rel":"instance_type","href":"/api/clouds/888/instance_types/ABC2184952124DEF"},
{"rel":"ssh_key","href":"/api/clouds/888/ssh_keys/ABC1282514156DEF"},
{"rel":"placement_group","href":"/api/placement_groups/ABC273108500DEF"},
{"rel":"datacenter","href":"/api/clouds/888/datacenters/ABC2088339203DEF"}
],
"cloud_specific_attributes": {
},
"associate_public_ip_address": true,
"actions": [
{
"rel": "terminate"
},
{
"rel": "reboot"
},
{
"rel": "run_executable"
},
{
"rel": "lock"
},
{
"rel": "unlock"
}
],
"public_ip_addresses": [
"184.9.35.124"
],
"private_ip_addresses": [
"9.6.9.2"
],
"pricing_type": "fixed",
"locked": false,
"state": "operational",
"description": null,
"terminated_at": null,
"os_platform": null,
"monitoring_server": "tss9",
"monitoring_collector_http": "tss9.test.rightscale.com",
"monitoring_collector_udp": "tss-collectd9.test.rightscale.com",
"monitoring_id": "monitoring2545513424",
"public_dns_names": [
"test_publicdns_1265186551.com"
],
"private_dns_names": [
"test_privatedns_123756966.com"
],
"rs_provisioned": false,
"user_data": "ud_2426115256",
"security_groups": [
{
"href": "/api/clouds/888/security_groups/ABC2703541362DEF"
}
]
}<?xml version="1.0" encoding="UTF-8"?>
<instance>
<name>NAME_409940392</name>
<created_at>2023/10/09 11:06:01 +0000</created_at>
<updated_at>2023/10/09 11:06:01 +0000</updated_at>
<resource_uid>RESOURCE_2014175382</resource_uid>
<links>
<link rel="self" href="/api/clouds/888/instances/RESOURCE_2014175382;RAND"/>
<link rel="cloud" href="/api/clouds/888"/>
<link rel="deployment" href="/api/deployments/2"/>
<link rel="server_template" href="/api/server_templates/1"/>
<link rel="multi_cloud_image" href="/api/multi_cloud_images/1" inherited_source="server_template"/>
<link rel="parent" href="/api/servers/1"/>
<link rel="volume_attachments" href="/api/clouds/888/instances/RESOURCE_2014175382;RAND/volume_attachments"/>
<link rel="inputs" href="/api/clouds/888/instances/RESOURCE_2014175382;RAND/inputs"/>
<link rel="monitoring_metrics" href="/api/clouds/888/instances/RESOURCE_2014175382;RAND/monitoring_metrics"/>
<link rel="alerts" href="/api/clouds/888/instances/RESOURCE_2014175382;RAND/alerts"/>
<link rel="alert_specs" href="/api/clouds/888/instances/RESOURCE_2014175382;RAND/alert_specs"/>
<link rel="image" href="/api/clouds/888/images/RS_ID_3851540459"/>
<link rel="ramdisk_image" href="/api/clouds/888/images/RS_ID_4246755185"/>
<link rel="kernel_image" href="/api/clouds/888/images/RS_ID_2514725657"/>
<link rel="instance_type" href="/api/clouds/888/instance_types/ABC2184952124DEF"/>
<link rel="ssh_key" href="/api/clouds/888/ssh_keys/ABC1282514156DEF"/>
<link rel="placement_group" href="/api/placement_groups/ABC273108500DEF"/>
<link rel="datacenter" href="/api/clouds/888/datacenters/ABC2088339203DEF"/>
</links>
<cloud_specific_attributes/>
<associate_public_ip_address>true</associate_public_ip_address>
<actions>
<action rel="terminate"/>
<action rel="reboot"/>
<action rel="run_executable"/>
<action rel="lock"/>
<action rel="unlock"/>
</actions>
<public_ip_addresses>
<public_ip_address>184.9.35.124</public_ip_address>
</public_ip_addresses>
<private_ip_addresses>
<private_ip_address>9.6.9.2</private_ip_address>
</private_ip_addresses>
<pricing_type>fixed</pricing_type>
<locked>false</locked>
<state>operational</state>
<description/>
<terminated_at/>
<os_platform/>
<monitoring_server>tss9</monitoring_server>
<monitoring_collector_http>tss9.test.rightscale.com</monitoring_collector_http>
<monitoring_collector_udp>tss-collectd9.test.rightscale.com</monitoring_collector_udp>
<monitoring_id>monitoring2545513424</monitoring_id>
<public_dns_names>
<public_dns_name>test_publicdns_1265186551.com</public_dns_name>
</public_dns_names>
<private_dns_names>
<private_dns_name>test_privatedns_123756966.com</private_dns_name>
</private_dns_names>
<rs_provisioned>false</rs_provisioned>
<user_data>ud_2426115256</user_data>
<security_groups>
<security_group href="/api/clouds/888/security_groups/ABC2703541362DEF"/>
</security_groups>
</instance>
Click on a format below to see an example response for the 'full' view:
JSON XML{
"name": "NAME_409940392",
"created_at": "2023/10/09 11:06:01 +0000",
"updated_at": "2023/10/09 11:06:01 +0000",
"resource_uid": "RESOURCE_2014175382",
"links": [
{"rel":"self","href":"/api/clouds/888/instances/RESOURCE_2014175382;RAND"},
{"rel":"cloud","href":"/api/clouds/888"},
{"rel":"deployment","href":"/api/deployments/2"},
{"rel":"server_template","href":"/api/server_templates/1"},
{"rel":"multi_cloud_image","href":"/api/multi_cloud_images/1","inherited_source":"server_template"},
{"rel":"parent","href":"/api/servers/1"},
{"rel":"volume_attachments","href":"/api/clouds/888/instances/RESOURCE_2014175382;RAND/volume_attachments"},
{"rel":"inputs","href":"/api/clouds/888/instances/RESOURCE_2014175382;RAND/inputs"},
{"rel":"monitoring_metrics","href":"/api/clouds/888/instances/RESOURCE_2014175382;RAND/monitoring_metrics"},
{"rel":"alerts","href":"/api/clouds/888/instances/RESOURCE_2014175382;RAND/alerts"},
{"rel":"alert_specs","href":"/api/clouds/888/instances/RESOURCE_2014175382;RAND/alert_specs"},
{"rel":"image","href":"/api/clouds/888/images/RS_ID_3851540459"},
{"rel":"ramdisk_image","href":"/api/clouds/888/images/RS_ID_4246755185"},
{"rel":"kernel_image","href":"/api/clouds/888/images/RS_ID_2514725657"},
{"rel":"instance_type","href":"/api/clouds/888/instance_types/ABC2184952124DEF"},
{"rel":"ssh_key","href":"/api/clouds/888/ssh_keys/ABC1282514156DEF"},
{"rel":"placement_group","href":"/api/placement_groups/ABC273108500DEF"},
{"rel":"datacenter","href":"/api/clouds/888/datacenters/ABC2088339203DEF"}
],
"cloud_specific_attributes": {
},
"associate_public_ip_address": true,
"actions": [
{
"rel": "terminate"
},
{
"rel": "reboot"
},
{
"rel": "run_executable"
},
{
"rel": "lock"
},
{
"rel": "unlock"
}
],
"public_ip_addresses": [
"184.9.35.124"
],
"private_ip_addresses": [
"9.6.9.2"
],
"pricing_type": "fixed",
"locked": false,
"state": "operational",
"description": null,
"terminated_at": null,
"os_platform": null,
"monitoring_server": "tss9",
"monitoring_collector_http": "tss9.test.rightscale.com",
"monitoring_collector_udp": "tss-collectd9.test.rightscale.com",
"monitoring_id": "monitoring2545513424",
"public_dns_names": [
"test_publicdns_1265186551.com"
],
"private_dns_names": [
"test_privatedns_123756966.com"
],
"rs_provisioned": false,
"user_data": "ud_2426115256",
"security_groups": [
{
"href": "/api/clouds/888/security_groups/ABC2703541362DEF"
}
],
"inputs": [
{
"name": "FOO",
"value": "text:"
},
{
"name": "input_definition_3604220013",
"value": "text:"
},
{
"name": "input_definition_422628238",
"value": "text:"
}
]
}<?xml version="1.0" encoding="UTF-8"?>
<instance>
<name>NAME_409940392</name>
<created_at>2023/10/09 11:06:01 +0000</created_at>
<updated_at>2023/10/09 11:06:01 +0000</updated_at>
<resource_uid>RESOURCE_2014175382</resource_uid>
<links>
<link rel="self" href="/api/clouds/888/instances/RESOURCE_2014175382;RAND"/>
<link rel="cloud" href="/api/clouds/888"/>
<link rel="deployment" href="/api/deployments/2"/>
<link rel="server_template" href="/api/server_templates/1"/>
<link rel="multi_cloud_image" href="/api/multi_cloud_images/1" inherited_source="server_template"/>
<link rel="parent" href="/api/servers/1"/>
<link rel="volume_attachments" href="/api/clouds/888/instances/RESOURCE_2014175382;RAND/volume_attachments"/>
<link rel="inputs" href="/api/clouds/888/instances/RESOURCE_2014175382;RAND/inputs"/>
<link rel="monitoring_metrics" href="/api/clouds/888/instances/RESOURCE_2014175382;RAND/monitoring_metrics"/>
<link rel="alerts" href="/api/clouds/888/instances/RESOURCE_2014175382;RAND/alerts"/>
<link rel="alert_specs" href="/api/clouds/888/instances/RESOURCE_2014175382;RAND/alert_specs"/>
<link rel="image" href="/api/clouds/888/images/RS_ID_3851540459"/>
<link rel="ramdisk_image" href="/api/clouds/888/images/RS_ID_4246755185"/>
<link rel="kernel_image" href="/api/clouds/888/images/RS_ID_2514725657"/>
<link rel="instance_type" href="/api/clouds/888/instance_types/ABC2184952124DEF"/>
<link rel="ssh_key" href="/api/clouds/888/ssh_keys/ABC1282514156DEF"/>
<link rel="placement_group" href="/api/placement_groups/ABC273108500DEF"/>
<link rel="datacenter" href="/api/clouds/888/datacenters/ABC2088339203DEF"/>
</links>
<cloud_specific_attributes/>
<associate_public_ip_address>true</associate_public_ip_address>
<actions>
<action rel="terminate"/>
<action rel="reboot"/>
<action rel="run_executable"/>
<action rel="lock"/>
<action rel="unlock"/>
</actions>
<public_ip_addresses>
<public_ip_address>184.9.35.124</public_ip_address>
</public_ip_addresses>
<private_ip_addresses>
<private_ip_address>9.6.9.2</private_ip_address>
</private_ip_addresses>
<pricing_type>fixed</pricing_type>
<locked>false</locked>
<state>operational</state>
<description/>
<terminated_at/>
<os_platform/>
<monitoring_server>tss9</monitoring_server>
<monitoring_collector_http>tss9.test.rightscale.com</monitoring_collector_http>
<monitoring_collector_udp>tss-collectd9.test.rightscale.com</monitoring_collector_udp>
<monitoring_id>monitoring2545513424</monitoring_id>
<public_dns_names>
<public_dns_name>test_publicdns_1265186551.com</public_dns_name>
</public_dns_names>
<private_dns_names>
<private_dns_name>test_privatedns_123756966.com</private_dns_name>
</private_dns_names>
<rs_provisioned>false</rs_provisioned>
<user_data>ud_2426115256</user_data>
<security_groups>
<security_group href="/api/clouds/888/security_groups/ABC2703541362DEF"/>
</security_groups>
<inputs>
<input>
<name>FOO</name>
<value>text:</value>
</input>
<input>
<name>input_definition_3604220013</name>
<value>text:</value>
</input>
<input>
<name>input_definition_422628238</name>
<value>text:</value>
</input>
</inputs>
</instance>
Click on a format below to see an example response for the 'full_inputs_2_0' view:
JSON XML{
"name": "NAME_409940392",
"created_at": "2023/10/09 11:06:01 +0000",
"updated_at": "2023/10/09 11:06:01 +0000",
"resource_uid": "RESOURCE_2014175382",
"links": [
{"rel":"self","href":"/api/clouds/888/instances/RESOURCE_2014175382;RAND"},
{"rel":"cloud","href":"/api/clouds/888"},
{"rel":"deployment","href":"/api/deployments/2"},
{"rel":"server_template","href":"/api/server_templates/1"},
{"rel":"multi_cloud_image","href":"/api/multi_cloud_images/1","inherited_source":"server_template"},
{"rel":"parent","href":"/api/servers/1"},
{"rel":"volume_attachments","href":"/api/clouds/888/instances/RESOURCE_2014175382;RAND/volume_attachments"},
{"rel":"inputs","href":"/api/clouds/888/instances/RESOURCE_2014175382;RAND/inputs"},
{"rel":"monitoring_metrics","href":"/api/clouds/888/instances/RESOURCE_2014175382;RAND/monitoring_metrics"},
{"rel":"alerts","href":"/api/clouds/888/instances/RESOURCE_2014175382;RAND/alerts"},
{"rel":"alert_specs","href":"/api/clouds/888/instances/RESOURCE_2014175382;RAND/alert_specs"},
{"rel":"image","href":"/api/clouds/888/images/RS_ID_3851540459"},
{"rel":"ramdisk_image","href":"/api/clouds/888/images/RS_ID_4246755185"},
{"rel":"kernel_image","href":"/api/clouds/888/images/RS_ID_2514725657"},
{"rel":"instance_type","href":"/api/clouds/888/instance_types/ABC2184952124DEF"},
{"rel":"ssh_key","href":"/api/clouds/888/ssh_keys/ABC1282514156DEF"},
{"rel":"placement_group","href":"/api/placement_groups/ABC273108500DEF"},
{"rel":"datacenter","href":"/api/clouds/888/datacenters/ABC2088339203DEF"}
],
"cloud_specific_attributes": {
},
"associate_public_ip_address": true,
"actions": [
{
"rel": "terminate"
},
{
"rel": "reboot"
},
{
"rel": "run_executable"
},
{
"rel": "lock"
},
{
"rel": "unlock"
}
],
"public_ip_addresses": [
"184.9.35.124"
],
"private_ip_addresses": [
"9.6.9.2"
],
"pricing_type": "fixed",
"locked": false,
"state": "operational",
"description": null,
"terminated_at": null,
"os_platform": null,
"monitoring_server": "tss9",
"monitoring_collector_http": "tss9.test.rightscale.com",
"monitoring_collector_udp": "tss-collectd9.test.rightscale.com",
"monitoring_id": "monitoring2545513424",
"public_dns_names": [
"test_publicdns_1265186551.com"
],
"private_dns_names": [
"test_privatedns_123756966.com"
],
"rs_provisioned": false,
"user_data": "ud_2426115256",
"security_groups": [
{
"href": "/api/clouds/888/security_groups/ABC2703541362DEF"
}
],
"inputs": [
{
"name": "FOO",
"value": "blank"
},
{
"name": "input_definition_3604220013",
"value": "blank"
},
{
"name": "input_definition_422628238",
"value": "blank"
}
]
}<?xml version="1.0" encoding="UTF-8"?>
<instance>
<name>NAME_409940392</name>
<created_at>2023/10/09 11:06:01 +0000</created_at>
<updated_at>2023/10/09 11:06:01 +0000</updated_at>
<resource_uid>RESOURCE_2014175382</resource_uid>
<links>
<link rel="self" href="/api/clouds/888/instances/RESOURCE_2014175382;RAND"/>
<link rel="cloud" href="/api/clouds/888"/>
<link rel="deployment" href="/api/deployments/2"/>
<link rel="server_template" href="/api/server_templates/1"/>
<link rel="multi_cloud_image" href="/api/multi_cloud_images/1" inherited_source="server_template"/>
<link rel="parent" href="/api/servers/1"/>
<link rel="volume_attachments" href="/api/clouds/888/instances/RESOURCE_2014175382;RAND/volume_attachments"/>
<link rel="inputs" href="/api/clouds/888/instances/RESOURCE_2014175382;RAND/inputs"/>
<link rel="monitoring_metrics" href="/api/clouds/888/instances/RESOURCE_2014175382;RAND/monitoring_metrics"/>
<link rel="alerts" href="/api/clouds/888/instances/RESOURCE_2014175382;RAND/alerts"/>
<link rel="alert_specs" href="/api/clouds/888/instances/RESOURCE_2014175382;RAND/alert_specs"/>
<link rel="image" href="/api/clouds/888/images/RS_ID_3851540459"/>
<link rel="ramdisk_image" href="/api/clouds/888/images/RS_ID_4246755185"/>
<link rel="kernel_image" href="/api/clouds/888/images/RS_ID_2514725657"/>
<link rel="instance_type" href="/api/clouds/888/instance_types/ABC2184952124DEF"/>
<link rel="ssh_key" href="/api/clouds/888/ssh_keys/ABC1282514156DEF"/>
<link rel="placement_group" href="/api/placement_groups/ABC273108500DEF"/>
<link rel="datacenter" href="/api/clouds/888/datacenters/ABC2088339203DEF"/>
</links>
<cloud_specific_attributes/>
<associate_public_ip_address>true</associate_public_ip_address>
<actions>
<action rel="terminate"/>
<action rel="reboot"/>
<action rel="run_executable"/>
<action rel="lock"/>
<action rel="unlock"/>
</actions>
<public_ip_addresses>
<public_ip_address>184.9.35.124</public_ip_address>
</public_ip_addresses>
<private_ip_addresses>
<private_ip_address>9.6.9.2</private_ip_address>
</private_ip_addresses>
<pricing_type>fixed</pricing_type>
<locked>false</locked>
<state>operational</state>
<description/>
<terminated_at/>
<os_platform/>
<monitoring_server>tss9</monitoring_server>
<monitoring_collector_http>tss9.test.rightscale.com</monitoring_collector_http>
<monitoring_collector_udp>tss-collectd9.test.rightscale.com</monitoring_collector_udp>
<monitoring_id>monitoring2545513424</monitoring_id>
<public_dns_names>
<public_dns_name>test_publicdns_1265186551.com</public_dns_name>
</public_dns_names>
<private_dns_names>
<private_dns_name>test_privatedns_123756966.com</private_dns_name>
</private_dns_names>
<rs_provisioned>false</rs_provisioned>
<user_data>ud_2426115256</user_data>
<security_groups>
<security_group href="/api/clouds/888/security_groups/ABC2703541362DEF"/>
</security_groups>
<inputs>
<input>
<name>FOO</name>
<value>blank</value>
</input>
<input>
<name>input_definition_3604220013</name>
<value>blank</value>
</input>
<input>
<name>input_definition_422628238</name>
<value>blank</value>
</input>
</inputs>
</instance>
Click on a format below to see an example response for the 'tiny' view:
JSON XML{
"name": "NAME_409940392",
"created_at": "2023/10/09 11:06:01 +0000",
"updated_at": "2023/10/09 11:06:01 +0000",
"resource_uid": "RESOURCE_2014175382",
"links": [
{"rel":"self","href":"/api/clouds/888/instances/RESOURCE_2014175382;RAND"}
]
}<?xml version="1.0" encoding="UTF-8"?>
<instance>
<name>NAME_409940392</name>
<created_at>2023/10/09 11:06:01 +0000</created_at>
<updated_at>2023/10/09 11:06:01 +0000</updated_at>
<resource_uid>RESOURCE_2014175382</resource_uid>
<links>
<link rel="self" href="/api/clouds/888/instances/RESOURCE_2014175382;RAND"/>
</links>
</instance>
Click on a format below to see an example response for the 'sensitive' view:
JSON XML{
"name": "NAME_409940392",
"created_at": "2023/10/09 11:06:01 +0000",
"updated_at": "2023/10/09 11:06:01 +0000",
"resource_uid": "RESOURCE_2014175382",
"links": [
{"rel":"self","href":"/api/clouds/888/instances/RESOURCE_2014175382;RAND"},
{"rel":"cloud","href":"/api/clouds/888"},
{"rel":"deployment","href":"/api/deployments/2"},
{"rel":"server_template","href":"/api/server_templates/1"},
{"rel":"multi_cloud_image","href":"/api/multi_cloud_images/1","inherited_source":"server_template"},
{"rel":"parent","href":"/api/servers/1"},
{"rel":"volume_attachments","href":"/api/clouds/888/instances/RESOURCE_2014175382;RAND/volume_attachments"},
{"rel":"inputs","href":"/api/clouds/888/instances/RESOURCE_2014175382;RAND/inputs"},
{"rel":"monitoring_metrics","href":"/api/clouds/888/instances/RESOURCE_2014175382;RAND/monitoring_metrics"},
{"rel":"alerts","href":"/api/clouds/888/instances/RESOURCE_2014175382;RAND/alerts"},
{"rel":"alert_specs","href":"/api/clouds/888/instances/RESOURCE_2014175382;RAND/alert_specs"}
],
"cloud_specific_attributes": {
},
"associate_public_ip_address": true,
"actions": [
{
"rel": "terminate"
},
{
"rel": "reboot"
},
{
"rel": "run_executable"
},
{
"rel": "lock"
},
{
"rel": "unlock"
}
],
"public_ip_addresses": [
"184.9.35.124"
],
"private_ip_addresses": [
"9.6.9.2"
],
"pricing_type": "fixed",
"locked": false,
"state": "operational"
}<?xml version="1.0" encoding="UTF-8"?>
<instance>
<name>NAME_409940392</name>
<created_at>2023/10/09 11:06:01 +0000</created_at>
<updated_at>2023/10/09 11:06:01 +0000</updated_at>
<resource_uid>RESOURCE_2014175382</resource_uid>
<links>
<link rel="self" href="/api/clouds/888/instances/RESOURCE_2014175382;RAND"/>
<link rel="cloud" href="/api/clouds/888"/>
<link rel="deployment" href="/api/deployments/2"/>
<link rel="server_template" href="/api/server_templates/1"/>
<link rel="multi_cloud_image" href="/api/multi_cloud_images/1" inherited_source="server_template"/>
<link rel="parent" href="/api/servers/1"/>
<link rel="volume_attachments" href="/api/clouds/888/instances/RESOURCE_2014175382;RAND/volume_attachments"/>
<link rel="inputs" href="/api/clouds/888/instances/RESOURCE_2014175382;RAND/inputs"/>
<link rel="monitoring_metrics" href="/api/clouds/888/instances/RESOURCE_2014175382;RAND/monitoring_metrics"/>
<link rel="alerts" href="/api/clouds/888/instances/RESOURCE_2014175382;RAND/alerts"/>
<link rel="alert_specs" href="/api/clouds/888/instances/RESOURCE_2014175382;RAND/alert_specs"/>
</links>
<cloud_specific_attributes/>
<associate_public_ip_address>true</associate_public_ip_address>
<actions>
<action rel="terminate"/>
<action rel="reboot"/>
<action rel="run_executable"/>
<action rel="lock"/>
<action rel="unlock"/>
</actions>
<public_ip_addresses>
<public_ip_address>184.9.35.124</public_ip_address>
</public_ip_addresses>
<private_ip_addresses>
<private_ip_address>9.6.9.2</private_ip_address>
</private_ip_addresses>
<pricing_type>fixed</pricing_type>
<locked>false</locked>
<state>operational</state>
</instance>
create
Creates and launches a raw instance using the provided parameters.
- URLs
- POST /api/clouds/:cloud_id/instances
- HTTP response code
- 201 Created
- Location
- Href of the created Instance.
Required roles
- actor
Parameters
| name | required | type | values | regexp | blank? | description |
|---|---|---|---|---|---|---|
| api_behavior | no | String | async, sync | * | no | When set to 'async', an instance resource will be returned immediately and processing will be handled in the background. Errors will not be returned and must be checked through the instance's audit entries. Default value is 'sync' |
| instance | yes | Hash | * | * | no | |
| instance[associate_public_ip_address] | no | String | true, false | * | no | Specify whether or not you want a public IP assigned when this Instance is launched. Only applies to Network-enabled Instances. If this is not specified, it will default to true. |
| instance[cloud_specific_attributes] | no | Hash | * | * | no | Cloud specific attributes that have no generic rightscale abstraction |
| instance[cloud_specific_attributes][admin_username] | no | String | * | * | no | The user that will be granted administrative privileges. Supported by AzureRM cloud only. For more information, review the documentation. |
| instance[cloud_specific_attributes][automatic_instance_store_mapping] | no | String | true, false | * | no | A flag indicating whether instance store mapping should be enabled. Not supported in all Clouds. |
| instance[cloud_specific_attributes][availability_set] | no | String | * | * | no | Availability set for raw instance. Supported by Azure v2 cloud only. |
| instance[cloud_specific_attributes][create_boot_volume] | no | String | true, false | * | no | If enabled, the instance will launch into volume storage. Otherwise, it will boot to local storage. |
| instance[cloud_specific_attributes][create_default_port_forwarding_rules] | no | String | true, false | * | no | Automatically create default port forwarding rules (enabled by default). Supported by Azure cloud only. |
| instance[cloud_specific_attributes][delete_boot_volume] | no | String | true, false | * | no | If enabled, the associated volume will be deleted when the instance is terminated. |
| instance[cloud_specific_attributes][disk_gb] | no | Integer | * | * | no | The size of root disk. Supported by UCA cloud only. |
| instance[cloud_specific_attributes][ebs_optimized] | no | String | true, false | * | no | Whether the instance is able to connect to IOPS-enabled volumes. |
| instance[cloud_specific_attributes][iam_instance_profile] | no | String | * | * | yes | The name or ARN of the IAM Instance Profile (IIP) to associate with the instance (Amazon only) |
| instance[cloud_specific_attributes][keep_alive_id] | no | String | * | * | no | The id of keep alive. Supported by UCA cloud only. |
| instance[cloud_specific_attributes][keep_alive_url] | no | String | * | * | no | The ulr of keep alive. Supported by UCA cloud only. |
| instance[cloud_specific_attributes][local_ssd_count] | no | String | * | * | no | Additional local SSDs. Supported by GCE cloud only |
| instance[cloud_specific_attributes][local_ssd_interface] | no | String | * | * | no | The type of SSD(s) to be created. Supported by GCE cloud only |
| instance[cloud_specific_attributes][max_spot_price] | no | String | * | * | no | Specify the max spot price you will pay for. Default is the on-demand price set by cloud.Only applies to clouds which support spot-pricing and when 'spot' is chosen as the 'pricing_type'. Can be blank or a float value >= 0.001, eg: 0.095, 0.123, 1.23, etc... |
| instance[cloud_specific_attributes][memory_mb] | no | Integer | * | * | no | The size of instance memory. Supported by UCA cloud only. |
| instance[cloud_specific_attributes][metadata] | no | String | * | * | no | Extra data used for configuration, in query string format. |
| instance[cloud_specific_attributes][num_cores] | no | Integer | * | * | no | The number of instance cores. Supported by UCA cloud only. |
| instance[cloud_specific_attributes][placement_tenancy] | no | String | default, dedicated | * | no | The tenancy of the server you want to launch. A server with a tenancy of dedicated runs on single-tenant hardware and can only be launched into a VPC. |
| instance[cloud_specific_attributes][preemptible] | no | String | true, false | * | no | Launch a preemptible instance. A preemptible instance costs much less, but lasts only 24 hours. It can be terminated sooner due to system demands. Supported by GCE cloud only. |
| instance[cloud_specific_attributes][pricing_type] | no | String | fixed, spot | * | no | Specify whether or not you want to utilize 'fixed' (on-demand) or 'spot' pricing. Defaults to 'fixed' and only applies to clouds which support spot instances. Can only be set on when creating a new Instance, Server, or ServerArray, or when updating a Server or ServerArray's next_instance.WARNING: By using spot pricing, you acknowledge that your instance/server/array may not be able to be launched (and arrays may be unable to grow) as newly launched instances might be stuck in bidding, and/or existing instances may be terminated at any time, due to the cloud's spot pricing changes and availability. |
| instance[cloud_specific_attributes][root_volume_performance] | no | String | * | * | no | The number of IOPS (I/O Operations Per Second) this root volume should support. Only available on clouds supporting performance provisioning. |
| instance[cloud_specific_attributes][root_volume_size] | no | String | * | * | no | The size for root disk. Not supported in all Clouds. |
| instance[cloud_specific_attributes][root_volume_type_uid] | no | String | * | * | no | The type of root volume for instance. Only available on clouds supporting root volume type. |
| instance[cloud_specific_attributes][service_account] | no | String | * | * | no | Email of service account for instance. Scope will default to cloud-platform. Supported by GCE cloud only. |
| instance[datacenter_href] | no | String | * | * | no | The href of the Datacenter / Zone. |
| instance[deployment_href] | no | String | * | * | no | The href of the deployment to which the Instance will be added. |
| instance[image_href] | yes | String | * | * | no | The href of the Image to use. |
| instance[instance_type_href] | yes | String | * | * | no | The href of the instance type. |
| instance[ip_forwarding_enabled] | no | String | true, false | * | no | Allows this Instance to send and receive network traffic when the source and destination IP addresses do not match the IP address of this Instance. |
| instance[kernel_image_href] | no | String | * | * | no | The href of the kernel image. |
| instance[name] | yes | String | * | * | no | The name of the instance. |
| instance[placement_group_href] | no | String | * | * | no | The placement group to launch the instance in. Not supported by all clouds & instance types. |
| instance[ramdisk_image_href] | no | String | * | * | no | The href of the ramdisk image. |
| instance[security_group_hrefs] | no | Array | * | * | no | The hrefs of the security groups. |
| instance[ssh_key_href] | no | String | * | * | no | The href of the SSH key to use. |
| instance[subnet_hrefs] | no | Array | * | * | no | The hrefs of the updated subnets. |
| instance[user_data] | no | String | * | * | no | User data that RightScale automatically passes to your instance at boot time. |
update
Updates attributes of a single instance.
- URLs
- PUT /api/clouds/:cloud_id/instances/:id
- HTTP response code
- 204 No Content
Required roles
- actor
Parameters
| name | required | type | values | regexp | blank? | description |
|---|---|---|---|---|---|---|
| instance | yes | Hash | * | * | no | |
| instance[associate_public_ip_address] | no | String | true, false | * | no | Specify whether or not you want a public IP assigned when this Instance is launched. Only applies to Network-enabled Instances. If this is not specified, it will default to true. |
| instance[cloud_specific_attributes] | no | Hash | * | * | no | Cloud specific attributes that have no generic rightscale abstraction |
| instance[cloud_specific_attributes][admin_username] | no | String | * | * | no | The user that will be granted administrative privileges. Supported by AzureRM cloud only. For more information, review the documentation. |
| instance[cloud_specific_attributes][automatic_instance_store_mapping] | no | String | true, false | * | no | A flag indicating whether instance store mapping should be enabled. Not supported in all Clouds. |
| instance[cloud_specific_attributes][availability_set] | no | String | * | * | no | Availability set for raw instance. Supported by Azure v2 cloud only. |
| instance[cloud_specific_attributes][create_boot_volume] | no | String | true, false | * | no | If enabled, the instance will launch into volume storage. Otherwise, it will boot to local storage. |
| instance[cloud_specific_attributes][create_default_port_forwarding_rules] | no | String | true, false | * | no | Automatically create default port forwarding rules (enabled by default). Supported by Azure cloud only. |
| instance[cloud_specific_attributes][delete_boot_volume] | no | String | true, false | * | no | If enabled, the associated volume will be deleted when the instance is terminated. |
| instance[cloud_specific_attributes][disk_gb] | no | Integer | * | * | no | The size of root disk. Supported by UCA cloud only. |
| instance[cloud_specific_attributes][iam_instance_profile] | no | String | * | * | yes | The name or ARN of the IAM Instance Profile (IIP) to associate with the instance (Amazon only) |
| instance[cloud_specific_attributes][keep_alive_id] | no | String | * | * | no | The id of keep alive. Supported by UCA cloud only. |
| instance[cloud_specific_attributes][keep_alive_url] | no | String | * | * | no | The ulr of keep alive. Supported by UCA cloud only. |
| instance[cloud_specific_attributes][local_ssd_count] | no | String | * | * | no | Additional local SSDs. Supported by GCE cloud only |
| instance[cloud_specific_attributes][local_ssd_interface] | no | String | * | * | no | The type of SSD(s) to be created. Supported by GCE cloud only |
| instance[cloud_specific_attributes][max_spot_price] | no | String | * | * | no | Specify the max spot price you will pay for. Default is the on-demand price set by cloud.Only applies to clouds which support spot-pricing and when 'spot' is chosen as the 'pricing_type'. Can be blank or a float value >= 0.001, eg: 0.095, 0.123, 1.23, etc... |
| instance[cloud_specific_attributes][memory_mb] | no | Integer | * | * | no | The size of instance memory. Supported by UCA cloud only. |
| instance[cloud_specific_attributes][metadata] | no | String | * | * | no | Extra data used for configuration, in query string format. |
| instance[cloud_specific_attributes][num_cores] | no | Integer | * | * | no | The number of instance cores. Supported by UCA cloud only. |
| instance[cloud_specific_attributes][placement_tenancy] | no | String | default, dedicated | * | no | The tenancy of the server you want to launch. A server with a tenancy of dedicated runs on single-tenant hardware and can only be launched into a VPC. |
| instance[cloud_specific_attributes][preemptible] | no | String | true, false | * | no | Launch a preemptible instance. A preemptible instance costs much less, but lasts only 24 hours. It can be terminated sooner due to system demands. Supported by GCE cloud only. |
| instance[cloud_specific_attributes][pricing_type] | no | String | fixed, spot | * | no | Specify whether or not you want to utilize 'fixed' (on-demand) or 'spot' pricing. Defaults to 'fixed' and only applies to clouds which support spot instances. Can only be set on when creating a new Instance, Server, or ServerArray, or when updating a Server or ServerArray's next_instance.WARNING: By using spot pricing, you acknowledge that your instance/server/array may not be able to be launched (and arrays may be unable to grow) as newly launched instances might be stuck in bidding, and/or existing instances may be terminated at any time, due to the cloud's spot pricing changes and availability. |
| instance[cloud_specific_attributes][root_volume_performance] | no | String | * | * | no | The number of IOPS (I/O Operations Per Second) this root volume should support. Only available on clouds supporting performance provisioning. |
| instance[cloud_specific_attributes][root_volume_size] | no | String | * | * | no | The size for root disk. Not supported in all Clouds. |
| instance[cloud_specific_attributes][root_volume_type_uid] | no | String | * | * | no | The type of root volume for instance. Only available on clouds supporting root volume type. |
| instance[cloud_specific_attributes][service_account] | no | String | * | * | yes | Email of service account for instance. Scope will default to cloud-platform. Supported by GCE cloud only. |
| instance[datacenter_href] | no | String | * | * | no | The href of the updated Datacenter / Zone for the Instance. |
| instance[deployment_href] | no | String | * | * | no | The href of the updated Deployment for the Instance. This is only supported for Instances that are not associated with a Server or ServerArray. |
| instance[image_href] | no | String | * | * | no | The href of the updated Image for the Instance. |
| instance[instance_type_href] | no | String | * | * | no | The href of the updated Instance Type. |
| instance[ip_forwarding_enabled] | no | String | true, false | * | no | Allows this Instance to send and receive network traffic when the source and destination IP addresses do not match the IP address of this Instance. |
| instance[kernel_image_href] | no | String | * | * | no | The href of the updated kernel image for the Instance. |
| instance[multi_cloud_image_href] | no | String | * | * | no | The href of the updated MultiCloudImage for the Instance. |
| instance[name] | no | String | * | * | no | The updated name to give the Instance. |
| instance[private_ip_address] | no | String | * | * | no | The private ip address for the instance |
| instance[ramdisk_image_href] | no | String | * | * | no | The href of the updated ramdisk image for the Instance. |
| instance[security_group_hrefs] | no | Array | * | * | no | The hrefs of the updated security groups. |
| instance[server_template_href] | no | String | * | * | no | The href of the updated ServerTemplate for the Instance. |
| instance[ssh_key_href] | no | String | * | * | no | The href of the updated SSH key for the Instance. |
| instance[subnet_hrefs] | no | Array | * | * | no | The hrefs of the updated subnets. |
| instance[user_data] | no | String | * | * | no | User data that RightScale automatically passes to your instance at boot time. |
launch
Launches an instance using the parameters that this instance has been configured with.
Note that this action can only be performed in "next" instances, and not on instances that are already running.
- URLs
- POST /api/clouds/:cloud_id/instances/:id/launch
- POST /api/server_arrays/:server_array_id/launch
- POST /api/servers/:server_id/launch
- HTTP response code
- 201 Created
- Location
- Href of the launched Instance
Required roles
- actor
Parameters
| name | required | type | values | regexp | blank? | description |
|---|---|---|---|---|---|---|
| api_behavior | no | String | async, sync | * | no | When set to 'async', an instance resource will be returned immediately and processing will be handled in the background. Errors will not be returned and must be checked through the instance's audit entries. Default value is 'sync' |
| count | no | String | * | * | no | For Server Arrays, will launch the specified number of instances into the ServerArray. Attempting to call this action on non-server array objects will result in a parameter error |
| inputs | no | Enumerable | * | * | no | |
| inputs[*] | no | String | * | * | no | The format used for passing 2.0-style Inputs. The key is the name of the input, and the value is the value to assign to the input. For more details on 2.0-style inputs, please see Inputs#multi_update. |
| inputs[][name] | no | String | * | * | no | The input name. This format is used for passing legacy 1.0-style Inputs. Will eventually be deprecated. |
| inputs[][value] | no | String | * | * | no | The value of that input. Should be of the form 'text:my_value' or 'cred:MY_CRED' etc. This format is used for passing legacy 1.0-style Inputs. Will eventually be deprecated. |
lock
- URLs
- POST /api/clouds/:cloud_id/instances/:id/lock
- HTTP response code
- 204 No Content
Required roles
- actor
multi_run_executable
Runs a script or a recipe in the running instances.
This is an asynchronous function, which returns immediately after queuing the executable for execution. Status of the execution can be tracked at the URL returned in the "Location" header.
- URLs
- POST /api/clouds/:cloud_id/instances/multi_run_executable
- POST /api/server_arrays/:server_array_id/multi_run_executable
- HTTP response code
- 202 Accepted
- Location
- Href of a Task to follow the status.
Required roles
- actor
Parameters
| name | required | type | values | regexp | blank? | description |
|---|---|---|---|---|---|---|
| filter | no | Array | * | * | no | See below for valid filter parameters. |
| ignore_lock | no | String | true, false | * | no | Specifies the ability to ignore the lock(s) on the Instance(s). |
| inputs | no | Enumerable | * | * | no | |
| inputs[*] | no | String | * | * | no | The format used for passing 2.0-style Inputs. The key is the name of the input, and the value is the value to assign to the input. For more details on 2.0-style inputs, please see Inputs#multi_update. |
| inputs[][name] | no | String | * | * | no | The name of inputs needed. This format is used for passing legacy 1.0-style Inputs. Will eventually be deprecated. |
| inputs[][value] | no | String | * | * | no | The value of these inputs. Should be of the form 'text:my_value' or 'cred:MY_CRED' etc. This format is used for passing legacy 1.0-style Inputs. Will eventually be deprecated. |
| recipe_name | no | String | * | * | no | The name of the recipe to be run. |
| right_script_href | no | String | * | * | no | The href of the RightScript to run. Should be of the form '/api/right_scripts/:id'. |
Filters
| name | partial_match? | description |
|---|---|---|
| datacenter_href | no | The href of the datacenter to filter on. |
| deployment_href | no | The href of the deployment to filter on. |
| name | yes | Name of the Instance to filter on. |
| os_platform | yes | The OS platform to filter on. |
| parent_href | no | The href of the parent to filter on. |
| placement_group_href | no | The href of the placement group to filter on. |
| private_dns_name | yes | The private dns name to filter on. |
| private_ip_address | yes | The private ip address to filter on. |
| public_dns_name | yes | The public dns name to filter on. |
| public_ip_address | yes | The public ip address to filter on. |
| resource_uid | no | Resource Unique IDentifier for the Instance to filter on. |
| server_template_href | no | The href of the ServerTemplate to filter on. |
| state | no | The state of Instances to filter on. |
multi_terminate
Terminates running instances. Either a filter or the parameter 'terminate_all' must be provided.
- URLs
- POST /api/clouds/:cloud_id/instances/multi_terminate
- POST /api/server_arrays/:server_array_id/multi_terminate
- HTTP response code
- 202 Accepted
- Location
- Href of a Task to follow the status.
Required roles
- actor
Parameters
| name | required | type | values | regexp | blank? | description |
|---|---|---|---|---|---|---|
| filter | no | Array | * | * | no | See below for valid filter parameters. |
| terminate_all | no | String | true, false | * | no | Specifies the ability to terminate all instances. |
Filters
| name | partial_match? | description |
|---|---|---|
| datacenter_href | no | The href of the datacenter to filter on. |
| deployment_href | no | The href of the deployment to filter on. |
| name | yes | Name of the Instance to filter on. |
| os_platform | yes | The OS platform to filter on. |
| parent_href | no | The href of the parent to filter on. |
| placement_group_href | no | The href of the placement group to filter on. |
| private_dns_name | yes | The private dns name to filter on. |
| private_ip_address | yes | The private ip address to filter on. |
| public_dns_name | yes | The public dns name to filter on. |
| public_ip_address | yes | The public ip address to filter on. |
| resource_uid | no | Resource Unique IDentifier for the Instance to filter on. |
| server_template_href | no | The href of the ServerTemplate to filter on. |
| state | no | The state of Instances to filter on. |
reboot
Reboot a running instance.
Note that this action can only succeed if the instance is running. One cannot reboot instances of type "next".
- URLs
- POST /api/clouds/:cloud_id/instances/:id/reboot
- POST /api/servers/:server_id/reboot
- HTTP response code
- 204 No Content
Required roles
- actor
run_executable
Runs a script or a recipe in the running instance.
This is an asynchronous function, which returns immediately after queuing the executable for execution. Status of the execution can be tracked at the URL returned in the "Location" header. Note that this can only be performed on running instances.
- URLs
- POST /api/clouds/:cloud_id/instances/:id/run_executable
- HTTP response code
- 202 Accepted
- Location
- Href of a Task to follow the status.
Required roles
- actor
Parameters
| name | required | type | values | regexp | blank? | description |
|---|---|---|---|---|---|---|
| ignore_lock | no | String | true, false | * | no | Specifies the ability to ignore the lock on the Instance. |
| inputs | no | Enumerable | * | * | no | |
| inputs[*] | no | String | * | * | no | The format used for passing 2.0-style Inputs. The key is the name of the input, and the value is the value to assign to the input. For more details on 2.0-style inputs, please see Inputs#multi_update. |
| inputs[][name] | no | String | * | * | no | The name of inputs needed. This format is used for passing legacy 1.0-style Inputs. Will eventually be deprecated. |
| inputs[][value] | no | String | * | * | no | The value of these inputs. Should be of the form 'text:my_value' or 'cred:MY_CRED' etc. This format is used for passing legacy 1.0-style Inputs. Will eventually be deprecated. |
| recipe_name | no | String | * | * | no | The name of the recipe to run. |
| right_script_href | no | String | * | * | no | The href of the RightScript to run. Should be of the form '/api/right_scripts/:id'. |
start
Starts an instance that has been stopped, resuming it to its previously saved volume state.
After an instance is started, the reference to your instance will have a different id.
The new id can be found by performing an index query with the appropriate filters on the Instances resource, performing a show action on the Server resource for Server Instances, or performing a current_instances action on the ServerArray resource for ServerArray Instances.
- URLs
- POST /api/clouds/:cloud_id/instances/:id/start
- HTTP response code
- 204 No Content
Required roles
- actor
stop
Stores the instance's current volume state to resume later using the 'start' action.
After an instance is stopped, the reference to your instance will have a different id.
The new id can be found by performing an index query with the appropriate filters on the Instances resource, performing a show action on the Server resource for Server Instances, or performing a current_instances action on the ServerArray resource for ServerArray Instances.
- URLs
- POST /api/clouds/:cloud_id/instances/:id/stop
- HTTP response code
- 204 No Content
Required roles
- actor
terminate
Terminates a running instance.
Note that this action can succeed only if the instance is running. One cannot terminate instances of type "next".
- URLs
- POST /api/clouds/:cloud_id/instances/:id/terminate
- POST /api/servers/:server_id/terminate
- HTTP response code
- 204 No Content
Required roles
- actor
unlock
- URLs
- POST /api/clouds/:cloud_id/instances/:id/unlock
- HTTP response code
- 204 No Content
Required roles
- actor