Cloud Management API 1.5
InstanceCustomLodgements
An InstanceCustomLodgement represents a way to create custom reports about a specific instance with a user defined quantity. Replaces the legacy Instances#set_custom_lodgement interface.
Actions
index
List InstanceCustomLodgements of a given cloud and instance.
- URLs
- GET /api/clouds/:cloud_id/instances/:instance_id/instance_custom_lodgements
- HTTP response code
- 200 OK
- Content-type
- application/vnd.rightscale.instance_custom_lodgement;type=collection
Required roles
- observer||instance
Parameters
| name | required | type | values | regexp | blank? | description |
|---|---|---|---|---|---|---|
| view | no | String | default | * | no | Specifies how many attributes and/or expanded nested relationships to include. |
Filters
| name | partial_match? | description |
|---|---|---|
| timeframe | no | The timeframe (either a month "YYYY_MM" or a single day "YYYY_MM_DD") of the Lodgement to filter on. |
show
Show the specified lodgement.
- URLs
- GET /api/clouds/:cloud_id/instances/:instance_id/instance_custom_lodgements/:id
- HTTP response code
- 200 OK
- Content-type
- application/vnd.rightscale.instance_custom_lodgement
Required roles
- observer||instance
create
Create a lodgement with the quantity and timeframe specified.
- URLs
- POST /api/clouds/:cloud_id/instances/:instance_id/instance_custom_lodgements
- HTTP response code
- 201 Created
- Location
- Href of created Lodgement.
Required roles
- actor||instance
Parameters
| name | required | type | values | regexp | blank? | description |
|---|---|---|---|---|---|---|
| quantity | yes | Array | * | * | no | At least one name/value pair must be specified. Currently, a maximum of 2 name/value pairs is supported. |
| quantity[][name] | no | String | * | * | no | The name of the quantity. A customer-specific string, e.g. "MB/s" or "GB/Month". |
| quantity[][value] | no | String | * | ^-?\d+$ | no | The value of the quantity. Should be a positive integer. |
| timeframe | yes | String | * | ^\d{4}_\d{2}(_\d{2})?$ | no | The time-frame (either a month "YYYY_MM" or a single day "YYYY_MM_DD") for which the quantity value is valid (currently for the PDT timezone only). |
update
Update a lodgement with the quantity specified.
- URLs
- PUT /api/clouds/:cloud_id/instances/:instance_id/instance_custom_lodgements/:id
- HTTP response code
- 204 No Content
Required roles
- actor||instance
Parameters
| name | required | type | values | regexp | blank? | description |
|---|---|---|---|---|---|---|
| quantity | yes | Array | * | * | no | At least one name/value pair must be specified. Currently, a maximum of 2 name/value pairs is supported. |
| quantity[][name] | no | String | * | * | no | The name of the quantity. A customer-specific string, e.g. "MB/s" or "GB/Month". |
| quantity[][value] | no | String | * | ^-?\d+$ | no | The value of the quantity. Should be a positive integer. |
destroy
Destroy the specified lodgement.
- URLs
- DELETE /api/clouds/:cloud_id/instances/:instance_id/instance_custom_lodgements/:id
- HTTP response code
- 204 No Content
Required roles
- actor||instance