diff options
| author | Zuul <zuul@review.opendev.org> | 2020-03-26 14:29:46 +0000 |
|---|---|---|
| committer | Gerrit Code Review <review@openstack.org> | 2020-03-26 14:29:46 +0000 |
| commit | df9195de72c6ceeeb05c3ea48b749c5666f7fdc9 (patch) | |
| tree | 2eee63b0046014dd343badd3cb375c2e5a49742d /api-guide | |
| parent | 15f0215df5d8e93312a511ec25c840d10e7645b9 (diff) | |
| parent | 4018d6fb71a4e5bb0554ac36479cb217f55a6fcf (diff) | |
| download | nova-df9195de72c6ceeeb05c3ea48b749c5666f7fdc9.tar.gz | |
Merge "Non-Admin user can filter their instances by more filters"
Diffstat (limited to 'api-guide')
| -rw-r--r-- | api-guide/source/server_concepts.rst | 23 |
1 files changed, 17 insertions, 6 deletions
diff --git a/api-guide/source/server_concepts.rst b/api-guide/source/server_concepts.rst index 1a42ffc3cf..ef7bf49eab 100644 --- a/api-guide/source/server_concepts.rst +++ b/api-guide/source/server_concepts.rst @@ -159,6 +159,17 @@ For different user roles, the user has different query options set: - ``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) Other options will be ignored by nova silently. @@ -177,12 +188,12 @@ Precondition: there are 2 servers existing in cloud with following info:: "servers": [ { "name": "t1", - "OS-EXT-STS:vm_state": "active", + "OS-EXT-SRV-ATTR:host": "devstack1", ... }, { "name": "t2", - "OS-EXT-STS:vm_state": "stopped", + "OS-EXT-SRV-ATTR:host": "devstack2", ... } ] @@ -190,13 +201,13 @@ Precondition: there are 2 servers existing in cloud with following info:: **Example: General user query server with administrator only options** -Request with non-administrator context: ``GET /servers/detail?vm_state=active`` +Request with non-administrator context: ``GET /servers/detail?host=devstack1`` .. note:: - The ``vm_state`` query parameter is only for administrator users and + The ``host`` query parameter is only for administrator users and the query parameter is ignored if specified by non-administrator users. - Thus the API returns servers of both ``active`` and ``stopped`` + Thus the API returns servers of both ``devstack1`` and ``devstack2`` in this example. Response:: @@ -216,7 +227,7 @@ Response:: **Example: Administrator query server with administrator only options** -Request with administrator context: ``GET /servers/detail?vm_state=active`` +Request with administrator context: ``GET /servers/detail?host=devstack1`` Response:: |