v1

latestOpenAPI 3.1.02026-07-172660204.4 KB
Extension

List Servers

List Servers

get/api/v1/extension/servers

Query parameters

limitinteger nullable

Requests a page size of items. Returns a number of items up to a limit value.

Requests a page size of items. Returns a number of items up to a limit value.

markerstring nullable

The ID of the last-seen item.

The ID of the last-seen item.

sort_dirs'desc' | 'asc'

Indicates in which directions to sort.

sort_keysServerSortKey[]

Indicates in which attributes to sort. Host is only used for admin role users

Indicates in which attributes to sort. Host is only used for admin role users

all_projectsboolean nullable

List servers for all projects.

List servers for all projects.

project_idstring nullable

Filter the list of servers by the given project ID. Only works when the all_projects filter is also specified.

Filter the list of servers by the given project ID. Only works when the all_projects filter is also specified.

project_namestring nullable

Filter the list of servers by the given project name. Only works when the all_projects filter is also specified.

Filter the list of servers by the given project name. Only works when the all_projects filter is also specified.

namestring nullable

Filter the list of servers by the given server name. Support fuzzy query.

Filter the list of servers by the given server name. Support fuzzy query.

status'ACTIVE' | 'BUILD' | 'ERROR' | 'HARD_REBOOT' | 'MIGRATING' | 'PAUSED' | 'REBOOT' | 'REBUILD' | 'RESCUE' | 'RESIZE' | 'SHELVED' | 'SHELVED_OFFLOADED' | 'SHUTOFF' | 'SOFT_DELETED' | 'SUSPENDED' | 'UNKNOWN'

Filter the list of servers by the given server status.

hoststring nullable

Filter the list of servers by the given host. It will be ignored for non-admin user.

Filter the list of servers by the given host. It will be ignored for non-admin user.

flavor_idstring

Filter the list of servers by the given flavor ID.

Filter the list of servers by the given flavor ID.

uuidstring

Filter the list of servers by the given server UUID.

Filter the list of servers by the given server UUID.

ipstring nullable

Filter the list of servers by the given IP address (only fixed, not floating). Also passed to Nova API if supported.

Filter the list of servers by the given IP address (only fixed, not floating). Also passed to Nova API if supported.

Headers

X-Openstack-Request-Idstring

Response

OK