Prev Next

4.7. Creating host aggregates¶

POST /os-aggregates

Create a host aggregate.

Source: https://docs.openstack.org/api-ref/compute/?expanded=remove-host-detail,create-or-update-aggregate-metadata-detail#create-aggregate

4.7.1. Request¶

Name	In	Type	Description
`aggregate`	body	object	The host aggregate object.
`name`	body	string	The name of the host aggregate.
`availability_zone` (Optional)	body	string	The availability zone of the host aggregate. You should use a custom availability zone rather than the default returned by the os-availability-zone API. The availability zone must not include ‘:’ in its name.

4.7.1.1. Example¶

curl -ks -X POST -H 'Content-Type: application/json' -H 'X-Auth-Token: gAAAAA<...>' -d '
{
  "aggregate": {
    "name": "CUSTOM_HCI_0A7F6A35E650420CB30200A8359861D9"
}' https://<node_IP_addr>:8774/v2.1/6ef5371261ea42008e3d1d41ba051977/os-aggregates

4.7.2. Response¶

Name	In	Type	Description
`aggregate`	body	object	The host aggregate object.
`availability_zone`	body	string	The availability zone of the host aggregate.
`created_at`	body	string	The date and time when the resource was created. The date and time stamp format is ISO 8601 CCYY-MM-DDThh:mm:ss±hh:mm For example, `2015-08-27T09:49:58-05:00`. The `±hh:mm` value, if included, is the time zone as an offset from UTC. In the previous example, the offset value is `-05:00`.
`deleted_at`	body	string	The date and time when the resource was deleted. If the resource has not been deleted yet, this field will be `null`, The date and time stamp format is ISO 8601 CCYY-MM-DDThh:mm:ss±hh:mm For example, `2015-08-27T09:49:58-05:00`. The `±hh:mm` value, if included, is the time zone as an offset from UTC. In the previous example, the offset value is `-05:00`.
`deleted`	body	boolean	A boolean indicates whether this aggregate is deleted or not, if it has not been deleted, `false` will appear.
`id`	body	integer	The ID of the host aggregate.
`name`	body	string	The name of the host aggregate.
`updated_at`	body	string	The date and time when the resource was updated, if the resource has not been updated, this field will show as `null`. The date and time stamp format is ISO 8601 CCYY-MM-DDThh:mm:ss±hh:mm For example, `2015-08-27T09:49:58-05:00`. The `±hh:mm` value, if included, is the time zone as an offset from UTC. In the previous example, the offset value is `-05:00`.
`uuid`	body	string	The UUID of the host aggregate. New in version 2.41

4.7.2.1. Status codes¶

4.7.2.1.1. Success¶

Code	Reason
`200 - OK`	Request was successful.

4.7.2.1.2. Error¶

Code	Reason
`400 - Bad Request`	Some content in the request was invalid.
`401 - Unauthorized`	User must authenticate before making a request.
`403 - Forbidden`	Policy does not allow current user to do this operation.
`409 - Conflict`	This operation conflicted with another operation on this resource.

4.7.2.2. Example¶

{
  "aggregate": {
    "name": "CUSTOM_HCI_0A7F6A35E650420CB30200A8359861D9",
    "availability_zone": null,
    "deleted": false,
    "created_at": "2020-04-19T12:56:10.191466",
    "updated_at": null,
    "deleted_at": null,
    "id": 4
  }
}

Version 5.0.0 — Feb 01, 2022

Prev Next