blob: 582fb086fd2906da411200c88ac3deb69f5ac7f6 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
|
---
upgrade:
- |
The filter and sort query parameters for server list API are
now limited according to whitelists. The whitelists are different
for admin and non-admin users.
**Filtering**
The whitelist for REST API filters for admin users:
- access_ip_v4
- access_ip_v6
- all_tenants
- auto_disk_config
- availability_zone
- config_drive
- changes-since
- created_at
- deleted
- description
- display_description
- display_name
- flavor
- host
- hostname
- image
- image_ref
- ip
- ip6
- kernel_id
- key_name
- launch_index
- launched_at
- limit
- locked_by
- marker
- name
- node
- not-tags (available in 2.26+)
- not-tags-any (available in 2.26+)
- power_state
- progress
- project_id
- ramdisk_id
- reservation_id
- root_device_name
- sort_dir
- sort_key
- status
- tags (available in 2.26+)
- tags-any (available in 2.26+)
- task_state
- tenant_id
- terminated_at
- user_id
- uuid
- vm_state
For non-admin users, there is a whitelist for filters already. That
whitelist is unchanged.
**Sorting**
The whitelist for sort keys for admin users:
- access_ip_v4
- access_ip_v6
- auto_disk_config
- availability_zone
- config_drive
- created_at
- display_description
- display_name
- host
- hostname
- image_ref
- instance_type_id
- kernel_id
- key_name
- launch_index
- launched_at
- locked_by
- node
- power_state
- progress
- project_id
- ramdisk_id
- root_device_name
- task_state
- terminated_at
- updated_at
- user_id
- uuid
- vm_state
For non-admin users, the sort key ``host`` and ``node`` will be excluded.
**Other**
`HTTP Bad Request 400` will be returned for the filters/sort keys which
are on joined tables or internal data model attributes. They would
previously cause a `HTTP Server Internal Error 500`, namely:
- block_device_mapping
- info_cache
- metadata
- pci_devices
- security_groups
- services
- system_metadata
In order to maintain backward compatibility, filter and sort parameters
which are not mapped to the REST API `servers` resource representation are
ignored.
|