diff options
| author | jichenjc <jichenjc@cn.ibm.com> | 2016-03-23 12:16:06 +0800 |
|---|---|---|
| committer | jichenjc <jichenjc@cn.ibm.com> | 2016-03-24 02:42:03 +0800 |
| commit | f03a3a5be46bff7532a666fe8f48bfac7b035327 (patch) | |
| tree | 90c55dbedefc841c1221f55839d828610a474d06 /api-ref/source/os-hypervisors.inc | |
| parent | 0315d46766fa4357c6608541be39aada4eb5941d (diff) | |
| download | nova-f03a3a5be46bff7532a666fe8f48bfac7b035327.tar.gz | |
Update 'os-hypervisors.inc' in api-ref
some changes including:
1) update the wrong reference link to json file
2) Add /v2.1/{tenant_id}/os-hypervisors/detail
3) Add /v2.1/{tenant_id}/os-hypervisors/{hypervisor_id}/search
4) Add /v2.1/{tenant_id}/os-hypervisors/{hypervisor_id}/servers
Part of bp:api-ref-in-rst
Change-Id: I73fbf4583cd75afb2f60c57acd1bdb179f86a9e9
Diffstat (limited to 'api-ref/source/os-hypervisors.inc')
| -rw-r--r-- | api-ref/source/os-hypervisors.inc | 85 |
1 files changed, 82 insertions, 3 deletions
diff --git a/api-ref/source/os-hypervisors.inc b/api-ref/source/os-hypervisors.inc index d23e4efdab..835d459d48 100644 --- a/api-ref/source/os-hypervisors.inc +++ b/api-ref/source/os-hypervisors.inc @@ -35,6 +35,32 @@ Response .. literalinclude:: ../../doc/api_samples/os-hypervisors/hypervisors-list-resp.json :language: javascript +List Hypervisors Details +======================== + +.. rest_method:: GET /v2.1/{tenant_id}/os-hypervisors/detail + +Lists hypervisors details. + +Normal response codes: 200 + +Error response codes: unauthorized(401), forbidden(403) + +Request +------- + +.. rest_parameters:: parameters.yaml + + - tenant_id: tenant_id + +Response +-------- + +**Example List Hypervisors Details: JSON request** + +.. literalinclude:: ../../doc/api_samples/os-hypervisors/hypervisors-detail-resp.json + :language: javascript + Show Hypervisor Statistics ========================== @@ -59,7 +85,7 @@ Response **Example Show Hypervisor Statistics: JSON response** -.. literalinclude:: ../../doc/api_samples/os-hypervisors/hypervisor-statistics-show-resp.json +.. literalinclude:: ../../doc/api_samples/os-hypervisors/hypervisors-statistics-resp.json :language: javascript Show Hypervisor Details @@ -87,7 +113,7 @@ Response **Example Show Hypervisor Details: JSON response** -.. literalinclude:: ../../doc/api_samples/os-hypervisors/hypervisor-show-resp.json +.. literalinclude:: ../../doc/api_samples/os-hypervisors/hypervisors-show-resp.json :language: javascript Show Hypervisor Uptime @@ -115,6 +141,59 @@ Response **Example Show Hypervisor Uptime: JSON response** -.. literalinclude:: ../../doc/api_samples/os-hypervisors/hypervisor-uptime-show-resp.json +.. literalinclude:: ../../doc/api_samples/os-hypervisors/hypervisors-uptime-resp.json :language: javascript +Search Hypervisor +================= + +.. rest_method:: GET /v2.1/{tenant_id}/os-hypervisors/{hypervisor_id}/search + +Search hypervisor by given hypervisor id. + +Normal response code: 200 + +Error response codes: unauthorized(401), forbidden(403), itemNotFound(404) + +Request +------- + +.. rest_parameters:: parameters.yaml + + - tenant_id: tenant_id + - hypervisor_id: hypervisor_id + +Response +-------- + +**Example Search Hypervisor: JSON request** + +.. literalinclude:: ../../doc/api_samples/os-hypervisors/hypervisors-search-resp.json + :language: javascript + +List Hypervisor Servers +======================= + +.. rest_method:: GET /v2.1/{tenant_id}/os-hypervisors/{hypervisor_id}/servers + +List all servers belong to given hypervisor. + +Normal response code: 200 + +Error response codes: unauthorized(401), forbidden(403), itemNotFound(404) + +Request +------- + +.. rest_parameters:: parameters.yaml + + - tenant_id: tenant_id + - hypervisor_id: hypervisor_id + +Response +-------- + +**Example List Hypervisor Servers: JSON request** + +.. literalinclude:: ../../doc/api_samples/os-hypervisors/hypervisors-with-servers-resp.json + :language: javascript |