Added descriptions of status for servers (list servers).
Updated desc of RESCUE mode to remove Rackspace KC link. Patch #3 - updated status descriptions to remove shared IP Patch #4 - corrected "contact support" per Anne's request and added REVERT_RESIZE status Change-Id: Ic26fe76fe445e0b1e0c93cf67de27aa4544779fd
This commit is contained in:
Diane Fleming
parent
f566433a8e
commit
c395be1769
3
openstack-compute-api-2/.gitignore
vendored
Normal file
3
openstack-compute-api-2/.gitignore
vendored
Normal file
@ -0,0 +1,3 @@
|
||||
*.bak
|
||||
*.DS_Store
|
||||
target/
|
||||
@ -753,24 +753,32 @@ X-Auth-Token: eaaafd18-0fed-4b3a-81b4-663c99ec1cbb
|
||||
<title>Full Image Reference: JSON</title>
|
||||
<programlisting language="javascript"><xi:include href="samples/server-post-req.json" parse="text"/></programlisting>
|
||||
</example>
|
||||
<para>
|
||||
For convenience, resources contain links to
|
||||
<para>For convenience, resources contain links to
|
||||
themselves. This allows a client to easily obtain
|
||||
resource URIs rather than to construct them. There
|
||||
are three kinds of link relations associated with
|
||||
resources. A <code>self</code> link contains a
|
||||
versioned link to the resource. These links should be
|
||||
used in cases where the link will be followed
|
||||
immediately. A <code>bookmark</code> link provides a
|
||||
permanent link to a resource that is appropriate for
|
||||
long term storage. An <code>alternate</code> link can
|
||||
contain an alternate representation of the resource.
|
||||
For example, an OpenStack Compute image may have an
|
||||
alternate representation in the OpenStack Image
|
||||
service. Note that the type attribute here is used to
|
||||
provide a hint as to the type of representation to
|
||||
expect when following the link.
|
||||
</para>
|
||||
rather than construct resource URIs. The following
|
||||
types of link relations are associated with resources: <itemizedlist>
|
||||
<listitem>
|
||||
<para>A <code>self</code> link contains a
|
||||
versioned link to the resource. Use these
|
||||
links when the link will be followed
|
||||
immediately.</para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para>A <code>bookmark</code> link provides a
|
||||
permanent link to a resource that is
|
||||
appropriate for long term storage.</para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para>An <code>alternate</code> link can
|
||||
contain an alternate representation of the
|
||||
resource. For example, an OpenStack
|
||||
Compute image might have an alternate
|
||||
representation in the OpenStack Image
|
||||
service.</para>
|
||||
</listitem>
|
||||
</itemizedlist>Note that the type attribute here is
|
||||
used to provide a hint as to the type of
|
||||
representation to expect when following the link. </para>
|
||||
<example>
|
||||
<title>Server with Self Links: XML</title>
|
||||
<programlisting language="xml"><xi:include href="samples/server-simple.xml" parse="text"/></programlisting>
|
||||
@ -1032,14 +1040,12 @@ X-Auth-Token: eaaafd18-0fed-4b3a-81b4-663c99ec1cbb
|
||||
minute because the rate limits for any &POST; is
|
||||
10/min.
|
||||
</para>
|
||||
<para>
|
||||
In the event a request exceeds the thresholds
|
||||
<para>In the event a request exceeds the thresholds
|
||||
established for your account, a
|
||||
<errorcode>413</errorcode> HTTP response will be
|
||||
returned with a <code>Retry-After</code> header to
|
||||
notify the client when they can attempt to try
|
||||
again.
|
||||
</para>
|
||||
<errorcode>413</errorcode> HTTP response will
|
||||
be returned with a <code>Retry-After</code> header
|
||||
to notify the client when they can attempt to try
|
||||
again. </para>
|
||||
</section>
|
||||
<?hard-pagebreak?>
|
||||
<section xml:id="Absolute_Limits-d1e994">
|
||||
@ -1675,20 +1681,18 @@ Host: servers.api.openstack.org/v2/
|
||||
</section>
|
||||
<section xml:id="Asynchronous_Faults-d1e2009">
|
||||
<title>Asynchronous Faults</title>
|
||||
<para>
|
||||
An error may occur in the background while a
|
||||
<para> An error may occur in the background while a
|
||||
server or image is being built or while a server
|
||||
is executing an action. In these cases, the
|
||||
server or image is placed in an <code>ERROR</code>
|
||||
state and the fault is embedded in the offending
|
||||
server or image. Note that these asynchronous
|
||||
faults follow the same format as the synchronous
|
||||
ones. The fault contains an error code, a human
|
||||
readable message, and optional details about the
|
||||
error. Additionally, asynchronous faults may also
|
||||
contain a created timestamp that specify when the
|
||||
fault occured.
|
||||
</para>
|
||||
is executing an action. In these cases, the server
|
||||
or image is placed in an <code>ERROR</code> state
|
||||
and the fault is embedded in the offending server
|
||||
or image. Note that these asynchronous faults
|
||||
follow the same format as the synchronous ones.
|
||||
The fault contains an error code, a human readable
|
||||
message, and optional details about the error.
|
||||
Additionally, asynchronous faults may also contain
|
||||
a created timestamp that specify when the fault
|
||||
occurred. </para>
|
||||
<?hard-pagebreak?>
|
||||
<example>
|
||||
<title>Server In Error State: XML</title>
|
||||
@ -1820,40 +1824,134 @@ Host: servers.api.openstack.org/v2/
|
||||
<para>The server status, which is one
|
||||
of the following values:<itemizedlist>
|
||||
<listitem>
|
||||
<para>ACTIVE</para>
|
||||
<para><emphasis role="bold"
|
||||
>ACTIVE</emphasis>. The server is
|
||||
active.</para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para>BUILD</para>
|
||||
<para><emphasis role="bold"
|
||||
>BUILD</emphasis>. The server has
|
||||
not finished the original build
|
||||
process.</para>
|
||||
</listitem>
|
||||
<!--<listitem>
|
||||
<para>DELETE_IP. An IP address is
|
||||
being removed from the
|
||||
server.</para>
|
||||
</listitem> -->
|
||||
<listitem>
|
||||
<para><emphasis role="bold"
|
||||
>DELETED</emphasis>. The server is
|
||||
deleted.</para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para>DELETED</para>
|
||||
<para><emphasis role="bold"
|
||||
>ERROR</emphasis>. The server is in
|
||||
error.</para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para>ERROR</para>
|
||||
<para><emphasis role="bold"
|
||||
>HARD_REBOOT</emphasis>. The server
|
||||
is hard rebooting. This is
|
||||
equivalent to pulling the power
|
||||
plug on a physical server, plugging
|
||||
it back in, and rebooting
|
||||
it.</para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para>HARD_REBOOT</para>
|
||||
<para><emphasis role="bold"
|
||||
>PASSWORD</emphasis>. The password
|
||||
is being reset on the
|
||||
server.</para>
|
||||
</listitem>
|
||||
<!-- <listitem>
|
||||
<para>PREP_RESIZE. The server is
|
||||
performing the initial copy of data
|
||||
to its new host. Server should
|
||||
still be active at this
|
||||
time.</para>
|
||||
</listitem> -->
|
||||
<!-- <listitem>
|
||||
<para>QUEUE_RESIZE. The server is
|
||||
in the queue pending a resize or
|
||||
migration. Server should still be
|
||||
active at this time.</para>
|
||||
</listitem> -->
|
||||
<listitem>
|
||||
<para><emphasis role="bold"
|
||||
>REBOOT</emphasis>. The server is
|
||||
in a soft reboot state. A reboot
|
||||
command was passed to the operating
|
||||
system.</para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para>PASSWORD</para>
|
||||
<para><emphasis role="bold"
|
||||
>REBUILD</emphasis>. The server is
|
||||
currently being rebuilt from an
|
||||
image.</para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para>REBOOT</para>
|
||||
<para><emphasis role="bold"
|
||||
>RESCUE</emphasis>. The server is
|
||||
in rescue mode. </para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para>REBUILD</para>
|
||||
<para><emphasis role="bold"
|
||||
>RESIZE</emphasis>. Server is
|
||||
performing the differential copy of
|
||||
data that changed during its
|
||||
initial copy. Server is down for
|
||||
this stage.</para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para>RESIZE</para>
|
||||
<para><emphasis role="bold"
|
||||
>REVERT_RESIZE</emphasis>. The
|
||||
resize or migration of a server
|
||||
failed for some reason. The
|
||||
destination server is being cleaned
|
||||
up and the original source server
|
||||
is restarting. </para>
|
||||
</listitem>
|
||||
<!-- <listitem>
|
||||
<para>SHARE_IP. An IP address is
|
||||
currently being shared with or from
|
||||
this server. The network
|
||||
configuration for this server will
|
||||
change, perhaps requiring an IP
|
||||
address. </para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para>SUSPENDED</para>
|
||||
<para>SHARE_IP_NO_CONFIG. The host
|
||||
is being reconfigured to allow your
|
||||
server to use an IP from another
|
||||
machine. No configuration change
|
||||
should occur on your guest server,
|
||||
however it might reboot if the
|
||||
kernel is not compatible with the
|
||||
pause state that the hypervisor
|
||||
requests during the process.</para>
|
||||
</listitem> -->
|
||||
<listitem>
|
||||
<para><emphasis role="bold"
|
||||
>SUSPENDED</emphasis>. The server
|
||||
is suspended, either by request or
|
||||
for necessity. Review support
|
||||
tickets or contact your cloud
|
||||
provider to determine why the
|
||||
server is in this state.</para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para>UNKNOWN</para>
|
||||
<para><emphasis role="bold"
|
||||
>UNKNOWN</emphasis>. The state of
|
||||
the server is unknown. Contact your
|
||||
cloud provider.</para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para>VERIFY_RESIZE</para>
|
||||
<para><emphasis role="bold"
|
||||
>VERIFY_RESIZE</emphasis>. System
|
||||
is awaiting confirmation that the
|
||||
server is operational after a move
|
||||
or resize.</para>
|
||||
</listitem>
|
||||
</itemizedlist></para>
|
||||
</listitem>
|
||||
@ -1894,15 +1992,8 @@ Host: servers.api.openstack.org/v2/
|
||||
attribute that can be used as an indication of the
|
||||
current server state. Servers with an
|
||||
<code>ACTIVE</code> status are available for
|
||||
use. Other possible values for the status
|
||||
attribute include: <code>BUILD</code>,
|
||||
<code>REBUILD</code>, <code>SUSPENDED</code>,
|
||||
<code>RESIZE</code>,
|
||||
<code>VERIFY_RESIZE</code>,
|
||||
<code>PASSWORD</code>, <code>REBOOT</code>,
|
||||
<code>HARD_REBOOT</code>,
|
||||
<code>DELETED</code>, <code>UNKNOWN</code>, and
|
||||
<code>ERROR</code>. </para>
|
||||
use. See the definition of the <parameter>status</parameter> attribute
|
||||
for a list of possible statuses.</para>
|
||||
<para>The compute provisioning algorithm has an
|
||||
anti-affinity property that attempts to spread
|
||||
customer VMs across hosts. Under certain
|
||||
@ -3878,9 +3969,7 @@ Host: servers.api.openstack.org/v2/
|
||||
the system. </para>
|
||||
<para>Specify the image ID as
|
||||
<parameter>id</parameter> in the URI. </para>
|
||||
<para>Images are immediately removed. Currently, there
|
||||
are no state transitions to track the delete
|
||||
operation. </para>
|
||||
<para>Images are immediately removed. </para>
|
||||
<para>This operation does not require a request body.</para>
|
||||
<para>This operation does not return a response
|
||||
body.</para>
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user