Cloud Management API 1.5

Clouds

Represents a Cloud (within the context of the account in the session).

Actions

index
show

index

Lists the clouds available to this account.

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

Required roles

observer||instance||infrastructure

Parameters

name	required	type	values	regexp	blank?	description
filter	no	Array	*	*	no	See below for valid filter parameters.
view	no	String	default, extended	*	no	Specifies how many attributes and/or expanded nested relationships to include.

Filters

name	partial_match?	description
cloud_type	no	The type of the cloud to filter on.
description	yes	The cloud description field to filter on.
name	yes	The name of the cloud to filter on.

Example Responses

Click on a format below to see an example response for the 'default' view:

JSON XML

[{
  "name": "habuka01",
  "display_name": "habuka01",
  "description": "",
  "cloud_type": "eucalyptus",
  "links": [
    {"rel":"self","href":"/api/clouds/888"},
    {"rel":"datacenters","href":"/api/clouds/888/datacenters"},
    {"rel":"instance_types","href":"/api/clouds/888/instance_types"},
    {"rel":"security_groups","href":"/api/clouds/888/security_groups"},
    {"rel":"instances","href":"/api/clouds/888/instances"},
    {"rel":"ssh_keys","href":"/api/clouds/888/ssh_keys"},
    {"rel":"images","href":"/api/clouds/888/images"},
    {"rel":"ip_addresses","href":"/api/clouds/888/ip_addresses"},
    {"rel":"ip_address_bindings","href":"/api/clouds/888/ip_address_bindings"},
    {"rel":"volume_attachments","href":"/api/clouds/888/volume_attachments"},
    {"rel":"recurring_volume_attachments","href":"/api/clouds/888/recurring_volume_attachments"},
    {"rel":"volume_snapshots","href":"/api/clouds/888/volume_snapshots"},
    {"rel":"volumes","href":"/api/clouds/888/volumes"}
  ]
},{
  "name": "habuka01",
  "display_name": "habuka01",
  "description": "",
  "cloud_type": "eucalyptus",
  "links": [
    {"rel":"self","href":"/api/clouds/888"},
    {"rel":"datacenters","href":"/api/clouds/888/datacenters"},
    {"rel":"instance_types","href":"/api/clouds/888/instance_types"},
    {"rel":"security_groups","href":"/api/clouds/888/security_groups"},
    {"rel":"instances","href":"/api/clouds/888/instances"},
    {"rel":"ssh_keys","href":"/api/clouds/888/ssh_keys"},
    {"rel":"images","href":"/api/clouds/888/images"},
    {"rel":"ip_addresses","href":"/api/clouds/888/ip_addresses"},
    {"rel":"ip_address_bindings","href":"/api/clouds/888/ip_address_bindings"},
    {"rel":"volume_attachments","href":"/api/clouds/888/volume_attachments"},
    {"rel":"recurring_volume_attachments","href":"/api/clouds/888/recurring_volume_attachments"},
    {"rel":"volume_snapshots","href":"/api/clouds/888/volume_snapshots"},
    {"rel":"volumes","href":"/api/clouds/888/volumes"}
  ]
}]

<?xml version="1.0" encoding="UTF-8"?>
<clouds>
  <cloud>
    <name>habuka01</name>
    <display_name>habuka01</display_name>
    <description/>
    <cloud_type>eucalyptus</cloud_type>
    <links>
      <link rel="self" href="/api/clouds/888"/>
      <link rel="datacenters" href="/api/clouds/888/datacenters"/>
      <link rel="instance_types" href="/api/clouds/888/instance_types"/>
      <link rel="security_groups" href="/api/clouds/888/security_groups"/>
      <link rel="instances" href="/api/clouds/888/instances"/>
      <link rel="ssh_keys" href="/api/clouds/888/ssh_keys"/>
      <link rel="images" href="/api/clouds/888/images"/>
      <link rel="ip_addresses" href="/api/clouds/888/ip_addresses"/>
      <link rel="ip_address_bindings" href="/api/clouds/888/ip_address_bindings"/>
      <link rel="volume_attachments" href="/api/clouds/888/volume_attachments"/>
      <link rel="recurring_volume_attachments" href="/api/clouds/888/recurring_volume_attachments"/>
      <link rel="volume_snapshots" href="/api/clouds/888/volume_snapshots"/>
      <link rel="volumes" href="/api/clouds/888/volumes"/>
    </links>
  </cloud>
  <cloud>
    <name>habuka01</name>
    <display_name>habuka01</display_name>
    <description/>
    <cloud_type>eucalyptus</cloud_type>
    <links>
      <link rel="self" href="/api/clouds/888"/>
      <link rel="datacenters" href="/api/clouds/888/datacenters"/>
      <link rel="instance_types" href="/api/clouds/888/instance_types"/>
      <link rel="security_groups" href="/api/clouds/888/security_groups"/>
      <link rel="instances" href="/api/clouds/888/instances"/>
      <link rel="ssh_keys" href="/api/clouds/888/ssh_keys"/>
      <link rel="images" href="/api/clouds/888/images"/>
      <link rel="ip_addresses" href="/api/clouds/888/ip_addresses"/>
      <link rel="ip_address_bindings" href="/api/clouds/888/ip_address_bindings"/>
      <link rel="volume_attachments" href="/api/clouds/888/volume_attachments"/>
      <link rel="recurring_volume_attachments" href="/api/clouds/888/recurring_volume_attachments"/>
      <link rel="volume_snapshots" href="/api/clouds/888/volume_snapshots"/>
      <link rel="volumes" href="/api/clouds/888/volumes"/>
    </links>
  </cloud>
</clouds>

Click on a format below to see an example response for the 'extended' view:

JSON XML

[{
  "name": "habuka01",
  "display_name": "habuka01",
  "description": "",
  "cloud_type": "eucalyptus",
  "links": [
    {"rel":"self","href":"/api/clouds/888"},
    {"rel":"datacenters","href":"/api/clouds/888/datacenters"},
    {"rel":"instance_types","href":"/api/clouds/888/instance_types"},
    {"rel":"security_groups","href":"/api/clouds/888/security_groups"},
    {"rel":"instances","href":"/api/clouds/888/instances"},
    {"rel":"ssh_keys","href":"/api/clouds/888/ssh_keys"},
    {"rel":"images","href":"/api/clouds/888/images"},
    {"rel":"ip_addresses","href":"/api/clouds/888/ip_addresses"},
    {"rel":"ip_address_bindings","href":"/api/clouds/888/ip_address_bindings"},
    {"rel":"volume_attachments","href":"/api/clouds/888/volume_attachments"},
    {"rel":"recurring_volume_attachments","href":"/api/clouds/888/recurring_volume_attachments"},
    {"rel":"volume_snapshots","href":"/api/clouds/888/volume_snapshots"},
    {"rel":"volumes","href":"/api/clouds/888/volumes"}
  ],
  "capabilities": [
    {
      "name": "supports_networks",
      "value": "false"
    },
    {
      "name": "supports_route_tables",
      "value": "false"
    },
    {
      "name": "supports_volume_attachments",
      "value": "true"
    },
    {
      "name": "supports_volume_snapshots",
      "value": "true"
    }
  ]
},{
  "name": "habuka01",
  "display_name": "habuka01",
  "description": "",
  "cloud_type": "eucalyptus",
  "links": [
    {"rel":"self","href":"/api/clouds/888"},
    {"rel":"datacenters","href":"/api/clouds/888/datacenters"},
    {"rel":"instance_types","href":"/api/clouds/888/instance_types"},
    {"rel":"security_groups","href":"/api/clouds/888/security_groups"},
    {"rel":"instances","href":"/api/clouds/888/instances"},
    {"rel":"ssh_keys","href":"/api/clouds/888/ssh_keys"},
    {"rel":"images","href":"/api/clouds/888/images"},
    {"rel":"ip_addresses","href":"/api/clouds/888/ip_addresses"},
    {"rel":"ip_address_bindings","href":"/api/clouds/888/ip_address_bindings"},
    {"rel":"volume_attachments","href":"/api/clouds/888/volume_attachments"},
    {"rel":"recurring_volume_attachments","href":"/api/clouds/888/recurring_volume_attachments"},
    {"rel":"volume_snapshots","href":"/api/clouds/888/volume_snapshots"},
    {"rel":"volumes","href":"/api/clouds/888/volumes"}
  ],
  "capabilities": [
    {
      "name": "supports_networks",
      "value": "false"
    },
    {
      "name": "supports_route_tables",
      "value": "false"
    },
    {
      "name": "supports_volume_attachments",
      "value": "true"
    },
    {
      "name": "supports_volume_snapshots",
      "value": "true"
    }
  ]
}]

<?xml version="1.0" encoding="UTF-8"?>
<clouds>
  <cloud>
    <name>habuka01</name>
    <display_name>habuka01</display_name>
    <description/>
    <cloud_type>eucalyptus</cloud_type>
    <links>
      <link rel="self" href="/api/clouds/888"/>
      <link rel="datacenters" href="/api/clouds/888/datacenters"/>
      <link rel="instance_types" href="/api/clouds/888/instance_types"/>
      <link rel="security_groups" href="/api/clouds/888/security_groups"/>
      <link rel="instances" href="/api/clouds/888/instances"/>
      <link rel="ssh_keys" href="/api/clouds/888/ssh_keys"/>
      <link rel="images" href="/api/clouds/888/images"/>
      <link rel="ip_addresses" href="/api/clouds/888/ip_addresses"/>
      <link rel="ip_address_bindings" href="/api/clouds/888/ip_address_bindings"/>
      <link rel="volume_attachments" href="/api/clouds/888/volume_attachments"/>
      <link rel="recurring_volume_attachments" href="/api/clouds/888/recurring_volume_attachments"/>
      <link rel="volume_snapshots" href="/api/clouds/888/volume_snapshots"/>
      <link rel="volumes" href="/api/clouds/888/volumes"/>
    </links>
    <capabilities>
      <capability>
        <name>supports_networks</name>
        <value>false</value>
      </capability>
      <capability>
        <name>supports_route_tables</name>
        <value>false</value>
      </capability>
      <capability>
        <name>supports_volume_attachments</name>
        <value>true</value>
      </capability>
      <capability>
        <name>supports_volume_snapshots</name>
        <value>true</value>
      </capability>
    </capabilities>
  </cloud>
  <cloud>
    <name>habuka01</name>
    <display_name>habuka01</display_name>
    <description/>
    <cloud_type>eucalyptus</cloud_type>
    <links>
      <link rel="self" href="/api/clouds/888"/>
      <link rel="datacenters" href="/api/clouds/888/datacenters"/>
      <link rel="instance_types" href="/api/clouds/888/instance_types"/>
      <link rel="security_groups" href="/api/clouds/888/security_groups"/>
      <link rel="instances" href="/api/clouds/888/instances"/>
      <link rel="ssh_keys" href="/api/clouds/888/ssh_keys"/>
      <link rel="images" href="/api/clouds/888/images"/>
      <link rel="ip_addresses" href="/api/clouds/888/ip_addresses"/>
      <link rel="ip_address_bindings" href="/api/clouds/888/ip_address_bindings"/>
      <link rel="volume_attachments" href="/api/clouds/888/volume_attachments"/>
      <link rel="recurring_volume_attachments" href="/api/clouds/888/recurring_volume_attachments"/>
      <link rel="volume_snapshots" href="/api/clouds/888/volume_snapshots"/>
      <link rel="volumes" href="/api/clouds/888/volumes"/>
    </links>
    <capabilities>
      <capability>
        <name>supports_networks</name>
        <value>false</value>
      </capability>
      <capability>
        <name>supports_route_tables</name>
        <value>false</value>
      </capability>
      <capability>
        <name>supports_volume_attachments</name>
        <value>true</value>
      </capability>
      <capability>
        <name>supports_volume_snapshots</name>
        <value>true</value>
      </capability>
    </capabilities>
  </cloud>
</clouds>

show

Show information about a single cloud.

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

Required roles

observer||instance||infrastructure

Parameters

name	required	type	values	regexp	blank?	description
view	no	String	default, extended	*	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": "habuka01",
  "display_name": "habuka01",
  "description": "",
  "cloud_type": "eucalyptus",
  "links": [
    {"rel":"self","href":"/api/clouds/888"},
    {"rel":"datacenters","href":"/api/clouds/888/datacenters"},
    {"rel":"instance_types","href":"/api/clouds/888/instance_types"},
    {"rel":"security_groups","href":"/api/clouds/888/security_groups"},
    {"rel":"instances","href":"/api/clouds/888/instances"},
    {"rel":"ssh_keys","href":"/api/clouds/888/ssh_keys"},
    {"rel":"images","href":"/api/clouds/888/images"},
    {"rel":"ip_addresses","href":"/api/clouds/888/ip_addresses"},
    {"rel":"ip_address_bindings","href":"/api/clouds/888/ip_address_bindings"},
    {"rel":"volume_attachments","href":"/api/clouds/888/volume_attachments"},
    {"rel":"recurring_volume_attachments","href":"/api/clouds/888/recurring_volume_attachments"},
    {"rel":"volume_snapshots","href":"/api/clouds/888/volume_snapshots"},
    {"rel":"volumes","href":"/api/clouds/888/volumes"}
  ]
}

<?xml version="1.0" encoding="UTF-8"?>
<cloud>
  <name>habuka01</name>
  <display_name>habuka01</display_name>
  <description/>
  <cloud_type>eucalyptus</cloud_type>
  <links>
    <link rel="self" href="/api/clouds/888"/>
    <link rel="datacenters" href="/api/clouds/888/datacenters"/>
    <link rel="instance_types" href="/api/clouds/888/instance_types"/>
    <link rel="security_groups" href="/api/clouds/888/security_groups"/>
    <link rel="instances" href="/api/clouds/888/instances"/>
    <link rel="ssh_keys" href="/api/clouds/888/ssh_keys"/>
    <link rel="images" href="/api/clouds/888/images"/>
    <link rel="ip_addresses" href="/api/clouds/888/ip_addresses"/>
    <link rel="ip_address_bindings" href="/api/clouds/888/ip_address_bindings"/>
    <link rel="volume_attachments" href="/api/clouds/888/volume_attachments"/>
    <link rel="recurring_volume_attachments" href="/api/clouds/888/recurring_volume_attachments"/>
    <link rel="volume_snapshots" href="/api/clouds/888/volume_snapshots"/>
    <link rel="volumes" href="/api/clouds/888/volumes"/>
  </links>
</cloud>

Click on a format below to see an example response for the 'extended' view:

JSON XML

{
  "name": "habuka01",
  "display_name": "habuka01",
  "description": "",
  "cloud_type": "eucalyptus",
  "links": [
    {"rel":"self","href":"/api/clouds/888"},
    {"rel":"datacenters","href":"/api/clouds/888/datacenters"},
    {"rel":"instance_types","href":"/api/clouds/888/instance_types"},
    {"rel":"security_groups","href":"/api/clouds/888/security_groups"},
    {"rel":"instances","href":"/api/clouds/888/instances"},
    {"rel":"ssh_keys","href":"/api/clouds/888/ssh_keys"},
    {"rel":"images","href":"/api/clouds/888/images"},
    {"rel":"ip_addresses","href":"/api/clouds/888/ip_addresses"},
    {"rel":"ip_address_bindings","href":"/api/clouds/888/ip_address_bindings"},
    {"rel":"volume_attachments","href":"/api/clouds/888/volume_attachments"},
    {"rel":"recurring_volume_attachments","href":"/api/clouds/888/recurring_volume_attachments"},
    {"rel":"volume_snapshots","href":"/api/clouds/888/volume_snapshots"},
    {"rel":"volumes","href":"/api/clouds/888/volumes"}
  ],
  "capabilities": [
    {
      "name": "supports_networks",
      "value": "false"
    },
    {
      "name": "supports_route_tables",
      "value": "false"
    },
    {
      "name": "supports_volume_attachments",
      "value": "true"
    },
    {
      "name": "supports_volume_snapshots",
      "value": "true"
    }
  ]
}

<?xml version="1.0" encoding="UTF-8"?>
<cloud>
  <name>habuka01</name>
  <display_name>habuka01</display_name>
  <description/>
  <cloud_type>eucalyptus</cloud_type>
  <links>
    <link rel="self" href="/api/clouds/888"/>
    <link rel="datacenters" href="/api/clouds/888/datacenters"/>
    <link rel="instance_types" href="/api/clouds/888/instance_types"/>
    <link rel="security_groups" href="/api/clouds/888/security_groups"/>
    <link rel="instances" href="/api/clouds/888/instances"/>
    <link rel="ssh_keys" href="/api/clouds/888/ssh_keys"/>
    <link rel="images" href="/api/clouds/888/images"/>
    <link rel="ip_addresses" href="/api/clouds/888/ip_addresses"/>
    <link rel="ip_address_bindings" href="/api/clouds/888/ip_address_bindings"/>
    <link rel="volume_attachments" href="/api/clouds/888/volume_attachments"/>
    <link rel="recurring_volume_attachments" href="/api/clouds/888/recurring_volume_attachments"/>
    <link rel="volume_snapshots" href="/api/clouds/888/volume_snapshots"/>
    <link rel="volumes" href="/api/clouds/888/volumes"/>
  </links>
  <capabilities>
    <capability>
      <name>supports_networks</name>
      <value>false</value>
    </capability>
    <capability>
      <name>supports_route_tables</name>
      <value>false</value>
    </capability>
    <capability>
      <name>supports_volume_attachments</name>
      <value>true</value>
    </capability>
    <capability>
      <name>supports_volume_snapshots</name>
      <value>true</value>
    </capability>
  </capabilities>
</cloud>

MediaTypes:

Resources:

Clouds

Actions

index

Required roles

Parameters

Filters

Example Responses

Click on a format below to see an example response for the 'default' view:

Click on a format below to see an example response for the 'extended' view:

show

Required roles

Parameters

Example Responses

Click on a format below to see an example response for the 'default' view:

Click on a format below to see an example response for the 'extended' view: