Cloud Management API 1.5

MultiCloudImages

A MultiCloudImage is a RightScale component that functions as a pointer to machine images in specific clouds (e.g. AWS US-East, Rackspace). Each ServerTemplate can reference many MultiCloudImages that defines which image should be used when a server is launched in a particular cloud.

Actions

index

Lists the MultiCloudImages available to this account. HEAD revisions have a revision of 0.

URLs
GET /api/multi_cloud_images
GET /api/server_templates/:server_template_id/multi_cloud_images
HTTP response code
200 OK
Content-type
application/vnd.rightscale.multi_cloud_image;type=collection

Required roles

Parameters

name required type values regexp blank? description
filter no Array * * no See below for valid filter parameters.

Filters

name partial_match? description
description yes The MultiCloudImage description to filter on.
name yes The name of the MultiCloudImage to filter on.
revision no The version of the MultiCloudImage to filter on.

Example Responses

Click on a format below to see an example response:

JSON XML
[{
  "name": "NAME_2183624020",
  "description": "DESCRIPTION_236983738",
  "revision": 0,
  "links": [
    {"rel":"self","href":"/api/multi_cloud_images/1"},
    {"rel":"settings","href":"/api/multi_cloud_images/1/settings"},
    {"rel":"matchers","href":"/api/multi_cloud_images/1/matchers"}
  ],
  "actions": [
    {
      "rel": "clone"
    }
  ]
},{
  "name": "NAME_64661079",
  "description": "DESCRIPTION_2064356258",
  "revision": 0,
  "links": [
    {"rel":"self","href":"/api/multi_cloud_images/2"},
    {"rel":"settings","href":"/api/multi_cloud_images/2/settings"},
    {"rel":"matchers","href":"/api/multi_cloud_images/2/matchers"}
  ],
  "actions": [
    {
      "rel": "clone"
    }
  ]
}]
<?xml version="1.0" encoding="UTF-8"?>
<multi_cloud_images>
  <multi_cloud_image>
    <name>NAME_2183624020</name>
    <description>DESCRIPTION_236983738</description>
    <revision>0</revision>
    <links>
      <link rel="self" href="/api/multi_cloud_images/1"/>
      <link rel="settings" href="/api/multi_cloud_images/1/settings"/>
      <link rel="matchers" href="/api/multi_cloud_images/1/matchers"/>
    </links>
    <actions>
      <action rel="clone"/>
    </actions>
  </multi_cloud_image>
  <multi_cloud_image>
    <name>NAME_64661079</name>
    <description>DESCRIPTION_2064356258</description>
    <revision>0</revision>
    <links>
      <link rel="self" href="/api/multi_cloud_images/2"/>
      <link rel="settings" href="/api/multi_cloud_images/2/settings"/>
      <link rel="matchers" href="/api/multi_cloud_images/2/matchers"/>
    </links>
    <actions>
      <action rel="clone"/>
    </actions>
  </multi_cloud_image>
</multi_cloud_images>

show

Show information about a single MultiCloudImage. HEAD revisions have a revision of 0.

URLs
GET /api/multi_cloud_images/:id
GET /api/server_templates/:server_template_id/multi_cloud_images/:id
HTTP response code
200 OK
Content-type
application/vnd.rightscale.multi_cloud_image

Required roles

Example Responses

Click on a format below to see an example response:

JSON XML
{
  "name": "NAME_2183624020",
  "description": "DESCRIPTION_236983738",
  "revision": 0,
  "links": [
    {"rel":"self","href":"/api/multi_cloud_images/1"},
    {"rel":"settings","href":"/api/multi_cloud_images/1/settings"},
    {"rel":"matchers","href":"/api/multi_cloud_images/1/matchers"}
  ],
  "actions": [
    {
      "rel": "clone"
    }
  ]
}
<?xml version="1.0" encoding="UTF-8"?>
<multi_cloud_image>
  <name>NAME_2183624020</name>
  <description>DESCRIPTION_236983738</description>
  <revision>0</revision>
  <links>
    <link rel="self" href="/api/multi_cloud_images/1"/>
    <link rel="settings" href="/api/multi_cloud_images/1/settings"/>
    <link rel="matchers" href="/api/multi_cloud_images/1/matchers"/>
  </links>
  <actions>
    <action rel="clone"/>
  </actions>
</multi_cloud_image>

create

Creates a new MultiCloudImage with the given parameters.

URLs
POST /api/multi_cloud_images
POST /api/server_templates/:server_template_id/multi_cloud_images
HTTP response code
201 Created
Location
Href of the created MultiCloudImage.

Required roles

Parameters

name required type values regexp blank? description
multi_cloud_image yes Hash * * no
multi_cloud_image[description] no String * * yes The description of the MultiCloudImage to be created.
multi_cloud_image[name] yes String * * no The name of the MultiCloudImage to be created.

update

Updates attributes of a given MultiCloudImage. Only HEAD revisions can be updated (revision 0). Currently, the attributes you can update are only the 'direct' attributes of a server template.

URLs
PUT /api/multi_cloud_images/:id
PUT /api/server_templates/:server_template_id/multi_cloud_images/:id
HTTP response code
204 No Content

Required roles

Parameters

name required type values regexp blank? description
multi_cloud_image yes Hash * * no
multi_cloud_image[description] no String * * yes The updated description for the MultiCloudImage.
multi_cloud_image[name] no String * * no The updated name for the MultiCloudImage.

destroy

Deletes a given MultiCloudImage.

URLs
DELETE /api/multi_cloud_images/:id
DELETE /api/server_templates/:server_template_id/multi_cloud_images/:id
HTTP response code
204 No Content

Required roles

clone

Clones a given MultiCloudImage.

URLs
POST /api/multi_cloud_images/:id/clone
HTTP response code
201 Created
Location
Href of the cloned MultiCloudImage.

Required roles

Parameters

name required type values regexp blank? description
multi_cloud_image yes Hash * * no
multi_cloud_image[description] no String * * no The description for the cloned MultiCloudImage.
multi_cloud_image[name] yes String * * no The name for the cloned MultiCloudImage.

commit

Commits a given MultiCloudImage. Only HEAD revisions can be committed.

URLs
POST /api/multi_cloud_images/:id/commit
HTTP response code
201 Created
Location
Href of the committed MultiCloudImage.

Required roles

Parameters

name required type values regexp blank? description
commit_message yes String * * no The message associated with the commit.