openstack/nova
Code Issues Proposed changes
456a80878d
nova/api-ref/source/os-hypervisors.inc

325 lines
8.2 KiB
PHP
Raw Normal View History

Import RST files for documentation This is the results of the RST conversion from WADL. It creates a single index plus a bunch of included files which represent sections of the API document. This is the starting point for fixing the documentation. Change-Id: I7d561c2ecdcd864172dedb54a551f17ad3bdfe26
2016-04-12 09:03:46 -04:00
.. -*- rst -*-
add tags to files for the content verification phase This adds a set of tags in comments to the beginning of files so that we can process them according to the documentation here: https://wiki.openstack.org/wiki/NovaAPIRef Part of bp:api-ref-in-rst Change-Id: I17cf584dafb5bd969c12f51b7e7185d92365bf93
2016-04-20 16:10:51 -04:00
.. needs:body_verification
Import RST files for documentation This is the results of the RST conversion from WADL. It creates a single index plus a bunch of included files which represent sections of the API document. This is the starting point for fixing the documentation. Change-Id: I7d561c2ecdcd864172dedb54a551f17ad3bdfe26
2016-04-12 09:03:46 -04:00
==============================
Hypervisors (os-hypervisors)
==============================
Lists all hypervisors, shows summary statistics for all hypervisors over
all compute nodes, shows details for a hypervisor, and shows the uptime
for a hypervisor.
List Hypervisors
================
remove /v2.1/{tenant_id} from all urls As discussed at summit, the version part of the URL is not really relevant, or a thing a user should be filling out themselves, this should instead be set by the service catalog and extracted from the token. This removes it's reference in all documented REST urls, and adds a new section describing how one gets the base URL for all calls. Change-Id: I4306b8c3de0225e54f3909dd8a1fb293c4e5944c
2016-06-02 08:50:03 -04:00
.. rest_method:: GET /os-hypervisors
Import RST files for documentation This is the results of the RST conversion from WADL. It creates a single index plus a bunch of included files which represent sections of the API document. This is the starting point for fixing the documentation. Change-Id: I7d561c2ecdcd864172dedb54a551f17ad3bdfe26
2016-04-12 09:03:46 -04:00
Lists hypervisors.
Fixed typos in api-ref and releasenotes directory This patchset fixes the typo errors in api-ref and releasenotes directories. TrivialFix Change-Id: Ib72e5c4ac7539c1b08adc858b9b3a0071cb3c866
2016-07-12 14:14:38 +02:00
Policy defaults enable only users with the administrative role to perform
this operation. Cloud providers can change these permissions through
the ``policy.json`` file.
Complete method Verification of os-hypervisors verified the API doc for os-hypervisors, added policy description as this is admin action by default, Also, remove some common error code like 500, 503 etc Part of bp:api-ref-in-rst Change-Id: Ic81eac06cb238d0940feac41940433f9e3befc29
2016-04-25 03:44:57 +08:00
Import RST files for documentation This is the results of the RST conversion from WADL. It creates a single index plus a bunch of included files which represent sections of the API document. This is the starting point for fixing the documentation. Change-Id: I7d561c2ecdcd864172dedb54a551f17ad3bdfe26
2016-04-12 09:03:46 -04:00
Normal response codes: 200
Complete method Verification of os-hypervisors verified the API doc for os-hypervisors, added policy description as this is admin action by default, Also, remove some common error code like 500, 503 etc Part of bp:api-ref-in-rst Change-Id: Ic81eac06cb238d0940feac41940433f9e3befc29
2016-04-25 03:44:57 +08:00
Error response codes: unauthorized(401), forbidden(403)
Import RST files for documentation This is the results of the RST conversion from WADL. It creates a single index plus a bunch of included files which represent sections of the API document. This is the starting point for fixing the documentation. Change-Id: I7d561c2ecdcd864172dedb54a551f17ad3bdfe26
2016-04-12 09:03:46 -04:00
Microversion 2.33 adds pagination support for hypervisors When there are thousands of compute nodes, it would be slow to get the whole hypervisor list, and it is bad for user experience to display thousands of items in a table in horizon. This patch is proposed to support pagination for hypervisor by adding `limit` and `marker` to the list api. Implements blueprint: pagination-for-hypervisor Change-Id: Ie7f8b5c733b383f3e69fa23188e56257e503b5f7
2016-06-03 13:16:36 +08:00
Request
-------
.. rest_parameters:: parameters.yaml
- limit: hypervisor_limit
- marker: hypervisor_marker
Import RST files for documentation This is the results of the RST conversion from WADL. It creates a single index plus a bunch of included files which represent sections of the API document. This is the starting point for fixing the documentation. Change-Id: I7d561c2ecdcd864172dedb54a551f17ad3bdfe26
2016-04-12 09:03:46 -04:00
Response
move sphinx h3 to '-' instead of '^' In the sphinx document h3 is supposed to be '-' not '^': =, for sections -, for subsections ^, for subsubsections We have to enforce consistency here because we're processing included files which all have to agree, otherwise it's a sphinx error. Part of bp:api-ref-in-rst Change-Id: Ic6eef5cacb07870f161b04b031e332f2b87aeedc
2016-04-14 13:10:59 -04:00
--------
Import RST files for documentation This is the results of the RST conversion from WADL. It creates a single index plus a bunch of included files which represent sections of the API document. This is the starting point for fixing the documentation. Change-Id: I7d561c2ecdcd864172dedb54a551f17ad3bdfe26
2016-04-12 09:03:46 -04:00
api-ref: parameter verification for os-hypervisors checked parameters Part of bp:api-ref-in-rst Change-Id: I6078a0ee0914f3c5cc92d9c17f0d19146f9d373b
2016-05-16 17:35:18 +08:00
.. rest_parameters:: parameters.yaml
- hypervisors: hypervisors
- hypervisor_hostname: hypervisor_hostname
- id: hypervisor_id_body
- state: hypervisor_state
- status: hypervisor_status
Add hypervisor_links into hypervisor v2.33 added hypervisor_links into response of hypervisor we need to add it Also, verified sample. Implements: blueprint api-ref-in-rst Change-Id: I38241f116482a99609e5892a9e20ea5496d89f2b
2016-09-09 10:09:31 +08:00
- hypervisor_links: hypervisor_links
api-ref: parameter verification for os-hypervisors checked parameters Part of bp:api-ref-in-rst Change-Id: I6078a0ee0914f3c5cc92d9c17f0d19146f9d373b
2016-05-16 17:35:18 +08:00
api-ref: use the examples with paging links Use the microversion response samples that include the paging links in the example JSON responses. Change-Id: I99ef8e8e709b0262f3038bf19e8746782c9f302a
2017-01-03 11:58:53 -06:00
**Example List Hypervisors (v2.33): JSON response**
Import RST files for documentation This is the results of the RST conversion from WADL. It creates a single index plus a bunch of included files which represent sections of the API document. This is the starting point for fixing the documentation. Change-Id: I7d561c2ecdcd864172dedb54a551f17ad3bdfe26
2016-04-12 09:03:46 -04:00
api-ref: use the examples with paging links Use the microversion response samples that include the paging links in the example JSON responses. Change-Id: I99ef8e8e709b0262f3038bf19e8746782c9f302a
2017-01-03 11:58:53 -06:00
.. literalinclude:: ../../doc/api_samples/os-hypervisors/v2.33/hypervisors-list-resp.json
Import RST files for documentation This is the results of the RST conversion from WADL. It creates a single index plus a bunch of included files which represent sections of the API document. This is the starting point for fixing the documentation. Change-Id: I7d561c2ecdcd864172dedb54a551f17ad3bdfe26
2016-04-12 09:03:46 -04:00
:language: javascript
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
2016-03-23 12:16:06 +08:00
List Hypervisors Details
========================
remove /v2.1/{tenant_id} from all urls As discussed at summit, the version part of the URL is not really relevant, or a thing a user should be filling out themselves, this should instead be set by the service catalog and extracted from the token. This removes it's reference in all documented REST urls, and adds a new section describing how one gets the base URL for all calls. Change-Id: I4306b8c3de0225e54f3909dd8a1fb293c4e5944c
2016-06-02 08:50:03 -04:00
.. rest_method:: GET /os-hypervisors/detail
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
2016-03-23 12:16:06 +08:00
Lists hypervisors details.
Fixed typos in api-ref and releasenotes directory This patchset fixes the typo errors in api-ref and releasenotes directories. TrivialFix Change-Id: Ib72e5c4ac7539c1b08adc858b9b3a0071cb3c866
2016-07-12 14:14:38 +02:00
Policy defaults enable only users with the administrative role to perform
this operation. Cloud providers can change these permissions through
the ``policy.json`` file.
Complete method Verification of os-hypervisors verified the API doc for os-hypervisors, added policy description as this is admin action by default, Also, remove some common error code like 500, 503 etc Part of bp:api-ref-in-rst Change-Id: Ic81eac06cb238d0940feac41940433f9e3befc29
2016-04-25 03:44:57 +08:00
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
2016-03-23 12:16:06 +08:00
Normal response codes: 200
Error response codes: unauthorized(401), forbidden(403)
Microversion 2.33 adds pagination support for hypervisors When there are thousands of compute nodes, it would be slow to get the whole hypervisor list, and it is bad for user experience to display thousands of items in a table in horizon. This patch is proposed to support pagination for hypervisor by adding `limit` and `marker` to the list api. Implements blueprint: pagination-for-hypervisor Change-Id: Ie7f8b5c733b383f3e69fa23188e56257e503b5f7
2016-06-03 13:16:36 +08:00
Request
-------
.. rest_parameters:: parameters.yaml
- limit: hypervisor_limit
- marker: hypervisor_marker
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
2016-03-23 12:16:06 +08:00
Response
--------
api-ref: parameter verification for os-hypervisors checked parameters Part of bp:api-ref-in-rst Change-Id: I6078a0ee0914f3c5cc92d9c17f0d19146f9d373b
2016-05-16 17:35:18 +08:00
.. rest_parameters:: parameters.yaml
- hypervisors: hypervisors
- cpu_info: cpu_info
- current_workload: current_workload
- status: hypervisor_status
- state: hypervisor_state
- disk_available_least: disk_available_least
- host_ip: host_ip
- free_disk_gb: hypervisor_free_disk_gb
- free_ram_mb: free_ram_mb
- hypervisor_hostname: hypervisor_hostname
- hypervisor_type: hypervisor_type_body
- hypervisor_version: hypervisor_version
- id: hypervisor_id_body
- local_gb: local_gb
- local_gb_used: local_gb_used
- memory_mb: memory_mb
- memory_mb_used: memory_mb_used
- running_vms: running_vms
- service: hypervisor_service
- service.host: host_name_body
- service.id: service_id_body
- service.disable_reason: service_disable_reason
- vcpus: hypervisor_vcpus
- vcpus_used: hypervisor_vcpus_used
Add hypervisor_links into hypervisor v2.33 added hypervisor_links into response of hypervisor we need to add it Also, verified sample. Implements: blueprint api-ref-in-rst Change-Id: I38241f116482a99609e5892a9e20ea5496d89f2b
2016-09-09 10:09:31 +08:00
- hypervisor_links: hypervisor_links
api-ref: parameter verification for os-hypervisors checked parameters Part of bp:api-ref-in-rst Change-Id: I6078a0ee0914f3c5cc92d9c17f0d19146f9d373b
2016-05-16 17:35:18 +08:00
api-ref: use the examples with paging links Use the microversion response samples that include the paging links in the example JSON responses. Change-Id: I99ef8e8e709b0262f3038bf19e8746782c9f302a
2017-01-03 11:58:53 -06:00
**Example List Hypervisors Details (v2.33): JSON response**
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
2016-03-23 12:16:06 +08:00
api-ref: use the examples with paging links Use the microversion response samples that include the paging links in the example JSON responses. Change-Id: I99ef8e8e709b0262f3038bf19e8746782c9f302a
2017-01-03 11:58:53 -06:00
.. literalinclude:: ../../doc/api_samples/os-hypervisors/v2.33/hypervisors-detail-resp.json
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
2016-03-23 12:16:06 +08:00
:language: javascript
Import RST files for documentation This is the results of the RST conversion from WADL. It creates a single index plus a bunch of included files which represent sections of the API document. This is the starting point for fixing the documentation. Change-Id: I7d561c2ecdcd864172dedb54a551f17ad3bdfe26
2016-04-12 09:03:46 -04:00
Show Hypervisor Statistics
==========================
remove /v2.1/{tenant_id} from all urls As discussed at summit, the version part of the URL is not really relevant, or a thing a user should be filling out themselves, this should instead be set by the service catalog and extracted from the token. This removes it's reference in all documented REST urls, and adds a new section describing how one gets the base URL for all calls. Change-Id: I4306b8c3de0225e54f3909dd8a1fb293c4e5944c
2016-06-02 08:50:03 -04:00
.. rest_method:: GET /os-hypervisors/statistics
Import RST files for documentation This is the results of the RST conversion from WADL. It creates a single index plus a bunch of included files which represent sections of the API document. This is the starting point for fixing the documentation. Change-Id: I7d561c2ecdcd864172dedb54a551f17ad3bdfe26
2016-04-12 09:03:46 -04:00
Shows summary statistics for all hypervisors over all compute nodes.
Fixed typos in api-ref and releasenotes directory This patchset fixes the typo errors in api-ref and releasenotes directories. TrivialFix Change-Id: Ib72e5c4ac7539c1b08adc858b9b3a0071cb3c866
2016-07-12 14:14:38 +02:00
Policy defaults enable only users with the administrative role to perform
this operation. Cloud providers can change these permissions through
the ``policy.json`` file.
Complete method Verification of os-hypervisors verified the API doc for os-hypervisors, added policy description as this is admin action by default, Also, remove some common error code like 500, 503 etc Part of bp:api-ref-in-rst Change-Id: Ic81eac06cb238d0940feac41940433f9e3befc29
2016-04-25 03:44:57 +08:00
Import RST files for documentation This is the results of the RST conversion from WADL. It creates a single index plus a bunch of included files which represent sections of the API document. This is the starting point for fixing the documentation. Change-Id: I7d561c2ecdcd864172dedb54a551f17ad3bdfe26
2016-04-12 09:03:46 -04:00
Normal response codes: 200
Complete method Verification of os-hypervisors verified the API doc for os-hypervisors, added policy description as this is admin action by default, Also, remove some common error code like 500, 503 etc Part of bp:api-ref-in-rst Change-Id: Ic81eac06cb238d0940feac41940433f9e3befc29
2016-04-25 03:44:57 +08:00
Error response codes: unauthorized(401), forbidden(403)
Import RST files for documentation This is the results of the RST conversion from WADL. It creates a single index plus a bunch of included files which represent sections of the API document. This is the starting point for fixing the documentation. Change-Id: I7d561c2ecdcd864172dedb54a551f17ad3bdfe26
2016-04-12 09:03:46 -04:00
Response
move sphinx h3 to '-' instead of '^' In the sphinx document h3 is supposed to be '-' not '^': =, for sections -, for subsections ^, for subsubsections We have to enforce consistency here because we're processing included files which all have to agree, otherwise it's a sphinx error. Part of bp:api-ref-in-rst Change-Id: Ic6eef5cacb07870f161b04b031e332f2b87aeedc
2016-04-14 13:10:59 -04:00
--------
Import RST files for documentation This is the results of the RST conversion from WADL. It creates a single index plus a bunch of included files which represent sections of the API document. This is the starting point for fixing the documentation. Change-Id: I7d561c2ecdcd864172dedb54a551f17ad3bdfe26
2016-04-12 09:03:46 -04:00
api-ref: parameter verification for os-hypervisors checked parameters Part of bp:api-ref-in-rst Change-Id: I6078a0ee0914f3c5cc92d9c17f0d19146f9d373b
2016-05-16 17:35:18 +08:00
.. rest_parameters:: parameters.yaml
- hypervisor_statistics: hypervisor_statistics
- count: hypervisor_count
- current_workload: current_workload
- disk_available_least: disk_available_least
- free_disk_gb: hypervisor_free_disk_gb
- free_ram_mb: free_ram_mb
- local_gb: local_gb
- local_gb_used: local_gb_used
- memory_mb: memory_mb
- memory_mb_used: memory_mb_used
- running_vms: running_vms_total
- vcpus: hypervisor_vcpus
- vcpus_used: hypervisor_vcpus_used
Fix json response example heading in api ref Heading for json response example is wrong, it is json request instead of json response. Part of bp:api-ref-in-rst Change-Id: I709b2bf19520eb76e0264c358a2146bb0dbcee2b
2016-04-19 17:52:18 +09:00
**Example Show Hypervisor Statistics: JSON response**
Import RST files for documentation This is the results of the RST conversion from WADL. It creates a single index plus a bunch of included files which represent sections of the API document. This is the starting point for fixing the documentation. Change-Id: I7d561c2ecdcd864172dedb54a551f17ad3bdfe26
2016-04-12 09:03:46 -04:00
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
2016-03-23 12:16:06 +08:00
.. literalinclude:: ../../doc/api_samples/os-hypervisors/hypervisors-statistics-resp.json
Import RST files for documentation This is the results of the RST conversion from WADL. It creates a single index plus a bunch of included files which represent sections of the API document. This is the starting point for fixing the documentation. Change-Id: I7d561c2ecdcd864172dedb54a551f17ad3bdfe26
2016-04-12 09:03:46 -04:00
:language: javascript
Show Hypervisor Details
=======================
remove /v2.1/{tenant_id} from all urls As discussed at summit, the version part of the URL is not really relevant, or a thing a user should be filling out themselves, this should instead be set by the service catalog and extracted from the token. This removes it's reference in all documented REST urls, and adds a new section describing how one gets the base URL for all calls. Change-Id: I4306b8c3de0225e54f3909dd8a1fb293c4e5944c
2016-06-02 08:50:03 -04:00
.. rest_method:: GET /os-hypervisors/{hypervisor_id}
Import RST files for documentation This is the results of the RST conversion from WADL. It creates a single index plus a bunch of included files which represent sections of the API document. This is the starting point for fixing the documentation. Change-Id: I7d561c2ecdcd864172dedb54a551f17ad3bdfe26
2016-04-12 09:03:46 -04:00
Shows details for a hypervisor.
Fixed typos in api-ref and releasenotes directory This patchset fixes the typo errors in api-ref and releasenotes directories. TrivialFix Change-Id: Ib72e5c4ac7539c1b08adc858b9b3a0071cb3c866
2016-07-12 14:14:38 +02:00
Policy defaults enable only users with the administrative role to perform
this operation. Cloud providers can change these permissions through
the ``policy.json`` file.
Complete method Verification of os-hypervisors verified the API doc for os-hypervisors, added policy description as this is admin action by default, Also, remove some common error code like 500, 503 etc Part of bp:api-ref-in-rst Change-Id: Ic81eac06cb238d0940feac41940433f9e3befc29
2016-04-25 03:44:57 +08:00
Import RST files for documentation This is the results of the RST conversion from WADL. It creates a single index plus a bunch of included files which represent sections of the API document. This is the starting point for fixing the documentation. Change-Id: I7d561c2ecdcd864172dedb54a551f17ad3bdfe26
2016-04-12 09:03:46 -04:00
Normal response codes: 200
Complete method Verification of os-hypervisors verified the API doc for os-hypervisors, added policy description as this is admin action by default, Also, remove some common error code like 500, 503 etc Part of bp:api-ref-in-rst Change-Id: Ic81eac06cb238d0940feac41940433f9e3befc29
2016-04-25 03:44:57 +08:00
Error response codes: unauthorized(401), forbidden(403), itemNotFound(404)
Import RST files for documentation This is the results of the RST conversion from WADL. It creates a single index plus a bunch of included files which represent sections of the API document. This is the starting point for fixing the documentation. Change-Id: I7d561c2ecdcd864172dedb54a551f17ad3bdfe26
2016-04-12 09:03:46 -04:00
Request
move sphinx h3 to '-' instead of '^' In the sphinx document h3 is supposed to be '-' not '^': =, for sections -, for subsections ^, for subsubsections We have to enforce consistency here because we're processing included files which all have to agree, otherwise it's a sphinx error. Part of bp:api-ref-in-rst Change-Id: Ic6eef5cacb07870f161b04b031e332f2b87aeedc
2016-04-14 13:10:59 -04:00
-------
Import RST files for documentation This is the results of the RST conversion from WADL. It creates a single index plus a bunch of included files which represent sections of the API document. This is the starting point for fixing the documentation. Change-Id: I7d561c2ecdcd864172dedb54a551f17ad3bdfe26
2016-04-12 09:03:46 -04:00
.. rest_parameters:: parameters.yaml
- hypervisor_id: hypervisor_id
Response
move sphinx h3 to '-' instead of '^' In the sphinx document h3 is supposed to be '-' not '^': =, for sections -, for subsections ^, for subsubsections We have to enforce consistency here because we're processing included files which all have to agree, otherwise it's a sphinx error. Part of bp:api-ref-in-rst Change-Id: Ic6eef5cacb07870f161b04b031e332f2b87aeedc
2016-04-14 13:10:59 -04:00
--------
Import RST files for documentation This is the results of the RST conversion from WADL. It creates a single index plus a bunch of included files which represent sections of the API document. This is the starting point for fixing the documentation. Change-Id: I7d561c2ecdcd864172dedb54a551f17ad3bdfe26
2016-04-12 09:03:46 -04:00
api-ref: parameter verification for os-hypervisors checked parameters Part of bp:api-ref-in-rst Change-Id: I6078a0ee0914f3c5cc92d9c17f0d19146f9d373b
2016-05-16 17:35:18 +08:00
.. rest_parameters:: parameters.yaml
- hypervisor: hypervisor
- cpu_info: cpu_info
- state: hypervisor_state
- status: hypervisor_status
- current_workload: current_workload
- disk_available_least: disk_available_least
- host_ip: host_ip
- free_disk_gb: hypervisor_free_disk_gb
- free_ram_mb: free_ram_mb
- hypervisor_hostname: hypervisor_hostname
- hypervisor_type: hypervisor_type_body
- hypervisor_version: hypervisor_version
- id: hypervisor_id_body
- local_gb: local_gb
- local_gb_used: local_gb_used
- memory_mb: memory_mb
- memory_mb_used: memory_mb_used
- running_vms: running_vms
- service: hypervisor_service
- service.host: host_name_body
- service.id: service_id_body
- service.disable_reason: service_disable_reason
- vcpus: hypervisor_vcpus
- vcpus_used: hypervisor_vcpus_used
api-ref: use the examples with paging links Use the microversion response samples that include the paging links in the example JSON responses. Change-Id: I99ef8e8e709b0262f3038bf19e8746782c9f302a
2017-01-03 11:58:53 -06:00
**Example Show Hypervisor Details (v2.28): JSON response**
api-ref: docs for microversion v2.28 Part of bp nova-api-hypervsor-cpu-info Part of bp api-ref-in-rst Change-Id: I48a5824c653825b9fdc6cd4d5a2f6ade03fff011
2016-06-20 18:42:54 +03:00
.. literalinclude:: ../../doc/api_samples/os-hypervisors/v2.28/hypervisors-show-resp.json
Import RST files for documentation This is the results of the RST conversion from WADL. It creates a single index plus a bunch of included files which represent sections of the API document. This is the starting point for fixing the documentation. Change-Id: I7d561c2ecdcd864172dedb54a551f17ad3bdfe26
2016-04-12 09:03:46 -04:00
:language: javascript
Show Hypervisor Uptime
======================
remove /v2.1/{tenant_id} from all urls As discussed at summit, the version part of the URL is not really relevant, or a thing a user should be filling out themselves, this should instead be set by the service catalog and extracted from the token. This removes it's reference in all documented REST urls, and adds a new section describing how one gets the base URL for all calls. Change-Id: I4306b8c3de0225e54f3909dd8a1fb293c4e5944c
2016-06-02 08:50:03 -04:00
.. rest_method:: GET /os-hypervisors/{hypervisor_id}/uptime
Import RST files for documentation This is the results of the RST conversion from WADL. It creates a single index plus a bunch of included files which represent sections of the API document. This is the starting point for fixing the documentation. Change-Id: I7d561c2ecdcd864172dedb54a551f17ad3bdfe26
2016-04-12 09:03:46 -04:00
Shows the uptime for a hypervisor.
Fixed typos in api-ref and releasenotes directory This patchset fixes the typo errors in api-ref and releasenotes directories. TrivialFix Change-Id: Ib72e5c4ac7539c1b08adc858b9b3a0071cb3c866
2016-07-12 14:14:38 +02:00
Policy defaults enable only users with the administrative role to perform
this operation. Cloud providers can change these permissions through
the ``policy.json`` file.
Complete method Verification of os-hypervisors verified the API doc for os-hypervisors, added policy description as this is admin action by default, Also, remove some common error code like 500, 503 etc Part of bp:api-ref-in-rst Change-Id: Ic81eac06cb238d0940feac41940433f9e3befc29
2016-04-25 03:44:57 +08:00
Import RST files for documentation This is the results of the RST conversion from WADL. It creates a single index plus a bunch of included files which represent sections of the API document. This is the starting point for fixing the documentation. Change-Id: I7d561c2ecdcd864172dedb54a551f17ad3bdfe26
2016-04-12 09:03:46 -04:00
Normal response codes: 200
Complete method Verification of os-hypervisors verified the API doc for os-hypervisors, added policy description as this is admin action by default, Also, remove some common error code like 500, 503 etc Part of bp:api-ref-in-rst Change-Id: Ic81eac06cb238d0940feac41940433f9e3befc29
2016-04-25 03:44:57 +08:00
Error response codes: unauthorized(401), forbidden(403), itemNotFound(404), NotImplemented(501)
Import RST files for documentation This is the results of the RST conversion from WADL. It creates a single index plus a bunch of included files which represent sections of the API document. This is the starting point for fixing the documentation. Change-Id: I7d561c2ecdcd864172dedb54a551f17ad3bdfe26
2016-04-12 09:03:46 -04:00
Request
move sphinx h3 to '-' instead of '^' In the sphinx document h3 is supposed to be '-' not '^': =, for sections -, for subsections ^, for subsubsections We have to enforce consistency here because we're processing included files which all have to agree, otherwise it's a sphinx error. Part of bp:api-ref-in-rst Change-Id: Ic6eef5cacb07870f161b04b031e332f2b87aeedc
2016-04-14 13:10:59 -04:00
-------
Import RST files for documentation This is the results of the RST conversion from WADL. It creates a single index plus a bunch of included files which represent sections of the API document. This is the starting point for fixing the documentation. Change-Id: I7d561c2ecdcd864172dedb54a551f17ad3bdfe26
2016-04-12 09:03:46 -04:00
.. rest_parameters:: parameters.yaml
- hypervisor_id: hypervisor_id
Response
move sphinx h3 to '-' instead of '^' In the sphinx document h3 is supposed to be '-' not '^': =, for sections -, for subsections ^, for subsubsections We have to enforce consistency here because we're processing included files which all have to agree, otherwise it's a sphinx error. Part of bp:api-ref-in-rst Change-Id: Ic6eef5cacb07870f161b04b031e332f2b87aeedc
2016-04-14 13:10:59 -04:00
--------
Import RST files for documentation This is the results of the RST conversion from WADL. It creates a single index plus a bunch of included files which represent sections of the API document. This is the starting point for fixing the documentation. Change-Id: I7d561c2ecdcd864172dedb54a551f17ad3bdfe26
2016-04-12 09:03:46 -04:00
api-ref: parameter verification for os-hypervisors checked parameters Part of bp:api-ref-in-rst Change-Id: I6078a0ee0914f3c5cc92d9c17f0d19146f9d373b
2016-05-16 17:35:18 +08:00
.. rest_parameters:: parameters.yaml
- hypervisor: hypervisor
- hypervisor_hostname: hypervisor_hostname
- id: hypervisor_id_body
- state: hypervisor_state
- status: hypervisor_status
- uptime: uptime
Fix json response example heading in api ref Heading for json response example is wrong, it is json request instead of json response. Part of bp:api-ref-in-rst Change-Id: I709b2bf19520eb76e0264c358a2146bb0dbcee2b
2016-04-19 17:52:18 +09:00
**Example Show Hypervisor Uptime: JSON response**
Import RST files for documentation This is the results of the RST conversion from WADL. It creates a single index plus a bunch of included files which represent sections of the API document. This is the starting point for fixing the documentation. Change-Id: I7d561c2ecdcd864172dedb54a551f17ad3bdfe26
2016-04-12 09:03:46 -04:00
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
2016-03-23 12:16:06 +08:00
.. literalinclude:: ../../doc/api_samples/os-hypervisors/hypervisors-uptime-resp.json
Import RST files for documentation This is the results of the RST conversion from WADL. It creates a single index plus a bunch of included files which represent sections of the API document. This is the starting point for fixing the documentation. Change-Id: I7d561c2ecdcd864172dedb54a551f17ad3bdfe26
2016-04-12 09:03:46 -04:00
:language: javascript
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
2016-03-23 12:16:06 +08:00
Search Hypervisor
=================
api-ref: Fix path parameters in os-hypervisors.inc The hypervisor ID in path parameters have been fixed to 'integer'. In "Search Hypervisor" and "List Hypervisor Servers", the hypervisor IDs have been fixed to a string for searching hypervisor host names. Change-Id: I2260f0c4ca82d5a2ae5a46bcf8f48f9eaaf09f2f Closes-Bug: #1654197
2017-01-05 18:40:52 +09:00
.. rest_method:: GET /os-hypervisors/{hypervisor_hostname_pattern}/search
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
2016-03-23 12:16:06 +08:00
api-ref: Fix path parameters in os-hypervisors.inc The hypervisor ID in path parameters have been fixed to 'integer'. In "Search Hypervisor" and "List Hypervisor Servers", the hypervisor IDs have been fixed to a string for searching hypervisor host names. Change-Id: I2260f0c4ca82d5a2ae5a46bcf8f48f9eaaf09f2f Closes-Bug: #1654197
2017-01-05 18:40:52 +09:00
Search hypervisor by a given hypervisor host name or portion of it.
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
2016-03-23 12:16:06 +08:00
Fixed typos in api-ref and releasenotes directory This patchset fixes the typo errors in api-ref and releasenotes directories. TrivialFix Change-Id: Ib72e5c4ac7539c1b08adc858b9b3a0071cb3c866
2016-07-12 14:14:38 +02:00
Policy defaults enable only users with the administrative role to perform
this operation. Cloud providers can change these permissions through
the ``policy.json`` file.
Complete method Verification of os-hypervisors verified the API doc for os-hypervisors, added policy description as this is admin action by default, Also, remove some common error code like 500, 503 etc Part of bp:api-ref-in-rst Change-Id: Ic81eac06cb238d0940feac41940433f9e3befc29
2016-04-25 03:44:57 +08:00
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
2016-03-23 12:16:06 +08:00
Normal response code: 200
Error response codes: unauthorized(401), forbidden(403), itemNotFound(404)
Request
-------
.. rest_parameters:: parameters.yaml
api-ref: Fix path parameters in os-hypervisors.inc The hypervisor ID in path parameters have been fixed to 'integer'. In "Search Hypervisor" and "List Hypervisor Servers", the hypervisor IDs have been fixed to a string for searching hypervisor host names. Change-Id: I2260f0c4ca82d5a2ae5a46bcf8f48f9eaaf09f2f Closes-Bug: #1654197
2017-01-05 18:40:52 +09:00
- hypervisor_hostname_pattern: hypervisor_hostname_pattern
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
2016-03-23 12:16:06 +08:00
Response
--------
api-ref: parameter verification for os-hypervisors checked parameters Part of bp:api-ref-in-rst Change-Id: I6078a0ee0914f3c5cc92d9c17f0d19146f9d373b
2016-05-16 17:35:18 +08:00
.. rest_parameters:: parameters.yaml
- hypervisors: hypervisors
- hypervisor_hostname: hypervisor_hostname
- id: hypervisor_id_body
- state: hypervisor_state
- status: hypervisor_status
api-ref: fix wrong description about response example in os-hypervisor change response sample file description from request to response Change-Id: I50a5d7f2edf24f5a2c4beb84e303e95921b6f208 Implements: blueprint api-ref-in-rst
2016-07-08 10:38:17 +08:00
**Example Search Hypervisor: JSON response**
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
2016-03-23 12:16:06 +08:00
.. literalinclude:: ../../doc/api_samples/os-hypervisors/hypervisors-search-resp.json
:language: javascript
List Hypervisor Servers
=======================
api-ref: Fix path parameters in os-hypervisors.inc The hypervisor ID in path parameters have been fixed to 'integer'. In "Search Hypervisor" and "List Hypervisor Servers", the hypervisor IDs have been fixed to a string for searching hypervisor host names. Change-Id: I2260f0c4ca82d5a2ae5a46bcf8f48f9eaaf09f2f Closes-Bug: #1654197
2017-01-05 18:40:52 +09:00
.. rest_method:: GET /os-hypervisors/{hypervisor_hostname_pattern}/servers
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
2016-03-23 12:16:06 +08:00
api-ref: Fix path parameters in os-hypervisors.inc The hypervisor ID in path parameters have been fixed to 'integer'. In "Search Hypervisor" and "List Hypervisor Servers", the hypervisor IDs have been fixed to a string for searching hypervisor host names. Change-Id: I2260f0c4ca82d5a2ae5a46bcf8f48f9eaaf09f2f Closes-Bug: #1654197
2017-01-05 18:40:52 +09:00
List all servers belong to each hypervisor whose host name is matching
a given hypervisor host name or portion of it.
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
2016-03-23 12:16:06 +08:00
Fixed typos in api-ref and releasenotes directory This patchset fixes the typo errors in api-ref and releasenotes directories. TrivialFix Change-Id: Ib72e5c4ac7539c1b08adc858b9b3a0071cb3c866
2016-07-12 14:14:38 +02:00
Policy defaults enable only users with the administrative role to perform
this operation. Cloud providers can change these permissions through
the ``policy.json`` file.
Complete method Verification of os-hypervisors verified the API doc for os-hypervisors, added policy description as this is admin action by default, Also, remove some common error code like 500, 503 etc Part of bp:api-ref-in-rst Change-Id: Ic81eac06cb238d0940feac41940433f9e3befc29
2016-04-25 03:44:57 +08:00
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
2016-03-23 12:16:06 +08:00
Normal response code: 200
Error response codes: unauthorized(401), forbidden(403), itemNotFound(404)
Request
-------
.. rest_parameters:: parameters.yaml
api-ref: Fix path parameters in os-hypervisors.inc The hypervisor ID in path parameters have been fixed to 'integer'. In "Search Hypervisor" and "List Hypervisor Servers", the hypervisor IDs have been fixed to a string for searching hypervisor host names. Change-Id: I2260f0c4ca82d5a2ae5a46bcf8f48f9eaaf09f2f Closes-Bug: #1654197
2017-01-05 18:40:52 +09:00
- hypervisor_hostname_pattern: hypervisor_hostname_pattern
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
2016-03-23 12:16:06 +08:00
Response
--------
api-ref: parameter verification for os-hypervisors checked parameters Part of bp:api-ref-in-rst Change-Id: I6078a0ee0914f3c5cc92d9c17f0d19146f9d373b
2016-05-16 17:35:18 +08:00
.. rest_parameters:: parameters.yaml
- hypervisors: hypervisors
- hypervisor_hostname: hypervisor_hostname
- id: hypervisor_id_body
- state: hypervisor_state
- status: hypervisor_status
- servers: servers
- servers.uuid: server_uuid
- servers.name: server_name
api-ref: fix wrong description about response example in os-hypervisor change response sample file description from request to response Change-Id: I50a5d7f2edf24f5a2c4beb84e303e95921b6f208 Implements: blueprint api-ref-in-rst
2016-07-08 10:38:17 +08:00
**Example List Hypervisor Servers: JSON response**
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
2016-03-23 12:16:06 +08:00
.. literalinclude:: ../../doc/api_samples/os-hypervisors/hypervisors-with-servers-resp.json
:language: javascript
Copy Permalink