openstack/api-site
Code Issues Proposed changes

Add hypervisor status calls for Compute v2 and v2.1 extensions

Browse Source 
Change-Id: I9429e1fc1d0b49f481f985452e683bce3affdbff
Closes-Bug: #1347165
This commit is contained in:
Diane Fleming 2015-04-13 11:06:41 -05:00 committed by Andreas Jaeger
parent ebb3f1b26c
commit 9e22c91522
15 changed files with 415 additions and 72 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
api-ref-guides/pom.xml
View File

@ -103,8 +103,8 @@
<includes> bk-api-ref-compute-v2.1.xml </includes>
<pdfFilenameBase>api-ref-compute-v2.1</pdfFilenameBase>
</configuration>
</execution>
<execution>
</execution>
<execution>
<id>os-api-ref-database-v1</id>
<goals>
<goal>generate-pdf</goal>

38
api-ref/src/docbkx/ch_compute-v2-ext.xml
View File

@ -1,5 +1,7 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE chapter [
<!ENTITY % common SYSTEM "../wadls/compute-api/src/v2/common.ent">
%common;
<!ENTITY % common_project SYSTEM "../wadls/common_project.ent">
%common_project;
]>
@ -12,11 +14,15 @@
version="5.0-extension RackBook-2.0" xml:id="compute-v2-ext"
role="api-reference">
<title>Compute API v2 extensions (SUPPORTED)</title>
<para>Extensions add features, MIME types, actions, states,
headers, parameters, and resources to the core Compute API
without requiring a version change.</para>
<note><para>XML support in requests and responses has been
deprecated for the Compute API v2.</para></note>
<para>
Extensions add features, MIME types, actions, states, headers,
parameters, and resources to the core Compute API without requiring a
version change.
</para>
<note><para>
XML support in requests and responses has been deprecated for the
Compute API v2.
</para></note>
<note><para>
The Compute API returns the <code>403 forbidden</code> error code if
you exceed your allotted quota for the operation.
@ -262,9 +268,11 @@
</section>
<section xml:id="ext-os-hypervisors">
<title>Hypervisors (os-hypervisors)</title>
<para>Displays extra statistical information from the machine
that hosts the hypervisor through the API for the
hypervisor (XenAPI and KVM/libvirt).</para>
<para>
Display extra statistical information from the machine that hosts
the hypervisor through the API for the hypervisor (XenAPI or
KVM/libvirt).
</para>
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
<wadl:resource
href="../wadls/compute-api/src/v2/ext/os-hypervisors.wadl#os-hypervisors">
@ -288,6 +296,20 @@
</wadl:resource>
</wadl:resources>
</section>
<section xml:id="ext-os-hypervisor-status">
<title>Hypervisor with status (os-hypervisor-status)</title>
<para>
Display extra statistical information including status from the
machine that hosts the hypervisor through the API for the
hypervisor (XenAPI or KVM/libvirt).
</para>
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
<wadl:resource
href="../wadls/compute-api/src/v2/ext/os-hypervisor-status.wadl#detail">
<wadl:method href="#showHypervisor-status"/>
</wadl:resource>
</wadl:resources>
</section>
<section xml:id="ext-os-instance-actions">
<title>Server actions (os-instance-actions)</title>
<para>Lists available actions for a specified server.

42
api-ref/src/wadls/compute-api/src/v2.1/api_samples/os-pci/hypervisors-pci-detail-resp.json Normal file
View File

@ -0,0 +1,42 @@
{
"hypervisors": [
{
"cpu_info": "{\"arch\": \"x86_64\", \"model\": \"Nehalem\", \"vendor\": \"Intel\", \"features\": [\"pge\", \"clflush\"], \"topology\": {\"cores\": 1, \"threads\": 1, \"sockets\": 4}}",
"state": "up",
"status": "enabled",
"current_workload": 0,
"disk_available_least": 0,
"host_ip": "1.1.1.1",
"free_disk_gb": 1028,
"free_ram_mb": 7680,
"hypervisor_hostname": "fake-mini",
"hypervisor_type": "fake",
"hypervisor_version": 1000,
"id": 1,
"local_gb": 1028,
"local_gb_used": 0,
"memory_mb": 8192,
"memory_mb_used": 512,
"os-pci:pci_stats": [
{
"count": 5,
"extra_info": {
"key1": "value1",
"phys_function": "[[\"0x0000\", \"0x04\", \"0x00\", \"0x1\"]]"
},
"keya": "valuea",
"product_id": "1520",
"vendor_id": "8086"
}
],
"running_vms": 0,
"service": {
"host": "043b3cacf6f34c90a7245151fc8ebcda",
"id": 2,
"disabled_reason": null
},
"vcpus": 1,
"vcpus_used": 0
}
]
}

40
api-ref/src/wadls/compute-api/src/v2.1/api_samples/os-pci/hypervisors-pci-show-resp.json Normal file
View File

@ -0,0 +1,40 @@
{
"hypervisor": {
"cpu_info": "{\"arch\": \"x86_64\", \"model\": \"Nehalem\", \"vendor\": \"Intel\", \"features\": [\"pge\", \"clflush\"], \"topology\": {\"cores\": 1, \"threads\": 1, \"sockets\": 4}}",
"current_workload": 0,
"disk_available_least": 0,
"host_ip": "1.1.1.1",
"state": "up",
"status": "enabled",
"free_disk_gb": 1028,
"free_ram_mb": 7680,
"hypervisor_hostname": "fake-mini",
"hypervisor_type": "fake",
"hypervisor_version": 1000,
"id": 1,
"local_gb": 1028,
"local_gb_used": 0,
"memory_mb": 8192,
"memory_mb_used": 512,
"os-pci:pci_stats": [
{
"count": 5,
"extra_info": {
"key1": "value1",
"phys_function": "[[\"0x0000\", \"0x04\", \"0x00\", \"0x1\"]]"
},
"keya": "valuea",
"product_id": "1520",
"vendor_id": "8086"
}
],
"running_vms": 0,
"service": {
"host": "043b3cacf6f34c90a7245151fc8ebcda",
"id": 2,
"disabled_reason": null
},
"vcpus": 1,
"vcpus_used": 0
}
}

36
api-ref/src/wadls/compute-api/src/v2.1/api_samples/os-pci/pci-detail-resp.json Normal file
View File

@ -0,0 +1,36 @@
{
"pci_devices": [
{
"address": "0000:04:10.0",
"compute_node_id": 1,
"dev_id": "pci_0000_04_10_0",
"dev_type": "type-VF",
"extra_info": {
"key1": "value1",
"key2": "value2"
},
"id": 1,
"server_uuid": "69ba1044-0766-4ec0-b60d-09595de034a1",
"label": "label_8086_1520",
"product_id": "1520",
"status": "available",
"vendor_id": "8086"
},
{
"address": "0000:04:10.1",
"compute_node_id": 1,
"dev_id": "pci_0000_04_10_1",
"dev_type": "type-VF",
"extra_info": {
"key3": "value3",
"key4": "value4"
},
"id": 2,
"server_uuid": "d5b446a6-a1b4-4d01-b4f0-eac37b3a62fc",
"label": "label_8086_1520",
"product_id": "1520",
"status": "available",
"vendor_id": "8086"
}
]
}

20
api-ref/src/wadls/compute-api/src/v2.1/api_samples/os-pci/pci-index-resp.json Normal file
View File

@ -0,0 +1,20 @@
{
"pci_devices": [
{
"address": "0000:04:10.0",
"compute_node_id": 1,
"id": 1,
"product_id": "1520",
"status": "available",
"vendor_id": "8086"
},
{
"address": "0000:04:10.1",
"compute_node_id": 1,
"id": 2,
"product_id": "1520",
"status": "available",
"vendor_id": "8086"
}
]
}

18
api-ref/src/wadls/compute-api/src/v2.1/api_samples/os-pci/pci-show-resp.json Normal file
View File

@ -0,0 +1,18 @@
{
"pci_device": {
"address": "0000:04:10.0",
"compute_node_id": 1,
"dev_id": "pci_0000_04_10_0",
"dev_type": "type-VF",
"extra_info": {
"key1": "value1",
"key2": "value2"
},
"id": 1,
"server_uuid": "69ba1044-0766-4ec0-b60d-09595de034a1",
"label": "label_8086_1520",
"product_id": "1520",
"status": "available",
"vendor_id": "8086"
}
}

8
api-ref/src/wadls/compute-api/src/v2.1/api_samples/os-pci/server-get-resp.json
View File

@ -4,8 +4,8 @@
"private": [
{
"addr": "192.168.0.3",
"mac_addr": "aa:bb:cc:dd:ee:ff",
"type": "fixed",
"OS-EXT-IPS-MAC:mac_addr": "aa:bb:cc:dd:ee:ff",
"OS-EXT-IPS:type": "fixed",
"version": 4
}
]
@ -20,13 +20,13 @@
}
]
},
"host_id": "b7e88944272df30c113572778bcf5527f02e9c2a745221214536c1a2",
"hostId": "b7e88944272df30c113572778bcf5527f02e9c2a745221214536c1a2",
"id": "9dafa6bc-7a9f-45b2-8177-11800ceb7224",
"image": {
"id": "70a599e0-31e7-49b7-b260-868f441e862b",
"links": [
{
"href": "http://glance.openstack.example.com/images/70a599e0-31e7-49b7-b260-868f441e862b",
"href": "http://openstack.example.com/images/70a599e0-31e7-49b7-b260-868f441e862b",
"rel": "bookmark"
}
]

8
api-ref/src/wadls/compute-api/src/v2.1/api_samples/os-pci/servers-detail-resp.json
View File

@ -5,8 +5,8 @@
"private": [
{
"addr": "192.168.0.3",
"mac_addr": "aa:bb:cc:dd:ee:ff",
"type": "fixed",
"OS-EXT-IPS-MAC:mac_addr": "aa:bb:cc:dd:ee:ff",
"OS-EXT-IPS:type": "fixed",
"version": 4
}
]
@ -21,13 +21,13 @@
}
]
},
"host_id": "416f83c758ea0f9271018b278a9dcedb91b1190deaa598704b87219b",
"hostId": "416f83c758ea0f9271018b278a9dcedb91b1190deaa598704b87219b",
"id": "ef440f98-04e8-46ea-ae74-e24d437040ea",
"image": {
"id": "70a599e0-31e7-49b7-b260-868f441e862b",
"links": [
{
"href": "http://glance.openstack.example.com/images/70a599e0-31e7-49b7-b260-868f441e862b",
"href": "http://openstack.example.com/images/70a599e0-31e7-49b7-b260-868f441e862b",
"rel": "bookmark"
}
]

109
api-ref/src/wadls/compute-api/src/v2.1/wadl/os-hypervisors-v2.1.wadl
View File

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8"?>
<!-- (C) 2014 OpenStack Foundation, All Rights Reserved -->
<!-- (C) 2014-2015 OpenStack Foundation, All Rights Reserved -->
<!DOCTYPE application [<!ENTITY % common SYSTEM "../common.ent">
%common;]>
<application xmlns="http://wadl.dev.java.net/2009/02"
@ -14,13 +14,39 @@
<resource id="statistics" path="statistics">
<method href="#showhypervisorstatistics"/>
</resource>
<resource id="search" path="search">
<param name="query" style="query"
type="xsd:string">
<wadl:doc
xmlns="http://docbook.org/ns/docbook"
xml:lang="EN"><para>Filters the search
results by the specified
<code>?query={filter}</code> query
parameter.</para>
</wadl:doc>
</param>
<method href="#searchhypervisors"/>
</resource>
<resource id="os-pci" path="os-pci">
<method href="#listPCIs"/>
<resource id="detail" path="detail">
<method href="#listhypervisor-pci-details"/>
</resource>
<resource id="hypervisor_id2" path="{hypervisor_id}">
<method href="#showhypervisor-pci"/>
</resource>
</resource>
<resource id="hypervisor_id" path="{hypervisor_id}">
<method href="#showhypervisordetails"/>
<resource id="uptime" path="uptime">
<method href="#showhypervisoruptime"/>
</resource>
<resource id="servers" path="servers">
<method href="#listservers"/>
<resource id="server_id" path="{server_id}">
<method href="#showserver">
</method>
</resource>
</resource>
<resource id="uptime" path="uptime">
<method href="#showhypervisoruptime"/>
</resource>
</resource>
</resource>
@ -57,7 +83,25 @@
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">
<xsdxt:code
href="../api_samples/os-hypervisors/hypervisors-servers-resp.json"
href="../api_samples/os-pci/servers-detail-resp.json"
/>
</wadl:doc> &x-openstack-request-idHeader;
</representation>
</response>
</method>
<method name="GET" id="showserver">
<wadl:doc xml:lang="EN" title="Show server details"
xmlns="http://docbook.org/ns/docbook">
<para role="shortdesc">Shows server details for a specified
hypervisor.</para>
</wadl:doc>
<request> </request>
<response status="200">
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">
<xsdxt:code
href="../api_samples/os-pci/server-get-resp.json"
/>
</wadl:doc> &x-openstack-request-idHeader;
</representation>
@ -117,4 +161,59 @@
</representation>
</response>
</method>
<method name="GET" id="listhypervisor-pci-details">
<wadl:doc xml:lang="EN" title="List hypervisors with PCI details"
xmlns="http://docbook.org/ns/docbook">
<para role="shortdesc">
Lists hypervisors with payment card industry (PCI) details.
</para>
</wadl:doc>
<request> </request>
<response status="200">
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">
<xsdxt:code
href="../api_samples/os-pci/hypervisors-pci-detail-resp.json"
/>
</wadl:doc> &x-openstack-request-idHeader;
</representation>
</response>
</method>
<method name="GET" id="listPCIs">
<wadl:doc xml:lang="EN" title="List PCIs"
xmlns="http://docbook.org/ns/docbook">
<para role="shortdesc">
Lists PCIs.
</para>
</wadl:doc>
<request> </request>
<response status="200">
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">
<xsdxt:code
href="../api_samples/os-pci/pci-index-resp.json"
/>
</wadl:doc> &x-openstack-request-idHeader;
</representation>
</response>
</method>
<method name="GET" id="showhypervisor-pci">
<wadl:doc xml:lang="EN" title="Show PCI details"
xmlns="http://docbook.org/ns/docbook">
<para role="shortdesc">Shows PCI details for a specified hypervisor.</para>
</wadl:doc>
<request> </request>
<response status="200">
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">
<xsdxt:code
href="../api_samples/os-pci/pci-show-resp.json"
/>
</wadl:doc> &x-openstack-request-idHeader;
</representation>
</response>
</method>
</application>

2
api-ref/src/wadls/compute-api/src/v2/api_samples/os-hypervisor-status/hypervisors-show-with-status-resp.json
View File

@ -1,6 +1,6 @@
{
"hypervisor": {
"cpu_info": "?",
"cpu_info": "{\"arch\": \"x86_64\", \"model\": \"Nehalem\", \"vendor\": \"Intel\", \"features\": [\"pge\", \"clflush\"], \"topology\": {\"cores\": 1, \"threads\": 1, \"sockets\": 4}}",
"current_workload": 0,
"disk_available_least": 0,
"free_disk_gb": 1028,

4
api-ref/src/wadls/compute-api/src/v2/api_samples/os-hypervisor-status/hypervisors-show-with-status-resp.xml
View File

@ -1,4 +0,0 @@
<?xml version='1.0' encoding='UTF-8'?>
<hypervisor vcpus_used="0" hypervisor_type="fake" local_gb_used="0" hypervisor_hostname="fake-mini" memory_mb_used="512" memory_mb="8192" current_workload="0" vcpus="1" cpu_info="?" running_vms="0" free_disk_gb="1028" hypervisor_version="1000" disk_available_least="0" local_gb="1028" free_ram_mb="7680" id="1" state="up" status="enabled">
<service host="807e1a43ceb740138eea32969c3e9fe5" id="2" disabled_reason="None"/>
</hypervisor>

9
api-ref/src/wadls/compute-api/src/v2/common.ent
View File

@ -73,10 +73,11 @@
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>Returns a unique identifier to provide tracking for the request.
The request-id associated with the request appears in the log lines for
that request. By default, the middleware configuration ensures the
request_id appears in the log files.
<para>
Returns a unique identifier to provide tracking for the request. The
request ID that is associated with the request appears in the log lines for that
request. By default, the middleware configuration ensures that the request ID
appears in the log files.
</para>
</wadl:doc>
</param>'>

50
api-ref/src/wadls/compute-api/src/v2/ext/os-hypervisor-status.wadl Normal file
View File

@ -0,0 +1,50 @@
<?xml version="1.0" encoding="UTF-8"?>
<!-- (C) 2015 OpenStack Foundation, All Rights Reserved -->
<application xmlns="http://wadl.dev.java.net/2009/02"
xmlns:xsdxt="http://docs.rackspacecloud.com/xsd-ext/v1.0"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:csapi="http://docs.openstack.org/compute/api/v2">
<resources base="https://servers.api.openstack.com"
xml:id="os-hypervisor-status-v2">
<resource id="version" path="//v2">
<resource id="tenant_id" path="{tenant_id}">
<param name="tenant_id" style="template"
type="xsd:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">
<para>The ID for the tenant or account in a
multi-tenancy cloud.</para></wadl:doc>
</param>
<resource id="os-hypervisor-status" path="os-hypervisor-status">
<resource id="detail" path="detail">
<method href="#showHypervisor-status"/>
</resource>
</resource>
</resource>
</resource>
</resources>
<method name="GET" id="showHypervisor-status">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="Show hypervisor information">
<para role="shortdesc">
Shows information for a specified hypervisor. Includes the
hypervisor status.
</para>
<para>
Typically configured as an admin-only extension by using
<code>policy.json</code> settings.
</para>
</wadl:doc>
<response status="200">
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">
<xsdxt:code
href="../api_samples/os-hypervisor-status/hypervisors-show-with-status-resp.json"
/>
</wadl:doc>
</representation>
</response>
</method>
</application>

99
api-ref/src/wadls/compute-api/src/v2/wadl/os-compute-2.wadl
View File

@ -3,7 +3,7 @@
<!--*******************************************************-->
<!-- Import Common XML Entities -->
<!-- -->
<!-- You can resolve the entities with xmllint -->
<!-- You can resolve the entities with xmllint -->
<!-- -->
<!-- xmllint -noent os-compute-2.wadl -->
<!--*******************************************************-->
@ -39,14 +39,12 @@
</param>
<resource id="extensions" type="#ExtensionList" path="extensions">
<resource id="extension" path="{alias}">
<param required="true" xmlns="http://wadl.dev.java.net/2009/02" name="alias"
style="template" type="xsd:string">
<param name="alias" style="template" type="xsd:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<para>An alias, which is a name for a pointer to a resource. For
example, a named extension.</para>
<para>The extension name.</para>
</wadl:doc>
</param>
<method href="#getExtensionv2"/>
<method href="#getExtension-v2"/>
</resource>
</resource>
<resource id="limits" path="limits">
@ -158,10 +156,10 @@
<method href="#getVersionDetailsv2"/>
</resource_type>
<resource_type id="ExtensionList">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="Detail image list">
<para>A list of supported extensions.</para>
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook" title="List extensions">
<para role="shortdesc">Lists supported extensions.</para>
</wadl:doc>
<method href="#listExtensionsv2"/>
<method href="#listExtensions-v2"/>
</resource_type>
<resource_type id="DetailServerList">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="Detail server list">
@ -196,8 +194,10 @@
</resource_type>
<resource_type id="ImageList">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="Image list">
<para>A list of images. Each image contains IDs, names, and links. Other attributes are
omitted.</para>
<para>
A list of images. Each image contains IDs, names, and links.
Other attributes are omitted.
</para>
</wadl:doc>
<method href="#listImages"/>
</resource_type>
@ -209,8 +209,10 @@
</resource_type>
<resource_type id="FlavorList">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="Flavor list">
<para>A list of flavors. Each flavor contains IDs, names, and links; other attributes
are omitted.</para>
<para>
A list of flavors. Each flavor contains IDs, names, and links;
other attributes are omitted.
</para>
</wadl:doc>
<method href="#listFlavors"/>
</resource_type>
@ -257,57 +259,74 @@
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<xsdxt:code href="../api_samples/limit-get-resp.json"/>
</wadl:doc> &x-compute-request-idHeader;
</wadl:doc> &x-compute-request-idHeader; &absoluteLimits; &rateLimits;
</representation>
<representation mediaType="application/xml" element="common:limits">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<xsdxt:code href="../api_samples/limit-get-resp.xml"/>
</wadl:doc>
&absoluteLimits; &rateLimits;
</representation>
</response>
<!-- Common Faults and Header --> &commonFaults; </method>
<!-- Extensions -->
<method name="GET" id="listExtensionsv2">
<method name="GET" id="listExtensions-v2">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="List extensions">
<para role="shortdesc">Lists available extensions.</para>
<para role="shortdesc">Lists extensions.</para>
</wadl:doc>
<response status="200 203">
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<xsdxt:code href="../api_samples/all_extensions/extensions-get-resp.json"/>
</wadl:doc> &x-compute-request-idHeader;
</representation>
<representation mediaType="application/xml" element="common:extensions">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<xsdxt:code href="../api_samples/all_extensions/extensions-get-resp.xml"/>
</wadl:doc>
&x-compute-request-idHeader;
<param name="next" style="plain" type="xsd:anyURI"
path="/common:extensions/atom:link[@rel='next']/@href">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"><para>Moves to the
next metadata item.</para></wadl:doc>
path="/capi:extensions/atom:link[@rel='next']/@href">
<wadl:doc xmlns:wadl="http://wadl.dev.java.net/2009/02"
xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<para>Moves to the next item in the list.</para>
</wadl:doc>
<link resource_type="#ExtensionList" rel="next"/>
</param>
<param name="previous" style="plain" type="xsd:anyURI"
path="/common:extensions/atom:link[@rel='previous']/@href">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"><para>Moves to the
previous metadata item.</para></wadl:doc>
path="/capi:extensions/atom:link[@rel='previous']/@href">
<wadl:doc xmlns:wadl="http://wadl.dev.java.net/2009/02"
xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<para>Moves to the previous item in the list.</para>
</wadl:doc>
<link resource_type="#ExtensionList" rel="previous"/>
</param>
</representation>
</response>
<!-- Common Faults and Header --> &commonFaults; </method>
<method name="GET" id="getExtensionv2">
<!-- Common Faults and Header -->
&commonFaults;
</method>
<method name="GET" id="getExtension-v2">
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook" title="Get extension">
<para role="shortdesc">Gets details about the specified extension.</para>
<para>Extensions introduce features and vendor-specific functionality to the API without
requiring a version change.</para>
<para>
Extensions introduce features and vendor-specific
functionality to the API without requiring a version change.
</para>
</wadl:doc>
<request>
<representation mediaType="application/json">
<param required="true" xmlns="http://wadl.dev.java.net/2009/02" name="alias"
style="template" type="xsd:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<para>
An alias, which is a name for a pointer to a resource.
For example, a named extension.
</para>
</wadl:doc>
</param>
</representation>
</request>
<response status="200 203">
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<xsdxt:code href="../api_samples/extension.json"/>
</wadl:doc> &x-compute-request-idHeader;
</wadl:doc>
&x-compute-request-idHeader;
</representation>
<representation mediaType="application/xml" element="common:extension">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
@ -505,14 +524,17 @@
still persists.</para>
</listitem>
<listitem>
<para><code>SUSPENDED</code>. The server is suspended, either by request or
necessity. This status appears for only the following hypervisors:
XenServer/XCP, KVM, and ESXi. Administrative users may suspend an instance
<para>
<code>SUSPENDED</code>. The server is suspended,
either by request or necessity. This status appears
for only the following hypervisors: XenServer/XCP,
KVM, and ESXi. Administrative users may suspend an instance
if it is infrequently used or to perform system maintenance. When you
suspend an instance, its VM state is stored on disk, all memory is written
to disk, and the virtual machine is stopped. Suspending an instance is
similar to placing a device in hibernation; memory and vCPUs become
available to create other instances.</para>
available to create other instances.
</para>
</listitem>
<listitem>
<para><code>UNKNOWN</code>. The state of the server is unknown. Contact your
@ -1327,7 +1349,6 @@
</representation>
</response>
<!-- Common Faults and GET Faults--> &commonFaults; &getFaults; </method>
<method name="GET" id="showImageMetadata">
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook" title="Show image metadata">
<para role="shortdesc">Shows metadata for a specified image.</para>
@ -1404,7 +1425,6 @@
</response>
<!-- Common, GET, POST/PUT, inProgress Faults--> &commonFaults; &getFaults; &postPutFaults;
&inProgressFault; </method>
<method name="POST" id="updateImageMetadata">
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook"
title="Update image metadata items">
@ -1566,7 +1586,6 @@
</response>
<!-- Common Faults and GET Faults--> &commonFaults; &getFaults;
</method>
<method name="GET" id="getImageMetadataItem">
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook"
title="Show image metadata item details">