Cloud Management API 1.5

MediaTypes:

AccountGroup | Account | AlertSpec | Alert | AuditEntry | Backup | CloudAccount | Cloud | CookbookAttachment | Cookbook | Credential | Datacenter | Deployment | IdentityProvider | Image | Input | InstanceType | Instance | IpAddressBinding | IpAddress | MonitoringMetric | MonitoringMetricData | MultiCloudImageMatcher | MultiCloudImageSetting | MultiCloudImage | NetworkGateway | NetworkOptionGroupAttachment | NetworkOptionGroup | Network | Permission | PlacementGroup | Preference | PublicationLineage | Publication | RecurringVolumeAttachment | Repository | RepositoryAsset | ResourceGroup | RightScriptAttachment | RightScript | RouteTable | Route | RunnableBinding | SecurityGroupRule | SecurityGroup | ServerArray | ServerTemplateMultiCloudImage | ServerTemplate | Server | Session | SshKey | Subnet | ResourceTag | Task | User | VolumeAttachment | VolumeSnapshot | VolumeType | Volume |

Resources:

AccountGroups | Accounts | AlertSpecs | Alerts | AuditEntries | Backups | ChildAccounts | CloudAccounts | Clouds | CookbookAttachments | Cookbooks | Credentials | Datacenters | Deployments | HealthCheck | IdentityProviders | Images | Inputs | InstanceTypes | Instances | IpAddressBindings | IpAddresses | MonitoringMetrics | MultiCloudImageMatchers | MultiCloudImageSettings | MultiCloudImages | NetworkGateways | NetworkOptionGroupAttachments | NetworkOptionGroups | Networks | Oauth2 | Permissions | PlacementGroups | Preferences | PublicationLineages | Publications | RecurringVolumeAttachments | Repositories | RepositoryAssets | ResourceGroups | RightScriptAttachments | RightScripts | RouteTables | Routes | RunnableBindings | SecurityGroupRules | SecurityGroups | ServerArrays | ServerTemplateMultiCloudImages | ServerTemplates | Servers | Sessions | SshKeys | Subnets | Tags | Tasks | UserDatas | Users | VolumeAttachments | VolumeSnapshots | VolumeTypes | Volumes |

PlacementGroups

Actions

index

Lists all PlacementGroups in an account.

URLs
GET /api/placement_groups
HTTP response code
200 OK
Content-type
application/vnd.rightscale.placement_group;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, extended * no Specifies how many attributes and/or expanded nested relationships to include.

Filters

name partial_match? description
cloud_href no Href of the Cloud to filter on.
deployment_href no Deployment href to filter on.
name yes Name of the Placement Groups to filter on.
state no State of the Placement Groups to filter on. Valid values are: ["pending", "available", "terminating"].

Example Responses

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

JSON XML 
[{
  "name": "NAME_341084324",
  "description": "",
  "state": null,
  "resource_uid": "RESOURCE_3477619576",
  "created_at": "2023/10/09 11:06:01 +0000",
  "updated_at": "2023/10/09 11:06:01 +0000",
  "links": [
    {"rel":"self","href":"/api/placement_groups/ABC273108500DEF"},
    {"rel":"cloud","href":"/api/clouds/888"}
  ],
  "actions": [

  ]
},{
  "name": "NAME_1733214571",
  "description": "",
  "state": null,
  "resource_uid": "RESOURCE_2606832386",
  "created_at": "2023/10/09 11:06:02 +0000",
  "updated_at": "2023/10/09 11:06:02 +0000",
  "links": [
    {"rel":"self","href":"/api/placement_groups/ABC16707556DEF"},
    {"rel":"cloud","href":"/api/clouds/888"}
  ],
  "actions": [

  ]
}]
<?xml version="1.0" encoding="UTF-8"?>
<placement_groups>
  <placement_group>
    <name>NAME_341084324</name>
    <description/>
    <state/>
    <resource_uid>RESOURCE_3477619576</resource_uid>
    <created_at>2023/10/09 11:06:01 +0000</created_at>
    <updated_at>2023/10/09 11:06:01 +0000</updated_at>
    <links>
      <link rel="self" href="/api/placement_groups/ABC273108500DEF"/>
      <link rel="cloud" href="/api/clouds/888"/>
    </links>
    <actions/>
  </placement_group>
  <placement_group>
    <name>NAME_1733214571</name>
    <description/>
    <state/>
    <resource_uid>RESOURCE_2606832386</resource_uid>
    <created_at>2023/10/09 11:06:02 +0000</created_at>
    <updated_at>2023/10/09 11:06:02 +0000</updated_at>
    <links>
      <link rel="self" href="/api/placement_groups/ABC16707556DEF"/>
      <link rel="cloud" href="/api/clouds/888"/>
    </links>
    <actions/>
  </placement_group>
</placement_groups>

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

JSON XML 
[{
  "name": "NAME_341084324",
  "description": "",
  "state": null,
  "resource_uid": "RESOURCE_3477619576",
  "created_at": "2023/10/09 11:06:01 +0000",
  "updated_at": "2023/10/09 11:06:01 +0000",
  "links": [
    {"rel":"self","href":"/api/placement_groups/ABC273108500DEF"},
    {"rel":"cloud","href":"/api/clouds/888"}
  ],
  "actions": [

  ],
  "cloud_specific_attributes": {
    "strategy": "cluster"
  }
},{
  "name": "NAME_1733214571",
  "description": "",
  "state": null,
  "resource_uid": "RESOURCE_2606832386",
  "created_at": "2023/10/09 11:06:02 +0000",
  "updated_at": "2023/10/09 11:06:02 +0000",
  "links": [
    {"rel":"self","href":"/api/placement_groups/ABC16707556DEF"},
    {"rel":"cloud","href":"/api/clouds/888"}
  ],
  "actions": [

  ],
  "cloud_specific_attributes": {
    "strategy": "cluster"
  }
}]
<?xml version="1.0" encoding="UTF-8"?>
<placement_groups>
  <placement_group>
    <name>NAME_341084324</name>
    <description/>
    <state/>
    <resource_uid>RESOURCE_3477619576</resource_uid>
    <created_at>2023/10/09 11:06:01 +0000</created_at>
    <updated_at>2023/10/09 11:06:01 +0000</updated_at>
    <links>
      <link rel="self" href="/api/placement_groups/ABC273108500DEF"/>
      <link rel="cloud" href="/api/clouds/888"/>
    </links>
    <actions/>
    <cloud_specific_attributes>
      <strategy>cluster</strategy>
    </cloud_specific_attributes>
  </placement_group>
  <placement_group>
    <name>NAME_1733214571</name>
    <description/>
    <state/>
    <resource_uid>RESOURCE_2606832386</resource_uid>
    <created_at>2023/10/09 11:06:02 +0000</created_at>
    <updated_at>2023/10/09 11:06:02 +0000</updated_at>
    <links>
      <link rel="self" href="/api/placement_groups/ABC16707556DEF"/>
      <link rel="cloud" href="/api/clouds/888"/>
    </links>
    <actions/>
    <cloud_specific_attributes>
      <strategy>cluster</strategy>
    </cloud_specific_attributes>
  </placement_group>
</placement_groups>

show

Shows information about a single PlacementGroup.

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

Required roles

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": "NAME_341084324",
  "description": "",
  "state": null,
  "resource_uid": "RESOURCE_3477619576",
  "created_at": "2023/10/09 11:06:01 +0000",
  "updated_at": "2023/10/09 11:06:01 +0000",
  "links": [
    {"rel":"self","href":"/api/placement_groups/ABC273108500DEF"},
    {"rel":"cloud","href":"/api/clouds/888"}
  ],
  "actions": [

  ]
}
<?xml version="1.0" encoding="UTF-8"?>
<placement_group>
  <name>NAME_341084324</name>
  <description/>
  <state/>
  <resource_uid>RESOURCE_3477619576</resource_uid>
  <created_at>2023/10/09 11:06:01 +0000</created_at>
  <updated_at>2023/10/09 11:06:01 +0000</updated_at>
  <links>
    <link rel="self" href="/api/placement_groups/ABC273108500DEF"/>
    <link rel="cloud" href="/api/clouds/888"/>
  </links>
  <actions/>
</placement_group>

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

JSON XML 
{
  "name": "NAME_341084324",
  "description": "",
  "state": null,
  "resource_uid": "RESOURCE_3477619576",
  "created_at": "2023/10/09 11:06:01 +0000",
  "updated_at": "2023/10/09 11:06:01 +0000",
  "links": [
    {"rel":"self","href":"/api/placement_groups/ABC273108500DEF"},
    {"rel":"cloud","href":"/api/clouds/888"}
  ],
  "actions": [

  ],
  "cloud_specific_attributes": {
    "strategy": "cluster"
  }
}
<?xml version="1.0" encoding="UTF-8"?>
<placement_group>
  <name>NAME_341084324</name>
  <description/>
  <state/>
  <resource_uid>RESOURCE_3477619576</resource_uid>
  <created_at>2023/10/09 11:06:01 +0000</created_at>
  <updated_at>2023/10/09 11:06:01 +0000</updated_at>
  <links>
    <link rel="self" href="/api/placement_groups/ABC273108500DEF"/>
    <link rel="cloud" href="/api/clouds/888"/>
  </links>
  <actions/>
  <cloud_specific_attributes>
    <strategy>cluster</strategy>
  </cloud_specific_attributes>
</placement_group>

create

Creates a PlacementGroup.

URLs
POST /api/placement_groups
HTTP response code
201 Created

Required roles

Parameters

name required type values regexp blank? description
placement_group yes Hash * * no
placement_group[cloud_href] yes String * * no The Href of the Cloud in which the PlacementGroup should be created. Note: This feature is not supported for all clouds.
placement_group[cloud_specific_attributes] no Hash * * no
placement_group[cloud_specific_attributes][account_type] no String * * no AzureRM: The type of Storage Account.
placement_group[deployment_href] no String * * no The href of the Deployment that owns this PlacementGroup.
placement_group[description] no String * * yes The description of the Placement Group to be created.
placement_group[name] yes String * * no The name of the Placement Group to be created.

destroy

Destroys a PlacementGroup.

URLs
DELETE /api/placement_groups/:id
HTTP response code
204 No Content

Required roles

For more information on API 1.5, including examples, please see the API 1.5 topic on our support site.

Generated: 2023-10-09 11:06:10 UTC