diff options
author | Kevin_Zheng <zhengzhenyu@huawei.com> | 2016-05-16 17:35:18 +0800 |
---|---|---|
committer | John Garbutt <john@johngarbutt.com> | 2016-06-07 13:57:13 +0000 |
commit | 126400a1c94e45ccbdb3a1a9a336c3e648c4011e (patch) | |
tree | 63825db3b60a5cb621a3c5c0d6ce1942098898b9 /api-ref/source/os-hypervisors.inc | |
parent | 5b0773f53a70564cb19003f0480e84e59d34c963 (diff) | |
download | nova-126400a1c94e45ccbdb3a1a9a336c3e648c4011e.tar.gz |
api-ref: parameter verification for os-hypervisors
checked parameters
Part of bp:api-ref-in-rst
Change-Id: I6078a0ee0914f3c5cc92d9c17f0d19146f9d373b
Diffstat (limited to 'api-ref/source/os-hypervisors.inc')
-rw-r--r-- | api-ref/source/os-hypervisors.inc | 107 |
1 files changed, 106 insertions, 1 deletions
diff --git a/api-ref/source/os-hypervisors.inc b/api-ref/source/os-hypervisors.inc index fe343df0dd..6532fa767b 100644 --- a/api-ref/source/os-hypervisors.inc +++ b/api-ref/source/os-hypervisors.inc @@ -1,5 +1,4 @@ .. -*- rst -*- -.. needs:parameter_verification .. needs:example_verification .. needs:body_verification @@ -27,6 +26,14 @@ Error response codes: unauthorized(401), forbidden(403) Response -------- +.. rest_parameters:: parameters.yaml + + - hypervisors: hypervisors + - hypervisor_hostname: hypervisor_hostname + - id: hypervisor_id_body + - state: hypervisor_state + - status: hypervisor_status + **Example List Hypervisors: JSON response** .. literalinclude:: ../../doc/api_samples/os-hypervisors/hypervisors-list-resp.json @@ -48,6 +55,33 @@ Error response codes: unauthorized(401), forbidden(403) Response -------- +.. 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 + **Example List Hypervisors Details: JSON request** .. literalinclude:: ../../doc/api_samples/os-hypervisors/hypervisors-detail-resp.json @@ -69,6 +103,22 @@ Error response codes: unauthorized(401), forbidden(403) Response -------- +.. 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 + **Example Show Hypervisor Statistics: JSON response** .. literalinclude:: ../../doc/api_samples/os-hypervisors/hypervisors-statistics-resp.json @@ -98,6 +148,33 @@ Request Response -------- +.. 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 + **Example Show Hypervisor Details: JSON response** .. literalinclude:: ../../doc/api_samples/os-hypervisors/hypervisors-show-resp.json @@ -127,6 +204,15 @@ Request Response -------- +.. rest_parameters:: parameters.yaml + + - hypervisor: hypervisor + - hypervisor_hostname: hypervisor_hostname + - id: hypervisor_id_body + - state: hypervisor_state + - status: hypervisor_status + - uptime: uptime + **Example Show Hypervisor Uptime: JSON response** .. literalinclude:: ../../doc/api_samples/os-hypervisors/hypervisors-uptime-resp.json @@ -156,6 +242,14 @@ Request Response -------- +.. rest_parameters:: parameters.yaml + + - hypervisors: hypervisors + - hypervisor_hostname: hypervisor_hostname + - id: hypervisor_id_body + - state: hypervisor_state + - status: hypervisor_status + **Example Search Hypervisor: JSON request** .. literalinclude:: ../../doc/api_samples/os-hypervisors/hypervisors-search-resp.json @@ -185,6 +279,17 @@ Request Response -------- +.. 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 + **Example List Hypervisor Servers: JSON request** .. literalinclude:: ../../doc/api_samples/os-hypervisors/hypervisors-with-servers-resp.json |