Cloud Management API 1.5

MultiCloudImageMatchers

A MultiCloudImageMatcher generates MultiCloudImageSettings for all clouds of a given cloud type. For now, only one type of matcher is supported (fingerprint). Fingerprint will match images based upon a checksum as returned by the cloud and is supported CloudStack, OpenStack, and vSphere clouds. Pass in an example image with an image_href from which to generate the fingerprint.

Actions

index

Lists the MultiCloudImage setting matchers.

URLs
GET /api/multi_cloud_images/:multi_cloud_image_id/matchers
HTTP response code
200 OK
Content-type
application/vnd.rightscale.multi_cloud_image_matcher;type=collection

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/matchers/1"},
    {"rel":"multi_cloud_image","href":"/api/multi_cloud_images/1"}
  ],
  "actions": [
    {
      "rel": "rematch"
    }
  ],
  "cloud_type": "eucalyptus",
  "match_type": "fingerprint",
  "match_criteria": {
    "fingerprint": "F960665283"
  },
  "user_data": "user_data_2556027745"
},{
  "links": [
    {"rel":"self","href":"/api/multi_cloud_images/2/matchers/4"},
    {"rel":"multi_cloud_image","href":"/api/multi_cloud_images/2"}
  ],
  "actions": [
    {
      "rel": "rematch"
    }
  ],
  "cloud_type": "eucalyptus",
  "match_type": "fingerprint",
  "match_criteria": {
    "fingerprint": "F1123785772"
  },
  "user_data": "user_data_4218948888"
}]
<?xml version="1.0" encoding="UTF-8"?>
<multi_cloud_image_matchers>
  <multi_cloud_image_matcher>
    <links>
      <link rel="self" href="/api/multi_cloud_images/1/matchers/1"/>
      <link rel="multi_cloud_image" href="/api/multi_cloud_images/1"/>
    </links>
    <actions>
      <action rel="rematch"/>
    </actions>
    <cloud_type>eucalyptus</cloud_type>
    <match_type>fingerprint</match_type>
    <match_criteria>
      <fingerprint>F960665283</fingerprint>
    </match_criteria>
    <user_data>user_data_2556027745</user_data>
  </multi_cloud_image_matcher>
  <multi_cloud_image_matcher>
    <links>
      <link rel="self" href="/api/multi_cloud_images/2/matchers/4"/>
      <link rel="multi_cloud_image" href="/api/multi_cloud_images/2"/>
    </links>
    <actions>
      <action rel="rematch"/>
    </actions>
    <cloud_type>eucalyptus</cloud_type>
    <match_type>fingerprint</match_type>
    <match_criteria>
      <fingerprint>F1123785772</fingerprint>
    </match_criteria>
    <user_data>user_data_4218948888</user_data>
  </multi_cloud_image_matcher>
</multi_cloud_image_matchers>

show

Show information about a single MultiCloudImage setting matcher.

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

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/matchers/1"},
    {"rel":"multi_cloud_image","href":"/api/multi_cloud_images/1"}
  ],
  "actions": [
    {
      "rel": "rematch"
    }
  ],
  "cloud_type": "eucalyptus",
  "match_type": "fingerprint",
  "match_criteria": {
    "fingerprint": "F960665283"
  },
  "user_data": "user_data_2556027745"
}
<?xml version="1.0" encoding="UTF-8"?>
<multi_cloud_image_matcher>
  <links>
    <link rel="self" href="/api/multi_cloud_images/1/matchers/1"/>
    <link rel="multi_cloud_image" href="/api/multi_cloud_images/1"/>
  </links>
  <actions>
    <action rel="rematch"/>
  </actions>
  <cloud_type>eucalyptus</cloud_type>
  <match_type>fingerprint</match_type>
  <match_criteria>
    <fingerprint>F960665283</fingerprint>
  </match_criteria>
  <user_data>user_data_2556027745</user_data>
</multi_cloud_image_matcher>

create

Creates a new setting matcher for an existing MultiCloudImage.

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

Required roles

Parameters

name required type values regexp blank? description
multi_cloud_image_matcher yes Hash * * no
multi_cloud_image_matcher[image_href] yes String * * no The href of the example Image to use. Mandatory if specifying fingerprint type.
multi_cloud_image_matcher[user_data] no String * * no User data that RightScale automatically passes to your instance at boot time.

destroy

Deletes a MultiCloudImage setting matcher.

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

Required roles

rematch

Generates new MultiCloudImageSettings based upon match_criteria. Returns hash of created/updated/destroyed settings.

URLs
POST /api/multi_cloud_images/:multi_cloud_image_id/matchers/:id/rematch
HTTP response code
200 OK

Required roles