Listing host aggregates

GET /os-aggregates

List host aggregates.

Source: https://docs.openstack.org/api-ref/compute/?expanded=list-aggregates-detail#list-aggregates

Request

Example

curl -ks -H 'Content-Type: application/json' -H 'X-Auth-Token: gAAAAA<...>' \
https://<node_IP_addr>:8774/v2.1/6ef5371261ea42008e3d1d41ba051977/os-aggregates

Response

Parameters

Name	In	Type	Description
`aggregates`	body	array	The list of existing aggregates.
`name`	body	string	The name of the host aggregate.
`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 this 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 this 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.
`hosts`	body	array	An array of host information.
`id`	body	integer	The ID of the host aggregate.
`metadata`	body	object	Metadata key and value pairs associated with the aggregate.
`updated_at`	body	string	The date and time when the resource was updated. If the resource has not been updated, 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 this example, the offset value is `-05:00`.
`uuid`	body	string	The UUID of the host aggregate. New in version 2.41

Status codes

Success

Code	Reason
`200 - OK`	Request was successful.

Error

Code	Reason
`401 - Unauthorized`	User must authenticate before making a request.
`403 - Forbidden`	Policy does not allow current user to do this operation.

Example

{
  "aggregates": [
    {
      "name": "CUSTOM_HCI_E3A45A6A4B614263893D72015BFB1A5F",
      "availability_zone": null,
      "deleted": false,
      "created_at": "2020-04-16T13:22:56.413373",
      "updated_at": null,
      "hosts": [
        "node2.vstoragedomain",
        "node3.vstoragedomain"
      ],
      "deleted_at": null,
      "id": 1,
      "metadata": {
        "trait:CUSTOM_HCI_E3A45A6A4B614263893D72015BFB1A5F": "required"
      }
    }
  ]
}