summaryrefslogtreecommitdiff
path: root/api-ref
diff options
context:
space:
mode:
authorZuul <zuul@review.opendev.org>2020-03-26 14:29:46 +0000
committerGerrit Code Review <review@openstack.org>2020-03-26 14:29:46 +0000
commitdf9195de72c6ceeeb05c3ea48b749c5666f7fdc9 (patch)
tree2eee63b0046014dd343badd3cb375c2e5a49742d /api-ref
parent15f0215df5d8e93312a511ec25c840d10e7645b9 (diff)
parent4018d6fb71a4e5bb0554ac36479cb217f55a6fcf (diff)
downloadnova-df9195de72c6ceeeb05c3ea48b749c5666f7fdc9.tar.gz
Merge "Non-Admin user can filter their instances by more filters"
Diffstat (limited to 'api-ref')
-rw-r--r--api-ref/source/parameters.yaml55
-rw-r--r--api-ref/source/servers.inc12
2 files changed, 44 insertions, 23 deletions
diff --git a/api-ref/source/parameters.yaml b/api-ref/source/parameters.yaml
index bc828c85f0..fc579791c7 100644
--- a/api-ref/source/parameters.yaml
+++ b/api-ref/source/parameters.yaml
@@ -417,8 +417,9 @@ availability_zone_query_server:
description: |
Filter the server list result by server availability zone.
- This parameter is only valid when specified by administrators.
- If non-admin users specify this parameter, it is ignored.
+ This parameter is restricted to administrators until microversion 2.82.
+ If non-admin users specify this parameter before microversion 2.83, it
+ is ignored.
in: query
required: false
type: string
@@ -579,8 +580,9 @@ config_drive_query_server:
description: |
Filter the server list result by the config drive setting of the server.
- This parameter is only valid when specified by administrators.
- If non-admin users specify this parameter, it is ignored.
+ This parameter is restricted to administrators until microversion 2.82.
+ If non-admin users specify this parameter before microversion 2.83, it
+ is ignored.
in: query
required: false
type: string
@@ -597,8 +599,9 @@ created_at_query_server:
For example, ``2015-08-27T09:49:58-05:00``.
If you omit the time zone, the UTC time zone is assumed.
- This parameter is only valid when specified by administrators.
- If non-admin users specify this parameter, it is ignored.
+ This parameter is restricted to administrators until microversion 2.82.
+ If non-admin users specify this parameter before microversion 2.83, it
+ is ignored.
in: query
required: false
type: string
@@ -888,8 +891,9 @@ key_name_query_server:
description: |
Filter the server list result by keypair name.
- This parameter is only valid when specified by administrators.
- If non-admin users specify this parameter, it is ignored.
+ This parameter is restricted to administrators until microversion 2.82.
+ If non-admin users specify this parameter before microversion 2.83, it
+ is ignored.
in: query
required: false
type: string
@@ -942,8 +946,9 @@ launched_at_query_server:
For example, ``2015-08-27T09:49:58-05:00``.
If you omit the time zone, the UTC time zone is assumed.
- This parameter is only valid when specified by administrators.
- If non-admin users specify this parameter, it is ignored.
+ This parameter is restricted to administrators until microversion 2.82.
+ If non-admin users specify this parameter before microversion 2.83, it
+ is ignored.
in: query
required: false
type: string
@@ -1121,15 +1126,17 @@ power_state_query_server:
6: CRASHED
7: SUSPENDED
- This parameter is only valid when specified by administrators.
- If non-admin users specify this parameter, it is ignored.
+ This parameter is restricted to administrators until microversion 2.82.
+ If non-admin users specify this parameter before microversion 2.83, it
+ is ignored.
progress_query_server:
description: |
Filter the server list result by the progress of the server.
The value could be from 0 to 100 as integer.
- This parameter is only valid when specified by administrators.
- If non-admin users specify this parameter, it is ignored.
+ This parameter is restricted to administrators until microversion 2.82.
+ If non-admin users specify this parameter before microversion 2.83, it
+ is ignored.
in: query
required: false
type: integer
@@ -1371,8 +1378,9 @@ task_state_query_server:
description: |
Filter the server list result by task state.
- This parameter is only valid when specified by administrators.
- If non-admin users specify this parameter, it is ignored.
+ This parameter is restricted to administrators until microversion 2.82.
+ If non-admin users specify this parameter before microversion 2.83, it
+ is ignored.
tenant_id_query:
description: |
Specify the project ID (tenant ID) to show the rate and absolute limits.
@@ -1392,8 +1400,9 @@ terminated_at_query_server:
For example, ``2015-08-27T09:49:58-05:00``.
If you omit the time zone, the UTC time zone is assumed.
- This parameter is only valid when specified by administrators.
- If non-admin users specify this parameter, it is ignored.
+ This parameter is restricted to administrators until microversion 2.82.
+ If non-admin users specify this parameter before microversion 2.83, it
+ is ignored.
in: query
required: false
type: string
@@ -1439,8 +1448,9 @@ user_id_query_server:
description: |
Filter the list of servers by the given user ID.
- This parameter is only valid when specified by administrators.
- If non-admin users specify this parameter, it is ignored.
+ This parameter is restricted to administrators until microversion 2.82.
+ If non-admin users specify this parameter before microversion 2.83, it
+ is ignored.
in: query
required: false
type: string
@@ -1469,8 +1479,9 @@ vm_state_query_server:
- ``STOPPED``
- ``SUSPENDED``
- This parameter is only valid when specified by administrators.
- If non-admin users specify this parameter, it is ignored.
+ This parameter is restricted to administrators until microversion 2.82.
+ If non-admin users specify this parameter before microversion 2.83, it
+ is ignored.
in: query
required: false
type: string
diff --git a/api-ref/source/servers.inc b/api-ref/source/servers.inc
index 6334a96fef..c6e6560b32 100644
--- a/api-ref/source/servers.inc
+++ b/api-ref/source/servers.inc
@@ -173,7 +173,17 @@ whitelist will be silently ignored.
- ``tags-any`` (New in version 2.26)
- ``changes-before`` (New in version 2.66)
- ``locked`` (New in version 2.73)
-
+ - ``availability_zone`` (New in version 2.83)
+ - ``config_drive`` (New in version 2.83)
+ - ``key_name`` (New in version 2.83)
+ - ``created_at`` (New in version 2.83)
+ - ``launched_at`` (New in version 2.83)
+ - ``terminated_at`` (New in version 2.83)
+ - ``power_state`` (New in version 2.83)
+ - ``task_state`` (New in version 2.83)
+ - ``vm_state`` (New in version 2.83)
+ - ``progress`` (New in version 2.83)
+ - ``user_id`` (New in version 2.83)
- For admin user, whitelist includes all filter keys mentioned in
:ref:`list-server-request` Section.