openstack/nova
Code Issues Proposed changes

Fix server query examples

Browse Source 
The 'locked' query parameter is not supported
in the "List Servers Detailed" API.
So replace examples using the 'locked' query parameter
with examples using another query parameters.

Change-Id: Ibcea6147dd6716ad544e7ac5fa0df17f8c397a28
Closes-Bug: #1801904
This commit is contained in:
Takashi NATSUME 2018-11-09 15:56:18 +09:00
parent 3e756ff674
commit 54d3745101
1 changed files with 10 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
api-guide/source/server_concepts.rst
View File

@ -155,12 +155,12 @@ Precondition: there are 2 servers existing in cloud with following info::
"servers": [
{
"name": "t1",
"locked": "true",
"OS-EXT-STS:vm_state": "active",
...
},
{
"name": "t2",
"locked": "false",
"OS-EXT-STS:vm_state": "stopped",
...
}
]
@ -168,10 +168,14 @@ 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?locked=1``
Request with non-administrator context: ``GET /servers/detail?vm_state=active``
Note that ``locked`` is returned through API layer starting from
microversion 2.9.
.. note::
The ``vm_state`` 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``
in this example.
Response::
@ -190,7 +194,7 @@ Response::
**Example: Administrator query server with administrator only options**
Request with administrator context: ``GET /servers/detail?locked=1``
Request with administrator context: ``GET /servers/detail?vm_state=active``
Response::