Cloud Management API 1.5

MultiCloudImageSettings

A MultiCloudImageSetting defines which settings should be used when a server is launched in a cloud.

Actions

index

Lists the MultiCloudImage settings.

URLs
GET /api/multi_cloud_images/:multi_cloud_image_id/settings
HTTP response code
200 OK
Content-type
application/vnd.rightscale.multi_cloud_image_setting;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
cloud_href no The Cloud href to filter on.

Example Responses

Click on a format below to see an example response:

JSON XML
[{
  "links": [
    {"rel":"self","href":"/api/multi_cloud_images/1/settings/3"},
    {"rel":"image","href":"/api/clouds/888/images/RS_ID_1206730659"},
    {"rel":"cloud","href":"/api/clouds/888"},
    {"rel":"instance_type","href":"/api/clouds/888/instance_types/RESOURCE_3523572377;RAND"},
    {"rel":"multi_cloud_image","href":"/api/multi_cloud_images/1"}
  ],
  "actions": [

  ],
  "user_data": null
},{
  "links": [
    {"rel":"self","href":"/api/multi_cloud_images/2/settings/6"},
    {"rel":"image","href":"/api/clouds/888/images/RS_ID_1144856963"},
    {"rel":"cloud","href":"/api/clouds/888"},
    {"rel":"instance_type","href":"/api/clouds/888/instance_types/RESOURCE_2918328469;RAND"},
    {"rel":"multi_cloud_image","href":"/api/multi_cloud_images/2"}
  ],
  "actions": [

  ],
  "user_data": null
}]
<?xml version="1.0" encoding="UTF-8"?>
<multi_cloud_image_settings>
  <multi_cloud_image_setting>
    <links>
      <link rel="self" href="/api/multi_cloud_images/1/settings/3"/>
      <link rel="image" href="/api/clouds/888/images/RS_ID_1206730659"/>
      <link rel="cloud" href="/api/clouds/888"/>
      <link rel="instance_type" href="/api/clouds/888/instance_types/RESOURCE_3523572377;RAND"/>
      <link rel="multi_cloud_image" href="/api/multi_cloud_images/1"/>
    </links>
    <actions/>
    <user_data/>
  </multi_cloud_image_setting>
  <multi_cloud_image_setting>
    <links>
      <link rel="self" href="/api/multi_cloud_images/2/settings/6"/>
      <link rel="image" href="/api/clouds/888/images/RS_ID_1144856963"/>
      <link rel="cloud" href="/api/clouds/888"/>
      <link rel="instance_type" href="/api/clouds/888/instance_types/RESOURCE_2918328469;RAND"/>
      <link rel="multi_cloud_image" href="/api/multi_cloud_images/2"/>
    </links>
    <actions/>
    <user_data/>
  </multi_cloud_image_setting>
</multi_cloud_image_settings>

show

Show information about a single MultiCloudImage setting.

URLs
GET /api/multi_cloud_images/:multi_cloud_image_id/settings/:id
HTTP response code
200 OK
Content-type
application/vnd.rightscale.multi_cloud_image_setting

Required roles

Example Responses

Click on a format below to see an example response:

JSON XML
{
  "links": [
    {"rel":"self","href":"/api/multi_cloud_images/1/settings/3"},
    {"rel":"image","href":"/api/clouds/888/images/RS_ID_1206730659"},
    {"rel":"cloud","href":"/api/clouds/888"},
    {"rel":"instance_type","href":"/api/clouds/888/instance_types/RESOURCE_3523572377;RAND"},
    {"rel":"multi_cloud_image","href":"/api/multi_cloud_images/1"}
  ],
  "actions": [

  ],
  "user_data": null
}
<?xml version="1.0" encoding="UTF-8"?>
<multi_cloud_image_setting>
  <links>
    <link rel="self" href="/api/multi_cloud_images/1/settings/3"/>
    <link rel="image" href="/api/clouds/888/images/RS_ID_1206730659"/>
    <link rel="cloud" href="/api/clouds/888"/>
    <link rel="instance_type" href="/api/clouds/888/instance_types/RESOURCE_3523572377;RAND"/>
    <link rel="multi_cloud_image" href="/api/multi_cloud_images/1"/>
  </links>
  <actions/>
  <user_data/>
</multi_cloud_image_setting>

create

Creates a new setting for an existing MultiCloudImage.

URLs
POST /api/multi_cloud_images/:multi_cloud_image_id/settings
HTTP response code
201 Created
Location
Href of the created MultiCloudImageSetting.

Required roles

Parameters

name required type values regexp blank? description
multi_cloud_image_setting yes Hash * * no
multi_cloud_image_setting[cloud_href] no String * * no The href of the Cloud to use.
multi_cloud_image_setting[image_href] no String * * no The href of the Image to use. Mandatory if specifying cloud_href.
multi_cloud_image_setting[instance_type_href] no String * * no The href of the instance type. Mandatory if specifying cloud_href.
multi_cloud_image_setting[kernel_image_href] no String * * no The href of the kernel image. Optional if specifying cloud_href.
multi_cloud_image_setting[ramdisk_image_href] no String * * no The href of the ramdisk image. Optional if specifying cloud_href.
multi_cloud_image_setting[user_data] no String * * no User data that RightScale automatically passes to your instance at boot time.

update

Updates a settings for a MultiCloudImage.

URLs
PUT /api/multi_cloud_images/:multi_cloud_image_id/settings/:id
HTTP response code
204 No Content

Required roles

Parameters

name required type values regexp blank? description
multi_cloud_image_setting yes Hash * * no
multi_cloud_image_setting[cloud_href] no String * * no The href of the Cloud to use.
multi_cloud_image_setting[image_href] no String * * no The href of the Image to use.
multi_cloud_image_setting[instance_type_href] no String * * no The href of the instance type.
multi_cloud_image_setting[kernel_image_href] no String * * no The href of the kernel image.
multi_cloud_image_setting[ramdisk_image_href] no String * * no The href of the ramdisk image.
multi_cloud_image_setting[user_data] no String * * no User data that RightScale automatically passes to your instance at boot time.

destroy

Deletes a MultiCloudImage setting.

URLs
DELETE /api/multi_cloud_images/:multi_cloud_image_id/settings/:id
HTTP response code
204 No Content

Required roles