Cloud Management API 1.5

InstanceTypes

Actions

index

Lists instance types.

URLs
GET /api/clouds/:cloud_id/instance_types
HTTP response code
200 OK
Content-type
application/vnd.rightscale.instance_type;type=collection

Required roles

Parameters

name required type values regexp blank? description
filter no Array * * no See below for valid filter parameters.
view no String default * no Specifies how many attributes and/or expanded nested relationships to include.
with_deleted no String true, false * no If set to 'true', deleted instance_type resources will be included. Default value is 'false'.

Filters

name partial_match? description
cpu_architecture yes The CPU architecture of the Instance Type to filter on.
description yes The Instance Type description to filter on.
name yes Name of the Instance Type to filter on.
resource_uid no Resource Unique IDentifier for the Instance Type to filter on.

Example Responses

Click on a format below to see an example response:

JSON XML
[{
  "resource_uid": "RESOURCE_2806704793",
  "name": "NAME_677699575",
  "description": "description_2610373034",
  "memory": null,
  "cpu_speed": null,
  "cpu_count": null,
  "cpu_architecture": null,
  "local_disks": null,
  "local_disk_size": null,
  "links": [
    {"rel":"self","href":"/api/clouds/888/instance_types/ABC2184952124DEF"},
    {"rel":"cloud","href":"/api/clouds/888"}
  ],
  "actions": [

  ]
},{
  "resource_uid": "RESOURCE_1482473252",
  "name": "NAME_2534165866",
  "description": "description_3884121860",
  "memory": null,
  "cpu_speed": null,
  "cpu_count": null,
  "cpu_architecture": null,
  "local_disks": null,
  "local_disk_size": null,
  "links": [
    {"rel":"self","href":"/api/clouds/888/instance_types/ABC2635552027DEF"},
    {"rel":"cloud","href":"/api/clouds/888"}
  ],
  "actions": [

  ]
}]
<?xml version="1.0" encoding="UTF-8"?>
<instance_types>
  <instance_type>
    <resource_uid>RESOURCE_2806704793</resource_uid>
    <name>NAME_677699575</name>
    <description>description_2610373034</description>
    <memory/>
    <cpu_speed/>
    <cpu_count/>
    <cpu_architecture/>
    <local_disks/>
    <local_disk_size/>
    <links>
      <link rel="self" href="/api/clouds/888/instance_types/ABC2184952124DEF"/>
      <link rel="cloud" href="/api/clouds/888"/>
    </links>
    <actions/>
  </instance_type>
  <instance_type>
    <resource_uid>RESOURCE_1482473252</resource_uid>
    <name>NAME_2534165866</name>
    <description>description_3884121860</description>
    <memory/>
    <cpu_speed/>
    <cpu_count/>
    <cpu_architecture/>
    <local_disks/>
    <local_disk_size/>
    <links>
      <link rel="self" href="/api/clouds/888/instance_types/ABC2635552027DEF"/>
      <link rel="cloud" href="/api/clouds/888"/>
    </links>
    <actions/>
  </instance_type>
</instance_types>

show

Displays information about a single Instance type.

URLs
GET /api/clouds/:cloud_id/instance_types/:id
HTTP response code
200 OK
Content-type
application/vnd.rightscale.instance_type

Required roles

Parameters

name required type values regexp blank? description
view no String default * no Specifies how many attributes and/or expanded nested relationships to include.
with_deleted no String true, false * no If set to 'true', deleted instance_type resources can be viewed. Default value is 'false'.

Example Responses

Click on a format below to see an example response:

JSON XML
{
  "resource_uid": "RESOURCE_2806704793",
  "name": "NAME_677699575",
  "description": "description_2610373034",
  "memory": null,
  "cpu_speed": null,
  "cpu_count": null,
  "cpu_architecture": null,
  "local_disks": null,
  "local_disk_size": null,
  "links": [
    {"rel":"self","href":"/api/clouds/888/instance_types/ABC2184952124DEF"},
    {"rel":"cloud","href":"/api/clouds/888"}
  ],
  "actions": [

  ]
}
<?xml version="1.0" encoding="UTF-8"?>
<instance_type>
  <resource_uid>RESOURCE_2806704793</resource_uid>
  <name>NAME_677699575</name>
  <description>description_2610373034</description>
  <memory/>
  <cpu_speed/>
  <cpu_count/>
  <cpu_architecture/>
  <local_disks/>
  <local_disk_size/>
  <links>
    <link rel="self" href="/api/clouds/888/instance_types/ABC2184952124DEF"/>
    <link rel="cloud" href="/api/clouds/888"/>
  </links>
  <actions/>
</instance_type>