Back to guides list

4.8. Listing host aggregates

GET /os-aggregates

List host aggregates.

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

4.8.1. Request

4.8.1.1. Example

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

4.8.2. Response

Name In Type Description
aggregates body array The list of existing aggregates.
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.
hosts body array A list of host ids in this aggregate.
id body integer The ID of the host aggregate.
metadata body object Metadata key and value pairs associated with the 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.8.2.1. Status codes

4.8.2.1.1. Success

Code Reason
200 - OK Request was successful.

4.8.2.1.2. Error

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

4.8.2.2. Example

{
  "aggregates": [
    {
      "name": "CUSTOM_HCI_E3A45A6A4B614263893D72015BFB1A5F",
      "availability_zone": null,
      "deleted": false,
      "created_at": "2020-04-16T13:22:56.413373",
      "updated_at": null,
      "hosts": [
        "hci-ac-am2.vstoragedomain",
        "hci-ac-am3.vstoragedomain"
      ],
      "deleted_at": null,
      "id": 1,
      "metadata": {
        "trait:CUSTOM_HCI_E3A45A6A4B614263893D72015BFB1A5F": "required"
      }
    }
  ]
}
Version 5.0.0 — Feb 01, 2022
Print